Product documentation
TenantIpRule
Tenant IP allow/deny rules enforced at the gateway.
TenantIpRule
Tenant IP allow/deny rules enforced at the gateway.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/ip-rules | Tenant Ip Rule List | tenant:settings.read |
POST | /api/v1/ip-rules | Tenant Ip Rule Create | tenant:settings.write |
DELETE | /api/v1/ip-rules/{ruleId} | Tenant Ip Rule Delete | tenant:settings.write |
Operation details
GET /api/v1/ip-rules
Tenant Ip Rule List
- Operation ID:
tenantIpRuleList - Required scopes:
tenant:settings.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | ListEnvelopeTenantIpRuleResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/ip-rules
Tenant Ip Rule Create
- Operation ID:
tenantIpRuleCreate - Required scopes:
tenant:settings.write
Request body (required): application/json → CreateTenantIpRuleRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/ip-rules/{ruleId}
Tenant Ip Rule Delete
- Operation ID:
tenantIpRuleDelete - Required scopes:
tenant:settings.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
ruleId | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |