Tenant users

The tenant users resource represents a relationship between a single user within a tenant. Users are added to a tenant after accepting an invitation.

Tenant user object

{
  "id": "01988bb8-1d00-7824-8a99-8e65d1eac266",
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "user": "0198080b-cb61-7e1d-98c3-83f2u44894f2",
  "created_at": "2025-08-08 22:05:55",
  "updated_at": null
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• user
  required string
  Unique ID of the user.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

List tenant users

GET /tenants/{tenantId}/users

Required permissions

Users can read all other users who belong to the same tenant.

Response

Read a tenant user

GET /tenants/{tenantId}/users/{id}

Required permissions

Users can read all other users who belong to the same tenant.

Response

List a tenant user's permissions

GET /tenants/{tenantId}/users/{id}/permissions

Required permissions

tenant_permissions:read

Response

Delete a tenant user

DELETE /tenants/{tenantId}/users/{id}

Required permissions

tenant_users:delete

Response