Skip to main content

updateSecuritySettings

Requires at least one of the permissions settings:security:update or settings:tenant:update.

Updates the security settings: two-factor sign-in, forced password change, password policy, session timeout, single sign-on, allowed domains, audit log, IP allow list and encrypted exports. Returns the saved settings. Needs settings:security:update, or settings:tenant:update.

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:

mutation UpdateSecuritySettings($input: SecuritySettingsInput!) {
  updateSecuritySettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateSecuritySettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}
updateSecuritySettings(
  input: SecuritySettingsInput!
): [TenantSetting!]!

Arguments​

updateSecuritySettings.input ● SecuritySettingsInput! non-null input​

The security settings to change; fields left out stay as they are.

Type​

TenantSetting object​

A setting of the organization.