tenantSettings

Requires permission settings:tenant:read.

Lists your organization's settings one page at a time, with optional filter, sort and category. Needs settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TenantSettings {
  tenantSettings {
    hasNextPage
    hasPreviousPage
    totalCount
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantSettings {\n  tenantSettings {\n    hasNextPage\n    hasPreviousPage\n    totalCount\n    pageInfo {\n      endCursor\n      hasNextPage\n      hasPreviousPage\n      startCursor\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "tenantSettings": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "totalCount": 0,
      "pageInfo": {
        "endCursor": "string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "string"
      }
    }
  }
}

tenantSettings(
  input: GetTenantSettingsInput
): PaginatedSettingsResponse!

Arguments

tenantSettings.input ● GetTenantSettingsInput input

Filter, sort, paging and category for the list, and whether to include default settings.

Type

PaginatedSettingsResponse object

A page of settings.