Cloud Administration Synchronize User API

Use the Cloud Administration Synchronize User API to synchronize the details of a single user between an identity source and Cloud Access Service (CAS).

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

Clients calling this API to synchronize a user must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to synchronize information about a particular user.

Resource Identifier

Use the following resource identifier.

Request Body

Request body is empty. Set Content-Length to zero when calling this resource.

Example Request Data

The following example displays a request to synchronize a user.

POST https://localhost/AdminInterface/restapi/v1/users/eb2e12ae-1112-451b-98e1-dfe4e6afd60d/sync

Content-Length: 0

Authorization: Bearer <JWT token>

Response

When the request succeeds, the response body contains user details with updated user information.

Example Response Body

The following example displays a response body.

{
    "id": "f85b6e95-f41f-45b4-bc84-559fead6460c",
    "emailAddress": "user.one@mycompany.com",
    "firstName": "User",
    "lastName": "One",
    "creationDate": "2018-08-31T19:10:30.045Z",
    "identitySource": "My Company AD",
    "userStatus": "Enabled",
    "markDeleted": false,
    "highRiskUser": false,
    "markDeletedAt": null,
    "markDeletedBy": null,
    "smsNumber": "+11235556799",
    "voiceNumber": "+1 774 291 4444",
    "isTokenLocked": false,
    "isSmsLocked": false,
    "isVoiceLocked": false,
    "lastSyncTime": "2018-08-31T19:20:30.045Z",
    "emergencyAccessStatus": "Disabled",
    "emergencyTokencodeId": null,
    "emergencyTokencodeExpiration": null,
    "emergencyTokencodeLastUse": null,
    "offlineEmergencyAccessStatus": "Disabled",
    "offlineEmergencyTokencodeExpiration": null,
    "monthLastAuthenticated": "Nov 2020",
    "identitySourceSpecificGroups": [
        "Group 1",
        "Group 2"
    ],
    "globalGroups": [
        "Group 3"
    ]
}

Response Property Descriptions

The following table describes properties used in the response.

Response Codes

The following table shows the response codes and their descriptions for this API.