Test LDAP Connection

Using this API, LDAP Connection for the provided componentID in the request can be tested.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/ldap/{componentId}/testconnection?action=testConnection

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_ldap/testLDAPConnection/{componentId}/testconnection?action=testConnection

note

At this moment, this API is applicable for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

Field Name	Type	Description
action	String	Action should be in 'testConnection' (Query Parameter)

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "LDAP test connection successful!",
    "status": "OK",
    "subSystem": 9
}

Response Status Information

Status Code	Status	Message
200	OK	LDAP test connection successful!
400	BAD_REQUEST	Component Not found
401	Unauthorized	HTTP 401 Unauthorized