Set Security Settings

Set the security settings of the ZITADEL instance.

application/json

application/grpc

application/grpc-web+proto

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

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

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

• 200
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T07:44:38.725Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T07:44:38.725Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-13T07:44:38.725Z",
    "resourceOwner": "69629023906488334"
  }
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

PUT /v2beta/policies/security

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

python / requests

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

go / native

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

nodejs / axios

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

ruby / Net::HTTP

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

csharp / RestSharp

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

php / cURL

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

java / OkHttp

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'

powershell / RestMethod

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/policies/security' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "embeddedIframe": {
    "enabled": true,
    "allowedOrigins": [
      "foo.bar.com",
      "localhost:8080"
    ]
  },
  "enableImpersonation": true
}'