POST
URI:
- /api/v1/user_sync
Input fields:
Field Name | Type | Required |
Description |
---|---|---|---|
realm | string | No | The realm name. |
users | list | No | A user list, which includes user IDs and actions. |
sn |
string |
Yes |
The device's serial number. |
license |
string |
No |
The FTM migration license number. |
Successful response fields:
Field name | Type | Description |
---|---|---|
task_id | string | The user sync task ID |
Response codes:
Code |
Response content |
Description |
---|---|---|
201 OK | User sync task is created. | |
401 Unauthorized | License was associated with other device. | The request license number is not available. |
403 Forbidden | License is not in migration. | The request license number is not available. |
404 not found | License was not found. | The request license number is not available. |
Example request body:
{ "realm":"default", "sn":"abcd", "users":[ { "username":"abc", "action":"delete", "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx" }, { "username":"def", "action":"create", "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx" }, { "username":"ghi", "action":"modify", "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx" } ] }
Example of successful response body:
{ "task_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx" }