Query Entitlement Compliance Status

Request

Retrieves entitlement compliance data that shows whether the tenant's license usage is within authorized limits. Entitlement compliance data provides visibility into license adherence by comparing actual device usage against purchased license quantities. This includes identifying compliant licenses (usage within limits), overallocated licenses (usage exceeds purchased quantity), and underutilized licenses (purchased quantity significantly exceeds usage).

What the Data Includes: Compliance status for each license type, total purchased quantities vs. consumed quantities, active device counts by type, license shortfall or surplus amounts, devices at risk of non-compliance, and compliance trends.

Content-Typestringrequired

Body

required

filtersobject(LicenseComplianceFilter)

Filter criteria object containing parameters to narrow down compliance query results based on license types and status.

{
  "filters": {
    "licenseType": [ … ]
  }
}

Responses

success

Body

dataArray of objects(ConsolidatedLicenseSummary)required

List of license summaries grouped by license type (APSW and SLTN_TOKEN)

Response

{
  "data": [
    { … }
  ]
}