Get Security Settings

GET 
/policies/security

Returns the security settings of the ZITADEL instance.

Responses

200

A successful response.

application/json

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 (string)

enableIframeEmbedding states if iframe embedding is enabled or disabled (boolean)

allowedOrigins string[]

enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well" (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-15T21:46:13.713Z",
      "changeDate": "2024-11-15T21:46:13.713Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

application/grpc

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 (string)

enableIframeEmbedding states if iframe embedding is enabled or disabled (boolean)

allowedOrigins string[]

enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well" (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-15T21:46:13.714Z",
      "changeDate": "2024-11-15T21:46:13.714Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

application/grpc-web+proto

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 (string)

enableIframeEmbedding states if iframe embedding is enabled or disabled (boolean)

allowedOrigins string[]

enableImpersonation allows users to impersonate other users. The impersonator needs the appropriate `*_IMPERSONATOR` roles assigned as well" (boolean)

Example (from schema)

{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-15T21:46:13.714Z",
      "changeDate": "2024-11-15T21:46:13.714Z",
      "resourceOwner": "69629023906488334"
    },
    "enableIframeEmbedding": true,
    "allowedOrigins": [
      "string"
    ],
    "enableImpersonation": true
  }
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

Loading...