OMomniapp
IP Allowlist

Update the IP allowlist

Changed on

Update the organization's IP allowlist. Every field is optional: omit one to leave it unchanged. entries replaces the whole list. The update is refused if it would leave the allowlist enabled with no entries, or enabled with a list that blocks the address this request came from. Requires organization admin access. Returns the stored settings, the same shape as GET.

patch/api/v1/ip-allowlist

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/ip-allowlist
  • Auth
    HTTP bearer

Request body

allowsSupportboolean

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

enabledboolean

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

exemptsScimboolean

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

Example request

{
  "enabled": true,
  "entries": [
    {
      "address": "203.0.113.0/24",
      "note": "Boston VPN"
    }
  ],
  "exemptsScim": true
}

Response

Settings updated. Returns the stored settings.

allowsSupportboolean required

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

enabledboolean required

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

exemptsScimboolean required

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

Example response

{
  "enabled": true,
  "entries": [
    {
      "address": "203.0.113.0/24",
      "note": "Boston VPN"
    }
  ],
  "exemptsScim": true
}

Changes