Cloud Administration Unassign Hardware Token APICloud 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.
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.
Administrative RolesAdministrative Roles
This API can use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration REST API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to unassign a hardware token assigned to a user by providing a token serial number as the input.
|Method||Request URL||Response Content Type||Response Body||Response Codes|
|PATCH||/AdminInterface/restapi/v1/users/<userId>/sidTokens/unassign||application/json||Token details with property||200, 400, 403, 404, 409, 500|
Example Request DataExample Request Data
The following example displays a hardware token unassignment request.
Authorization: Bearer <JWT token>
Example Request BodyExample Request Body
"tokenSerialNumber" : "000123456789"
Request Property DescriptionsRequest 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|
Example ResponseExample Response
The following example response shows the state of a single hardware token that was unassigned from a user.
Response Property DescriptionsResponse Property Descriptions
The following table shows response property descriptions and the associated data types.
|tokenSerialNumber||Serial number of the hardware token.||String|
|tokenState||State of the hardware token: Unassigned, Activation Pending, or Activated.||String|
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
|200||The hardware token is successfully unassigned from the user.|
|400||Invalid parameters provided (such as invalid token serial number or user ID format).|
|403||User is not authorized to perform the request. (Possible causes: Lack of administrator rights or invalid JSON web token provided).|
|404||Either the user ID or the hardware token serial number does not exist.|
The request has inconsistent or conflicting state preventing it from getting completed. (Possible causes: The hardware token is not assigned to a specific user or vice versa).
|500||The request cannot be completed due to an internal server error.|