Create user or service account

Create a user account (type=user, email required; returns user + password for login) or a service account (type=service_account, roles required) for API/automation access.

POST /users

Create user or service account

cURL

curl --request POST \
  --url https://api.tirdad.ai/v1/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "<string>",
  "roles": [
    "<string>"
  ]
}
'

201

{
  "email": "<string>",
  "id": "<string>",
  "password": "<string>",
  "roles": [
    "<string>"
  ],
  "tenant": {
    "billing_details": {
      "address": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>"
      },
      "email": "<string>",
      "help_email": "<string>",
      "phone": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "status": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Create user (email, type=user) or service account (type=service_account, roles)

type · enum<string> · required

Available options: user, service_account

email · string

Required when type is "user"

roles · string[]

Required when type is "service_account"

Response

201

application/json

Created

email · string

Empty for service accounts

id · string

password · string

roles · string[]

tenant · object

Show child attributes

type · enum<string>

Available options: user, service_account