Settings

Configuration for the enterprise: how members are provisioned, and the currency it is invoiced in.

Reading

query {
  settings {
    id
    scimEnabled
    scimBaseUrl
    sftpEnabled
    sftpUsername
    currencyCode
  }
}

Returns a plain list — not paginated — that in practice holds one record. The record is created on first read, so this never fails because nothing has been configured yet. Keep its id: it is the settingId the single-record mutations below take.

Requires enterprise:settings:read.

What settings control

The record has a fixed set of fields. There are no free-form keys.

Field	Writable	Meaning
`scimEnabled`	Yes	The tenant switch for SCIM provisioning
`scimBaseUrl`	Yes	A stored URL string. Nothing on the SCIM surface reads it
`sftpEnabled`	Yes	The tenant switch for SFTP data automation
`sftpUsername`	No	The username to log in to SFTP with — your enterprise id. `null` while `sftpEnabled` is `false`
`currencyCode`	Yes	ISO 4217 code the enterprise is invoiced in

Both switches are read when they are used, not baked into credentials: scimEnabled on every SCIM request, and sftpEnabled on every SFTP login. So turning one off takes effect on the next request or login rather than when a token expires.

SCIM and SFTP cannot both be on. Any write that would leave scimEnabled and sftpEnabled both true is rejected with SFTP and SCIM provisioning cannot both be enabled simultaneously. To move from one to the other, turn the first off in the same write that turns the second on.

Changing the record

mutation {
  updateSetting(settingId: 5, input: { sftpEnabled: true }) {
    sftpEnabled
    sftpUsername
  }
}

updateSetting(settingId:, input:) changes only the fields you pass and returns the updated record. A settingId that is not your enterprise's record is Setting not found.

createSetting(input:) inserts a record, and deleteSetting(settingId:) removes one and returns true. Because settings creates the record on first read, updateSetting is normally the only one of the three you need.

Changing several fields by key

mutation {
  bulkUpdateSettings(input: {
    settings: [
      { key: "scim_enabled", value: "false" }
      { key: "sftp_enabled", value: "true" }
    ]
  })
}

bulkUpdateSettings takes no settingId and addresses the fields by snake_case key:

Key	Value
`scim_enabled`	`"true"` turns it on. Any other string turns it off
`scim_base_url`	Stored as given
`sftp_enabled`	`"true"` turns it on. Any other string turns it off
`currency_code`	Stored as given

Any other key fails the whole call. Every value is a string, so "True" or "1" switches a flag off.

Returns Boolean — true on success — rather than the updated record. Query settings afterwards if you need to see the result. All the pairs are applied in one update, which is what makes the SCIM-to-SFTP switch above valid.

All writes require enterprise:settings:write.

Reference

Generated reference — every type, field and argument, built from the live schema.

SFTP FAQ Enterprise vouchers

Built with