Skip to main content

Restrict the instances features​

Undefined values don't change the current restriction. Zero values remove the current restriction.

Request Body required
    disallowPublicOrgRegistration boolean

    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.

    allowedLanguages object

    restricts the allowed languages. If allowed_languages is undefined, the allowed languages are not changed.

    list string[]

    defines which languages to select. An empty list means all languages are selected.

Responses

Restrictions set.

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

    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
PUT /restrictions

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/admin/v1
Bearer Token
Content-Type
Body required
{

  "disallowPublicOrgRegistration": true,

  "allowedLanguages": {

    "list": [

      "string"

    ]

  }

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/restrictions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "disallowPublicOrgRegistration": true,
  "allowedLanguages": {
    "list": [
      "string"
    ]
  }
}'