Retrieve user MFA status

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

SecurityAPI Key: SecretApiKey or HTTP: JWT
get
/profile/mfa
Request samples
const mfa = await api.profile.getMfa();
console.log(mfa.fields.status, mfa.fields.type, mfa.fields.lastAuthTime);
Responses

200

User MFA status retrieved.

Response Schema: application/json
status
string

Status of Multi-Factor Authentication (MFA) enrollment.

Enum: "active" "inactive"
type
string or null

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

Enum: "duo" "guardian" null
lastAuthTime
string or null <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.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{ "status": "active", "type": "duo", "lastAuthTime": "2019-08-24T14:15:22Z", "_links": [ ] }