Claude Platform Docs

Organização

Obter organização atual
organization.retrieve() -> OrganizationInfo
GET/v1/organizations/me

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

Models
class OrganizationInfo: type: "organization"; id; name
type: Literal["organization"]

Object type.

For Organizations, this is always "organization".

defaultorganization
id: str

ID of the Organization.

formatuuid
name: str

Name of the Organization.

type OrganizationRole = Literal["admin", "billing", "claude_code_user", 6 more]
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganizaçãoChaves de API

Listar chaves de API
organization.api_keys.list(**kwargs) -> SyncPage[APIKey]
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
organization.api_keys.retrieve(api_key_id) -> APIKey
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
organization.api_keys.update(api_key_id, **kwargs) -> APIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganizaçãoChaves externas

Criar chave externa
organization.external_keys.create(**kwargs) -> ExternalKey
POST/v1/organizations/external_keys

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

Listar chaves externas
organization.external_keys.list(**kwargs) -> SyncPageCursor[ExternalKey]
GET/v1/organizations/external_keys

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

Obter chave externa
organization.external_keys.retrieve(external_key_id) -> ExternalKey
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
organization.external_keys.update(external_key_id, **kwargs) -> ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

Excluir chave externa
organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
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
organization.federation.issuers.create(**kwargs) -> FederationIssuer
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
organization.federation.issuers.list(**kwargs) -> SyncPageCursor[FederationIssuer]
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
organization.federation.issuers.retrieve(federation_issuer_id) -> FederationIssuer
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
organization.federation.issuers.update(federation_issuer_id, **kwargs) -> FederationIssuer
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
organization.federation.issuers.archive(federation_issuer_id) -> FederationIssuer
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
organization.federation.rules.create(**kwargs) -> FederationRule
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
organization.federation.rules.list(**kwargs) -> SyncPageCursor[FederationRule]
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
organization.federation.rules.retrieve(federation_rule_id) -> FederationRule
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
organization.federation.rules.update(federation_rule_id, **kwargs) -> FederationRule
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
organization.federation.rules.archive(federation_rule_id) -> FederationRule
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
organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> FederationRuleWorkspace
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
organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[FederationRuleWorkspace]
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
organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
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
organization.invites.create(**kwargs) -> OrganizationInvite
POST/v1/organizations/invites

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

Listar convites
organization.invites.list(**kwargs) -> SyncPage[OrganizationInvite]
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
organization.invites.retrieve(invite_id) -> OrganizationInvite
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
organization.invites.delete(invite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

OrganizaçãoContas de serviço

Criar conta de serviço
organization.service_accounts.create(**kwargs) -> ServiceAccount
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
organization.service_accounts.list(**kwargs) -> SyncPageCursor[ServiceAccount]
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
organization.service_accounts.retrieve(service_account_id) -> ServiceAccount
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
organization.service_accounts.update(service_account_id, **kwargs) -> ServiceAccount
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
organization.service_accounts.archive(service_account_id) -> ServiceAccount
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
organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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
organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
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
organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
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
organization.users.list(**kwargs) -> SyncPage[OrganizationUser]
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
organization.users.retrieve(user_id) -> OrganizationUser
GET/v1/organizations/users/{user_id}

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

Atualizar usuário
organization.users.update(user_id, **kwargs) -> OrganizationUser
POST/v1/organizations/users/{user_id}

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

Remover usuário
organization.users.remove(user_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

OrganizaçãoEspaços de trabalho

Listar workspaces
organization.workspaces.list(**kwargs) -> SyncPage[Workspace]
GET/v1/organizations/workspaces
Criar workspace
organization.workspaces.create(**kwargs) -> Workspace
POST/v1/organizations/workspaces
Obter workspace
organization.workspaces.retrieve(workspace_id) -> Workspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
organization.workspaces.update(workspace_id, **kwargs) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
organization.workspaces.archive(workspace_id) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[WorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

OrganizaçãoEspaços de trabalhoMembros

Listar membros do workspace
organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[WorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
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
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
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
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
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
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
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
organization.rate_limits.list(**kwargs) -> SyncPageCursor[OrganizationRateLimit]
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
organization.compliance_settings.retrieve() -> OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

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

Atualizar configurações de conformidade
organization.compliance_settings.update(**kwargs) -> OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

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