Update user MFA

Updates the Multi-Factor Authentication (MFA) information of a user.

The generated link with an enrollment rel link must be followed to verify the existing MFA 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

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.

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": [
    ]
}