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 na sua organização, consultada pelo ID. Este endpoint da Admin API requer uma chave de API Admin, 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 chave externa na organização do chamador.
Obter chave externa
Recupere uma única configuração de chave externa na organização do chamador por 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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
Lista os "rate limits" (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 conta de serviço do workspace
Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou por uma regra de workload identity federation (federação de identidade de carga de trabalho); chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.
Criar membro de conta de serviço do workspace
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 administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.
Obter membro de conta de serviço do workspace
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 administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.
Atualizar membro de conta de serviço do workspace
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 administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.
Excluir membro de conta de serviço do workspace
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 administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.
OrganizaçãoLimites de taxa
Listar limites de taxa da organização
List Messages API rate limits for your organization.
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álisesSummaries
Obter resumos de atividade
Get organization-wide activity summaries for a date range.
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 em 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
Obtenha o uso de tokens ao longo do tempo em um intervalo de datas.
OrganizaçãoAnálisesUser Usage Report
Obter uso de tokens por usuário
Obtenha o uso de tokens por usuário em um intervalo de datas.
OrganizaçãoAnálisesRelatório de custos
Obter custo ao longo do tempo
Obtenha o custo em USD ao longo do tempo em um intervalo de datas.
OrganizaçãoAnálisesUser Cost Report
Obter custo por usuário
Obtenha 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 gastosEffective
Listar limites de gastos efetivos
Liste o limite de gastos efetivo de cada membro e o gasto acumulado 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
Create Plugin
Create an organization-owned Plugin and its first version by uploading the version's files.
Update Plugin
Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.
List Plugins
List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.
Delete Plugin
Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.
OrganizaçãoPluginsVersões
Create Plugin Version
Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.
List Plugin Versions
List a Plugin's versions, newest first.
Get Plugin Version
Retrieve one version of a Plugin by its ID, or the Plugin's newest version.
Download Plugin Version Archive
Download one version's .zip archive, exactly as stored. Each download of a
Plugin from a member's personal plugin marketplace is recorded on the Compliance API
activity feed.
OrganizaçãoPluginsInstallation Settings
List Plugin Installation Settings
List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.
Set Plugin Installation Setting
Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.
Remove Plugin Installation Setting
Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.
OrganizaçãoPlugin Marketplaces
List Plugin Marketplaces
List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.
Get Plugin Marketplace
Retrieve a plugin marketplace by ID.
Update Plugin Marketplace
Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.
Validate Plugin Marketplace Repository
Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.
Validate Plugin Marketplace Archive
Check whether a plugin marketplace, uploaded as a .zip of the marketplace
directory, would synchronize into claude.ai, without connecting or storing it.