コンテンツにスキップ

List admin IP allowlist entries

GET
/api/admin/ip-allowlist
Code sample: Shell / cURL
curl --request GET \
--url 'https://auth.example.com/api/admin/ip-allowlist?include_disabled=false' \
--header 'Authorization: Bearer <token>'

Lists enabled admin IP allowlist entries by default. When the list is empty, admin IP restrictions are inactive.

include_disabled
boolean

Include disabled entries when true.

Admin IP allowlist entries.

Media type application/json
object
items
required
Array<object>
object
id
string
tenant_id
string
ip_range
string
ip_version
integer
Allowed values: 4 6
description
One of:
string
enabled
boolean
created_by
One of:
string
created_at
integer
updated_at
integer
key
additional properties
total
required
integer
current_ip
required
string
restriction_active
required
boolean
key
additional properties
Example
{
"items": [
{
"id": "ipallow_123",
"tenant_id": "tenant_123",
"ip_range": "203.0.113.0/24",
"ip_version": 4,
"description": "Office network",
"enabled": {},
"created_by": "admin_123",
"created_at": 1770000000000,
"updated_at": 1770000000000
}
],
"total": 1,
"current_ip": "203.0.113.10",
"restriction_active": true
}

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"
}