Skip to main content
POST
Create User

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
email
string<email>
required

Must be globally unique across all Connect AI orgs.

first_name
string
required

The user's first name.

last_name
string | null

The user's last name. Omit for users with a single name.

external_id
string

Idempotency key supplied by the calling system (for example, an HR system employee ID or Terraform resource ID). A second POST with the same key returns the existing user instead of creating a duplicate. Connect AI does not generate this value; the caller provides it.

Response

Created

id
string<uuid>

User identifier.

email
string<email>

The email address of the user.

first_name
string

The user's first name.

last_name
string | null

The user's last name.

status
enum<string>

Current lifecycle state of the user.

Available options:
active,
invited,
deactivated
scim_managed
boolean

false for API-created users. true for SCIM-provisioned users.

external_id
string | null

Idempotency key supplied by the calling system.

created_at
string<date-time>

ISO 8601 UTC.

created_by
string<uuid> | null

User ID of the creator. null for SCIM-provisioned users.