Claude Platform Docs

Organização

Obter organização atual
GET/v1/organizations/me

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

Models
ConcurrentMembershipChangeErrorDetails object{ error_code }

Another change to the organization's members is in progress. Retry the request once it completes.

error_code: "concurrent_membership_change"
OrgMemberLimitExceededErrorDetails object{ error_code }

The organization has reached the member limit that Anthropic set for it. Pending invites count toward the limit.

error_code: "org_member_limit_exceeded"
OrganizationInfo object{ type: "organization", id, name }
type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization
id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

OrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
RBACRoleNotFoundErrorDetails object{ error_code }

No RBAC Role with this ID was found.

error_code: "rbac_role_not_found"

OrganizaçãoChaves de API

Listar chaves de API
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

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
POST/v1/organizations/api_keys/{api_key_id}

OrganizaçãoChaves externas

Criar chave externa
POST/v1/organizations/external_keys

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

Listar chaves externas
GET/v1/organizations/external_keys

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

Obter chave externa
GET/v1/organizations/external_keys/{external_key_id}

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

Atualizar chave externa
POST/v1/organizations/external_keys/{external_key_id}

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

Excluir chave externa
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
POST/v1/organizations/external_keys/{external_key_id}/validate

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

OrganizaçãoFederaçãoEmissores

Criar emissor de federação
POST/v1/organizations/federation_issuers

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
GET/v1/organizations/federation_issuers

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
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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
POST/v1/organizations/federation_rules

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
GET/v1/organizations/federation_rules

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
GET/v1/organizations/federation_rules/{federation_rule_id}

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
POST/v1/organizations/federation_rules/{federation_rule_id}

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
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

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
POST/v1/organizations/invites

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

Listar convites
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

OrganizaçãoContas de serviço

Criar conta de serviço
POST/v1/organizations/service_accounts

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
GET/v1/organizations/service_accounts

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
GET/v1/organizations/service_accounts/{service_account_id}

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
POST/v1/organizations/service_accounts/{service_account_id}

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
POST/v1/organizations/service_accounts/{service_account_id}/archive

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
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

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

Listar usuários
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
GET/v1/organizations/users/{user_id}

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

Atualizar usuário
POST/v1/organizations/users/{user_id}

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

Remover usuário
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

OrganizaçãoEspaços de trabalho

Listar workspaces
GET/v1/organizations/workspaces
Criar workspace
POST/v1/organizations/workspaces
Obter workspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

Definir limites de taxa do workspace
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

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

OrganizaçãoEspaços de trabalhoMembros

Listar membros do workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizaçãoEspaços de trabalhoContas de serviço

Listar membros de workspace de conta de serviço
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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
GET/v1/organizations/rate_limits

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

OrganizaçãoConfigurações de conformidade

Obter configurações de conformidade
GET/v1/organizations/compliance_settings

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

Atualizar configurações de conformidade
POST/v1/organizations/compliance_settings

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

OrganizaçãoAnálisesResumos

Obter resumos de atividade
GET/v1/organizations/analytics/summaries

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

OrganizaçãoAnálisesUsuários

Listar atividade de usuários
GET/v1/organizations/analytics/users

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
GET/v1/organizations/analytics/apps/chat/projects

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

OrganizaçãoAnálisesConectores

Obter uso de conectores
GET/v1/organizations/analytics/connectors

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

OrganizaçãoAnálisesPlugins

Obter uso de plugins
GET/v1/organizations/analytics/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
GET/v1/organizations/analytics/skills

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

OrganizaçãoAnálisesArtifacts

Obter atividade de artifacts
GET/v1/organizations/analytics/artifacts

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

OrganizaçãoLimites de gastosEfetivos

Listar limites de gastos efetivos
GET/v1/organizations/spend_limits/effective

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
GET/v1/organizations/spend_limit_increase_requests

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

Obter solicitação de aumento de limite de gastos
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

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

Aprovar solicitação de aumento de limite de gastos
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

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

Negar solicitação de aumento de limite de gastos
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

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

OrganizaçãoGrupos RBAC

Criar grupo RBAC
POST/v1/organizations/rbac_groups

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

Listar grupos RBAC
GET/v1/organizations/rbac_groups

Lista os grupos RBAC no tenant do Claude Enterprise.

Obter grupo RBAC
GET/v1/organizations/rbac_groups/{rbac_group_id}

Recupera um grupo RBAC por ID.

Atualizar grupo RBAC
POST/v1/organizations/rbac_groups/{rbac_group_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.

Excluir grupo RBAC
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

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
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista os membros de um grupo RBAC.

Adicionar membro ao grupo RBAC
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

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
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

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

Listar funções RBAC
GET/v1/organizations/rbac_roles

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

Obter função RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}

Recupera uma função RBAC por ID.

OrganizaçãoFunções RBACPermissões

Listar permissões da função RBAC
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

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