Authentication (Allauth Headless)

Whether or not username, email, phone or combination of those are required depends on the configuration of django-allauth. Additionally, if a custom signup form is used there may be other custom properties required.

post/api/v2/allauth/browser/v1/auth/signup

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.

usernamestring required

The username.

newsletter_subscriptionboolean
terms_of_serviceboolean
passwordstring required

The password.

Example request

{
  "email": "email@domain.org",
  "username": "wizard",
  "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

    • info

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

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////