Skip to main content

UpdateUIPluginRequest

Properties​

NameTypeDescriptionNotes
AliasStringReplacement alias, unique per tenant and normalized to lowercase[optional]
Namemap[string]StringLocalized string keyed by locale code. At least one non-empty locale entry is required on create/update. Conventionally includes en.[optional]
Descriptionmap[string]StringLocalized string keyed by locale code. At least one non-empty locale entry is required on create/update. Conventionally includes en.[optional]
ApiScopes[]StringReplaces the existing list entirely when provided[optional]
Slots[]PluginSlotReplaces the existing list when provided[optional]
ContentSecurityPoliciesmap[string]String[]Map of directive name to allowlist values. Used for CSP, Permissions-Policy, and iframe-allow on create/update. Only platform allowlisted directives/keywords are accepted (see UMS validators).[optional]
PermissionPolicymap[string]String[]Map of directive name to allowlist values. Used for CSP, Permissions-Policy, and iframe-allow on create/update. Only platform allowlisted directives/keywords are accepted (see UMS validators).[optional]
IframeAllowmap[string]String[]Map of directive name to allowlist values. Used for CSP, Permissions-Policy, and iframe-allow on create/update. Only platform allowlisted directives/keywords are accepted (see UMS validators).[optional]
IframeSandbox[]StringOpt-in iframe sandbox grants. Replaces the existing list entirely when provided; send [] to clear all grants. Omit to leave unchanged.[optional]
StatePluginInstanceState[optional]

Examples​

  • Prepare the resource
$UpdateUIPluginRequest = Initialize-UpdateUIPluginRequest -Alias my-custom-plugin `
-Name {"en":"Example text","fr":"Texte d'exemple"} `
-Description {"en":"Example text","fr":"Texte d'exemple"} `
-ApiScopes ["idn:account:read"] `
-Slots null `
-ContentSecurityPolicies {"default-src":["'self'"]} `
-PermissionPolicy {"default-src":["'self'"]} `
-IframeAllow {"default-src":["'self'"]} `
-IframeSandbox ["allow-modals","allow-popups"] `
-State null
  • Convert the resource to JSON
$UpdateUIPluginRequest | ConvertTo-JSON

[Back to top]