Skip to content

Get MFA status

GET
/api/mfa/status
curl --request GET \
--url http://localhost:3001/api/mfa/status \
--header 'Authorization: <Authorization>'

Retrieve the current multi-factor authentication status and configuration for the authenticated user

OK

Media typeapplication/json
object
backup_codes_remaining
integer
message
string
mfa_enabled
boolean
setup_at
string
success
boolean
totp_enabled
boolean
trusted_devices_count
integer
Examplegenerated
{
"backup_codes_remaining": 1,
"message": "example",
"mfa_enabled": true,
"setup_at": "example",
"success": true,
"totp_enabled": true,
"trusted_devices_count": 1
}

Unauthorized

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}