Cloud Administration Clear PIN RSA DS100 OTP Credential API
2 months ago

Cloud Administration Clear PIN RSA DS100 OTP Credential API

The Cloud Administration Clear PIN for RSA DS100 OTP Credential API enables Help Desk Administrators or Super Administrator to clear the PIN for an OTP credential of RSA DS100 authenticator assigned 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 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 clear the OTP credential PIN.

MethodRequest URLResponse Content TypeResponse BodyResponse Codes
PATCH/AdminInterface/restapi/v1/ds100/clearPin/otpapplication/json OTP credential PIN status 200, 400, 403, 404, 429, 500

Example Request Data

The following example displays a request.

PATCH /AdminInterface/restapi/v1/ds100/clearPin/otp

Accept: application/json

Authorization: Bearer <JWT Token>

Example Request Body

{

"tokenSerialNumber": "014010008039",

"userId" : "87927fb7-e185-4c33-c7e3-8e077675973c"

}

Request Property Descriptions

PropertyDescriptionData Type
toeknSerialNumberThe serial number of the OTP credential. The credential serial number can be obtained using Retrieve RSA DS100 OTP Credential API.String
userId Identifies the user associated with this authenticator.String

Example Response

{

"tokenSerialNumber":"014010008038"

"pinSet": false

}

Response Property Descriptions

PropertyDescriptionData Type
tokenSerialNumberThe serial number of the OTP credential.String
pinSetFlag that tells the system whether the user has set a PIN or not. This is managed by the system and is mainly for informational purposes. Possible values: True - PIN is set. False - PIN is not set. Boolean

Response Codes

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

CodeDescription
200Successfully cleared the PIN for the OTP credential for RSA DS100 authenticator assigned to the user.
400Bad Request. Operation not performed because of client syntax errors.
403Not authorized to perform the request.
404Either the user or the RSA DS100 token does not exist.
429Too many requests.
500Internal server error occurred while processing the request.
Don't see what you're looking for?