Cloud Administration Read FIDO Configuration API
9 days ago

Cloud Administration Read FIDO Configuration API

The Cloud Administration Read FIDO Configuration API allows you to retrieve the current configuration of FIDO authenticators. This API requires the rsa.fido.configuration.read 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 retrieve FIDO configuration.

MethodRequest URLResponse Content TypeResponse BodyResponse codes
GET

 

AdminInterface/restapi/v1/configuration/fido


application/jsonObject containing FIDO configuration details200, 429, 500

Example Request Data

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

GET AdminInterface/restapi/v1/configuration/fido

Accept: application/json

Authorization: Bearer <JWT token>

Example Response Body

The following example response shows the FIDO configuration.

  {
    "fidoAppIdDTOList": [
        {
            "id": 2,
            "errors": {},
            "appId": "https://google.com",
            "fidoAppIdDtoType": "UNKNOWN"
        }
    ],
    "passkeyStatus": false,
    "endPasskeyGracePeriodDate": 1771365600000,
    "minimumCertificationLevel": "FIDO_CERTIFIED_L2",
    "allowedAuthenticatorsList": "DS100,yubikey",
    "deniedAuthenticatorsList": "DS101,yubik*",
    "allowedAuthenticatorsListEnabled": true,
    "deniedAuthenticatorsListEnabled": true,
    "fidoStaticNamedList": [
        {
            "id": null,
            "createDate": null,
            "errors": {},
            "aaguid": null,
            "name": "RSA Authenticator App",
            "enabled": true
        },
        {
            "id": null,
            "createDate": null,
            "errors": {},
            "aaguid": null,
            "name": "RSA DS100",
            "enabled": false
        },
        {
            "id": null,
            "createDate": null,
            "errors": {},
            "aaguid": null,
            "name": "Windows Hello",
            "enabled": false
        }
    ],
    "fidoAddedNamedList": [
        {
            "id": "c9657914-c6d4-2afd-ea11-1a168f98bb3a",
            "createDate": null,
            "errors": {},
            "aaguid": "5626bed4-e756-430b-a7ff-ca78c8b12738",
            "name": "VALMIDO PRO FIDO",
            "enabled": true
        },
        {
            "id": "e59352d2-bc54-17ed-83b3-093f24ef5a99",
            "createDate": null,
            "errors": {},
            "aaguid": "22222222-2222-2222-2222-222222222222",
            "name": "Unknown",
            "enabled": true
        }
    ],
    "errors": {},
    "baseDomain": "https://t1-digitalpowerhouse-01.auth-dev.securid.com",
    "cname": null,
    "errorString": "Errors: {}"
}

 

Response Body Parameters

The table lists the parameters returned in the response body.

 

PropertyDescriptionData Type
fidoAppIdDTOListFIDO Relying Party Domain(s)List of objects containing appId
passkeyStatusWhen disabled, FIDO Synced Passkeys can no longer be registered or used for authentication.Boolean
endPasskeyGracePeriodDateUnix timestamp in milliseconds for the date when the grace period ends. When enabled, users with registered disallowed authenticators can continue to authenticate using those authenticators until the grace period ends.String
minimumCertificationLevelRepresents the authenticator’s compliance with the security requirements of the FIDO certification program.String
allowedAuthenticatorsListComma-separated list of allowed authenticators.String
deniedAuthenticatorsListComma-separated list of denied authenticators.String
allowedAuthenticatorsListEnabledBoolean that determines whether the allowedAuthenticatorsList parameter should be used.Boolean
deniedAuthenticatorsListEnabledBoolean that determines whether the deniedAuthenticatorsList parameter should be used.Boolean
fidoStaticNamedListStatic list of FIDO authenticators (RSA DS100, Windows Hello, RSA Authenticator App) that administrators can enable or disable.List
fidoAddedNamedListDynamic list of FIDO authenticators, where administrators can add or remove authenticators using the AAGUID and change their enabled status.List

 

Response Codes

The following table lists the response codes and their descriptions.

 

CodeDescription
200Emergency Access Code generated successfully.
429Too many requests.
500Internal error occurred when processing the request.