Claude Platform Docs

Plugins

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.

Models
interface BetaDeletedPlugin { type: "plugin_deleted"; id }
type: "plugin_deleted"

Always plugin_deleted.

defaultplugin_deleted
id: string

The deleted Plugin's ID.

interface BetaPlugin { type: "plugin"; id; components; /* 16 more */ }
interface BetaPluginAPIActor { type: "api_actor"; api_key_id }
type: "api_actor"

An Admin API key, in the same form the Compliance API activity feed uses for it.

defaultapi_actor
api_key_id: string

The key's ID.

interface BetaPluginComponent { type; description; name }
type: "agent" | "cli" | "command" | 3 more

The kind of component.

One of the following:
"agent"
"cli"
"command"
"hook"
"mcp_server"
"skill"
description: string | null

What the component declares about itself; always null for MCP servers, hooks, and CLIs.

name: string

The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable.

interface BetaPluginContentScan { assessment; reason; status }
assessment: "fail" | "pass" | "unknown" | "warn" | null

The scan's verdict; set only when status is completed.

One of the following:
"fail"
"pass"
"unknown"
"warn"
reason: string | null

The primary mechanism behind a warn or fail, such as credential-exposure or guardrail-tampering; a mechanism this API does not yet name reads as other. Null on a pass, whenever assessment is null, and when no mechanism is reported for the verdict.

status: "completed" | "errored" | "processing"

processing while a scan runs, completed when it ran to completion, errored when it could not run or its outcome cannot be read.

One of the following:
"completed"
"errored"
"processing"
interface BetaPluginOwnerOrganization { type: "organization" }
type: "organization"

The Plugin lives in a plugin marketplace the organization owns.

defaultorganization
interface BetaPluginOwnerUser { type: "user"; user_id }
type: "user"

The Plugin lives in one member's personal plugin marketplace.

defaultuser
user_id: string

The member's User ID.

interface BetaPluginTargetOrganization { type: "organization" }
type: "organization"

Every member of the organization.

defaultorganization
interface BetaPluginTargetOrganizationMember { type: "organization_member"; user_id }
type: "organization_member"

One member of the organization.

defaultorganization_member
user_id: string

The member's User ID.

interface BetaPluginTargetRBACGroup { type: "rbac_group"; rbac_group_id }
type: "rbac_group"

An RBAC Group.

defaultrbac_group
rbac_group_id: string

The RBAC Group's ID.

interface BetaPluginUserActor { type: "user_actor"; email_address; user_id }
type: "user_actor"

A member of the organization.

defaultuser_actor
email_address: string | null

The member's email address; may be null, for example when they are no longer a member of the organization.

user_id: string

The member's User ID.

PluginsVersõ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.

PluginsConfiguraçõ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.

PluginsCompartilhamentos

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.