login

POST

/api/v1/auth/login

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

Request Body^required

Media typeapplication/json

object

email

required

string

>= 3 characters <= 320 characters

password

required

string

>= 1 characters <= 1024 characters

key

additional properties

any

Example^generated

{
  "email": "example",
  "password": "example"
}

Responses

200

OK

Media typeapplication/json

object

auth_type

required

string

Allowed values: session token

email

required

string

id

required

string

must_change_password

required

boolean

name

required

string

role

required

string

Allowed values: viewer operator editor admin

key

additional properties

any

Example

{
  "auth_type": "session",
  "role": "viewer"
}

Headers

Set-Cookie

string

default

Error

Media typeapplication/json

object

error

required

object

code

required

string

details

message

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}