PingOne Platform APIs

Enable Users MFA

The multi-factor authentication settings (MFA) control whether a user can authenticate using MFA actions. This endpoint enables or disables MFA capability.

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.

For information about user MFA device management, refer to MFA devices.

MFA settings data model

Property Type Required Mutable Description

id

String

Required

Immutable

The user resource’s unique identifier.

mfaEnabled

Boolean

Required

Mutable

Whether multi-factor authentication is enabled. This attribute is set to 'false' by default when the user is created.

Response codes

Code Message

200

Successful operation.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

404

The requested resource was not found.

Enable Users MFA errors

In addition to the general error codes, Enable Users MFA operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_REQUEST

INVALID_VALUE

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: A PUT /users/{{userID}}/mfaEnabled request body cannot be deserialized

Details: For a JSON field conversion error, the target is the field path. Otherwise no detail is returned.

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A PUT /users/{{userID}}/mfaEnabled request targets a user whose lifecycle status is INVITED

Details: Operation not allowed for users with lifecycle.status INVITED

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the dir:read:user permission (GET) or the dir:update:userMfaEnabled permission (PUT), or is not the target user, a population administrator, or a member of a group that has the user

Details: None

403

ACCESS_FAILED

INSUFFICIENT_PERMISSIONS

Message: The request could not be completed. You do not have access to this resource.

When and details

When: A GET /users/{{userID}}/mfaEnabled self-service request uses an access token whose user profile scope does not include the mfaEnabled attribute

Details: You do not have permissions or are not licensed to make this request.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A GET or PUT /users/{{userID}}/mfaEnabled operation references a user or environment that does not exist

Details: None