RSA SecurID Access Update SMS and Voice Phone API

Document created by RSA Information Design and Development on Nov 16, 2018
Version 1Show Document
  • View in full screen mode

The RSA SecurID Access 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.

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 RSA SecurID Access Administration REST API Download from RSA SecurID Access 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 RSA SecurID Access User Details API .

                        
MethodRequest URLRequest Content TypeResponse Content TypeResponse Codes
PATCH/AdminInterface/restapi/v1/users/
<userId>
application/jsonapplication/json200, 400, 403, 404, 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": "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,

"markDeletedAt": null,

"markDeletedBy": null,

"smsNumber": "+15151239876",

"voiceNumber": "+15151239877",

"isTokenLocked": false,

"isSmsLocked": false,

"isVoiceLocked": false,

"lastSyncTime": "2018-09-06T19:45:57.000Z"

}

Property Response Descriptions

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 the Cloud Authentication 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

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.
500Internal error occurred when processing the request.

 

 

You are here
Table of Contents > Cloud Administration REST APIs > RSA SecurID Access Update SMS and Voice Phone API

Attachments

    Outcomes