Authentication API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
enabled |
True/False. Indicates if the authentication settings are used when trying to authenticate a user. |
If this parameter is false, only the application administrator can access the system. |
|
managerDistinguishedName |
The distinguished name of a user that has manager access to the AD server. For example CN=Administrator, CN=users, DC=MYSERVER, DC=COM. |
Required if the enabled parameter is true. |
|
managerPassword |
The password of the user specified in the managerDistinguishedName field. |
Required if the enabled parameter is true. |
|
primaryPort |
The host port. |
Required if the enabled parameter is true. |
|
primaryHost |
The host address of the AD server. |
Required if the enabled parameter is true. |
|
primaryUseSSL |
Indicates if a secure connection should be established. |
If enabled, this parameter requires that a domain certificate is uploaded to the server and that the primaryPort allows secure connections. If set to true, then you must follow the instructions in Enable SSL for Active Directory Authentication. |
|
roleName |
The name of an AD role or group. |
All users in this AD role or group can access Customer Collaboration Platform. Users in AD who are not members of this role or group cannot access Customer Collaboration Platform. Blank or * indicates that all users in AD can use the application. |