Listar organizações, usuários, funções, grupos e configurações

Os endpoints desta página expõem o lado de diretório de uma organização Claude Enterprise: suas organizações vinculadas, os usuários em cada uma, as funções definidas em cada uma e seus grupos de "role-based access control" (controle de acesso baseado em funções), ou RBAC, ou provisionados por SCIM (System for Cross-domain Identity Management), e seus membros. Use-os para alimentar listas de usuários de eDiscovery, criar painéis de relatórios e reconciliar a associação a grupos com um sistema de registro externo. Uma Compliance Access Key que cobre a organização pai retorna dados de todas as organizações vinculadas abaixo dela, de modo que uma única chave alcança toda a árvore. O endpoint de configurações efetivas complementa o diretório: ele retorna as configurações de privacidade de dados, segurança e capacidades realmente em vigor para uma organização.

Listar organizações

O endpoint Listar organizações retorna todas as organizações sob a organização pai à qual a chave está vinculada.

A chamada a seguir lista todas as organizações sob sua organização pai. A resposta é um array data de registros de organização ordenados por created_at em ordem crescente, além de has_more e next_page para paginação. Quando has_more for true, passe o token next_page retornado de volta, sem alterações, como o parâmetro de consulta page na sua próxima requisição. Consulte Listar organizações na referência da API para os valores padrão e intervalos dos parâmetros limit e page.

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

