Test LDAP Server Connection – POST /LDAPServers/TestConnection

Test LDAP Server connection.

Usage:

1. GET /LDAPServers/{id} and get details of an LDAP Server
2. POST /LDAPServers/TestConnection and test the LDAP Server connection

URL

/cxrestapi/auth/LDAPServers/TestConnection

Method:

POST

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

ldapServerViewModel=[body]: Specifies the details of LDAP Server to test
host=[integer] - LDAP Server host name
port=[integer] - LDAP Server Port
username=[string] - Username of the binding user
password=[integer] - Password of the binding user
useSsl=[boolean] - Whether to use SSL when connecting to this LDAP Server (false/true)
verifySslCertificate=[boolean] - Whether to verify SSL certificate (false/true)
baseDn=[string] - LDAP Server base DN
userObjectFilter=[string] - User object filter
userObjectClass=[string] - User object class
usernameAttribute=[string] – User name attribute
firstNameAttribute=[string] - First name attribute
lastNameAttribute=[string] - Last name attribute
emailAttribute=[string] - Email attribute
synchronizationEnabled=[boolean] - Whether synchronization is enabled for this LDAP Server (false/true)
advancedTeamAndRoleMappingEnabled=[boolean] - Whether to enable advanced team and role mapping (false/true)
additionalGroupDn=[string] - Additional group Dn. Limit groups search to specified DN
groupObjectClass=[string] - Group object class
groupObjectFilter=[string] - Group object filter
groupNameAttribute=[string] - Group name attribute
groupMembersAttribute=[string] - Group members attribute
userMembershipAttribute=[string] - User membership attribute

Success Response:

Code: 200 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

{
  "isSuccessful": true,
  "message": "Successfully connected to the LDAP Server, validated user schema settings and attributes"
}

Notes:

Tests LDAP Server connection. 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!