Organização
Obter organização atual
Recupere informações sobre a organização associada à chave de API autenticada.
Models
OrganizaçãoChaves de API
Listar chaves de API
Recuperar chave de API (Admin API)
Recupere informações sobre uma única chave de API em sua organização, pesquisada pelo ID. Este endpoint da Admin API requer uma chave de Admin API, destina-se ao gerenciamento programático de chaves e nunca retorna o valor secreto da chave. Para visualizar ou criar suas próprias chaves de API, acesse Chaves de API no Claude Console.
Atualizar chave de API
OrganizaçãoChaves externas
Criar chave externa
Crie uma configuração de chave externa pertencente à organização do chamador.
Listar chaves externas
Liste as configurações de chaves externas na organização do chamador.
Obter chave externa
Recupere uma única configuração de chave externa na organização do chamador pelo ID.
Atualizar chave externa
Atualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.
Excluir chave externa
Exclua uma configuração de chave externa.
Validar chave externa
Valide uma configuração de chave externa em relação ao KMS do cliente.
OrganizaçãoFederaçãoEmissores
Criar emissor de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Listar emissores de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Obter emissor de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Atualizar emissor de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Arquivar emissor de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoFederaçãoRegras
Criar regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Listar regras de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Obter regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Atualizar regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Arquivar regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoFederaçãoRegrasEspaços de trabalho
Adicionar workspace à regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Listar workspaces da regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Remover workspace da regra de federação
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoConvites
Criar convite
Convide um usuário para ingressar na organização por e-mail.
OrganizaçãoContas de serviço
Criar conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Listar contas de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Obter conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Atualizar conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Arquivar conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoContas de serviçoEspaços de trabalho
Adicionar workspace à conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Listar workspaces da conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Remover workspace da conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoUsuários
Obter usuário
Recupere um membro da organização pelo ID de usuário.
Atualizar usuário
Atualize a função de um membro na organização.
OrganizaçãoEspaços de trabalho
Listar workspaces
Criar workspace
Obter workspace
Atualizar workspace
Arquivar workspace
OrganizaçãoEspaços de trabalhoLimites de taxa
Listar limites de taxa do workspace
Liste os limites de taxa de um workspace.
OrganizaçãoEspaços de trabalhoMembros
Listar membros do workspace
Criar membro do workspace
Obter membro do workspace
Atualizar membro do workspace
Excluir membro do workspace
OrganizaçãoEspaços de trabalhoContas de serviço
Listar membros de workspace de conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Criar membro de workspace de conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Obter membro de workspace de conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Atualizar membro de workspace de conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Excluir membro de workspace de conta de serviço
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou por uma regra de federação de identidade de carga de trabalho; chaves de API de Admin não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoLimites de taxa
Listar limites de taxa da organização
Lista os "rate limits" (limites de taxa) da Messages API para sua organização.
OrganizaçãoConfigurações de conformidade
Obter configurações de conformidade
Recupera as Configurações de conformidade da sua organização.
Atualizar configurações de conformidade
Atualiza as Configurações de conformidade da sua organização.
OrganizaçãoRelatório de uso
Obter relatório de uso de mensagens
Obter relatório de uso do Claude Code
Recupere métricas de uso diárias agregadas para usuários do Claude Code. Permite que as organizações analisem a produtividade dos desenvolvedores e criem dashboards personalizados.
OrganizaçãoRelatório de custos
Obter relatório de custos
OrganizaçãoTúneis MCP
Listar túneis
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Obter túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Arquivar túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Revelar token do túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Rotacionar token do túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
OrganizaçãoTúneis MCPCertificados de túnel
Criar certificado de túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Listar certificados de túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Obter certificado de túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
Arquivar certificado de túnel
Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.
OrganizaçãoAnálisesResumos
Obter resumos de atividade
Obtenha resumos de atividade de toda a organização para um intervalo de datas.
OrganizaçãoAnálisesUsuários
Listar atividade de usuários
Obtém a atividade por usuário em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesAplicativosChatProjetos
Obter uso de projetos de chat
Obtém a atividade por projeto para um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesConectores
Obter uso de conectores
Obtém o uso por conector em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesPlugins
Obter uso de plugins
Obtém o uso de instalação + invocação por plugin em um determinado dia, com paginação.
OrganizaçãoAnálisesSkills
Obter uso de skills
Obtém o uso por skill em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesArtifacts
Obter atividade de artifacts
Obtém a atividade de criação de artifacts em um determinado dia, detalhada por tipo MIME.
OrganizaçãoAnálisesRelatório de uso
Obter uso de tokens ao longo do tempo
Obtém o uso de tokens ao longo do tempo em um intervalo de datas.
OrganizaçãoAnálisesRelatório de uso por usuário
Obter uso de tokens por usuário
Obtém o uso de tokens por usuário em um intervalo de datas.
OrganizaçãoAnálisesRelatório de custos
Obter custo ao longo do tempo
Obtém o custo em USD ao longo do tempo em um intervalo de datas.
OrganizaçãoAnálisesRelatório de custos por usuário
Obter custo por usuário
Obtém o custo por usuário em USD em um intervalo de datas.
OrganizaçãoLimites de gastos
Obter limite de gastos
Recupere um limite de gastos por ID.
Excluir limite de gastos
Exclui um limite de gastos.
OrganizaçãoLimites de gastosEfetivos
Listar limites de gastos efetivos
Lista o limite de gastos efetivo de cada membro e os gastos acumulados no período.
OrganizaçãoLimites de gastosSolicitações de aumento
Listar solicitações de aumento de limite de gastos
Liste as solicitações de aumento de limite de gastos, mais recentes primeiro.
Obter solicitação de aumento de limite de gastos
Recupere uma solicitação de aumento de limite de gastos.
Aprovar solicitação de aumento de limite de gastos
Aprove uma solicitação pendente de aumento de limite de gastos.
Negar solicitação de aumento de limite de gastos
Negue uma solicitação pendente de aumento de limite de gastos.
OrganizaçãoGrupos RBAC
Criar grupo RBAC
Cria um grupo RBAC no tenant do Claude Enterprise. Grupos criados pela API têm o tipo de origem "direct".
Listar grupos RBAC
Lista os grupos RBAC no tenant do Claude Enterprise.
Atualizar grupo RBAC
Atualiza o nome de um grupo RBAC. Grupos provisionados por um provedor de identidade (tipo de origem "scim") não podem ser modificados pela API enquanto uma organização no tenant usar provisionamento SCIM.
Excluir grupo RBAC
Exclui um grupo RBAC. Grupos provisionados por um provedor de identidade (tipo de origem "scim") não podem ser excluídos pela API enquanto uma organização no tenant usar provisionamento SCIM.
OrganizaçãoGrupos RBACMembros
Listar membros do grupo RBAC
Lista os membros de um grupo RBAC.
Adicionar membro ao grupo RBAC
Adiciona um usuário a um grupo RBAC. A associação a grupos provisionados por um provedor de identidade (tipo de origem "scim") não pode ser modificada pela API enquanto uma organização no tenant usar provisionamento SCIM.
Remover membro do grupo RBAC
Remove um usuário de um grupo RBAC. A associação a grupos provisionados por um provedor de identidade (tipo de origem "scim") não pode ser modificada pela API enquanto uma organização no tenant usar provisionamento SCIM.
OrganizaçãoFunções RBAC
OrganizaçãoFunções RBACPermissões
Listar permissões da função RBAC
Lista as permissões concedidas por uma função RBAC.
OrganizaçãoPlugins
Criar plugin
Cria um plugin pertencente à organização e sua primeira versão fazendo upload dos arquivos da versão.
Atualizar plugin
Altere qual versão armazenada de um Plugin pertencente à organização é servida aos membros, por exemplo, para reverter para uma versão anterior. Isso fixa a versão servida: uploads posteriores são armazenados, mas deixam de alterar o que é servido, e a fixação atualmente não pode ser desfeita, nem aqui nem no claude.ai.
Listar Plugins
Liste os Plugins criados na organização, do mais recente para o mais antigo: os que estão nos marketplaces de plugins da própria organização e os que estão nos marketplaces de plugins pessoais dos membros.
Excluir Plugin
Exclua permanentemente um Plugin e todas as versões que ele contém, exatamente como quando um administrador o exclui no claude.ai. O Plugin pode pertencer à organização ou a um membro, incluindo um membro que já saiu da organização.
OrganizaçãoPluginsVersões
Criar versão do Plugin
Adicione uma versão a um Plugin pertencente à organização enviando os arquivos da nova versão; ela se torna a versão servida aos membros, a menos que a versão servida do Plugin tenha sido fixada.
Listar versões do Plugin
Liste as versões de um Plugin, da mais recente para a mais antiga.
Obter versão do Plugin
Recupere uma versão de um Plugin pelo seu ID, ou a versão mais recente do Plugin.
Baixar arquivo da versão do Plugin
Baixe o arquivo .zip de uma versão, exatamente como armazenado. Cada download de um Plugin do marketplace de plugins pessoal de um membro é registrado no feed de atividades da Compliance API.
OrganizaçãoPluginsConfigurações de instalação
Listar configurações de instalação do Plugin
Liste as configurações de instalação de um Plugin pertencente à organização, que indicam para quais membros ele se destina, das criadas mais recentemente para as mais antigas.
Definir configuração de instalação do Plugin
Defina ou altere a configuração de instalação de um Plugin pertencente à organização para toda a organização ou para um Grupo RBAC.
Remover configuração de instalação do Plugin
Remova a configuração de instalação própria de um Plugin pertencente à organização para toda a organização ou para um Grupo RBAC.
OrganizaçãoMarketplaces de plugins
Listar marketplaces de plugins
Liste os marketplaces de plugins em que os Plugins estão, do mais recente para o mais antigo: os da própria organização e os pessoais de seus membros.
Obter marketplace de plugins
Recupere um marketplace de plugins pelo ID.
Atualizar marketplace de plugins
Defina a configuração de instalação padrão de um dos marketplaces de plugins da própria organização. Todo Plugin nele sem uma configuração própria recebe esse padrão como sua configuração para toda a organização, incluindo Plugins adicionados posteriormente.
Validar repositório do marketplace de plugins
Verifique se um marketplace de plugins mantido em um repositório público do GitHub seria sincronizado no claude.ai, sem conectá-lo nem armazená-lo.
Validar arquivo do marketplace de plugins
Verifique se um marketplace de plugins, enviado como um .zip do diretório do marketplace, seria sincronizado no claude.ai, sem conectá-lo nem armazená-lo.
OrganizaçãoDestinos de telemetria
Criar um destino de telemetria
Registra um destino OpenTelemetry para a organização.
Listar destinos de telemetria
Lista os destinos da organização, do mais recente para o mais antigo, opcionalmente apenas aqueles que cobrem determinados workspaces.
Recuperar um destino de telemetria
Lê a configuração, o estado e os resultados de entrega mais recentes de um destino.
Atualizar um destino de telemetria
Altera as configurações de um destino de telemetria, seu estado ou quais workspaces ele cobre.
Excluir um destino de telemetria
Exclui um destino e sua lista de workspaces.
Testar um destino de telemetria
Envia um span de teste, chamado anthropic.test, ao destino com seus cabeçalhos registrados, uma única vez e sem novas tentativas, e relata a resposta do destino. A resposta é 200, quer o destino tenha respondido com um status 2xx ou não: seu result tem o tipo success, ou o tipo failure e o motivo em error. A configuração, o state e o delivery_health do destino não mudam. Um destino desabilitado também pode ser testado. Aguarde 10 segundos entre testes de um mesmo destino; uma solicitação que chegar antes disso pode ser respondida com o status 429.
OrganizaçãoDestinos de telemetriaEspaços de trabalho
Listar workspaces de destino de telemetria
Lista os workspaces na lista de workspaces de um destino, com a entrada mais recente primeiro.
Adicionar um workspace de destino de telemetria
Adiciona um workspace à lista de workspaces de um destino.
Remover um workspace de destino de telemetria
Remove um workspace da lista de workspaces de um destino.