Organização

Recupere informações sobre a organização associada à chave de API autenticada.

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.

Crie uma configuração de chave externa pertencente à organização do chamador.

Liste as configurações de chaves externas na organização do chamador.

Recupere uma única configuração de chave externa na organização do chamador pelo ID.

Atualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.

Exclua uma configuração de chave externa.

Valide uma configuração de chave externa em relação ao KMS do cliente.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Convide um usuário para ingressar na organização por e-mail.

Liste os convites da organização.

Recupere um convite pelo ID.

Exclua um convite pendente.

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.

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.

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.

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.

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.

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.

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.

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.

Liste os membros da organização.

Recupere um membro da organização pelo ID de usuário.

Atualize a função de um membro na organização.

Remova um membro da organização.

Liste os limites de taxa de um workspace.

Define ou remove substituições de limite de taxa para um grupo de limite de taxa em um workspace.

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.

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.

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.

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.

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.

Lista os "rate limits" (limites de taxa) da Messages API para sua organização.

Recupera as Configurações de conformidade da sua organização.

Update your organization's Compliance Settings.

Obtenha resumos de atividade de toda a organização para um intervalo de datas.

Obtém a atividade por usuário em um determinado dia, com paginação baseada em cursor.

Obtém a atividade por projeto para um determinado dia, com paginação baseada em cursor.

Obtém o uso por conector em um determinado dia, com paginação baseada em cursor.

Obtém o uso de instalação + invocação por plugin em um determinado dia, com paginação.

Obtém o uso por skill em um determinado dia, com paginação baseada em cursor.

Obtém a atividade de criação de artifacts em um determinado dia, detalhada por tipo MIME.

Obtém o uso de tokens em um intervalo de datas, detalhado por dimensão.

Obtém o custo em USD em um intervalo de datas, detalhado por dimensão.

[Legado] Obtém o uso de tokens ao longo do tempo em um intervalo de datas.

[Legacy] Get per-user token usage across a date range.

[Legado] Obtém o custo em USD ao longo do tempo em um intervalo de datas.

[Legacy] Get per-user cost in USD across a date range.

Define um limite de gastos.

Recupere um limite de gastos por ID.

Exclui um limite de gastos.

Lista os limites de gastos da organização.

Lista o limite de gastos efetivo de cada membro e os gastos acumulados no período.

Liste as solicitações de aumento de limite de gastos, mais recentes primeiro.

Recupere uma solicitação de aumento de limite de gastos.

Aprove uma solicitação pendente de aumento de limite de gastos.

Negue uma solicitação pendente de aumento de limite de gastos.

Cria um grupo RBAC no tenant do Claude Enterprise. Grupos criados pela API têm o tipo de origem "direct".

Lista os grupos RBAC no tenant do Claude Enterprise.

Recupera um grupo RBAC por ID.

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.

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.

Lista os membros de um 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.

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.

Lista as funções RBAC na organização.

Recupera uma função RBAC por ID.

Lista as permissões concedidas por uma função RBAC.

Cria um plugin pertencente à organização e sua primeira versão fazendo upload dos arquivos da versão.

Recupera um plugin pelo ID.

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.

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.

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.

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.

Liste as versões de um Plugin, da mais recente para a mais antiga.

Recupere uma versão de um Plugin pelo seu ID, ou a versão mais recente 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.

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.

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.

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.

Liste os compartilhamentos que o proprietário de um Plugin pertencente a um membro concedeu — a todos os membros da organização, a um Grupo RBAC ou a um membro — dos concedidos mais recentemente para os mais antigos.

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.

Recupere um marketplace de plugins pelo ID.

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.

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.

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.

Registra um destino OpenTelemetry para a organização.

Lista os destinos da organização, do mais recente para o mais antigo, opcionalmente apenas aqueles que cobrem determinados workspaces.

Lê a configuração, o estado e os resultados de entrega mais recentes de um destino.

Altera as configurações de um destino de telemetria, seu estado ou quais workspaces ele cobre.

Exclui um destino e sua lista de workspaces.

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.

Lista os workspaces na lista de workspaces de um destino, com a entrada mais recente primeiro.

Adiciona um workspace à lista de workspaces de um destino.

Remove um workspace da lista de workspaces de um destino.

