Update MFA Settings
PUT {{apiPath}}/environments/{{envID}}/mfaSettings
The operation PUT /environments/{{envID}}/mfaSettings updates the MFA settings for an environment.
In this example, the following MFA settings are updated: * Number of failures before lockout * Lockout duration * Maximum number of devices allowed per user * The pairing key format to use * Enabling of phone extensions * Enabling of MFA by default for new users
Prerequisites
- See MFA Settings for important overview information.
| Property | Type | Required? |
|---|---|---|
lockout.failureCount | Integer | Optional |
lockout.durationSeconds | Integer | Optional |
pairing.maxAllowedDevices | Integer | Optional |
pairing.pairingKeyFormat | String | Optional |
phoneExtensions.enabled | Boolean | Optional |
users.mfaEnabled | Boolean | Optional |
See the MFA Settings data model for full property descriptions.
Request Body
{"pairing"=>{"maxAllowedDevices"=>10, "pairingKeyFormat"=>"ALPHANUMERIC"}, "lockout"=>{"failureCount"=>6, "durationSeconds"=>1200}, "phoneExtensions"=>{"enabled"=>true}, "users"=>{"mfaEnabled"=>true}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/mfaSettings"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"pairing":{"maxAllowedDevices":10,"pairingKeyFormat":"ALPHANUMERIC"},"lockout":{"failureCount":6,"durationSeconds":1200},"authentication":{"deviceSelection":"DEFAULT_TO_FIRST"},"updatedAt":"2023-08-06T16:59:11.737Z","phoneExtensions":{"enabled":true},"users":{"mfaEnabled":true}}