Cloud Administration Update SMS and Voice Phone API
Last Modified: 2026-11-12

Cloud Administration Update SMS and Voice Phone API

The Cloud Administration Update SMS and Voice Phone API enables Help Desk administrators to update a user's SMS Tokencode or Voice Tokencode phone number when it has changed. The API also can add an SMS Tokencode or Voice Tokencode phone number if no phone number previously existed for a user.

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

Authentication

Clients calling this API 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 API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to update a user's SMS Tokencode or Voice Tokencode phone number. The <userId> parameter is a unique user identifier that is sent in the response to the User Details API.

MethodRequest URLRequest Content TypeResponse Content TypeResponse Codes
PATCH/AdminInterface/restapi/v1/users/
<userId>
application/jsonapplication/json200, 400, 403, 404, 429, 500

Request Body

The following table describes the request body.

Request BodyDescription

smsNumber

voiceNumber

Must be a valid SMS Tokencode or Voice Tokencode phone number. To ensure that phone numbers are correctly routed during transmission, the country code is required. RSA recommends using the E.123 international format, +<country_code> <national_number>. For example, +1 555 555 5555 is a U.S. phone number that includes the country code +1. Extensions are not yet supported. To clear SMS Tokencode or Voice Tokencode phone numbers, send an empty string as the values of these properties.

For more information on managing users' SMS Tokencode and Voice Tokencode phone numbers, see Manage User Phone Numbers.

Example Request Body

The following example displays a request.

{

"smsNumber":"+15151239876",

"voiceNumber":"+15151239877"

}

Response Body

When the request succeeds, the response body contains user details with updated SMS Tokencode and Voice Tokencode phone numbers.

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,

}

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 after a successful update.

{

"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 shows property descriptions and data types.

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 Cloud Access Service.
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
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 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
isTokenLockedToken locked status is either true (locked) or false (unlocked).Boolean
isSmsLockedSMS phone locked status is either true (locked) or false (unlocked).Boolean
isVoiceLocked

Voice locked 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
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
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 API returns the following response codes.

CodeDescription
200Successfully updated phone number.
400Invalid User ID or request body.
403Not authorized to perform the request.
404User is not found.
429Too many requests.
500Internal error occurred when processing the request.