Skip to content
Product Docs

Users

Get User Claims
client.Admin.Users.GetClaims(ctx, userID) (*UserClaims, error)
GET/api/v1/admin/users/{user_id}/claims
Update User Claims
client.Admin.Users.UpdateClaims(ctx, userID, body) (*UserClaims, error)
PATCH/api/v1/admin/users/{user_id}/claims
ModelsExpand Collapse
type CustomClaims struct{…}

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.

AllowOrgDeletion boolOptional

Whether the user is allowed to delete organizations.

AllowedOrgCreation boolOptional

Whether the user is allowed to create organizations.

APIDatasourceAccess boolOptional

Whether the user is allowed to access API data sources.

MaximumOrgCreation int64Optional

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

type UserClaims struct{…}

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

The user’s resolved custom claims.

AllowOrgDeletion boolOptional

Whether the user is allowed to delete organizations.

AllowedOrgCreation boolOptional

Whether the user is allowed to create organizations.

APIDatasourceAccess boolOptional

Whether the user is allowed to access API data sources.

MaximumOrgCreation int64Optional

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

UserID string

The user ID the claims belong to.