ZITADEL Docs
APIsCore ResourcesV2Settings

List Organization Settings

Returns a list of organization settings.

Required permission:

  • iam.policy.read
  • org.policy.read
POST
/v2/settings/organization/search

Request Body

application/json

pagination?|

List limitations and ordering.

sortingColumn?|

The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

filters?array<|>

Define the criteria to query for.

[key: string]?never

Response Body

application/json

curl -X POST "https://loading/v2/settings/organization/search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "organizationSettings": [
    {
      "organizationId": "string",
      "creationDate": "2023-01-15T01:30:15.01Z",
      "changeDate": "2023-01-15T01:30:15.01Z",
      "organizationScopedUsernames": true
    }
  ]
}

Was this page helpful?