Verifies that the emailAuthCode from a magic link email is valid. If the password is valid, several responses can be returned. Please refer to the result response field description to see the different types of responses that can be returned.

If the emailAuthCode is invalid, a 400 response will be returned containing a Constraint Violations Error like the following:

{
  "type": "constraint_violations_error",
  "code": "message_body_constraint_violations",
  "message": "Field violations were detected in the request body",
  "ticket": "jgqgau2nj4eobeaje6m4jhoop8",
  "violations": {
    "emailAuthCode": [{
      "code": "invalid_email_auth_code"
    }]
  }
}

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
magic-link-login-workflow:execute	Application	The subject can perform this operation for requests associated with the application to which the subject belongs.

200OK

400Bad Request

401Unauthorized

403Forbidden

405Method Not Allowed

406Not Acceptable

415Unsupported Media Type

500Internal Server Error

503Service Unavailable