Cloud Administration Update Hardware Token Name API

The Cloud Administration Update Hardware Token Name API enables Help Desk Administrators to update the token name for an assigned or registered hardware token.

Authentication

Clients calling this API must authenticate themselves by including a JSON web token in the request. For instructions on using this token, see Authentication for the Cloud Administration APIs.

Administrative Roles

This API can use an API key associated with either Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.

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 retrieve a hardware token by providing a token serial number.

Method Request URL Response Content Type Response Body Response Codes
PATCH /AdminInterface/restapi/v1/users/<userId>/sidTokens/updateName application/json Token details with property 200, 400, 403, 404, 409, 500

Example Request Data

The following example displays a request.

PATCH /AdminInterface/restapi/v1/users/<userId>/sidTokens/updateName

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"tokenSerialNumber": "000000200002",

"updatedName": "newTokenName"

}

Request Property Descriptions

The following table shows request property descriptions and other associated information.

Property Description Required? Max Length Data Type
tokenSerialNumber The token serial number associated with a user. The number is displayed at the back of the SecurID700 hardware token. Yes 36 String
updatedName The updated name of the token. Yes 255 String

Example Response

The following example response shows the status of a single hardware token and the new token name, along with the token serial number specified in the request.

{

"tokenSerialNumber":"000000200002",

"name":"newTokenName",

"userId":"0d2620f5-ca8d-4f2d-a762-7c07dd373534",

"updatedAt":"2021-06-18T17:50:21.983Z"

}

Response Property Descriptions

The following table shows response property descriptions and the associated data types.

Property Description Data Type
tokenSerialNumber Serial number of the hardware token. String
name The new name that is specified for the hardware token. String
userId Identifies the user to whom the hardware token is assigned or registered. String
updatedAt Last updated timestamp of the hardware token. For information about formatting timestamps using ISO 8601 format, see https://www.w3.org/TR/NOTE-datetime. String

Response Codes

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

Code Description
200 Successfully updated the name for the hardware token.
400 Invalid parameters provided.
403 User is not authorized to perform this request.
404 Either the user ID or the hardware token serial number does not exist.
409 The request has inconsistent or conflicting state preventing it from getting completed.
500 Internal error while processing the request.