Get LDAP Server by Id - GET /LDAPServers/{id}
Get details of an LDAP Server according to LDAP Server Id.
The ‘Manage Authentication Providers’ permission is required to execute this API.
Usage:
- GET /LDAPServers/{id} and get details of an LDAP Server
- PUT /LDAPServers/{id} and update LDAP Server details
URL
/cxrestapi/auth/LDAPServers/{id}
Method:
GET
Media Type (header):
Authorization: Bearer <access token value>
Accept: application/json;v=1.0
Parameters
Required:
id=[integer] - Unique Id of the LDAP Server. LDAP Server Id (id) is retrieved using the LDAP Servers API.
Success Response:
Code: 200 Success
Error Response:
Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
Sample Response:
[
{
"id": 2,
"active": true,
"name": "microsoft.ldap",
"host": "0.0.0.0",
"port": 389,
"username": "cn=admin,dc=example,dc=com",
"useSsl": false,
"verifySslCertificate": false,
"ldapDirectoryType": "ActiveDirectory",
"ssoEnabled": false,
"mappedDomainId": null,
"baseDn": "ou=automation,dc=example,dc=com",
"additionalUserDn": "ou=people",
"userObjectFilter": "(&(objectClass=inetOrgPerson)(uid=*))",
"userObjectClass": "inetOrgPerson",
"usernameAttribute": "uid",
"firstNameAttribute": "givenName",
"lastNameAttribute": "sn",
"emailAttribute": "mail",
"synchronizationEnabled": true,
"defaultTeamId": 1,
"defaultRoleId": 1,
"updateTeamAndRoleUponLoginEnabled": false,
"periodicalSynchronizationEnabled": true,
"advancedTeamAndRoleMappingEnabled": false,
"additionalGroupDn": "ou=groups",
"groupObjectClass": "groupOfUniqueNames",
"groupObjectFilter": "(objectClass=groupOfUniqueNames)",
"groupNameAttribute": "cn",
"groupMembersAttribute": "uniqueMember",
"userMembershipAttribute": "memberOf"
}
]
Notes:
Retrieves details of an LDAP Server according to the defined LDAP Server Id. If the request fails, it returns an error response.
Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!