Skip to content
Product Docs

Users

Get User Claims
UserClaims admin().users().getClaims(UserGetClaimsParamsparams = UserGetClaimsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/admin/users/{user_id}/claims
Update User Claims
UserClaims admin().users().updateClaims(UserUpdateClaimsParamsparams = UserUpdateClaimsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
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.

Optional<Boolean> allowOrgDeletion

Whether the user is allowed to delete organizations.

Optional<Boolean> allowedOrgCreation

Whether the user is allowed to create organizations.

Optional<Boolean> apiDatasourceAccess

Whether the user is allowed to access API data sources.

Optional<Long> maximumOrgCreation

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.

The user’s resolved custom claims.

Optional<Boolean> allowOrgDeletion

Whether the user is allowed to delete organizations.

Optional<Boolean> allowedOrgCreation

Whether the user is allowed to create organizations.

Optional<Boolean> apiDatasourceAccess

Whether the user is allowed to access API data sources.

Optional<Long> maximumOrgCreation

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

String userId

The user ID the claims belong to.