Get Organization IP Allowlist

Returns the IP addresses and CIDR blocks your organization accepts requests from, and which surfaces that restriction is enforced on.

An EMPTY entries list means the allowlist is OFF; read it as “not enforcing”, never as “locked down”.

The organization is resolved from your token. There is no parameter naming another one, so this cannot read someone else’s allowlist.

Read-only: nothing changes.

Failures:

• 403 — two different failures share this status, so read the code. AUT-1020 is a permissions problem: your token lacks the security resource. With AUT-0021 it is the LOCKOUT case: your own address is outside the allowlist you are trying to read.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/security/ip-allowlist

Get Organization IP Allowlist

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/security/ip-allowlist \
  --header 'Authorization: Bearer <token>'

200

{
  "entries": [
    "203.0.113.0/24",
    "198.51.100.7"
  ],
  "labeledEntries": [
    {
      "cidr": "203.0.113.0/24",
      "description": "São Paulo office"
    }
  ],
  "scopes": [
    "console",
    "api"
  ]
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Response

200

application/json

OK

entries · string[] · required

Example:

["203.0.113.0/24", "198.51.100.7"]

labeledEntries · object[] · required

The same allowlist as entries, in the same order and with the same CIDRs, each paired with the description an administrator gave it. The description is empty for an entry saved as a bare string or stored before descriptions existed. entries keeps its current shape and stays available; it will be retired later in favor of this member. The description is display text only and never influences an access decision.

Show child attributes

scopes · string[] · required

Example:

["console", "api"]