Cloud Administration Unassign Hardware Token API

The Cloud Administration Unassign Hardware Token API enables Help Desk Administrators to unassign a single hardware token from 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 unassign a hardware token assigned to a user by providing a token serial number as the input.

Example Request Data

The following example displays a hardware token unassignment request.

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

Content-Type: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"tokenSerialNumber" : "000123456789"

}

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 that was unassigned from a user.

{

"tokenSerialNumber": "000123456789",

"tokenState": "Unassigned"

}

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.