Skip to main content
PUT
Upsert a plugin declaration

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

slug
string
obrigatório

Plugin slug that owns the declaration being upserted.

Exemplo:

"plugin-fees"

Corpo

application/json

Declaration manifest to upsert for the slug.

levels
object[] | null

Scope-only form of the permissions' levels: one entry per permission that declares a level, sent when the permission section is not. Forwarded with the scope catalog. Not accepted next to permissions, which carry their level themselves; alone it is not a section, since it would replace the catalog's dimensions and opt-in with nothing.

m2m
object

Bilateral machine-to-machine contract: which targets this plugin calls and whether it is callable.

partners
boolean

Opts the product in to partner credentials: a partner can be granted this product only when it is true. Forwarded with the scope catalog; a body carrying only this member is a scope-only body. Replaces the opt-in whenever the catalog is replaced.

Exemplo:

true

permissions
object[] | null

Permissions declared by the plugin; one entry per (resource, action).

roles
object[] | null

Roles declared by the plugin. Names may use '/' for hierarchy but must not repeat the service prefix (it is added automatically).

scope
object

Dimensions the product's routes address instances by — the WHERE a partner's scope lines name. Replaces the product's catalog when present; leaves it untouched when absent. Accepted in single- and multi-tenant deployments.

service
string

Service that owns this declaration; matches the caller token (the plugin- prefix is kept).

Exemplo:

"plugin-fees"

version
integer<int64>

Advisory manifest version. Must be a positive integer. Excluded from the canonical content hash.

Exemplo:

3

Resposta

OK

slug
string
obrigatório

Slug of the declaration that was upserted.

Exemplo:

"plugin-fees"

status
string
obrigatório

Outcome of the upsert operation.

Exemplo:

"accepted"