Invite a User

post/public/v1/users

post/public/v1/users

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/users' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "string",
  "last_name": "string",
  "email": "jane.citizen@example.com",
  "user_type": "auditor",
  "role": "admin",
  "groups": [
    {
      "id": "string"
    }
  ]
}'

Response

{
  "data": {
    "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "status": "active",
    "employment_title": "Service Manager"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Body

application/json

first_namestringrequiredmax length 255
last_namestringrequiredmax length 255
emailstring<email>requiredmax length 255
user_typeenum<string>
Available options:auditorstandardsupport_worker
roleenum<string> | null
Available options:adminauditormanagersupport-workerteam-member
groupsobject[]max items 100
▶Show 1 child attributesHide child attributes
- idstringrequired

Response

200application/json

UserResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- first_namestringrequired
  Example:John
- last_namestringrequired
  Example:Doe
- emailstringrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activedeactivatedinvitedrestricted
- employment_titlestring | nullrequired
  Example:Service Manager

Errors

401Unauthenticated
403Authorization error
422Validation error

Command Palette

Authorization

Body

Response

Errors