Get the current feature restrictions for the instance​
Undefined values mean that the feature is not restricted. If restrictions were never set, the instances features are not restricted, all properties are undefined and the details object is empty.
- 200
- 403
- 404
- default
The status 200 is also returned if no restrictions were ever set. In this case, all feature restrictions are undefined.
Schema
details object
defines if ZITADEL should expose the endpoint /ui/login/register/org. If it is true, the org registration endpoint returns the HTTP status 404 on GET requests, and 409 on POST requests.
defines the allowed languages. If allowed_languages has one or more entries, only these languages are allowed. If it has no entries, all supported languages are allowed
{
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.781Z",
"changeDate": "2024-06-17T09:46:06.781Z",
"resourceOwner": "69629023906488334"
},
"disallowPublicOrgRegistration": true,
"allowedLanguages": [
"string"
]
}
Schema
details object
defines if ZITADEL should expose the endpoint /ui/login/register/org. If it is true, the org registration endpoint returns the HTTP status 404 on GET requests, and 409 on POST requests.
defines the allowed languages. If allowed_languages has one or more entries, only these languages are allowed. If it has no entries, all supported languages are allowed
{
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.781Z",
"changeDate": "2024-06-17T09:46:06.781Z",
"resourceOwner": "69629023906488334"
},
"disallowPublicOrgRegistration": true,
"allowedLanguages": [
"string"
]
}
Schema
details object
defines if ZITADEL should expose the endpoint /ui/login/register/org. If it is true, the org registration endpoint returns the HTTP status 404 on GET requests, and 409 on POST requests.
defines the allowed languages. If allowed_languages has one or more entries, only these languages are allowed. If it has no entries, all supported languages are allowed
{
"details": {
"sequence": "2",
"creationDate": "2024-06-17T09:46:06.781Z",
"changeDate": "2024-06-17T09:46:06.781Z",
"resourceOwner": "69629023906488334"
},
"disallowPublicOrgRegistration": true,
"allowedLanguages": [
"string"
]
}
Returned when the user does not have permission to access the resource.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
GET /restrictions
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "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
Request
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'