Partially update a plugin instance

PATCH 
/ui-plugins/v1/:pluginInstanceId

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Patch any subset of mutable fields. When slots is provided, replaces the entire slots list and re-validates registry / maxPlugins rules. When apiScopes is provided, replaces the entire scopes list. When iframeSandbox is provided, replaces the entire sandbox grant list; unlike CSP / Permissions-Policy changes, it does not rotate the active asset bundle. state may be set to ENABLED or DISABLED (DISABLED omits the instance from active-slots delivery).

Requires product license idn:ui-plugins or idn:ui-plugins-author (404 if neither is present). Returns 400 User context is invalid when the caller has no tenant id. The instance is updated only when it belongs to that tenant; a mismatch is 404. Emits Kafka audit event UI_PLUGIN_INSTANCE_UPDATED on success.

Request

Responses

200

Updated plugin instance

400

Client Error - Returned if the request body is invalid.

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

404

Not Found - returned if the request URL refers to a resource or object that does not exist

409

Alias already in use for this tenant

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

500

Internal Server Error - Returned if there is an unexpected error.