Skip to content

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

MethodPathSummaryScopes
GET/api/v1/entitlement/assignmentsEntitlement List Assignmentstenant:entitlement.read or tenant:entitlement.admin
POST/api/v1/entitlement/assignmentsEntitlement Request Assignmenttenant:entitlement.read or tenant:entitlement.admin
GET/api/v1/entitlement/assignments/active-scopesEntitlement Get Active Scopestenant:entitlement.read or tenant:entitlement.admin
POST/api/v1/entitlement/assignments/{id}/approveEntitlement Approve Assignmenttenant:entitlement.approve
POST/api/v1/entitlement/assignments/{id}/denyEntitlement Deny Assignmenttenant:entitlement.approve
POST/api/v1/entitlement/assignments/{id}/revokeEntitlement Revoke Assignmenttenant:entitlement.approve or tenant:entitlement.read or tenant:entitlement.admin
GET/api/v1/entitlement/packagesEntitlement List Catalogtenant:entitlement.read or tenant:entitlement.admin
POST/api/v1/entitlement/packagesEntitlement Create Packagetenant:entitlement.admin

Operation details

GET /api/v1/entitlement/assignments

Entitlement List Assignments

  • Operation ID: entitlementListAssignments
  • Required scopes: tenant:entitlement.read or tenant:entitlement.admin

Parameters:

NameInRequiredTypeDescription
limitquerynointeger
cursorquerynostring

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)

POST /api/v1/entitlement/assignments

Entitlement Request Assignment

  • Operation ID: entitlementRequestAssignment
  • Required scopes: tenant:entitlement.read or tenant:entitlement.admin

Request body (required): application/jsonAssignmentRequest

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)

GET /api/v1/entitlement/assignments/active-scopes

Entitlement Get Active Scopes

  • Operation ID: entitlementGetActiveScopes
  • Required scopes: tenant:entitlement.read or tenant:entitlement.admin

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)

POST /api/v1/entitlement/assignments/{id}/approve

Entitlement Approve Assignment

  • Operation ID: entitlementApproveAssignment
  • Required scopes: tenant:entitlement.approve

Parameters:

NameInRequiredTypeDescription
idpathyesstring

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)

POST /api/v1/entitlement/assignments/{id}/deny

Entitlement Deny Assignment

  • Operation ID: entitlementDenyAssignment
  • Required scopes: tenant:entitlement.approve

Parameters:

NameInRequiredTypeDescription
idpathyesstring

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)

POST /api/v1/entitlement/assignments/{id}/revoke

Entitlement Revoke Assignment

  • Operation ID: entitlementRevokeAssignment
  • Required scopes: tenant:entitlement.approve or tenant:entitlement.read or tenant:entitlement.admin

Parameters:

NameInRequiredTypeDescription
idpathyesstring

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)

GET /api/v1/entitlement/packages

Entitlement List Catalog

  • Operation ID: entitlementListCatalog
  • Required scopes: tenant:entitlement.read or tenant:entitlement.admin

Parameters:

NameInRequiredTypeDescription
limitquerynointeger
cursorquerynostring

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)

POST /api/v1/entitlement/packages

Entitlement Create Package

  • Operation ID: entitlementCreatePackage
  • Required scopes: tenant:entitlement.admin

Request body (required): application/jsonCreatePackageRequest

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)