Skip to main content

Unlink users from LDAP

Resource Informations

NameValue
Requires authentication?Yes
Rate limited?No

Request

Request headers

KeyValue
AuthorizationBearer token
Content-Typeapplication/json

HTTP request URL for SSMS

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

HTTP request URL for SSMS

POST https://{hostname}/auth/realms/{tenantId}/v3_ldap/user/unlink?action=unlink
note

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

Parameters

Field NameTypeDescription
componentIdStringComponent Id of the LDAP (Path Parameter)
actionStringAction should be in 'unlink' (Query Parameter)

Request body

No Request Body.

Response

Field NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
"message": "Success",
"status": "OK",
"subSystem": 9
}