Cloud Administration Manage FIDO Configuration API

The Cloud Administration Manage FIDO Configuration API allows you to manage the configuration of FIDO authenticators. This API requires the rsa.fido.configuration.manage OAuth permission. For more information, see OAuth 2.0-Based Permissions for the Cloud Administration APIs.

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 manage FIDO configuration.

Example Request Data

The request does not contain any parameters. The following example displays a request.

PATCH AdminInterface/restapi/v1/configuration/fido

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

The following example request shows the FIDO configuration.

  {
    "fidoAppIdDTOList": [
        {
            "id": 2,
            "appId": "https://google.com",
        }
    ],
    "passkeyStatus": false,
    "endPasskeyGracePeriodDate": 1771365600000,
    "minimumCertificationLevel": "FIDO_CERTIFIED_L2",
    "allowedAuthenticatorsList": "DS100,yubikey",
    "deniedAuthenticatorsList": "DS101,yubik*",
    "allowedAuthenticatorsListEnabled": true,
    "deniedAuthenticatorsListEnabled": true,
    "fidoStaticNamedList": [
        {
            "name": "RSA Authenticator App",
            "enabled": true
        },
        {
            "name": "RSA DS100",
            "enabled": false
        },
        {
            "name": "Windows Hello",
            "enabled": false
        }
    ],
    "fidoAddedNamedList": [
        {
            "aaguid": "5626bed4-e756-430b-a7ff-ca78c8b12738",
            "enabled": true
        },
        {
            "aaguid": "22222222-2222-2222-2222-222222222222",
            "enabled": true
        }
    ]
}

Response Body Parameters

The table lists the parameters returned in the response body.

Response Codes

The following table lists the response codes and their descriptions.