• Mensagens
  • Agentes Gerenciados
  • Administração
Search...
⌘K
Organização
API de AdministraçãoWorkspaces
Autenticação
Visão geralWorkload Identity FederationReferência de WIF
Monitoramento
API de Uso e CustoAPI de Limites de TaxaAPI de Análise do Claude Code
Dados e conformidade
Residência de dadosAPI e retenção de dados
API de Conformidade
Visão geralObter acessoFeed de AtividadesChats, arquivos e projetosOrganizações, usuários, funções e gruposProjetar sua integraçãoErrosPerguntas frequentes
Log in
Organizações, usuários, funções e grupos
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

Solutions

  • AI agents
  • Code modernization
  • Coding
  • Customer support
  • Education
  • Financial services
  • Government
  • Life sciences

Partners

  • Amazon Bedrock
  • Google Cloud's Vertex AI

Learn

  • Blog
  • Courses
  • Use cases
  • Connectors
  • Customer stories
  • Engineering at Anthropic
  • Events
  • Powered by Claude
  • Service partners
  • Startups program

Company

  • Anthropic
  • Careers
  • Economic Futures
  • Research
  • News
  • Responsible Scaling Policy
  • Security and compliance
  • Transparency

Learn

  • Blog
  • Courses
  • Use cases
  • Connectors
  • Customer stories
  • Engineering at Anthropic
  • Events
  • Powered by Claude
  • Service partners
  • Startups program

Help and security

  • Availability
  • Status
  • Support
  • Discord

Terms and policies

  • Privacy policy
  • Responsible disclosure policy
  • Terms of service: Commercial
  • Terms of service: Consumer
  • Usage policy
Administração/API de Conformidade

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

Enumere organizações sob sua organização pai, seus usuários, funções e grupos por meio da Compliance API.

A Compliance API é habilitada mediante solicitação. Organizações do Claude Enterprise têm acesso à API completa; organizações do Claude Console têm acesso apenas ao Feed de Atividades. Consulte Obter acesso à Compliance API.

Escopo obrigatório: read:compliance_org_data na Compliance Access Key. Os endpoints de usuários e de membros de grupos exigem read:compliance_user_data em vez disso.

Compliance Access Keys (sk-ant-api01-...) criadas no claude.ai são o único tipo de chave aceito; consulte Obter acesso à Compliance API para provisionar uma. Chamadas autenticadas com uma Admin API key (sk-ant-admin01-...) retornam 403 Forbidden.

Os endpoints nesta 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 via SCIM (System for Cross-domain Identity Management), além de seus membros. Use-os para preencher listas de usuários de eDiscovery, criar dashboards de relatórios e reconciliar a associação de grupos com um sistema de registro externo. As Compliance Access Keys são vinculadas a uma organização pai e retornam dados de todas as organizações vinculadas abaixo dela, de modo que uma única chave alcança toda a árvore.

Listar organizações

O endpoint List organizations 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 único array data de registros de organização ordenados por created_at em ordem crescente. O endpoint retorna até 1.000 organizações em uma única chamada; se sua árvore exceder esse limite, ele retorna um erro 500.

cURL
curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "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"
    }
  ]
}

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

CampoOndeRelação com uuid
{org_uuid}Parâmetro de caminho nos endpoints por organização nesta páginaMesmo valor
organization_uuidRegistros do Activity Feed, de chats e de projetosMesmo valor; faça join diretamente nesses dois campos
organization_idRegistros do Activity Feed, de chats e de projetosMesma organização, com prefixo org_. Descontinuado em registros de chats e projetos; use organization_uuid em vez disso.
organization_ids[]Filtro em Consultar o Activity Feed e Recuperar chats e mensagensAceita uuid ou a forma com prefixo org_

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

Se sua árvore exceder o limite de 1.000 organizações, entre em contato com o suporte da Anthropic. Para acompanhar mudanças de associação de organizações ao longo do tempo, liste este endpoint novamente periodicamente. 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 List organization users retorna uma lista paginada de registros de usuários de uma organização.

Este endpoint requer 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 List organization users 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 por 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 é true, passe next_page de volta sem alterações como o parâmetro de consulta page na próxima requisição.

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

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/users" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"
Response
{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "[email protected]",
      "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 pelo filtro user_ids[] de Recuperar chats e mensagens. O campo organization_role contém o nível de associação integrado do usuário dentro da organização listada (um de 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 em 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 excluídos 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 Listar usuários da organização.

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

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "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 alterações 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 via 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 grupos de ponta a ponta. Ambos os endpoints de listagem aceitam os mesmos parâmetros limit e page que Listar 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 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
curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "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:

cURL
group_id="rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups/$group_id/members" \
  --header "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "[email protected]",
      "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 e a lista de chats aceitam. Para obter o nome completo de um membro, consulte-o por meio da lista de usuários da organização.

Próximos passos

Referência da API de organizações de Compliance

O esquema completo de requisição e resposta para cada endpoint de organização, usuário, função e grupo.

Tratar erros da Compliance API

Payloads de erro literais e a correção para cada um.

Was this page helpful?

  • Listar organizações
  • Listar usuários da organização
  • Listar funções
  • Listar grupos e membros
  • Próximos passos