Authentication (Allauth Headless)

Get password reset information

Changed on

Used to obtain information on and validate a password reset key. The key passed is either the key encoded in the password reset URL that the user has received per email, or, the password reset code in case of ACCOUNT_PASSWORD_RESET_BY_CODE_ENABLED. Note that in case of a code, the number of requests you can make is limited (by ACCOUNT_PASSWORD_RESET_BY_CODE_MAX_ATTEMPTS).

get/api/v2/allauth/browser/v1/auth/password/reset

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-Password-Reset-Key

Path parameters

client'app' | 'browser' required

The type of client accessing the API.

Headers

X-Password-Reset-Keystring required

The password reset key

Response

Information about the password reset key.

status200 required

Example response

{
  "data": {
    "user": {
      "id": 123,
      "display": "Magic Wizard",
      "email": "email@domain.org",
      "has_usable_password": true,
      "username": "wizard",
      "has_validated_password": true
    }
  }
}

Changes

  • v2b147245b3d11Revision changes
    • info

      added the required property // to the response with the status