Sign in
MFA API

Get MFA Status

Use this endpoint to retrieve the current MFA configuration and status for a user.

get/v1/users/{id}/mfa

Path parameters

idstring required

The unique identifier of the user you want to retrieve.

Response

MFA status and configuration for the user.

enabledboolean

Indicates whether MFA is enabled for the user.

preferredType'app' | 'email' | 'sms'

The user's preferred MFA method.

methodsstring[]

List of MFA methods currently enabled for the user.

totpEnabledboolean

Indicates whether app-based TOTP MFA is enabled.

emailEnabledboolean

Indicates whether email-based MFA is enabled.

smsEnabledboolean

Indicates whether SMS-based MFA is enabled.

Changes