Get Security Settings
GEThttps://$CUSTOM-DOMAIN/admin/v1/policies/security
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
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-03-21T10:51:29.924Z",
"changeDate": "2025-03-21T10:51:29.924Z",
"resourceOwner": "69629023906488334"
},
"enableIframeEmbedding": true,
"allowedOrigins": [
"string"
],
"enableImpersonation": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-03-21T10:51:29.924Z",
"changeDate": "2025-03-21T10:51:29.924Z",
"resourceOwner": "69629023906488334"
},
"enableIframeEmbedding": true,
"allowedOrigins": [
"string"
],
"enableImpersonation": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2025-03-21T10:51:29.925Z",
"changeDate": "2025-03-21T10:51:29.925Z",
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
code int32
message string
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/policies/security' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear