Skip to main content

Set Security Settings

PUT 
https://$CUSTOM-DOMAIN/v2/policies/security

Set the security settings of the ZITADEL instance.

Request​

Body

required

    embeddedIframe

    object

    enabled boolean

    states if iframe embedding is enabled or disabled

    allowedOrigins string[]

    origins allowed loading ZITADEL in an iframe if enabled.

    enableImpersonation boolean

    allows users to impersonate other users. The impersonator needs the appropriate *_IMPERSONATOR roles assigned as well

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    creationDate date-time
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Body required
{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}
ResponseClear

Click the Send API Request button above and see the response here!