Create User

post

https://users.lucid.app/scim/v2/Users

Create a new user.

Body Params

Core attributes shared by all user representations.

schemas

array of strings

required

URIs identifying the SCIM schemas that describe this resource's attributes.

schemas*

userName

string

required

The user's username (usually their email).

name

object

An object representing a user's name in various formats.

displayName

string

The name that is displayed and represents the user (usually their email).

emails

array of objects

required

emails*

active

boolean

Whether the user can authenticate to Lucid.

externalId

string

An identifier for the user as defined by the provisioning client.

title

string

The user's job title.

phoneNumbers

array of objects

A list of phone numbers for the user. Currently only "work" type phone numbers are supported.

phoneNumbers

meta

object

roles

array of objects

A list of administrative roles assigned to the user. Assigning a role to a user allows that user to perform administrative actions associated with that role.

roles

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object

Enterprise extension attributes for the user.

password

string

Passwords must be at least 8 characters in length.

Responses

400

Bad Request. Occurs if request body syntax is incorrect.

401

Unauthorized. Occurs if bearer token is invalid.

409

Conflict. if username or email already exists on the account.

424

Failed Dependency. Occurs if add-on license requires base license to be active.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201OK. Returns the created User.