Users

Get User Claims

client.admin.users.getClaims(, ?): UserClaims { claims, user_id }

GET/api/v1/admin/users/{user_id}/claims

Update User Claims

client.admin.users.updateClaims(, , ?): UserClaims { claims, user_id }

PATCH/api/v1/admin/users/{user_id}/claims

ModelsExpand Collapse

CustomClaims { allow_org_deletion, allowed_org_creation, api_datasource_access, maximum_org_creation }

Custom claims that dictate various limits or allowed behaviors. Currently these claims reside at a per user level. Claims may expand to a per organization level or project in the future.

allow_org_deletion?: boolean

Whether the user is allowed to delete organizations.

allowed_org_creation?: boolean

Whether the user is allowed to create organizations.

api_datasource_access?: boolean

Whether the user is allowed to access API data sources.

maximum_org_creation?: number | null

Cap on how many organizations this user may create. None means unlimited. Only enforced when allowed_org_creation is True.

UserClaims { claims, user_id }

A user’s fully resolved custom claims after applying system defaults.

claims: CustomClaims { allow_org_deletion, allowed_org_creation, api_datasource_access, maximum_org_creation }

The user’s resolved custom claims.