Organização
Obter organização atual
$ ant beta:organization retrieveRecupere informações sobre a organização associada à chave de API autenticada.
Models
OrganizaçãoChaves de API
Recuperar chave de API (Admin API)
$ ant beta:organization:api-keys retrieveRecupere 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
$ ant beta:organization:api-keys updateOrganizaçãoChaves externas
Criar chave externa
$ ant beta:organization:external-keys createCrie uma configuração de chave externa pertencente à organização do chamador.
Listar chaves externas
$ ant beta:organization:external-keys listListe as configurações de chaves externas na organização do chamador.
Obter chave externa
$ ant beta:organization:external-keys retrieveRecupere uma única configuração de chave externa na organização do chamador pelo ID.
Atualizar chave externa
$ ant beta:organization:external-keys updateAtualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.
Excluir chave externa
$ ant beta:organization:external-keys deleteExclua uma configuração de chave externa.
Validar chave externa
$ ant beta:organization:external-keys validateValide uma configuração de chave externa em relação ao KMS do cliente.
OrganizaçãoFederaçãoEmissores
Criar emissor de federação
$ ant beta:organization:federation:issuers createRequer 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
$ ant beta:organization:federation:issuers listRequer 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
$ ant beta:organization:federation:issuers retrieveRequer 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
$ ant beta:organization:federation:issuers updateRequer 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
$ ant beta:organization:federation:issuers archiveRequer 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
$ ant beta:organization:federation:rules createRequer 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
$ ant beta:organization:federation:rules listRequer 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
$ ant beta:organization:federation:rules retrieveRequer 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
$ ant beta:organization:federation:rules updateRequer 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
$ ant beta:organization:federation:rules archiveRequer 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
$ ant beta:organization:federation:rules:workspaces addRequer 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
$ ant beta:organization:federation:rules:workspaces listRequer 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
$ ant beta:organization:federation:rules:workspaces removeRequer 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
$ ant beta:organization:invites createConvide um usuário para ingressar na organização por e-mail.
Listar convites
$ ant beta:organization:invites listListe os convites da organização.
Obter convite
$ ant beta:organization:invites retrieveRecupere um convite pelo ID.
Excluir convite
$ ant beta:organization:invites deleteExclua um convite pendente.
OrganizaçãoContas de serviço
Criar conta de serviço
$ ant beta:organization:service-accounts createRequer 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
$ ant beta:organization:service-accounts listRequer 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
$ ant beta:organization:service-accounts retrieveRequer 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
$ ant beta:organization:service-accounts updateRequer 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
$ ant beta:organization:service-accounts archiveRequer 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
$ ant beta:organization:service-accounts:workspaces addRequer 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
$ ant beta:organization:service-accounts:workspaces listRequer 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
$ ant beta:organization:service-accounts:workspaces removeRequer 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
Listar usuários
$ ant beta:organization:users listListe os membros da organização.
Obter usuário
$ ant beta:organization:users retrieveRecupere um membro da organização pelo ID de usuário.
Atualizar usuário
$ ant beta:organization:users updateAtualize a função de um membro na organização.
Remover usuário
$ ant beta:organization:users removeRemova um membro da organização.
OrganizaçãoEspaços de trabalho
Obter workspace
$ ant beta:organization:workspaces retrieveAtualizar workspace
$ ant beta:organization:workspaces updateArquivar workspace
$ ant beta:organization:workspaces archiveOrganizaçãoEspaços de trabalhoLimites de taxa
Listar limites de taxa do workspace
$ ant beta:organization:workspaces:rate-limits listListe os limites de taxa de um workspace.
OrganizaçãoEspaços de trabalhoMembros
Listar membros do workspace
$ ant beta:organization:workspaces:members listCriar membro do workspace
$ ant beta:organization:workspaces:members addObter membro do workspace
$ ant beta:organization:workspaces:members retrieveAtualizar membro do workspace
$ ant beta:organization:workspaces:members updateExcluir membro do workspace
$ ant beta:organization:workspaces:members removeOrganizaçãoEspaços de trabalhoContas de serviço
Listar membros de workspace de conta de serviço
$ ant beta:organization:workspaces:service-accounts listRequer 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
$ ant beta:organization:workspaces:service-accounts addRequer 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
$ ant beta:organization:workspaces:service-accounts retrieveRequer 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
$ ant beta:organization:workspaces:service-accounts updateRequer 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
$ ant beta:organization:workspaces:service-accounts removeRequer 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
$ ant beta:organization:rate-limits listLista os "rate limits" (limites de taxa) da Messages API para sua organização.
OrganizaçãoConfigurações de conformidade
Obter configurações de conformidade
$ ant beta:organization:compliance-settings retrieveRecupera as Configurações de conformidade da sua organização.
Atualizar configurações de conformidade
$ ant beta:organization:compliance-settings updateAtualiza as Configurações de conformidade da sua organização.
OrganizaçãoAnálisesResumos
Obter resumos de atividade
$ ant beta:organization:analytics:summaries listObtenha resumos de atividade de toda a organização para um intervalo de datas.
OrganizaçãoAnálisesUsuários
Listar atividade de usuários
$ ant beta:organization:analytics:users listObté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
$ ant beta:organization:analytics:apps:chat:projects listObtém a atividade por projeto para um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesConectores
Obter uso de conectores
$ ant beta:organization:analytics:connectors listObtém o uso por conector em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesPlugins
Obter uso de plugins
$ ant beta:organization:analytics:plugins listObtém o uso de instalação + invocação por plugin em um determinado dia, com paginação.
OrganizaçãoAnálisesSkills
Obter uso de skills
$ ant beta:organization:analytics:skills listObtém o uso por skill em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesArtifacts
Obter atividade de artifacts
$ ant beta:organization:analytics:artifacts listObté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
$ ant beta:organization:analytics:usage-report listObté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
$ ant beta:organization:analytics:user-usage-report listObté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
$ ant beta:organization:analytics:cost-report listObté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
$ ant beta:organization:analytics:user-cost-report listObtém o custo por usuário em USD em um intervalo de datas.
OrganizaçãoLimites de gastos
Definir limite de gastos
$ ant beta:organization:spend-limits setDefine um limite de gastos.
Obter limite de gastos
$ ant beta:organization:spend-limits retrieveRecupere um limite de gastos por ID.
Excluir limite de gastos
$ ant beta:organization:spend-limits deleteExclui um limite de gastos.
Listar limites de gastos
$ ant beta:organization:spend-limits listLista os limites de gastos da organização.
OrganizaçãoLimites de gastosEfetivos
Listar limites de gastos efetivos
$ ant beta:organization:spend-limits:effective listLista 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
$ ant beta:organization:spend-limits:increase-requests listListe as solicitações de aumento de limite de gastos, mais recentes primeiro.
Obter solicitação de aumento de limite de gastos
$ ant beta:organization:spend-limits:increase-requests retrieveRecupere uma solicitação de aumento de limite de gastos.
Aprovar solicitação de aumento de limite de gastos
$ ant beta:organization:spend-limits:increase-requests approveAprove uma solicitação pendente de aumento de limite de gastos.
Negar solicitação de aumento de limite de gastos
$ ant beta:organization:spend-limits:increase-requests denyNegue uma solicitação pendente de aumento de limite de gastos.
OrganizaçãoGrupos RBAC
Criar grupo RBAC
$ ant beta:organization:rbac-groups createCria um grupo RBAC no tenant do Claude Enterprise. Grupos criados pela API têm o tipo de origem "direct".
Listar grupos RBAC
$ ant beta:organization:rbac-groups listLista os grupos RBAC no tenant do Claude Enterprise.
Obter grupo RBAC
$ ant beta:organization:rbac-groups retrieveRecupera um grupo RBAC por ID.
Atualizar grupo RBAC
$ ant beta:organization:rbac-groups updateAtualiza 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
$ ant beta:organization:rbac-groups deleteExclui 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
$ ant beta:organization:rbac-groups:members listLista os membros de um grupo RBAC.
Adicionar membro ao grupo RBAC
$ ant beta:organization:rbac-groups:members addAdiciona 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
$ ant beta:organization:rbac-groups:members removeRemove 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
Listar funções RBAC
$ ant beta:organization:rbac-roles listLista as funções RBAC na organização.
Obter função RBAC
$ ant beta:organization:rbac-roles retrieveRecupera uma função RBAC por ID.
OrganizaçãoFunções RBACPermissões
Listar permissões da função RBAC
$ ant beta:organization:rbac-roles:permissions listLista as permissões concedidas por uma função RBAC.
OrganizaçãoPlugins
Criar plugin
$ ant beta:organization:plugins createCria um plugin pertencente à organização e sua primeira versão fazendo upload dos arquivos da versão.
Obter plugin
$ ant beta:organization:plugins retrieveRecupera um plugin pelo ID.
Atualizar plugin
$ ant beta:organization:plugins updateAltere 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
$ ant beta:organization:plugins listListe 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
$ ant beta:organization:plugins deleteExclua 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
$ ant beta:organization:plugins:versions createAdicione 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
$ ant beta:organization:plugins:versions listListe as versões de um Plugin, da mais recente para a mais antiga.
Obter versão do Plugin
$ ant beta:organization:plugins:versions retrieveRecupere uma versão de um Plugin pelo seu ID, ou a versão mais recente do Plugin.
Baixar arquivo da versão do Plugin
$ ant beta:organization:plugins:versions downloadBaixe 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
$ ant beta:organization:plugins:installation-settings listListe 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
$ ant beta:organization:plugins:installation-settings setDefina 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
$ ant beta:organization:plugins:installation-settings removeRemova 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
$ ant beta:organization:plugin-marketplaces listListe 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
$ ant beta:organization:plugin-marketplaces retrieveRecupere um marketplace de plugins pelo ID.
Atualizar marketplace de plugins
$ ant beta:organization:plugin-marketplaces updateDefina 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
$ ant beta:organization:plugin-marketplaces validate-repositoryVerifique 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
$ ant beta:organization:plugin-marketplaces validate-archiveVerifique 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
$ ant beta:organization:telemetry-destinations createRegistra um destino OpenTelemetry para a organização.
Listar destinos de telemetria
$ ant beta:organization:telemetry-destinations listLista os destinos da organização, do mais recente para o mais antigo, opcionalmente apenas aqueles que cobrem determinados workspaces.
Recuperar um destino de telemetria
$ ant beta:organization:telemetry-destinations retrieveLê a configuração, o estado e os resultados de entrega mais recentes de um destino.
Atualizar um destino de telemetria
$ ant beta:organization:telemetry-destinations updateAltera as configurações de um destino de telemetria, seu estado ou quais workspaces ele cobre.
Excluir um destino de telemetria
$ ant beta:organization:telemetry-destinations deleteExclui um destino e sua lista de workspaces.
Testar um destino de telemetria
$ ant beta:organization:telemetry-destinations testEnvia 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
$ ant beta:organization:telemetry-destinations:workspaces listLista os workspaces na lista de workspaces de um destino, com a entrada mais recente primeiro.
Adicionar um workspace de destino de telemetria
$ ant beta:organization:telemetry-destinations:workspaces addAdiciona um workspace à lista de workspaces de um destino.
Remover um workspace de destino de telemetria
$ ant beta:organization:telemetry-destinations:workspaces removeRemove um workspace da lista de workspaces de um destino.