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.
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 APIs .
This API can use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.
Software Developer Kit
You can download API Software Developer Kit (SDK) from Cloud Administration REST API Download.
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 Cloud Administration User Details API .
|Method||Request URL||Request Content Type||Response Content Type||Response Codes|
|application/json||application/json||200, 400, 403, 404, 500|
The following table describes the request body.
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.
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.
"identitySource": "Viaengdc1 nga2012.local forest IS Pontus",
Property Response Descriptions
The following table shows property descriptions and data types.
|id||Identifies the user.||String|
|emailAddress||User's email address.||String|
|firstName||User's first name.||String|
|lastName||User's last name.||String|
|creationDate||Date when the user account was added to the Cloud Authentication Service. |
for information on formatting timestamps in ISO 8601 format.
|identitySource||Name of identity source.||String|
Enabled. Users can access protected resources.
Disabled. Users cannot access protected resources or register devices.
Date when a user is marked deleted.
|markDeletedBy||Administrator who initiated mark for delete.||String|
|smsNumber||Displays user phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized.||String|
|voiceNumber||Displays user voice phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized.||String|
|isTokenLocked||Token locked status is either true (locked) or false (unlocked).||Boolean|
|isSmsLocked||SMS phone locked status is either true (locked) or false (unlocked).||Boolean|
Voice locked status is either true (locked) or false (unlocked).
Most recent time when user details were synchronized with an identity source.
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.
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.
|emergencyTokencodeId||Identifies the Emergency Tokencode, if one has been generated for this user.||String|
|emergencyTokencodeExpiration||Emergency Tokencode expiration date.||String|
|emergencyTokencodeLastUse||Emergency Tokencode last used date.||String|
The API returns the following response codes.
|200||Successfully updated phone number.|
|400||Invalid User ID or request body.|
|403||Not authorized to perform the request.|
|404||User is not found.|
|500||Internal error occurred when processing the request.|
We want your feedback! Tell us what you think of this page.