Cloud Administration Enable FIDO Authenticator API

The Cloud Administration Enable FIDO authenticator API allows Help Desk Administrators and Super Administrators to enable a FIDO authenticator that is assigned to a user.

Authentication

Clients calling this API must authenticate themselves by including a JSON web token in the request. For instructions on using this token, see Authentication for the Cloud Administration APIs .

Administrative Roles

This API can use an API key associated with either Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.

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 FIDO authenticator.

Method Request URL Response Content Type Response Body Response Codes
PATCH /AdminInterface/restapi/v1/fido/{userId}/authenticators/{authenticatorId}/enable application/json FIDO staus 200, 400, 403, 500.

Example Request Data

PATCH /AdminInterface/restapi/v1/fido/{userId}/authenticators/{authenticatorId}/enable

Accept: application/json

Authorization: Bearer <JWT token>

EXAMPLE REQUEST BODY: NA

REQUEST PROPERTY DESCRIPTIONS: NA

Example Response

{

"statusChangedAt": 1654604832860,

"statusChangedBy": <admin subject>,

"status": "Enabled"

}

Response Property Descriptions:

  • statusChangedAt: The timestamp when the FIDO authenticator was enabled. For information on formatting timestamps in ISO 8601 format, see https://www.w3.org/TR/NOTE-datetime.

  • statusChangedBy : Identifies the administrator who enabled the FIDO authenticator

  • status: FIDO Status (Enabled/Disabled)

Response Codes:

Code Description
200 Successfully enabled FIDO assigned to the user
400 Invalid userId/authenticatorId/api url (Bad Request)
403 Not authorized to perform the request.
500 Internal server error occurred while processing the request.