Update FIDO Policy
PUT {{apiPath}}/environments/{{envID}}/fido2Policies/{{fidoPolicyID}}
Use PUT {{apiPath}}/environments/{{envID}}/fido2Policies/{{fidoPolicyID}} to update the details of an existing 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.
Prerequisites
- See FIDO Policies for important overview information.
| Property | Type | Required? |
|---|---|---|
allowedAuthenticators | Array | Optional |
attestationRequirements | String | Required |
default | Boolean | Optional |
description | String | Optional |
enforceDuringAuthentication | Boolean | Optional |
name | String | Required |
residentKeyRequirement | String | Required |
See the FIDO Policies data model for full property descriptions.
Request Body
{"name"=>"FIDO Policy - specific authenticators - updated list of authenticators", "description"=>"FIDO Policy that specifies two authenticators that can be used", "deviceDisplayName"=>"Fido2 device B", "discoverableCredentials"=>"REQUIRED", "authenticatorAttachment"=>"BOTH", "userVerification"=>{"enforceDuringAuthentication"=>true, "option"=>"REQUIRED"}, "backupEligibility"=>{"enforceDuringAuthentication"=>true, "allow"=>true}, "userDisplayNameAttributes"=>{"attributes"=>[{"name"=>"username"}, {"name"=>"email"}]}, "attestationRequirements"=>"DIRECT", "mdsAuthenticatorsRequirements"=>{"option"=>"SPECIFIC", "allowedAuthenticators"=>[{"id"=>"{{allowedAuthenticatorID}}"}, {"id"=>"{{allowedAuthenticatorID_2}}"}], "enforceDuringAuthentication"=>true}, "relyingPartyId"=>"relyingpartydomain.example.com", "default"=>false}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/fido2Policies/4a3dcf3b-b079-42d5-8e90-529205ce0b75"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"4a3dcf3b-b079-42d5-8e90-529205ce0b75","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"updatedAt":"2023-06-06T09:54:40.734Z","createdAt":"2023-06-05T12:43:50.905Z","name":"FIDO Policy - specific authenticators - updated list of authenticators","description":"FIDO Policy that specifies two authenticators that can be used","deviceDisplayName":"Fido2 device B","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":"SPECIFIC","allowedAuthenticators":[{"id":"e077926504cd75eb405a45be160f783044e3f5a2"},{"id":"50a45b0c-80e7-f944-bf29-f552bfa2e048"}]},"relyingPartyId":"relyingpartydomain.example.com","default":false}