API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List

GET/organizations/{organization_id}/users

Retrieve

GET/organizations/{organization_id}/users/{user_id}

Update

PATCH/organizations/{organization_id}/users/{user_id}

Delete

DELETE/organizations/{organization_id}/users/{user_id}

ModelsExpand Collapse

OrganizationRole = "org_admin" or "org_member" or "org_viewer"

User's role in the organization

Accepts one of the following:

"org_admin"

"org_member"

"org_viewer"

OrganizationStatus = "active" or "disabled"

Status of organization membership

Accepts one of the following:

"active"

"disabled"

OrganizationUser = object { id, created_at, role, 5 more }

id: string

The keycard account ID

minLength1

maxLength255

created_at: string

The time the entity was created in utc

formatdate-time

role: OrganizationRole

User's role in the organization

Accepts one of the following:

"org_admin"

"org_member"

"org_viewer"

source: string

Identity provider issuer

formaturi

status: OrganizationStatus

Status of organization membership

Accepts one of the following:

"active"

"disabled"

updated_at: string

The time the entity was mostly recently updated in utc

formatdate-time

email: optional string

User email address

formatemail

permissions: optional map[map[boolean]]

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.