Read Single FIDO Policy

GET {{apiPath}}/environments/{{envID}}/fido2Policies/{{fidoPolicyID}}

Use GET {{apiPath}}/environments/{{envID}}/fido2Policies/{{fidoPolicyID}} to retrieve the details of a specific FIDO policy.

The policy ID can be taken from the id field for the policy in the list of policies returned when you retrieve all of the FIDO policies for an environment. The ID of each policy is also displayed on the FIDO Policies page in the PingOne UI.

ParameterDescription
expand(Optional) Use expand=deviceAuthenticationPolicies to return _embedded.deviceAuthenticationPolicies for each policy in the response. This is a list of the device authentication policies that use that FIDO policy.

Note: If the FIDO policy that you want to retrieve has not yet been updated to the newer FIDO policy format, the request must use the previous endpoint, fidoPolicies.

Request Params

KeyDatatypeRequiredDescription
expandstringReturns _embedded.deviceAuthenticationPolicies for each policy in the response. This is a list of the device authentication policies that use that FIDO policy.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/fido2Policies/33163ff8-5803-46bf-a558-bd7aeb07d590"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"33163ff8-5803-46bf-a558-bd7aeb07d590","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"updatedAt":"2023-06-05T12:26:00.422Z","createdAt":"2023-06-05T12:26:00.422Z","name":"FIDO Policy - allow only FIDO-certified authenticators","description":"FIDO Policy that specifies that only FIDO-certified authenticators can be used","deviceDisplayName":"Fido2 device","discoverableCredentials":"REQUIRED","authenticatorAttachment":"BOTH","userVerification":{"enforceDuringAuthentication":true,"option":"REQUIRED"},"backupEligibility":{"enforceDuringAuthentication":true,"allow":true},"userDisplayNameAttributes":{"attributes":[{"name":"username"},{"name":"email"}]},"attestationRequirements":"DIRECT","mdsAuthenticatorsRequirements":{"enforceDuringAuthentication":true,"option":"CERTIFIED"},"relyingPartyId":"relyingpartydomain.example.com","aggregateDevices":false,"default":false}