{
  "data": [
    {
      "uuid": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
      "name": "Acme Engineering",
      "created_at": "2025-06-01T10:00:00Z"
    },
    {
      "uuid": "5a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "name": "Acme Legal",
      "created_at": "2025-07-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

O campo uuid é o identificador canônico para consultas subsequentes. A tabela a seguir o relaciona aos outros identificadores de organização em toda a Compliance API:

A maioria das outras APIs da Anthropic usa a forma com prefixo org_.

Para acompanhar mudanças na associação de organizações ao longo do tempo, liste novamente este endpoint periodicamente, seguindo o token next_page por todas as páginas em cada passagem. O Activity Feed também expõe eventos de associação por meio dos tipos de atividade org_deletion_requested, org_deleted_via_bulk, org_parent_join_proposal_created e org_join_proposal_decided; consulte Consultar o Activity Feed.

Listar usuários da organização

O endpoint Listar usuários da organização retorna uma lista paginada de registros de usuários de uma organização.

Este endpoint exige read:compliance_user_data, não read:compliance_org_data. Crie a Compliance Access Key com ambos os escopos quando pretender usá-la para enumeração de diretório; caso contrário, a chamada retorna 403 Forbidden.

Consulte Listar usuários da organização na referência da API para os valores padrão e intervalos dos parâmetros de consulta limit e page.

Os resultados são ordenados pela data de entrada na organização em ordem crescente. Diferentemente dos cursores before_id/after_id do Activity Feed (consulte Paginar resultados), os endpoints de diretório paginam com um token next_page: quando has_more for true, passe next_page de volta, sem alterações, como o parâmetro de consulta page na próxima requisição.

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/users" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"

{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "priya@example.com",
      "organization_role": "admin",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "page_8aW5kZXgicG9zaXRpb25fdG9rZW5fOTE0"
}

Os IDs de usuário retornados aqui são os mesmos identificadores user_... aceitos pelo filtro actor_ids[] de Consultar o Activity Feed e pelos filtros user_ids[] em Recuperar chats e mensagens e na lista de sessões remotas; a lista de sessões locais não tem filtro de usuário, portanto atribua sessões locais pelo user.id em cada objeto de sessão. O campo organization_role carrega o nível de associação integrado do usuário dentro da organização listada (um entre admin, billing, claude_code_user, developer, managed, membership_admin, owner, primary_owner ou user), um eixo independente de quaisquer atribuições de funções RBAC personalizadas retornadas por Listar funções. Um fluxo típico de eDiscovery lista usuários de uma ou mais organizações, filtra com base nos seus próprios registros externos e alimenta os IDs resultantes em consultas de chats e projetos.

Um usuário só aparece aqui enquanto for um membro ativo da organização. Usuários removidos são retirados da lista imediatamente. Sua atividade histórica permanece consultável por meio do Activity Feed durante toda a janela de retenção, indexada pelo mesmo ID user_....

Listar funções

O endpoint List Compliance Roles retorna uma lista paginada de registros de funções definidas em uma organização, e Get Compliance Role retorna uma função por ID.

Ambos os endpoints de funções exigem read:compliance_org_data. O endpoint de listagem aceita os mesmos parâmetros limit e page que o endpoint de usuários da organização.

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

{
  "data": [
    {
      "id": "rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh",
      "name": "Compliance Reviewer",
      "description": "Read-only access to chat and project content for legal review.",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Consulte o esquema de resposta de List Compliance Roles para o formato completo do registro de função. Para listar as permissões atualmente concedidas a uma função, use List Compliance Role Permissions. Para auditar atribuições históricas de funções e mudanças de permissões, consulte os tipos de atividade RBAC (por exemplo, rbac_role_assigned e rbac_role_permission_added) por meio do Activity Feed; consulte Filtrar atividades.

Listar grupos e membros

O endpoint List Compliance Groups retorna uma lista paginada de grupos RBAC e provisionados por SCIM, e Get Compliance Group retorna um grupo por ID. O endpoint List Compliance Group Members retorna os membros de um grupo.

Os endpoints de listagem e recuperação de grupos exigem read:compliance_org_data. O endpoint de membros exige read:compliance_user_data. Crie a chave com ambos os escopos para percorrer os grupos de ponta a ponta. Ambos os endpoints de listagem aceitam os mesmos parâmetros limit e page que o endpoint de usuários da organização.

Consulte o esquema de resposta de List Compliance Groups para o formato completo do registro de grupo. O array roles lista os IDs de funções atribuídas ao grupo, correspondendo aos IDs de Listar funções. source_type é o discriminador entre grupos criados manualmente por meio do claude.ai (direct) e grupos sincronizados de um provedor de identidade externo por meio de SCIM (scim).

Liste os grupos e, em seguida, para cada grupo, liste seus membros:

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

{
  "data": [
    {
      "id": "rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK",
      "name": "Engineering",
      "description": "Engineering team members",
      "source_type": "scim",
      "roles": ["rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh"],
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Para cada ID de grupo, liste seus membros:

group_id="rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups/$group_id/members" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "priya@example.com",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Consulte o esquema de resposta de List Compliance Group Members para o formato completo do registro de membro. O campo user_id é o mesmo identificador user_... que o Activity Feed, a lista de chats e a lista de sessões remotas aceitam; ele também corresponde a user.id em objetos de sessão local e em objetos de sessão remota pertencentes a usuários (sessões remotas pertencentes a agentes carregam o ID do humano em started_by_user.id em vez disso). Para obter o nome completo de um membro, consulte-o por meio da lista de usuários da organização.

Obter configurações efetivas da organização

O endpoint Obter configurações efetivas da organização retorna as configurações em vigor para uma organização sob sua organização pai: o estado aplicado depois que restrições regulatórias (como HIPAA), regras de disponibilidade de recursos, padrões por tipo de organização e dependências entre recursos são aplicados, o que pode diferir do que um administrador configurou. Use-o para atestar que janelas de retenção, redação de conteúdo, imposição de single sign-on, a lista de permissões de IP e os controles de duração de sessão correspondem à sua linha de base documentada, sem acesso de administrador ao Console.

Este endpoint exige read:compliance_org_data; uma chave sem esse escopo retorna 403 Forbidden. O alvo deve ser uma das organizações vinculadas à organização pai: a própria organização pai não é um alvo válido. Uma organização desconhecida, um ID de organização que não seja um UUID válido, uma organização fora da árvore da sua organização pai e uma organização pai que ainda não tenha acesso a este endpoint retornam todos o mesmo 404 Not Found, de modo que um 404 não revela se uma organização existe. O endpoint de configurações é habilitado por organização pai separadamente do restante da Compliance API; se todas as requisições retornarem 404, entre em contato com seu representante da Anthropic.

org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/settings" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

A resposta é uma lista de linhas de configuração tipadas, e quais linhas aparecem varia por organização: uma configuração que os administradores da organização não podem alterar, porque é controlada por política da Anthropic ou não está disponível para a organização, é omitida da lista. Trate uma linha ausente como "não controlável pelos administradores desta organização", não como "desativada". O exemplo resumido a seguir mostra três das linhas que uma resposta pode conter:

{
  "type": "effective_organization_settings",
  "organization_id": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
  "settings": [
    {
      "name": "data_retention_periods",
      "type": "data_retention",
      "value": {
        "chat": {
          "type": "fixed",
          "timescale": "day",
          "duration": 90
        }
      }
    },
    {
      "name": "content_redaction_enabled",
      "type": "boolean",
      "value": true
    },
    {
      "name": "ip_allowlist_ip_ranges",
      "type": "string_list",
      "value": ["10.0.0.0/8", "203.0.113.0/24"]
    }
  ],
  "api_keys": [
    {
      "type": "compliance_api_key",
      "id": "apikey_01Hx7k2mP9nQ4rS6tU8vW0xY",
      "name": "Compliance Export Key",
      "scopes": ["read:compliance_activities", "read:compliance_org_data"],
      "is_active": true,
      "created_at": "2026-03-14T09:30:00Z",
      "created_by_id": "user_01Jz3a4bC5dE6fG7hI8jK9lM",
      "expires_at": null
    }
  ]
}

Cada linha carrega name, type e value; o campo type (boolean, integer, string_list, provisioning_mode ou data_retention) informa o formato de value. A lista completa de nomes de configurações, e o esquema de value para cada tipo, está em Obter configurações efetivas da organização na referência da API.

O array api_keys lista todas as Compliance Access Keys configuradas para sua organização pai, de modo que a mesma lista é retornada independentemente de qual organização vinculada você consultar. Cada entrada carrega o type da chave (compliance_api_key), id, name, scopes, o sinalizador is_active, os timestamps created_at e expires_at, e created_by_id (o ID do usuário que criou a chave; pode ser null). O valor secreto da chave nunca é retornado. Chaves desativadas são incluídas com is_active: false para que você possa revisar chaves que anteriormente tinham acesso, e chaves que carregam apenas o escopo desativado read:compliance_org_settings permanecem na lista para visibilidade de auditoria e limpeza, mesmo que esse escopo não conceda mais acesso.

O organization_id de nível superior é o UUID simples da organização: o mesmo valor que uuid na lista de organizações, não a forma com prefixo org_ que organization_id carrega nos registros do Activity Feed, de chat e de projeto (consulte a tabela de identificadores de organização).

As linhas refletem o estado aplicado em vez da última configuração armazenada: por exemplo, sso_provisioning_mode informa um modo SCIM configurado apenas enquanto a sincronização de diretório estiver habilitada, ip_allowlist_enabled é true apenas enquanto a lista de permissões estiver ativada e tiver pelo menos um intervalo ativo, e code_execution_network_egress_enabled é false sempre que a execução de código estiver desativada.

A resposta reflete o estado no momento da leitura; nada é capturado em snapshot. Mudanças na maioria dessas configurações aparecem como eventos no Activity Feed; use este endpoint para o estado resolvido atual e o feed para auditar quem alterou o quê, e quando.

Próximos passos