Cloud Administration Assign Hardware Token API

The Cloud Administration Assign Hardware Token API enables Help Desk Administrators to assign a single hardware token to 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 the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to assign a hardware token to a user by providing a token serial number and optional token name.

Example Request Data

The following example displays a hardware token assignment request.

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

Content-Type: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"tokenSerialNumber" : "000123456789",

"tokenName" : "My SecurID Token 789"

}

Request Property Descriptions

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

Example Response

The following example response shows the state of a single hardware token with basic assignment related information.

{

"userId": "86beae30-8706-4a41-8b02-d6092ed3f896",

"tokenSerialNumber": "000123456789",

"tokenState": "Activation Pending",

"assignedAt": "2021-06-13T04:38:51.961Z",

"assignedBy": "ed042594-b230-4b68-9191-9bfa759d0866@securid.com"

}

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.