Get Security Settings

Returns the security settings of the ZITADEL instance.

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

policy object
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
creationDate date-time
on read: the timestamp of the first event of the object
on create: 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
resourceOwner resource_owner is the organization an object belongs to
enableIframeEmbedding states if iframe embedding is enabled or disabled
allowedOrigins string[]
enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well"

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-13T06:44:38.882Z",
      "changeDate": "2024-06-13T06:44:38.882Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

Schema

Example (from schema)

---

Schema

policy object
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
creationDate date-time
on read: the timestamp of the first event of the object
on create: 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
resourceOwner resource_owner is the organization an object belongs to
enableIframeEmbedding states if iframe embedding is enabled or disabled
allowedOrigins string[]
enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well"

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-13T06:44:38.882Z",
      "changeDate": "2024-06-13T06:44:38.882Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

Schema

Example (from schema)

---

Schema

policy object
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
creationDate date-time
on read: the timestamp of the first event of the object
on create: 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
resourceOwner resource_owner is the organization an object belongs to
enableIframeEmbedding states if iframe embedding is enabled or disabled
allowedOrigins string[]
enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well"

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-13T06:44:38.882Z",
      "changeDate": "2024-06-13T06:44:38.882Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

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"
    }
  ]
}

Loading...