Skip to main content
PATCH

Update requirements and checks

The update is refused if it would leave the allowlist enabled with no entries, or enabled with a list that doesn’t cover the address this request came from. The check runs on any update that leaves the list enabled, including {"enabled": true} on its own, not only on updates to entries. The check only confirms that the address sending the request is on the list. It doesn’t check your admins’ addresses. A script that runs from a listed server can enable or replace the list and lock every admin out of Omni.

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
allowsSupport
boolean

Whether Omni support staff, signing in through Omni's own support login, can reach the organization from outside the list.

Example:

false

enabled
boolean

Whether the allowlist is enforced. While false the entries are kept, but no address is blocked.

Example:

true

entries
object[]

Replaces the whole list, notes included. Each address may appear only once.

exemptsScim
boolean

Whether SCIM provisioning requests (everything under /api/scim/) are accepted from any address. They still need an organization API key.

Example:

true

Response

Settings updated. Returns the stored settings.

allowsSupport
boolean
required

Whether Omni support staff, signing in through Omni's own support login, can reach the organization from outside the list.

Example:

false

enabled
boolean
required

Whether the allowlist is enforced. While false the entries are kept, but no address is blocked.

Example:

true

entries
object[]
required

The allowed addresses and ranges, in the order given.

exemptsScim
boolean
required

Whether SCIM provisioning requests (everything under /api/scim/) are accepted from any address. They still need an organization API key.

Example:

true