Product documentation
Policy
The Policy resource.
Policy
The Policy resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/policies/{policyKey}/effective | Policy Effective | tenant:policy.read |
GET | /api/v1/policies/{policyKey}/overrides | Policy List Overrides | tenant:policy.read |
PUT | /api/v1/policies/{policyKey}/overrides | Policy Put Override | tenant:policy.write |
DELETE | /api/v1/policies/{policyKey}/overrides | Policy Delete Override | tenant:policy.write |
Operation details
GET /api/v1/policies/{policyKey}/effective
Policy Effective
- Operation ID:
policyEffective - Required scopes:
tenant:policy.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
policyKey | path | yes | string | |
organizationId | query | no | string | |
clientId | query | no | 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) |
GET /api/v1/policies/{policyKey}/overrides
Policy List Overrides
- Operation ID:
policyListOverrides - Required scopes:
tenant:policy.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
policyKey | 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) |
PUT /api/v1/policies/{policyKey}/overrides
Policy Put Override
- Operation ID:
policyPutOverride - Required scopes:
tenant:policy.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
policyKey | path | yes | string |
Request body (required): application/json → PutOverrideRequest
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/policies/{policyKey}/overrides
Policy Delete Override
- Operation ID:
policyDeleteOverride - Required scopes:
tenant:policy.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
policyKey | path | yes | string | |
organizationId | query | no | string | |
clientId | query | no | 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) |