Function putMfaEnrollment

PUT /mfa/enrollments/{id} – Updates or creates an MFA enrollment configuration for a user.

---

📥 Request

Headers:

• Authorization: Bearer <access_token> (required)
• Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

• provider: The authentication provider (optional). Defaults to auth0-user.
• requiresMfa: Boolean indicating if MFA is required for the user (required).

Path Parameters:

• id: The ID of the MFA enrollment to update or create. (required)

Query Parameters:

• None

---

📤 Response

• 200 OK – Returns a JSON-stringified MultiFactorEnrollment object.

---

❗ Errors

Status Code	Meaning	When it Happens
400	Bad Request	Missing or invalid fields in request body
401	Unauthorized	Missing or invalid authentication token
404	Not Found	Specified MFA enrollment not found
500	Internal Server Error	Unexpected error during MFA enrollment update

Error Response Format

{
  "error": "Detailed error message here"
}
Copy

---

📦 Examples

📥 Auth0 Request

PUT /mfa/enrollments/exampleMfaEnrollmentId
{
  "requiresMfa": true
}
Copy

📥 Cognito Request

PUT /mfa/enrollments/exampleMfaEnrollmentId
{
  "provider": "cognito-user",
  "requiresMfa": true
}
Copy

📤 Response Example

{
	"id": "exampleMfaEnrollmentId",
	"requiredMfa": true
}
Copy

---