Update Device Authentication Policy

PUT {{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}

The PUT /environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}} operation updates the specified device authentication policy for the environment.

Note that in the body of the request the email object contains "pairingDisabled": true. You can use the pairingDisabled option if you want to phase out an existing authentication method but want to allow users to continue using the method for authentication for existing devices.

Prerequisites

• See Device Authentication Policies for important overview information.

See the Device authentication policy data model for full property descriptions.

Request Body

{"name"=>"Environment Policy8 - phasing out email - updated", "sms"=>{"enabled"=>false, "otp"=>{"failure"=>{"count"=>3, "coolDown"=>{"duration"=>0, "timeUnit"=>"MINUTES"}}, "lifeTime"=>{"duration"=>30, "timeUnit"=>"MINUTES"}}}, "email"=>{"enabled"=>true, "pairingDisabled"=>true, "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"}}}, "applications"=>[{"id"=>"{{appID}}", "push"=>{"enabled"=>true}, "otp"=>{"enabled"=>true}, "pushTimeout"=>{"duration"=>48, "timeUnit"=>"SECONDS"}, "pushLimit"=>{"count"=>4, "timePeriod"=>{"duration"=>10, "timeUnit"=>"MINUTES"}, "lockDuration"=>{"duration"=>30, "timeUnit"=>"MINUTES"}}, "pairingKeyLifetime"=>{"duration"=>24, "timeUnit"=>"HOURS"}, "deviceAuthorization"=>{"enabled"=>true, "extraVerification"=>"permissive"}, "autoEnrollment"=>{"enabled"=>true}, "integrityDetection"=>"permissive"}]}, "totp"=>{"enabled"=>true, "otp"=>{"failure"=>{"count"=>3, "coolDown"=>{"duration"=>2, "timeUnit"=>"MINUTES"}}}}, "voice"=>{"enabled"=>true, "otp"=>{"failure"=>{"count"=>3, "coolDown"=>{"duration"=>0, "timeUnit"=>"MINUTES"}}, "lifeTime"=>{"duration"=>30, "timeUnit"=>"MINUTES"}}}, "fido2"=>{"enabled"=>true, "fidoPolicyId"=>"{{fidoPolicyID}}"}, "forSignOnPolicy"=>false, "default"=>false}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/8992b573-1c1b-4a39-8935-b3ec86b5c7ee"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"8992b573-1c1b-4a39-8935-b3ec86b5c7ee","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Environment Policy8 - phasing out email - updated","authentication":{"deviceSelection":"DEFAULT_TO_FIRST"},"newDeviceNotification":"SMS_THEN_EMAIL","sms":{"enabled":false,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"email":{"enabled":true,"pairingDisabled":true,"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"}}},"applications":[{"id":"8370dc35-a30d-45b6-9ff5-58aa943fca7d","push":{"enabled":true},"otp":{"enabled":true},"autoEnrollment":{"enabled":true},"deviceAuthorization":{"enabled":true,"extraVerification":"permissive"},"pushTimeout":{"duration":48,"timeUnit":"SECONDS"},"pairingKeyLifetime":{"duration":24,"timeUnit":"HOURS"},"pushLimit":{"count":4,"timePeriod":{"duration":10,"timeUnit":"MINUTES"},"lockDuration":{"duration":30,"timeUnit":"MINUTES"}},"integrityDetection":"permissive"}]},"totp":{"enabled":true,"otp":{"failure":{"count":3,"coolDown":{"duration":2,"timeUnit":"MINUTES"}}}},"voice":{"enabled":true,"otp":{"failure":{"count":3,"coolDown":{"duration":0,"timeUnit":"MINUTES"}},"lifeTime":{"duration":30,"timeUnit":"MINUTES"}}},"fido2":{"enabled":true},"forSignOnPolicy":false,"updatedAt":"2023-07-02T12:54:19.073Z","createdAt":"2023-07-02T10:06:19.991Z","default":false}