TransaktDocs
API referenceEntitlements

Check whether a user may use a product

GET
/api/v1/entitlements/{tenantId}/eligibility

The user question: may this user of the tenant use the product? Send userObjectId, or a delegated user token (scope Entitlement.Read) to ask about the signed-in user. The answer's licenceOutcome is Licensed, NotLicensed, Unconfirmed (Microsoft could not confirm: apply your own grace policy) or ConsentRequired (repeat with the user's delegated token). Questions by email use the POST form so that personal data never appears in a URL.

Errors: request.validation_failed, api_client.product_not_allowed, entitlement.user_tenant_mismatch, product.not_found, plan.not_found, auth.credentials_invalid, auth.forbidden, request.rate_limited.

Authorization

headerAuthorizationBearer <token>

A Microsoft Entra client-credentials token for the Transakt API (scope api://{apiAppId}/.default), issued in the tenant recorded on the API client credential, with the app role matching the operation: Entitlement.Read.All, Catalogue.Read.All or Usage.Write.All.

Scope: api://{apiAppId}/.default

Path Parameters

tenantId*string
Formatuuid

Query Parameters

product?string
plan?string
userObjectId?string
Formatuuid

Response Body

OK

application/json
  1. response

UserEligibility (6.5.8).

tenantId*string
Formatuuid
product*
plan*null|
requestedPlan*null|string
subject*
tenantEntitled*boolean
licenceModel*null|
licenceOutcome*LicenceOutcome
Value in"Licensed""NotLicensed""Unconfirmed""ConsentRequired""NotApplicable"
isEligible*boolean
reason*EligibilityReason
Value in"TenantWideEntitlement""SeatAssigned""MicrosoftLicensed""TenantNotEntitled""PlanMismatch""NoSeatAssigned""MicrosoftNotLicensed""NoMicrosoftPlan""MicrosoftNoLicencesReported""MicrosoftUnavailable""MicrosoftNotConfigured""DelegatedConsentMissing"
seats*null|
microsoftLicence*null|
evaluatedAt*string
Formatdate-time
curl -X GET "https://example.com/api/v1/entitlements/497f6eca-6276-4993-bfeb-53cbbbba6f08/eligibility"
{  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",  "product": {    "slug": "string",    "name": "string"  },  "plan": null,  "requestedPlan": null,  "subject": {    "objectId": null,    "email": null,    "isCaller": true  },  "tenantEntitled": true,  "licenceModel": null,  "licenceOutcome": "Licensed",  "isEligible": true,  "reason": "TenantWideEntitlement",  "seats": null,  "microsoftLicence": null,  "evaluatedAt": "2019-08-24T14:15:22Z"}

Get a tenant entitlement GET

What the tenant (a customer's Microsoft Entra tenant id) holds for one of your products: status, access level, edition, plans, licence model, feature capabilities, seat quantity and validity. Ask with `plan` for a plan-scoped answer. `status` is `None` when the tenant never bought the product. Scope `entitlements:read` (app role `Entitlement.Read.All`). Errors: [`api_client.product_not_allowed`](/errors/api_client.product_not_allowed/), [`entitlement.user_tenant_mismatch`](/errors/entitlement.user_tenant_mismatch/), [`product.not_found`](/errors/product.not_found/), [`plan.not_found`](/errors/plan.not_found/), [`auth.credentials_invalid`](/errors/auth.credentials_invalid/), [`auth.forbidden`](/errors/auth.forbidden/), [`request.rate_limited`](/errors/request.rate_limited/).

Get a product GET

One product of the catalogue, as in the list. Errors: [`api_client.product_not_allowed`](/errors/api_client.product_not_allowed/), [`product.not_found`](/errors/product.not_found/), [`auth.credentials_invalid`](/errors/auth.credentials_invalid/), [`auth.forbidden`](/errors/auth.forbidden/), [`request.rate_limited`](/errors/request.rate_limited/).