Get User Claims

UserClaims admin().users().getClaims(, )

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.

ParametersExpand Collapse

UserGetClaimsParams params

Optional<String> userId

ReturnsExpand Collapse

class UserClaims:

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

CustomClaims claims

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.

Get User Claims

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.admin.users.UserClaims;
import ai.llamaindex.llamacloudadmin.models.admin.users.UserGetClaimsParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        UserClaims userClaims = client.admin().users().getClaims("user_id");
    }
}

{
  "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"
}