Skip to main content
POST
/
api
/
auth
/
login
Login Route
curl --request POST \
  --url https://api.example.com/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "password": "<string>"
}
'
{
  "username": "<string>",
  "display_name": "<string>",
  "must_change_pw": true,
  "permissions": []
}

Documentation Index

Fetch the complete documentation index at: https://www.halite-app.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
username
string
required
password
string
required

Response

Successful Response

username
string
required
display_name
string
required
must_change_pw
boolean
required
permissions
PermissionPair · object[]