Check admin IP allowlist

POST

/api/admin/ip-allowlist/check

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/ip-allowlist/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ip": "203.0.113.10" }'

Checks whether an IP address is allowed for the current tenant and whether restrictions are active.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

ip

required

string

key

additional properties

Example

{
  "ip": "203.0.113.10"
}

Responses

200

IP allowlist evaluation result.

Media type application/json

object

ip

required

string

allowed

required

boolean

restriction_active

required

boolean

entry_count

required

integer

key

additional properties

Example

{
  "ip": "203.0.113.10",
  "allowed": true,
  "restriction_active": true,
  "entry_count": 3
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}