Skip to main content
POST
/
api
/
auth
/
login
Login
curl --request POST \
  --url https://api.example.com/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "totp_code": "<string>",
  "backup_code": "<string>",
  "remember_device": true
}
'
{
  "access_token": "<string>",
  "expires_in": 123,
  "user": {
    "id": 123,
    "email": "<string>",
    "is_active": true,
    "name": "<string>",
    "roles": [],
    "mfa_enabled": false,
    "is_platform_owner": false,
    "organization_id": 123,
    "organization": {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "license_type": "<string>",
      "uuid": "<string>",
      "plan_tier": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "token_type": "bearer",
  "roles": [
    "<string>"
  ]
}

Body

application/json
email
string<email>
required
password
string
required
totp_code
string | null
backup_code
string | null
remember_device
boolean | null

Response

Successful Response

access_token
string
required
expires_in
integer
required
user
UserRead · object
required
token_type
string
default:bearer
roles
string[] | null