Organização
Obter organização atual
$client->organization->retrieve(): OrganizationInfoRecupere informações sobre a organização associada à chave de API autenticada.
Models
OrganizaçãoChaves de API
Listar chaves de API
$client->organization->apiKeys->list(?string afterID, ?string beforeID, ?string createdByUserID, ?int limit, ?Status status, ?string workspaceID): Page<APIKey>Recuperar chave de API (Admin API)
$client->organization->apiKeys->retrieve(string apiKeyID): APIKeyRecupere 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
$client->organization->apiKeys->update(string apiKeyID, ?string name, ?Status status): APIKeyOrganizaçãoChaves externas
Criar chave externa
$client->organization->externalKeys->create(ProviderConfig providerConfig, ?string displayName, ?Geo geo, ?string userProfileID): ExternalKeyCrie uma configuração de chave externa pertencente à organização do chamador.
Listar chaves externas
$client->organization->externalKeys->list(?int limit, ?string page): PageCursor<ExternalKey>Liste as configurações de chaves externas na organização do chamador.
Obter chave externa
$client->organization->externalKeys->retrieve(string externalKeyID): ExternalKeyRecupere uma única configuração de chave externa na organização do chamador pelo ID.
Atualizar chave externa
$client->organization->externalKeys->update(string externalKeyID, ?string displayName, ?Geo geo, ?ProviderConfig providerConfig): ExternalKeyAtualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.
Excluir chave externa
$client->organization->externalKeys->delete(string externalKeyID): ExternalKeyDeleteResponseExclua uma configuração de chave externa.
Validar chave externa
$client->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponseValide uma configuração de chave externa em relação ao KMS do cliente.
OrganizaçãoFederaçãoEmissores
Criar emissor de federação
$client->organization->federation->issuers->create(string issuerURL, string name, ?bool checkJTI, ?JWKS jwks, ?int maxJWTLifetimeSeconds): FederationIssuerRequer 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
$client->organization->federation->issuers->list(?bool includeArchived, ?int limit, ?string page): PageCursor<FederationIssuer>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
$client->organization->federation->issuers->retrieve(string federationIssuerID): FederationIssuerRequer 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
$client->organization->federation->issuers->update(string federationIssuerID, ?bool checkJTI, ?string issuerURL, ?JWKS jwks, ?bool jwksPollingDisabled, ?int maxJWTLifetimeSeconds, ?string name): FederationIssuerRequer 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
$client->organization->federation->issuers->archive(string federationIssuerID): FederationIssuerRequer 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
$client->organization->federation->rules->create(string issuerID, FederationRuleMatch match, string name, string oauthScope, ServiceAccountTarget target, ?bool appliesToAllWorkspaces, ?string description, ?int tokenLifetimeSeconds, ?string workspaceID): FederationRuleRequer 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
$client->organization->federation->rules->list(?bool includeArchived, ?string issuerID, ?int limit, ?string page): PageCursor<FederationRule>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
$client->organization->federation->rules->retrieve(string federationRuleID): FederationRuleRequer 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
$client->organization->federation->rules->update(string federationRuleID, ?bool appliesToAllWorkspaces, ?string description, ?FederationRuleMatch match, ?string name, ?string oauthScope, ?ServiceAccountTarget target, ?int tokenLifetimeSeconds, ?string workspaceID): FederationRuleRequer 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
$client->organization->federation->rules->archive(string federationRuleID): FederationRuleRequer 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
$client->organization->federation->rules->workspaces->add(string federationRuleID, string workspaceID): FederationRuleWorkspaceRequer 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
$client->organization->federation->rules->workspaces->list(string federationRuleID, ?int limit, ?string page): PageCursor<FederationRuleWorkspace>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
$client->organization->federation->rules->workspaces->remove(string workspaceID, string federationRuleID): WorkspaceRemoveResponseRequer 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
$client->organization->invites->create(string email, Role role, ?list<string> rbacGroupIDs): OrganizationInviteConvide um usuário para ingressar na organização por e-mail.
Listar convites
$client->organization->invites->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles, ?list<Status> statuses): Page<OrganizationInvite>Liste os convites da organização.
Obter convite
$client->organization->invites->retrieve(string inviteID): OrganizationInviteRecupere um convite pelo ID.
Excluir convite
$client->organization->invites->delete(string inviteID): InviteDeleteResponseExclua um convite pendente.
OrganizaçãoContas de serviço
Criar conta de serviço
$client->organization->serviceAccounts->create(string name, ?string description, ?OrganizationRole organizationRole): ServiceAccountRequer 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
$client->organization->serviceAccounts->list(?bool includeArchived, ?int limit, ?string page): PageCursor<ServiceAccount>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
$client->organization->serviceAccounts->retrieve(string serviceAccountID): ServiceAccountRequer 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
$client->organization->serviceAccounts->update(string serviceAccountID, ?string description, ?OrganizationRole organizationRole): ServiceAccountRequer 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
$client->organization->serviceAccounts->archive(string serviceAccountID): ServiceAccountRequer 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
$client->organization->serviceAccounts->workspaces->add(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMemberRequer 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
$client->organization->serviceAccounts->workspaces->list(string serviceAccountID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>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
$client->organization->serviceAccounts->workspaces->remove(string workspaceID, string serviceAccountID): WorkspaceRemoveResponseRequer 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
$client->organization->users->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles): Page<OrganizationUser>Liste os membros da organização.
Obter usuário
$client->organization->users->retrieve(string userID): OrganizationUserRecupere um membro da organização pelo ID de usuário.
Atualizar usuário
$client->organization->users->update(string userID, Role role): OrganizationUserAtualize a função de um membro na organização.
Remover usuário
$client->organization->users->remove(string userID): UserRemoveResponseRemova um membro da organização.
OrganizaçãoEspaços de trabalho
Listar workspaces
$client->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?bool includeDefault, ?int limit): Page<Workspace>Criar workspace
$client->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array<string,string> tags, ?string userProfileID): WorkspaceObter workspace
$client->organization->workspaces->retrieve(string workspaceID): WorkspaceAtualizar workspace
$client->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array<string,string> tags, ?string userProfileID): WorkspaceArquivar workspace
$client->organization->workspaces->archive(string workspaceID): WorkspaceOrganizaçãoEspaços de trabalhoLimites de taxa
Listar limites de taxa do workspace
$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>Liste os limites de taxa de um workspace.
Definir limites de taxa do workspace
$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimitDefine 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
$client->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page<WorkspaceMember>Criar membro do workspace
$client->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMemberObter membro do workspace
$client->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMemberAtualizar membro do workspace
$client->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMemberExcluir membro do workspace
$client->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponseOrganizaçãoEspaços de trabalhoContas de serviço
Listar membros de workspace de conta de serviço
$client->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>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
$client->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMemberRequer 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
$client->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID): ServiceAccountWorkspaceMemberRequer 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
$client->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMemberRequer 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
$client->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID): ServiceAccountRemoveResponseRequer 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
$client->organization->rateLimits->list(?GroupType groupType, ?int limit, ?string model, ?string page): PageCursor<OrganizationRateLimit>Lista os "rate limits" (limites de taxa) da Messages API para sua organização.
OrganizaçãoConfigurações de conformidade
Obter configurações de conformidade
$client->organization->complianceSettings->retrieve(): OrganizationComplianceSettingsRecupera as Configurações de conformidade da sua organização.
Atualizar configurações de conformidade
$client->organization->complianceSettings->update(ComplianceSettingsStateParam state): OrganizationComplianceSettingsAtualiza as Configurações de conformidade da sua organização.
OrganizaçãoAnálisesResumos
Obter resumos de atividade
$client->organization->analytics->summaries->list(\Datetime startingDate, ?\Datetime endingDate, ?list<string> filter, ?int limit, ?string page): PageCursor<AnalyticsSingleDayActivitySummary>Obtenha resumos de atividade de toda a organização para um intervalo de datas.
OrganizaçãoAnálisesUsuários
Listar atividade de usuários
$client->organization->analytics->users->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsUserGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsUserActivity>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
$client->organization->analytics->apps->chat->projects->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsProjectGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsProjectActivity>Obtém a atividade por projeto para um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesConectores
Obter uso de conectores
$client->organization->analytics->connectors->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsConnectorGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsConnectorActivity>Obtém o uso por conector em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesPlugins
Obter uso de plugins
$client->organization->analytics->plugins->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsPluginGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsPluginActivity>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
$client->organization->analytics->skills->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsSkillGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsSkillActivity>Obtém o uso por skill em um determinado dia, com paginação baseada em cursor.
OrganizaçãoAnálisesArtifacts
Obter atividade de artifacts
$client->organization->analytics->artifacts->list(\Datetime date, ?list<string> filter, ?list<AnalyticsArtifactGroupBy> groupBy, ?int limit, ?string page): PageCursor<AnalyticsArtifactActivity>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
$client->organization->spendLimits->effective->list(?int limit, ?string page, ?list<SpendLimitPeriod> period, ?list<string> userIDs): PageCursor<SpendSummary>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
$client->organization->spendLimits->increaseRequests->list(?list<string> actorIDs, ?int limit, ?string page, ?list<SpendLimitIncreaseRequestStatus> status): PageCursor<SpendLimitIncreaseRequest>Liste as solicitações de aumento de limite de gastos, mais recentes primeiro.
Obter solicitação de aumento de limite de gastos
$client->organization->spendLimits->increaseRequests->retrieve(string spendLimitIncreaseRequestID): SpendLimitIncreaseRequestRecupere uma solicitação de aumento de limite de gastos.
Aprovar solicitação de aumento de limite de gastos
$client->organization->spendLimits->increaseRequests->approve(string spendLimitIncreaseRequestID, string amount, ?SpendLimitPeriod period, ?bool suppressNotification): IncreaseRequestApproveResponseAprove uma solicitação pendente de aumento de limite de gastos.
Negar solicitação de aumento de limite de gastos
$client->organization->spendLimits->increaseRequests->deny(string spendLimitIncreaseRequestID, ?bool suppressNotification): SpendLimitIncreaseRequestNegue uma solicitação pendente de aumento de limite de gastos.
OrganizaçãoGrupos RBAC
Criar grupo RBAC
$client->organization->rbacGroups->create(string name): RBACGroupCria um grupo RBAC no tenant do Claude Enterprise. Grupos criados pela API têm o tipo de origem "direct".
Listar grupos RBAC
$client->organization->rbacGroups->list(?int limit, ?string page): PageCursor<RBACGroup>Lista os grupos RBAC no tenant do Claude Enterprise.
Obter grupo RBAC
$client->organization->rbacGroups->retrieve(string rbacGroupID): RBACGroupRecupera um grupo RBAC por ID.
Atualizar grupo RBAC
$client->organization->rbacGroups->update(string rbacGroupID, ?string name): RBACGroupAtualiza 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
$client->organization->rbacGroups->delete(string rbacGroupID): DeletedRBACGroupExclui 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
$client->organization->rbacGroups->members->list(string rbacGroupID, ?int limit, ?string page): PageCursor<RBACGroupMember>Lista os membros de um grupo RBAC.
Adicionar membro ao grupo RBAC
$client->organization->rbacGroups->members->add(string rbacGroupID, string userID): RBACGroupMemberAdiciona 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
$client->organization->rbacGroups->members->remove(string userID, string rbacGroupID): DeletedRBACGroupMemberRemove 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
$client->organization->rbacRoles->list(?int limit, ?string page): PageCursor<RBACRole>Lista as funções RBAC na organização.
Obter função RBAC
$client->organization->rbacRoles->retrieve(string rbacRoleID): RBACRoleRecupera uma função RBAC por ID.
OrganizaçãoFunções RBACPermissões
Listar permissões da função RBAC
$client->organization->rbacRoles->permissions->list(string rbacRoleID, ?int limit, ?string page): PageCursor<RBACRolePermission>Lista as permissões concedidas por uma função RBAC.