Create a plugin instance

POST 
/ui-plugins/v1

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.

Registers a new tenant-scoped plugin installation.

Enforces:

• Max 20 plugin instances per tenant
• Slot registry rules (slotId must exist; per-slot maxPlugins; no duplicate slotIds)
• Alias uniqueness within the tenant (normalized lowercase)
• CSP / Permissions-Policy / iframe-allow / iframe-sandbox allowlists
• Product license idn:ui-plugins-author (404 if missing)
• Caller tenant id is present (400 User context is invalid otherwise). The instance is created in that tenant.

Emits Kafka audit event UI_PLUGIN_INSTANCE_CREATED on success.

Response body is the created plugin instance plus devDocumentHeaders, the ephemeral Content-Security-Policy and Permissions-Policy header values a local dev server can use for CSP parity with the deployed plugin. They are returned only on create (and link), not when reading the instance.

Request

Responses

201

Plugin instance created; includes devDocumentHeaders

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.