Login

POST

/auth/login/

curl --request POST \
  --url https://example.com/api/auth/login/ \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=example \
  --data username=example \
  --data password=example \
  --data scope= \
  --data client_id=example \
  --data client_secret=example

Authenticate with username and password, receive a JWT token.

Request Body ^required

Media type application/x-www-form-urlencoded

Body_login_auth_login__post

object

grant_type

Any of:

string

string

/^password$/

null

null

username

required

Username

string

password

required

Password

string format: password

scope

Scope

string

""

client_id

Any of:

string

string

null

null

client_secret

Any of:

string

string

null

null

Responses

200

Successful Response

Media type application/json

TokenResponse

object

access_token

required

Access Token

JWT access token for Authorization header

string

refresh_token

required

Refresh Token

Opaque token used to obtain a new access token

string

token_type

Token Type

string

default: bearer

expires_in

required

Expires In

Seconds until the access token expires

integer

Example

{
  "token_type": "bearer"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}