Get All LDAP Servers - GET /LDAPServers
Owned by David P (Deactivated)
Get details of all LDAP Servers.
The ‘Manage Authentication Providers’ permission is required to execute this API.
Usage:
- GET /LDAPServers and get details of all LDAP Servers
- PUT /LDAPServers/{id} and update the LDAP Server details
URL
/cxrestapi/auth/LDAPServers
Method:
GET
Media Type (header):
Authorization: Bearer <access token value>
Accept: application/json;v=1.0
Parameters
None
Success Response:
Code: 200 Success
Error Response:
Code: 401 Unauthorized
Code: 403 Forbidden
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 all LDAP Servers. 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!