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.

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 the request. For instructions on using this token, see Authentication for the Cloud Administration APIs.

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.

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.

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.

Response Codes

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