Skip to content
Product Docs

Users

Get User Claims
admin.users.get_claims(struser_id) -> UserClaims
GET/api/v1/admin/users/{user_id}/claims
Update User Claims
admin.users.update_claims(struser_id, UserUpdateClaimsParams**kwargs) -> UserClaims
PATCH/api/v1/admin/users/{user_id}/claims
ModelsExpand Collapse
class CustomClaims:

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: Optional[bool]

Whether the user is allowed to delete organizations.

allowed_org_creation: Optional[bool]

Whether the user is allowed to create organizations.

api_datasource_access: Optional[bool]

Whether the user is allowed to access API data sources.

maximum_org_creation: Optional[int]

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

class UserClaims:

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

claims: CustomClaims

The user’s resolved custom claims.

allow_org_deletion: Optional[bool]

Whether the user is allowed to delete organizations.

allowed_org_creation: Optional[bool]

Whether the user is allowed to create organizations.

api_datasource_access: Optional[bool]

Whether the user is allowed to access API data sources.

maximum_org_creation: Optional[int]

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

user_id: str

The user ID the claims belong to.