logo

Retrieve user MFA status

Retrieves Multi-Factor Authentication (MFA) status of a user.

SecuritySecretApiKey or JWT
Responses
200

User MFA status retrieved.

Response Schema: application/json
status
string

Status of Multi-Factor Authentication (MFA) enrollment.

Enum: "active" "inactive"
type
string

Type of MFA enrollment. Type duo cannot be updated or deleted. If you need to reset your Duo MFA, Contact support.

Enum: "duo" "guardian"
lastAuthTime
string <date-time>

Date and time when MFA verification is most recently passed. To disable MFA, no more than 10 minutes must elapse between this value and the request to disable MFA.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "enrollment"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/profile/mfa
Request samples 
const mfa = await api.profile.getMfa();
console.log(mfa.fields.status, mfa.fields.type, mfa.fields.lastAuthTime);
Response samples
application/json
{
  • "status": "active",
  • "type": "duo",
  • "lastAuthTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Update user MFA