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.
| Method | Request URL | Request Content Type | Response Content Type | Response Codes |
|---|---|---|---|---|
| PATCH | /AdminInterface/restapi/v1/users/ <userId> | application/json | application/json | 200, 400, 403, 404, 429, 500 |
Request Body
The following table describes the request body.
| Request Body | Description |
|---|---|
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. SecurID 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": "bf40077e-767b-495d-a7c8-d9909601bea6",
"emailAddress": "borg-del-user@via.com",
"firstName": "borg-del-user",
"lastName": "borg-del-user",
"creationDate": "2018-09-06T19:27:47.000Z",
"identitySource": "Viaengdc1 nga2012.local forest IS Pontus",
"userStatus": "Enabled",
"markDeleted": false,
"highRiskUser": false,
"markDeletedAt": null,
"markDeletedBy": null,
"smsNumber": "+15151239876",
"voiceNumber": "+15151239877",
"isTokenLocked": false,
"isSmsLocked": false,
"isVoiceLocked": false,
"lastSyncTime": "2018-09-06T19:45:57.000Z",
"emergencyAccessStatus": "Disabled",
"emergencyTokencodeId": null,
"emergencyTokencodeExpiration": null,
"emergencyTokencodeLastUse": null
"offlineEmergencyAccessStatus": "Disabled",
"offlineEmergencyTokencodeExpiration": null,
}
Response Property Descriptions
The following table shows property descriptions and data types.
| Property | Description | Data Type |
|---|---|---|
| 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 Access Service. See https://www.w3.org/TR/NOTE-datetime for information on formatting timestamps in ISO 8601 format. | String |
| identitySource | Name 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. | String |
| 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 |
| 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. | 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 |
| 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 |
| emergencyTokencodeOneTimeUse | True indicates that an Emergency Tokencode can be used only once. False indicates that an Emergency Tokencode can be used multiple times. | Boolean |
| offlineEmergencyTokencodeExpiration | Offline 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 |
Response Codes
The API returns the following response codes.
| Code | Description |
|---|---|
| 200 | Successfully updated phone number. |
| 400 | Invalid User ID or request body. |
| 403 | Not authorized to perform the request. |
| 404 | User is not found. |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
Related Articles
Workstation can be unlocked without using correct PIN Number of Views Cloud Administration Synchronize User API Number of Views How to Install a Third Party Certificate into enVision Number of Views Appliance Logs Number of Views How to delete software token from Windows Phone Number of Views
Trending Articles
How to recover the Application and AFX after an unexpected database failure in RSA Identity Governance & Lifecycle RSA MFA Agent 2.3.6 for Microsoft Windows Installation and Administration Guide RSA Release Notes for RSA Authentication Manager 8.8 RSA Release Notes: Cloud Access Service and RSA Authenticators RSA SecurID Software Token 5.0.2 for Windows Desktop displays message after reboot due to roaming profile: No token stor…
