Skip to content

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

MethodPathSummaryScopes
GET/api/v1/ip-rulesTenant Ip Rule Listtenant:settings.read
POST/api/v1/ip-rulesTenant Ip Rule Createtenant:settings.write
DELETE/api/v1/ip-rules/{ruleId}Tenant Ip Rule Deletetenant:settings.write

Operation details

GET /api/v1/ip-rules

Tenant Ip Rule List

  • Operation ID: tenantIpRuleList
  • Required scopes: tenant:settings.read

Parameters:

NameInRequiredTypeDescription
limitquerynointeger
cursorquerynostring

Responses:

StatusDescriptionBody
200OKListEnvelopeTenantIpRuleResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonCreateTenantIpRuleRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
ruleIdpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)