Claude Platform Docs

Organização

Obter organização atual
$ ant organization retrieve
GET/v1/organizations/me

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

Models
organization_info: object{ type: "organization", id, name }
type: "organization"

Object type.

For Organizations, this is always "organization".

id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

organization_role: "admin" or "billing" or "claude_code_user" or 6 more
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganizaçãoChaves de API

Listar chaves de API
$ ant organization:api-keys list
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
$ ant organization:api-keys retrieve
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
$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

OrganizaçãoChaves externas

Criar chave externa
$ ant organization:external-keys create
POST/v1/organizations/external_keys

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

Listar chaves externas
$ ant organization:external-keys list
GET/v1/organizations/external_keys

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

Obter chave externa
$ ant organization:external-keys retrieve
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
$ ant organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

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

Excluir chave externa
$ ant organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
$ ant organization:external-keys validate
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
$ ant organization:federation:issuers create
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
$ ant organization:federation:issuers list
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
$ ant organization:federation:issuers retrieve
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
$ ant organization:federation:issuers update
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
$ ant organization:federation:issuers archive
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
$ ant organization:federation:rules create
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
$ ant organization:federation:rules list
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
$ ant organization:federation:rules retrieve
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
$ ant organization:federation:rules update
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
$ ant organization:federation:rules archive
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
$ ant organization:federation:rules:workspaces add
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
$ ant organization:federation:rules:workspaces list
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
$ ant organization:federation:rules:workspaces remove
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
$ ant organization:invites create
POST/v1/organizations/invites

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

Listar convites
$ ant organization:invites list
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
$ ant organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
$ ant organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

OrganizaçãoContas de serviço

Criar conta de serviço
$ ant organization:service-accounts create
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
$ ant organization:service-accounts list
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
$ ant organization:service-accounts retrieve
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
$ ant organization:service-accounts update
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
$ ant organization:service-accounts archive
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
$ ant organization:service-accounts:workspaces add
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
$ ant organization:service-accounts:workspaces list
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
$ ant organization:service-accounts:workspaces remove
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
$ ant organization:users list
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
$ ant organization:users retrieve
GET/v1/organizations/users/{user_id}

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

Atualizar usuário
$ ant organization:users update
POST/v1/organizations/users/{user_id}

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

Remover usuário
$ ant organization:users remove
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

OrganizaçãoEspaços de trabalho

Listar workspaces
$ ant organization:workspaces list
GET/v1/organizations/workspaces
Criar workspace
$ ant organization:workspaces create
POST/v1/organizations/workspaces
Obter workspace
$ ant organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
$ ant organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
$ ant organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
$ ant organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

Definir limites de taxa do workspace
$ ant organization:workspaces:rate-limits update
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
$ ant organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
$ ant organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
$ ant organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
$ ant organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
$ ant organization:workspaces:members remove
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
$ ant organization:workspaces:service-accounts list
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
$ ant organization:workspaces:service-accounts add
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
$ ant organization:workspaces:service-accounts retrieve
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
$ ant organization:workspaces:service-accounts update
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
$ ant organization:workspaces:service-accounts remove
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
$ ant organization:rate-limits list
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
$ ant organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

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

Atualizar configurações de conformidade
$ ant organization:compliance-settings update
POST/v1/organizations/compliance_settings

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