Cloud Administration Enable SecurID DS100 OTP Credential API
a year ago

Cloud Administration Enable SecurID DS100 OTP Credential API

The Cloud Administration Enable SecurID DS100 OTP Credential API allows Help Desk Administrators and Super Administrators to enable SecurID DS100 OTP credential.

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 enable OTP credential by providing the device serial number and user ID.

MethodRequest URLResponse Content TypeResponse BodyResponse Codes
PATCH/AdminInterface/restapi/v1/ds100/enable/otpapplication/json OTP credential details with property 200, 400, 403, 404, 429, 500

Example Request Data

The following example displays a request.

PATCH /AdminInterface/restapi/v1/ds100/enable/otp

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"deviceSerialNumber": "140100080",

"userId" : "ece30fe9-414c-7536-5403-0656220b3046"

}

Request Property Descriptions

PropertyDescriptionData Type
deviceSerialNumberThe serial number of the hardware authenticator. The number is displayed at the back of the SecurID DS100 authenticator.String
userId Identifies the user to whom the SecurID DS100 authenticator is registered.String

Example Response

[

{

"userId": "ece30fe9-414c-7536-5403-0656220b3046",

"tokenSerialNumber": "014010008031",

"tokenStatus": "Enabled",

"tokenStatusChangedAt": "2022-05-24T07:30:55.856Z",

"tokenStatusChangedBy": "<admin subject>",

"deviceSerialNumber": "140100080"

}

]

Response Property Descriptions

PropertyDescriptionData Type
userId Identifies the user associated with this authenticator.String
tokenSerialNumber Serial number of the OTP credential.String
tokenStatus Status of the OTP credential: Enabled or Disabled.String
tokenStatusChangedAt The timestamp when the OTP credential was enabled. For information on formatting timestamps in ISO 8601 format, see https://www.w3.org/TR/NOTE-datetime. String
tokenStatusChangedBy Identifies the administrator who enabled the credential.String
deviceSerialNumber The serial number of the hardware authenticator. The number is displayed at the back of the SecurID DS100 authenticator.String

Response Codes

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

CodeDescription
200Successfully enabled SecurID DS100 OTP credential 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 SecurID DS100 authenticator does not exist.
429Too many requests.
500Internal server error occurred while processing the request.
Don't see what you're looking for?