Product documentation
Entitlement
Access packages — catalog, assignment requests, and approvals.
Entitlement
Access packages — catalog, assignment requests, and approvals.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/entitlement/assignments | Entitlement List Assignments | tenant:entitlement.read or tenant:entitlement.admin |
POST | /api/v1/entitlement/assignments | Entitlement Request Assignment | tenant:entitlement.read or tenant:entitlement.admin |
GET | /api/v1/entitlement/assignments/active-scopes | Entitlement Get Active Scopes | tenant:entitlement.read or tenant:entitlement.admin |
POST | /api/v1/entitlement/assignments/{id}/approve | Entitlement Approve Assignment | tenant:entitlement.approve |
POST | /api/v1/entitlement/assignments/{id}/deny | Entitlement Deny Assignment | tenant:entitlement.approve |
POST | /api/v1/entitlement/assignments/{id}/revoke | Entitlement Revoke Assignment | tenant:entitlement.approve or tenant:entitlement.read or tenant:entitlement.admin |
GET | /api/v1/entitlement/packages | Entitlement List Catalog | tenant:entitlement.read or tenant:entitlement.admin |
POST | /api/v1/entitlement/packages | Entitlement Create Package | tenant:entitlement.admin |
Operation details
GET /api/v1/entitlement/assignments
Entitlement List Assignments
- Operation ID:
entitlementListAssignments - Required scopes:
tenant:entitlement.readortenant:entitlement.admin
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | 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) |
POST /api/v1/entitlement/assignments
Entitlement Request Assignment
- Operation ID:
entitlementRequestAssignment - Required scopes:
tenant:entitlement.readortenant:entitlement.admin
Request body (required): application/json → AssignmentRequest
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/entitlement/assignments/active-scopes
Entitlement Get Active Scopes
- Operation ID:
entitlementGetActiveScopes - Required scopes:
tenant:entitlement.readortenant:entitlement.admin
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) |
POST /api/v1/entitlement/assignments/{id}/approve
Entitlement Approve Assignment
- Operation ID:
entitlementApproveAssignment - Required scopes:
tenant:entitlement.approve
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | 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) |
POST /api/v1/entitlement/assignments/{id}/deny
Entitlement Deny Assignment
- Operation ID:
entitlementDenyAssignment - Required scopes:
tenant:entitlement.approve
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | 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) |
POST /api/v1/entitlement/assignments/{id}/revoke
Entitlement Revoke Assignment
- Operation ID:
entitlementRevokeAssignment - Required scopes:
tenant:entitlement.approveortenant:entitlement.readortenant:entitlement.admin
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | 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) |
GET /api/v1/entitlement/packages
Entitlement List Catalog
- Operation ID:
entitlementListCatalog - Required scopes:
tenant:entitlement.readortenant:entitlement.admin
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | 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) |
POST /api/v1/entitlement/packages
Entitlement Create Package
- Operation ID:
entitlementCreatePackage - Required scopes:
tenant:entitlement.admin
Request body (required): application/json → CreatePackageRequest
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) |