Cloud Administration Synchronize User API
Last Modified: 2026-11-12

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.

MethodRequest URLResponse Content TypeResponse BodyResponse Codes
POST /AdminInterface/restapi/v1/users/<userId>/sync
application/jsonUser details with property200, 400, 403, 404, 429, 500

Resource Identifier

Use the following resource identifier.

Request ParameterDescription
<userId>Unique user identifier sent in the response to the User Details API.

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/d7c0c371-b892-8ec3-8ed3-c79fc2093b3c/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": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
    "emailAddress": "SampleUser1@rsavia.com",
    "firstName": "SampleUser1",
    "lastName": SampleLname1",
    "creationDate": "2026-08-07T08:41:23.000Z",
    "identitySource": "LOCAL_IS",
    "userStatus": "Enabled",
    "markDeleted": false,
    "highRiskUser": false,
    "markDeletedAt": null,
    "markDeletedBy": null,
    "smsNumber": "+15151239876",
    "voiceNumber": "+15151239877",
    "isTokenLocked": false,
    "isSmsLocked": false,
    "isVoiceLocked": false,
    "lastSyncTime": "2026-08-07T08:41:23.000Z",
    "emergencyAccessStatus": "Disabled",
    "emergencyTokencodeId": null,
    "emergencyTokencodeExpiration": null,
    "emergencyTokencodeLastUse": null,
    "offlineEmergencyAccessStatus": "Disabled",
    "offlineEmergencyTokencodeExpiration": null,
    "monthLastAuthenticated": "Sept 2026",
    "identitySourceSpecificGroups": [
        "Group 1",
        "Group 2"
    ],
    "globalGroups": [
        "Group 3"
    ]
}

When Enable Common User Schema Attributes is enabled, the API returns additional common schema attributes in the response body. This setting is disabled by default. For more information, see the Common User Schema Attributes section in Identity Sources for Cloud Access Service.

The following example response returns a user's additional common schema attributes.

{
    "id": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
    "emailAddress": "SampleUser1@rsavia.com",
    "firstName": "SampleUser1",
    "lastName": "SampleLname1",
    "creationDate": "2026-08-07T08:41:23.000Z",
    "identitySource": "LOCAL_IS",
    "userStatus": "Enabled",
    "highRiskUser": false,
    "markDeleted": false,
    "markDeletedAt": null,
    "markDeletedBy": null,
    "smsNumber": "+15151239876",
    "voiceNumber": "+15151239877",
    "isTokenLocked": false,
    "isSmsLocked": false,
    "isVoiceLocked": false,
    "isFingerprintLocked": false,
    "isApproveLocked": false,
    "lastSyncTime": "2026-08-07T08:41:23.000Z",
    "emergencyAccessStatus": "Disabled",
    "emergencyTokencodeId": null,
    "emergencyTokencodeExpiration": null,
    "emergencyTokencodeLastUse": null,
    "emergencyTokencodeOneTimeUse": null,
    "offlineEmergencyTokencodeExpiration": null,
    "offlineEmergencyAccessStatus": "Disabled",
    "monthLastAuthenticated": null,
    "principalUsername": "SampleUser1",
    "alternateUsername": "group1, group2",
    "primaryUniqueIdentifier": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
    "lastSuccessfulAuthenticationMethod": null,
    "lastSuccessfulAuthenticationDate": null,
    "identitySourceSpecificGroups": [
        "group1",
        "group2"
    ],
    "globalGroups": [],
    "identitySourceType": "CLOUD",
    "appAuthenticityCheckRelaxedUntil": null,
    "businessCategory": "Sample Business Category",
    "companyOrOrganization": "Sample Company",
    "department": "Sample Department",
    "countryCode": "+1",
    "description": "Software Engineer",
    "displayName": "SampleUser1",
    "employeeNumber": "EMP001",
    "employeeType": "Full-Time",
    "homeEmail": "username3@personal.com",
    "mobile": "+1234567892",
    "workPhone": "+0987654322",
    "fullName": "sample fullName"
}

Response Properties

The following table describes properties used in the response.

PropertyDescriptionData Type
idIdentifies the user.String
emailAddressUser's email address.String
firstNameUser's first name.String
lastNameUser's last name.String
creationDateDate when the user account was added to CAS.
See https://www.w3.org/TR/NOTE-datetime
for information on formatting timestamps in ISO 8601 format.
String
identitySourceName of identity source.String
userStatus

Enabled: Users can access protected resources.

Disabled: Users cannot access protected resources or register devices.

String
markDeletedIndicates whether the user is marked deleted.Boolean
markDeletedAt

Date when a user is marked deleted.
See https://www.w3.org/TR/NOTE-datetime

for information on formatting timestamps in ISO 8601 format.
String
markDeletedByAdministrator who initiated mark for delete. String
smsNumberDisplays user SMS phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized. String
voiceNumberDisplays user voice phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized.String
isTokenLockedTokencode status is either true (locked) or false (unlocked).Boolean
isSmsLockedSMS Tokencode status is either true (locked) or false (unlocked).Boolean
isVoiceLocked

Voice Tokencode status is either true (locked) or false (unlocked).

Boolean
lastSyncTime

Most recent time when user details were synchronized with an identity source.
See https://www.w3.org/TR/NOTE-datetime

for information on formatting timestamps in ISO 8601 format.
String
highRiskUser

True indicates the user is marked as high risk by an external third-party application. False indicates the user is not marked as high risk by an external third-party application.

Boolean
emergencyAccessStatus

Enabled: An Emergency Tokencode has been generated for this user.

Disabled: An Emergency Tokencode has not been generated for this user.

Locked: Emergency Tokencode is locked for this user.

String
emergencyTokencodeIdIdentifies the Emergency Tokencode, if one has been generated for this user.String
emergencyTokencodeExpirationEmergency Tokencode expiration date.String
emergencyTokencodeLastUseEmergency Tokencode last used date.String
emergencyTokencodeOneTimeUseTrue indicates that an Emergency Tokencode can be used only once. False indicates that an Emergency Tokencode can be used multiple times.Boolean
offlineEmergencyTokencodeExpirationOffline Emergency Tokencode expiration date.String
offlineEmergencyAccessStatus

Enabled: An offline Emergency Tokencode has been generated for this user.

Disabled: An offline Emergency Tokencode has not been generated for this user.

String
identitySourceSpecificGroups

Names of identity source groups that the user belongs to.

Array of strings
globalGroupsNames of CAS groups (local groups) that the user belongs to.Array of strings
businessCategoryDescriptive text about an organizational unit the user is associated with.String
companyOrOrganizationName of the company or organization the user belongs to.String
countryCodeTwo-letter country code for the user.String
departmentDepartment the user belongs to.String
descriptionDescriptive text about the user.String
displayNameName shown for the user. This may be the full name or a nickname set by the user or an administrator.String
employeeNumberNumeric or alphanumeric identifier assigned to the person.String
employeeTypeJob category of the employee.String
fullNameUser's full name.String
homeEmailAdditional mail addresses associated with the user.String
mobileUser's mobile phone number.String
workPhoneUser's work telephone number.String

Response Codes

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

CodeDescription
200

Successfully synchronized user.

Note:  This response creates an administration log event.

400Operation not performed because of client syntax errors.
403Not authorized to perform the request.
404

User is not found by CAS.

Note:  This response creates an administration log event.

429Too many requests.
500

Internal error occurred when processing the request.

Note:  This response creates an administration log event.