Crie um endpoint de webhook da organização.

Liste os endpoints de webhook da organização.

Recupere um endpoint de webhook da organização pelo ID.

Atualize um endpoint de webhook da organização. Somente os campos que você enviar são alterados.

Exclua um endpoint de webhook da organização.

Substitua o segredo de assinatura de um endpoint de webhook da organização. O segredo antigo deixa de funcionar imediatamente. O novo segredo é retornado somente nesta resposta.

Set a Slack channel up for Claude Tag and return it with its identifier. If the channel is already set up, whether in claude.ai, by Claude's first use in it or by an earlier request, the existing channel is returned, so the request can be repeated. settings, when sent, is applied as an update applies it. Before a channel is set up, Claude's Slack app confirms with Slack that the channel is in the workspace, is not archived and is visible to the app; a channel that fails the confirmation returns 404. Setting the channel up and applying settings are two steps: when the second is refused, the response is the refusal, the channel stays set up with every setting unset, and the error's details.slack_channel_id holds the channel's identifier.

List the set-up Slack channels of one Slack workspace, newest first by created_at. A channel that is not set up is not listed: Slack holds the full list of a workspace's channels. Pass slack_channel_id as well to look one channel up by its Slack identifiers: data then holds that channel, or is empty when it is not set up, and limit and page are ignored. A workspace that the organization owns only through a Slack Enterprise Grid returns 404 until it is set up. With include_inherited=true each channel's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get one Slack channel and its settings. By default settings holds what the channel itself stores: a setting that is null there is not set on the channel and is inherited. With include_inherited=true, settings holds what applies in the channel once the settings levels above it are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from, so a caller tells the channel's own value from an inherited one by its source, not by whether it is null.

Change the settings a Slack channel stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the channel inherits it. If any value is refused, no setting in the request is stored. A group direct message takes no settings and returns 400.

Remove a Slack channel from Claude Tag. This deletes the channel's stored settings and its Bundle Targets at once, and then, in the background, the channel's sessions and their transcripts, its memory, its routines and the artifacts published from it. None of it can be restored. The channel in Slack and its messages are unchanged. The request is refused with 400 and error.details.error_code slack_channel_enabled while enabled resolves to true for the channel, as a read with include_inherited=true returns it: set enabled to false on the channel first. This guards against removing a channel in use by mistake; it is not a way to keep Claude out, because the removal deletes the channel's own enabled: false with its other settings, after which the channel inherits again and Claude's next use of it can set it up anew with a new identifier. The identifier returns 404 as soon as the request returns, so a repeated removal returns 404. A group direct message returns 400, and so does a channel that holds configuration this API does not manage.

List the set-up Slack workspaces the organization owns, newest first by created_at. Pass slack_workspace_id to look one workspace up by its Slack identifier: data then holds that workspace, or is empty when it is not set up. A workspace of a Slack Enterprise Grid the organization has connected returns 404 until it is set up. With include_inherited=true each workspace's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get one Slack workspace and its settings. By default settings holds what the workspace itself stores: a setting that is null there is not set on the workspace and is inherited. With include_inherited=true, settings holds what applies in the workspace once the organization's Slack defaults are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from.

Change the settings a Slack workspace stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the workspace inherits it. If any value is refused, no setting in the request is stored.

List the organization's Bundles, newest first by created_at. A Bundle that Claude Tag manages for itself is not listed.

Get one Bundle. What the Bundle grants (connectors, repositories and credentials) is never returned.

List the Slack channels and Slack workspaces a Bundle is attached to, newest first by created_at. Only channels and workspaces the organization owns are listed; a Bundle that is attached to anything else has no Bundle Target for it.

Attach a Bundle to a Slack channel or a Slack workspace. A Bundle attached to a workspace can be used in the workspace and in every channel in it. Attaching a Bundle to a channel or workspace it is already attached to returns the existing Bundle Target. The channel or workspace must be set up: attaching never sets a channel up. A group direct message takes no Bundle and returns 400.

Get one Bundle Target. Returns 404 when target_id is the identifier of another Bundle's Bundle Target, or the Bundle Target was detached.

Detach a Bundle from a Slack channel or a Slack workspace. A repeated detach returns 404.