Get User Claims

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

Get a user’s resolved custom claims.

Claims that have not been explicitly set fall back to their system default. Returns 404 if the user does not exist.

Global admin only.

Path ParametersExpand Collapse

user_id: string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

UserClaims object { 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.

allow_org_deletion: optional boolean

Whether the user is allowed to delete organizations.

allowed_org_creation: optional boolean

Whether the user is allowed to create organizations.

api_datasource_access: optional boolean

Whether the user is allowed to access API data sources.

maximum_org_creation: optional number

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

user_id: string

The user ID the claims belong to.

Get User Claims

curl https://api.cloud.llamaindex.ai/api/v1/admin/users/$USER_ID/claims \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

{
  "claims": {
    "allow_org_deletion": true,
    "allowed_org_creation": true,
    "api_datasource_access": true,
    "maximum_org_creation": 0
  },
  "user_id": "user_id"
}

Returns Examples

{
  "claims": {
    "allow_org_deletion": true,
    "allowed_org_creation": true,
    "api_datasource_access": true,
    "maximum_org_creation": 0
  },
  "user_id": "user_id"
}