Authentication (Allauth Headless)

Request password

Initiates the password reset procedure. Depending on whether or not ACCOUNT_PASSWORD_RESET_BY_CODE_ENABLED is True, the procedure is either stateless or stateful.

In case codes are used, it is stateful, and a new password_reset_by_code flow is started. In this case, on a successful password reset request, you will receive a 401 indicating the pending status of this flow.

In case password reset is configured to use (stateless) links, you will receive a 200 on a successful password reset request.

post/api/v2/allauth/browser/v1/auth/password/request

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

emailstring required

The email address.

Example request

{
  "email": "email@domain.org"
}

Response

A success response.

status200 required

Changes

No recorded changes to this operation across all 50 revisions of this API.