Create User
Create a user in Lucidchart.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
User |
|||
|
User Name |
The unique identifier for the user. Lucid recommends using the user's primary email address. If the username matches an existing record in the account, that record is updated. |
Text | TRUE |
|
|
The email address of the user. Change the capitalization of an existing user's email (for example, changing User@Example.com to user@example.com). |
Text | TRUE |
|
First Name |
The first name of the user. |
Text | FALSE |
|
Last Name |
The last name of the user. |
Text | FALSE |
|
Is Active |
A boolean value that indicates the user's account status. |
True/False | FALSE |
|
Roles |
A list of administrative roles to assign to the user. These roles grant the user specific administrative permissions within Lucidchart. If you provide roles that don't exist or are unsupported, the system ignores those specific entries. |
List of Text | FALSE |
|
Password |
The password for the user. |
Text | FALSE |
|
Title |
The title of the user. |
Text | FALSE |
|
Phone Number |
The phone number of the user. |
Text | FALSE |
|
Enterprise |
|||
|
Cost Center |
The name of the cost center assigned to the user. |
Text | FALSE |
|
Organization |
The name of the user's organization. |
Text | FALSE |
|
Division |
The name of the user's division. |
Text | FALSE |
|
Department |
The name of the user's department. |
Text | FALSE |
|
Manager ID |
The unique identifier of the user's manager. |
Text | FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
User |
||
|
ID |
The ID of the Lucid user. For example: lucid-1234, where 1234 is the ID. |
Text |
|
Emails |
List of Objects | |
|
|
The email address of the user. |
Text |
|
Is Primary |
A boolean value that specifies whether this email address is the primary contact for the user account. |
True/False |
|
User Name |
The unique identifier for the user. In most configurations, this is the user's primary email address. |
Text |
|
Full Name |
The full name of the user. |
Text |
|
First Name |
The first name of the user. |
Text |
|
Last Name |
The last name of the user. |
Text |
|
Is Active |
A boolean value that indicates the user's account status. Set to True to allow the user to sign in, or False to disable their access. |
True/False |
|
Display Name |
The user's name as it appears within the Lucid app interface. By default, this is typically set to the user's email address. |
Text |
|
Roles |
A list of administrative roles to assign to the user. These roles grant the user specific administrative permissions within Lucidchart. If you provide roles that don't exist or are unsupported, the system ignores those specific entries. |
List of Text |
|
Title |
The title of the user. |
Text |
|
Phone Numbers |
List of Objects | |
|
Phone Number |
The phone number associated with the user account. |
Text |
|
Type |
The category of the phone number. For example, work, mobile, or home. |
Text |
|
Meta |
Object | |
|
Resource Type |
The type of resource. |
Text |
|
Created At |
The date and time when the user was created. |
Date & Time |
|
Last Modified |
The date and time when the user record was most recently updated. |
Date & Time |
|
Version |
The version ID of the user. |
Text |
|
Location |
The URI of the user. |
Text |
|
Cost Center |
The name of the cost center assigned to the user. |
Text |
|
Organization |
The name of the user's organization. |
Text |
|
Division |
The name of the user's division. |
Text |
|
Department |
The name of the user's department. |
Text |
|
Manager |
List of Objects | |
|
ID |
The unique identifier of the user's manager. |
Text |
|
Raw Output |
The raw output returned by the Lucidchart API. |
Object |