auth

Confirm Email

Changed on

Confirms a user's email address using the token sent in the confirmation email.

get/auth/confirm

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /auth/confirm
  • Auth: bearer (a scheme the document does not define)

Query parameters

tokenstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Email confirmation token

emailstring required
Example:user@example.com

Email address to confirm

Response

Email successfully confirmed

unknown required

Example response

{
  "message": "Email confirmed successfully"
}

Changes

  • 02af33f085aaRevision changes
    • info

      api operation id confirm removed and replaced with confirmEmail

    • info

      the endpoint scheme security bearer was added to the API

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

  • cc4509de78d1Revision changes
    • breaking

      added the new required query request parameter email

    • breaking

      added the new required query request parameter token

    • warning

      deleted the query request parameter code

    • warning

      deleted the query request parameter redirectUrl

    • warning

      deleted the query request parameter username

    • info

      api operation id AuthController_confirm removed and replaced with confirm