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

For information about user MFA device management, see 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.