GET /ldapClientSettings
Use this method to return information about the client settings when an external LDAP server is used for authentication.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/ldapClientSettings
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| default={Boolean} | Optional | Indicates whether default LDAP client settings are returned. This can be one of the following values.
|
GET https://192.0.2.0/ldapClientSettings?default=true
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| response | Array of objects | Information about each user account | ||
| bindingMethod | String | Method that is used to bind XClarity Administrator to the external authentication server. This can be one of the following values.
| ||
| clientDn | String | Distinguished name of the client | ||
| clientPw | Boolean | Indicates if a client password is stored currently. This can be one of the following values.
| ||
| domainName | String | Domain name used by DNS to locate LDAP servers | ||
| forestName | String | Forest name used by DNS to locate LDAP servers | ||
| groupFilters | String | Groups search filters to customize the authentication process when configuring XClarity Administrator with an external LDAP server For information about search filter syntax, see How to write LDAP search filters. For search filter examples, see Examples of Common ldapsearches | ||
| groupNameAttribute | String | Attribute name that is used to identify the group name that is configured by the LDAP server The default is uid. | ||
| groupSearchAttribName | String | Attribute name that is used to identify the groups to which a user belongs The default is memberOf. | ||
| rootDn | String | Root distinguished name with the topmost entry in your LDAP directory tree | ||
| searchLimit | Integer | Maximum number of in-search results that can be retrieved in an LDAP search operation using user and group filters This can be a value from 0 – 5000. The default value is 0, which means that the operation does not time out. | ||
| serverAddress | Array of objects | Information about the server address | ||
| address | String | IP address for the server | ||
| port | Integer | Port number of the server connection | ||
| serverSelectionMethod | String | Specifies how LDAP servers are to be selected. This can be one of the following values.
| ||
| sslEnabled | Boolean | Indicates if SSL is enabled. This can be one of the following values.
| ||
| timeout | Integer | Amount of time, in seconds, to complete an LDAP search operation before timing out This can be a value from 0 – 300 (5 minutes). The default value is 0. | ||
| userAuthenticationMethod | String | Type of user authentication. This can be one of the following values.
| ||
| userFilters | String | Users search filters to customize the authentication process when configuring XClarity Administrator with an external LDAP server For information about search filter syntax, see How to write LDAP search filters. For search filter examples, see Examples of Common ldapsearches | ||
| userSearchAttribName | String | Attribute name that is used to identify the user IDs on the LDAP server When the binding method is set to Configured Credentials, the initial bind to the LDAP server is followed by a search request that retrieves specific information about the user, including the user's DN, login permissions, and group membership. This search request must specify the attribute name that represents the user IDs on that server. The default is cn. | ||
| useServersAsGlobalCatalogs | Boolean | Indicates whether to treat domain controllers as global catalogs. This can be one of the following values.
| ||
| result | String | Request results. This can be one of the following values.
| ||
| messages | Array of objects | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
{
"response": {
"bindingMethod": "configured_credentials",
"clientDn": "",
"clientPw": false,
"domainName": "",
"forestName": "",
"groupFilter": "",
"groupNameAttribute": "cn",
"groupSearchAttribName": "memberOf",
"rootDn": "",
"serverAddress": [{
"address": "1.1.1.1",
"port": 1
},
{
"address": "2.2.2.2",
"port": 2
},
{
"address": "3.3.3.3",
"port": 3
},
{
"address": "4.4.4.4",
"port": 4
}],
"searchFilter": "",
"searchSizeLimit": 0,
"serverSelectionMethod": "preconfigured",
"sslEnabled": true,
"timeoutLimit": 0,
"userAuthenticationMethod": "local",
"userSearchAttribName": "cn"
"useServersAsGlobalCatalogs" : true
},
"result": "success",
"messages": [{
"explanation": "",
"id": "FQXHMSE0001I",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}