Migrate Device Authentication Policies

POST {{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies

This example uses the deviceAuthenticationPolicies endpoint with content type: application/vnd.pingidentity.deviceAuthenticationPolicy.fido2.migrate+json to carry out a batch migration of device authentication policies associated with the previous FIDO policy format (device authentication policies that have FIDO Biometrics or Security Key enabled).

The response contains a collection of the updated device authentication policies.

Note: When you run a migration request, all of the MFA policies that require an update will be updated, even if they are not explicitly included in the body of the request. You only have to include the MFA policies that you want to associate with a specific enhanced FIDO policy. Any MFA policies that will just use the default FIDO policy can be left out.

See the Policy migration data model for full property descriptions.

Request Body

{"migrationData"=>[{"deviceAuthenticationPolicyId"=>"{{mfaPolicyID}}", "fido2PolicyId"=>"{{fidoPolicyID_2}}"}, {"deviceAuthenticationPolicyId"=>"{{mfaPolicyID_2}}"}]}

HEADERS

RESPONSES

status: OK

{"_links":{"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicy"}},"_embedded":{"deviceAuthenticationPolicies":[{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/3f8ec0d9-f56c-0de2-37da-675ad7d1840e"}},"id":"3f8ec0d9-f56c-0de2-37da-675ad7d1840e","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Environment Policy","authentication":{"deviceSelection":"DEFAULT_TO_FIRST"},"sms":{"enabled":false,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"email":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"mobile":{"enabled":true,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"totp":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"voice":{"enabled":false,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"securityKey":{"enabled":false,"pairingDisabled":false},"platform":{"enabled":false,"pairingDisabled":false},"fido2":{"enabled":true,"pairingDisabled":false},"forSignOnPolicy":true,"updatedAt":"2023-06-22T12:42:57.827Z","createdAt":"2022-03-02T12:51:13.185Z","default":false},{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/a7257bc1-cd9c-0483-1b67-06317bc5c64f"}},"id":"a7257bc1-cd9c-0483-1b67-06317bc5c64f","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Default MFA Policy","authentication":{"deviceSelection":"DEFAULT_TO_FIRST"},"sms":{"enabled":false,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"email":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"mobile":{"enabled":true,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"totp":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"voice":{"enabled":false,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"securityKey":{"enabled":false,"pairingDisabled":false},"platform":{"enabled":false,"pairingDisabled":false},"fido2":{"enabled":true,"pairingDisabled":false},"forSignOnPolicy":false,"updatedAt":"2023-06-22T12:42:57.857Z","createdAt":"2022-03-02T12:51:13.187Z","default":true},{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/2d20ed61-9c8d-4af5-ae87-816d6f3d2255"}},"id":"2d20ed61-9c8d-4af5-ae87-816d6f3d2255","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"New Policy","authentication":{"deviceSelection":"DEFAULT_TO_FIRST"},"sms":{"enabled":false,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"email":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"mobile":{"enabled":true,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"totp":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"voice":{"enabled":true,"pairingDisabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"securityKey":{"enabled":false,"pairingDisabled":false},"platform":{"enabled":false,"pairingDisabled":false},"fido2":{"enabled":true,"pairingDisabled":false,"fido2PolicyId":"cca7e284-2acf-4346-8752-b9109c56fb42"},"forSignOnPolicy":false,"updatedAt":"2023-06-22T12:42:57.865Z","createdAt":"2022-05-24T11:39:21.053Z","default":false}]},"size":3}