Claude Platform Docs

Organização

Obter organização atual
client.beta.organization.retrieve(options?): BetaOrganization
GET/v1/organizations/me

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

Models
interface BetaOrganization { 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.

type BetaOrganizationRole = "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
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey
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
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganizaçãoChaves externas

Criar chave externa
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey
POST/v1/organizations/external_keys

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

Listar chaves externas
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys

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

Obter chave externa
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey
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
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

Excluir chave externa
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
client.beta.organization.externalKeys.validate(externalKeyID, options?): 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
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer
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
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>
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
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer
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
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer
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
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer
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
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule
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
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>
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
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule
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
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule
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
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule
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
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace
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
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<BetaFederationRuleWorkspace>
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
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): 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
client.beta.organization.invites.create(body, options?): BetaOrganizationInvite
POST/v1/organizations/invites

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

Listar convites
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

OrganizaçãoContas de serviço

Criar conta de serviço
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount
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
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>
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
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount
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
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount
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
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount
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
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): 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
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}

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

Atualizar usuário
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}

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

Remover usuário
client.beta.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

OrganizaçãoEspaços de trabalho

Listar workspaces
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
Criar workspace
client.beta.organization.workspaces.create(params, options?): BetaWorkspace
POST/v1/organizations/workspaces
Obter workspace
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>
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
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
client.beta.organization.workspaces.members.remove(userID, params, options?): 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
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember
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
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): 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
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>
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
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings
GET/v1/organizations/compliance_settings

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

Atualizar configurações de conformidade
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings
POST/v1/organizations/compliance_settings

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

OrganizaçãoAnálisesResumos

Obter resumos de atividade
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>
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
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>
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
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>
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
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>
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
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>
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
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>
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
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>
GET/v1/organizations/analytics/artifacts

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

OrganizaçãoAnálisesRelatório de uso

Obter uso de tokens ao longo do tempo
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

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

OrganizaçãoAnálisesRelatório de uso por usuário

Obter uso de tokens por usuário
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

Obtém o uso de tokens por usuário em um intervalo de datas.

OrganizaçãoAnálisesRelatório de custos

Obter custo ao longo do tempo
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>
GET/v1/organizations/analytics/cost_report

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

OrganizaçãoAnálisesRelatório de custos por usuário

Obter custo por usuário
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>
GET/v1/organizations/analytics/user_cost_report

Obtém o custo por usuário em USD em um intervalo de datas.

OrganizaçãoLimites de gastos

Definir limite de gastos
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit
POST/v1/organizations/spend_limits

Define um limite de gastos.

Obter limite de gastos
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit
GET/v1/organizations/spend_limits/{spend_limit_id}

Recupere um limite de gastos por ID.

Excluir limite de gastos
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Exclui um limite de gastos.

Listar limites de gastos
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>
GET/v1/organizations/spend_limits

Lista os limites de gastos da organização.

OrganizaçãoLimites de gastosEfetivos

Listar limites de gastos efetivos
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>
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
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>
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
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest
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
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse
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
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest
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
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup
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
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>
GET/v1/organizations/rbac_groups

Lista os grupos RBAC no tenant do Claude Enterprise.

Obter grupo RBAC
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroup
GET/v1/organizations/rbac_groups/{rbac_group_id}

Recupera um grupo RBAC por ID.

Atualizar grupo RBAC
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup
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
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse
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
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista os membros de um grupo RBAC.

Adicionar membro ao grupo RBAC
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember
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
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse
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
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>
GET/v1/organizations/rbac_roles

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

Obter função RBAC
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole
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
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

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

OrganizaçãoPlugins

Criar plugin
client.beta.organization.plugins.create(params, options?): BetaPlugin
POST/v1/organizations/plugins

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

Obter plugin
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin
GET/v1/organizations/plugins/{plugin_id}

Recupera um plugin pelo ID.

Atualizar plugin
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin
POST/v1/organizations/plugins/{plugin_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.

Listar Plugins
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>
GET/v1/organizations/plugins

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.

Excluir Plugin
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin
DELETE/v1/organizations/plugins/{plugin_id}

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.

OrganizaçãoPluginsVersões

Criar versão do Plugin
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion
POST/v1/organizations/plugins/{plugin_id}/versions

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.

Listar versões do Plugin
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>
GET/v1/organizations/plugins/{plugin_id}/versions

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

Obter versão do Plugin
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Recupere uma versão de um Plugin pelo seu ID, ou a versão mais recente do Plugin.

Baixar arquivo da versão do Plugin
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

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.

OrganizaçãoPluginsConfigurações de instalação

Listar configurações de instalação do Plugin
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

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.

Definir configuração de instalação do Plugin
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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.

Remover configuração de instalação do Plugin
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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.

OrganizaçãoPluginsCompartilhamentos

Listar compartilhamentos do Plugin
client.beta.organization.plugins.shares.list(pluginID, params?, options?): PageCursor<BetaPluginShare>
GET/v1/organizations/plugins/{plugin_id}/shares

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.

OrganizaçãoMarketplaces de plugins

Listar marketplaces de plugins
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>
GET/v1/organizations/plugin_marketplaces

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.

Obter marketplace de plugins
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Recupere um marketplace de plugins pelo ID.

Atualizar marketplace de plugins
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_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.

Validar repositório do marketplace de plugins
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_repository

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.

Validar arquivo do marketplace de plugins
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_archive

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.