Skip to main content
POST
/
api
/
users
Create User Route
curl --request POST \
  --url https://api.example.com/api/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "password": "<string>",
  "display_name": "",
  "email": "jsmith@example.com",
  "must_change_pw": true,
  "role_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "username": "<string>",
  "display_name": "<string>",
  "email": "<string>",
  "is_active": true,
  "is_builtin": true,
  "must_change_pw": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_login_at": "2023-11-07T05:31:56Z"
}

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
Required string length: 1 - 255
password
string
required
Required string length: 8 - 1024
display_name
string
default:""
Maximum string length: 255
email
string<email> | null
must_change_pw
boolean
default:true
role_ids
string<uuid>[]

Response

Successful Response

id
string<uuid>
required
username
string
required
display_name
string
required
email
string | null
required
is_active
boolean
required
is_builtin
boolean
required
must_change_pw
boolean
required
created_at
string<date-time>
required
last_login_at
string<date-time> | null
required