Skip to main content
POST
/
api
/
v3
/
users
Create a new company member
curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "username": "<string>"
}
'
{
  "id": 123,
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "is_active": true,
  "date_joined": "2023-11-07T05:31:56Z",
  "account_expiration_date": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z",
  "invitation_status": "<string>",
  "language": "<string>",
  "company": {
    "name": "<string>",
    "id": 123
  },
  "roles": [
    {
      "name": "<string>",
      "id": 123
    }
  ],
  "groups": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "role": "<string>",
      "category": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

email
string<email>
required

The email address of the user.

username
string
required

The username of the user. This value may contain only letters, numbers, and @/./+/-/_ characters.

first_name
string

The first name of the user.

last_name
string

The last name of the user.

company_id
integer | null

The unique identifier of the company.

groups
integer[]

List of user group IDs to assign the user to.

roles
integer[]

List of role IDs to assign to the user.

account_expiration_date
string<date-time>

The account expiration date and time with timezone.

language
enum<string>

The preferred language of the user.

  • ar - Arabic
  • en - English
  • fr - French
  • de - German
Available options:
ar,
en,
fr,
de

Response

Company member created successfully

id
integer
required
username
string
required
first_name
string
required
last_name
string
required
email
string
required
is_active
boolean
required
date_joined
string<date-time>
required
account_expiration_date
string<date-time>
required
last_login
string<date-time>
required
invitation_status
string
required
language
string
required
company
object
required
roles
object[]
required
groups
object[]
required