directory

Unique across all organizations. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

Unique across all organizations. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null or empty to clear the description.

at most 2000 characters

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

Nests the new department under one in the same organization.

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null or empty to clear the description.

at most 2000 characters

Moves the department under another in the same organization — never itself or anything nested beneath it. Send null to make it top level.

Unique within the department. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

The permissions the role grants, from the set the code understands. Duplicates are collapsed; an empty array grants nothing.

at most 34 items · defaults to []

Unique within the department. Slugs are lowercase letters and digits in words separated by single hyphens, like customer-success.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null or empty to clear the description.

at most 2000 characters

Replaces the whole permission set, from the set the code understands. Duplicates are collapsed; an empty array grants nothing.

at most 34 items

Sign-in provider UUID id or slug; every row's user_id is the OIDC `sub` claim the member will present at this provider.

at least 1 character

Set true to accept rows with a blank (or absent) user_id and an email: each resolves to the account a pending email link or a single live profile email already names, or else creates an account with a pending email link at the provider, so that person's first sign-in there lands in it. Default false.

one of "true" | "false"

CSV file, at most 1 MB: a header row naming a `user_id` (the OIDC `sub` claim at the named provider; `user_subject`, `subject` and `sub` are accepted too), `name` (or `display_name`) and `email` column in any order, then one member per row. Header matching is case-insensitive and extra columns are ignored. A member's name and email cells may be left blank; they seed a newly created account's profile. With `allow_email_only`, the user_id column may be blank or missing and rows are matched by email instead.

The member's account id (`users.id`). Mutually exclusive with provider_id/subject.

Sign-in provider UUID id or slug.

at least 1 character

OIDC `sub` claim the member will present at that provider.

1–255 characters

Starting profile for a newly created account; ignored for an existing one.

1–300 characters

1–300 characters

Department UUID id or slug, resolved within the organization.

at least 1 character

Role UUID id or slug, resolved within the department.

at least 1 character

When the grant lapses; omit for an open-ended one. Must be in the future.

New expiry of the grant; null makes it open-ended.

The role to make a manager of this one. Any role of the same organization except this role itself, or one that would close a cycle.