API v2: User Directory Synchronization Status πΒΆ
Data StructuresΒΆ
Attribute |
Type |
Required |
Description |
|---|---|---|---|
|
boolean; default value |
yes |
Enable User Directory synchronization. |
|
string |
yes |
Synchronization is performed on node with given serial number. |
|
boolean |
Read-only. Synchronization is performed on current node. |
Retrieve Available Attributes of the UserDirectoryEnableModelΒΆ
Request
Method |
|
Path |
|
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
Get User Directory Synchronization StatusΒΆ
Request
Method |
|
Path |
|
GET /api/v2/user_directory/enable
Example Request
curl -s -k -X GET \
-H 'Authorization:vg1ei6rgo58fsbobr7octp0w3afd9vsm' \
https://10.31.87.227/api/v2/user_directory/enable'
Response
{
"enabled": true,
"node": "86496998",
"current_node": true,
"result": "success"
}
Enable/Disable User Directory SynchronizationΒΆ
Request
Method |
|
Path |
|
Headers |
|
Body |
|
PATCH /api/v2/user_directory/enable
Example Request
curl -s -k -X PATCH \
-H 'Authorization:vg1ei6rgo58fsbobr7octp0w3afd9vsm' \
https://10.31.87.227/api/v2/user_directory/enable -H 'Content-Type: application/json' -d'{"enabled":true}'
Response
{
"result": "success"
}
Force Full SynchronizationΒΆ
Request
Method |
|
Path |
|
PATCH /api/v2/user_directory/<user_directory_id>/force_full_sync
Example Request
curl -s -k -X POST \
-H 'Authorization:vg1ei6rgo58fsbobr7octp0w3afd9vsm' \
https://10.31.87.227/api/v2/user_directory/9115285645797883908/force_full_sync
Response
{
"result": "success"
}