v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Users

Create User

Creates a new user and adds them to the authenticated account. Licenses are automatically assigned to the new user based on the account's auto-licensing configuration. Only available to Enterprise accounts.

post/v1/users

Request body

emailstring required

The user's email.

firstNamestring required

The user's first name.

lastNamestring required

The user's last name.

usernamestring

The user's username. If not provided the email will be used as the username.

passwordstring

The user's password.

rolesUserRole[]

A list of roles assigned to the user.

Example request

{
  "email": "john-doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "username": "john-doe@example.com",
  "password": "`.~b\"J<CA95m`bV@",
  "roles": [
    "billing-admin",
    "team-admin"
  ]
}

Response

Created. Returns a User resource containing information about the created user.

accountIdnumber

The unique ID for the user's account.

enabledboolean

Whether the user can authenticate to Lucid. Corresponds to the SCIM active attribute.

emailstring

The user's email.

namestring

The user's full name.

userIdnumber

The unique ID for the user.

usernamestring

The user's username.

rolesUserRole[]

A list of administrative roles assigned to the user.

Example response

{
  "accountId": 100,
  "enabled": true,
  "email": "john-doe@example.com",
  "name": "John Doe",
  "userId": 101,
  "username": "johndoe",
  "roles": [
    "billing-admin",
    "team-admin"
  ],
  "avatar": {
    "type": "url",
    "link": "https://www.gravatar.com/avatar/00000000000000000000000000000000?s=200&d=404"
  }
}