Sign in
Authentication (Allauth Headless)

Reset password

Changed on

Perform the password reset, by handing over the password reset key and the new password. After successfully completing the password reset, the user is either logged in (in case ACCOUNT_LOGIN_ON_PASSWORD_RESET is True), or, the user will need to proceed to the login page. In case of the former, a 200 status code is returned, in case of the latter a 401.

post/api/v2/allauth/app/v1/auth/password/reset

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

client'app' | 'browser' required

The type of client accessing the API.

Request body

keystring required

The password reset key

passwordstring required

The password.

Example request

{
  "key": "2f-c4nqd4-e07d9bc694f9f28cd4fe92569d495333",
  "password": "Alohomora!"
}

Response

Authenticated by password.

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
    },
    "methods": [
      {
        "at": 1711555057.065702,
        "email": "email@domain.org",
        "username": "wizard"
      }
    ]
  },
  "meta": {
    "session_token": "ufwcig0zen9skyd545jc0fkq813ghar2",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW"
  }
}

Changes

  • v2b147245b3d11Revision changes
    • info

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