Sync All users from LDAP

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}/fullsync?action=triggerFullSync

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_ldap/sync/{componentId}/fullsync?action=triggerFullSync

note

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

Parameters

Field Name	Type	Description
componentId	String	Component Id of the LDAP (Path Parameter)
action	String	Action should be in 'triggerFullSync' (Query Parameter)

Request body

No Request Body.

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.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Objects	Synced users details

Sample Response

{
    "message": "Success",
    "status": "OK",
    "subSystem": 9,
    "data": {
        "ignored": false,
        "added": 0,
        "updated": 0,
        "removed": 0,
        "failed": 11,
        "status": "0 imported users, 0 updated users, 11 users failed sync! See server log for more details"
    }
}