IP Allowlist

Get the IP allowlist

Changed on

Get the organization's IP allowlist: whether it is enforced, the support and SCIM bypasses, and the allowed addresses with their notes. Requires organization admin access.

get/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

Response

The current IP allowlist 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