Update User MFA Enabled
PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/mfaEnabled
You can enable multi-factor authentication by setting mfaEnabled to true with POST Create User, POST Create User (Import), or PUT Update User MFA Enabled.
You cannot update mfaEnabled with PUT Update User or PATCH Update User.
Prerequisites
- See PingOne MFA for important overview information.
| Property | Type | Required? |
|---|---|---|
mfaEnabled | Boolean | Required |
See the Enable Users MFA data model for full property descriptions.
Request Body
{"mfaEnabled"=>true}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/05ad3cc6-8723-4f85-9711-05ad549717f6/mfaEnabled"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/05ad3cc6-8723-4f85-9711-05ad549717f6"}},"mfaEnabled":true}