GET /mfa/enrollments/{id} – Retrieves MFA Enrollment given the ID.


Headers:

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

Body:

  • None

Path Parameters:

  • id: The ID of the MFA enrollment to retrieve. (required)

Query Parameters:

  • userPoolId: The Cognito user pool ID (required for Cognito)
  • provider: The authentication provider (optional). Defaults to auth0-user.


Status Code Meaning When it Happens
400 Bad Request Missing or invalid parameters
401 Unauthorized Missing or invalid authentication token
404 Not Found MFA Enrollment not found
500 Internal Server Error Unexpected error during MFA enrollment retrieval
{
"error": "Detailed error message here"
}

GET /mfa/enrollments/exampleMfaEnrollmentId
GET /mfa/enrollments/exampleMfaEnrollmentId?userPoolId=us-east-1_1234test&provider=cognito-user
{
"id": "exampleMfaEnrollmentId",
"requiredMfa": true
}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.