Update user MFA

Update user MFA. Link with rel enrollment must be followed to verify existing or enroll new MFA.

SecuritySecretApiKey or JWT
Responses
201

User MFA update url created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
status
string

MFA enrollment status.

Enum: "active" "inactive"
type
string

MFA enrollment type. Type duo can't be updated or deleted. Contact support if you need to reset your Duo MFA.

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

Last time MFA verification passed. To disable MFA it must be no more than 10 minutes before disable.

Array of Self (object) or EnrollmentLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

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