Skip to content
PalomPalomAtlas

Login

POST
/api/v1/auth/login
curl --request POST \
  --url https://example.com/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "username": "example", "password": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LoginRequest
object
username
required
Username
string
password
required
Password
string
Examplegenerated
{
  "username": "example",
  "password": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MeResponse
object
id
required
Id
string
type
required
PrincipalType
string
Allowed values: USER API
name
required
Name
string
superuser
required
Superuser
boolean
extra
required
Extra
object
key
additional properties
any
Example
{
  "type": "USER"
}

422

Section titled “422”

Validation Error

Media typeapplication/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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}