# Sync MSP entitlement summaries (deprecated)

Retrieves MSPs entitlement summaries with an optional refresh capability. When called without the 'refresh' parameter or with 'refresh=false', returns cached summary data including all MSPs bulk entitlements, expiration banners, and aggregated summaries by device type. When called with 'refresh=true', initiates a synchronization with external licensing systems to update entitlement data from the source, then returns a 202 accepted response with an activity tracking link to monitor the refresh progress. After refresh completes, call this endpoint again without the refresh parameter to retrieve the updated summaries from cache. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/utilizations/query can be used for this content.

Endpoint: GET /mspEntitlements/summaries
Version: v0.2.0

## Query parameters:

  - `refresh` (boolean)

## Response 200 fields (application/json):

  - `mspEntitlementBanners` (array)
    Collection of banner notifications generated based on the refreshed entitlement data. Contains alerts for expiring licenses, capacity warnings, and compliance issues requiring administrator attention. Banners are derived from analyzing the refreshed entitlements for conditions that need visibility.

  - `mspEntitlementBanners.affectedDeviceCount` (integer)
    Number of active devices that will be affected by this banner's condition. Indicates how many devices will lose entitlement coverage when the licenses expire or if the compliance issue is not resolved. Critical for capacity planning and risk assessment.
    Example: 150

  - `mspEntitlementBanners.alm` (boolean)
    Indicates whether this banner is for an ALM (advanced license management) consumption model licensing. When true, the entitlement uses ALM with consumption tracking; when false, it uses traditional perpetual or subscription licensing. Determines which licensing rules and calculations apply.

  - `mspEntitlementBanners.almExtraEntitlementInfoDto` (object)
    Additional ALM related entitlement information included only when the alm field is true. Contains extended data about consumption model licensing metrics, usage statistics, and ALM attributes. Null for standard entitlements.

  - `mspEntitlementBanners.almExtraEntitlementInfoDto.licenseType` (string)
    Type of license in the ALM system, categorizing the specific license classification for entitlement management.
    Enum: "UNKNOWN", "APSW", "URLF", "EDGE_SECS", "EDGE_SECL", "SLTN_TOKEN"

  - `mspEntitlementBanners.almExtraEntitlementInfoDto.remainingQuantity` (integer)
    Remaining license quantity available for this license type, indicating how many licenses are still unused or unassigned.

  - `mspEntitlementBanners.almExtraEntitlementInfoDto.soEntQuantity` (integer)
    Total licensed daily device count in the sales order, representing the complete entitlement quantity from the original sales order.

  - `mspEntitlementBanners.deviceCount` (integer)
    Quantity of MSP entitlements that are expiring or affected in this banner. For aggregated banners (multipleLicense=true), this represents the count of distinct entitlements included in the alert. Used for reporting the scope of the issue.
    Example: 5

  - `mspEntitlementBanners.deviceType` (string)
    Type of device associated with this banner notification. Indicates which device category (AP for access points, SW for switches) the entitlement alert applies to. Used to categorize and filter banner notifications by device type.
    Enum: "MSP_WIFI", "MSP_SWITCH", "MSP_EDGE", "MSP_APSW", "MSP_SLTN_TOKEN"

  - `mspEntitlementBanners.effectDate` (string)
    Effective date when the action described in the banner takes effect, typically the expiration date of the MSP entitlement. For expiration banners, this is when the license will expire. Displayed in UTC timezone.
    Example: "2024-12-31T23:59:59.000Z"

  - `mspEntitlementBanners.effectDays` (integer)
    Number of days between tomorrow and the effect date. Provides a countdown to help administrators understand how urgent the action is. For expiration banners, this shows days remaining until license expiration. Negative values indicate the event has already occurred.
    Example: 30

  - `mspEntitlementBanners.multipleLicense` (boolean)
    Indicates whether multiple MSP entitlements are contributing to this banner. When true, the banner represents an aggregated alert for more than one entitlement; when false, it represents a single entitlement. This helps administrators understand if the alert affects one or multiple license pools.

  - `mspEntitlementBanners.type` (string)
    Banner type indicating the severity or category of the notification. String values are configured in the application configuration file. Common types include expiration warnings, license shortage alerts, and compliance notifications.
    Example: "LICENSE_EXPIRING"

  - `mspEntitlementSummaries` (array)
    Collection of aggregated entitlement summaries grouped by license type and expiration characteristics. Provides summary statistics and remaining capacity calculations derived from the detailed entitlements. Used for dashboard displays and quick availability checks without processing individual entitlement records.

  - `mspEntitlementSummaries.courtesyQuantity` (integer)
    Number of courtesy or grace period licenses included in this summary. Courtesy licenses are additional capacity provided temporarily (often during renewals or for customer satisfaction) beyond the purchased quantity. Helps administrators track promotional or temporary capacity extensions.
    Example: 50

  - `mspEntitlementSummaries.deviceSubType` (string)
    Specific device subtype variant within the device type category. Provides more granular classification such as 'Indoor AP', 'Outdoor AP', or 'Edge Switch'. Only populated for device types that have subtypes. Null for device types without subtype distinctions.
    Example: "Indoor AP"

  - `mspEntitlementSummaries.deviceType` (string)
    Type of device this entitlement summary applies to. Categorizes the license pool by device category (AP for access points, SW for switches). Used to filter and organize entitlement data by infrastructure component type.
    Enum: "MSP_WIFI", "MSP_SWITCH", "MSP_EDGE", "MSP_APSW", "MSP_SLTN_TOKEN"

  - `mspEntitlementSummaries.effectiveDate` (string)
    Date when the entitlements in this summary became active. Represents the start of the license validity period. Used to calculate license age and determine when capacity became available.
    Example: "2024-01-01T00:00:00.000Z"

  - `mspEntitlementSummaries.expirationDate` (string)
    Date when the entitlements in this summary expire. Represents the end of the license validity period, typically set to 23:59:59 on the expiration day. After this date, the licenses are no longer valid for device activation. Critical for renewal scheduling and capacity planning.
    Example: "2024-12-31T23:59:59.000Z"

  - `mspEntitlementSummaries.licenseType` (string)
    Specific license type identifier for this entitlement summary. Combines device type, subtype, and licensing model into a unique identifier (e.g., 'MSP_APSW', 'MSP_URLF'). Used as the primary grouping key for aggregating entitlements.
    Enum: "MSP_WIFI", "MSP_WIFI_TEMP", "MSP_ICX", "MSP_ICX71L", "MSP_ICX71", "MSP_ICX75", "MSP_ICX76", "MSP_ICX78", "MSP_ICX_ANY", "MSP_EDGE", "MSP_EDGE_TEMP", "MSP_APSW", "MSP_APSW_TEMP", "MSP_URLF", "MSP_EDGE_SECL", "MSP_EDGE_SELS", "MSP_SLTN_TOKEN", "MSP_SLTN_TOKEN_TEMP"

  - `mspEntitlementSummaries.quantity` (integer)
    Total quantity of licenses in this entitlement summary group. Represents the aggregate count of all entitlements matching this device type, license type, and expiration characteristics. Used for capacity reporting and allocation planning.
    Example: 1000

  - `mspEntitlementSummaries.remainingDays` (integer)
    Number of days remaining until the entitlements in this summary expire. Calculated from tomorrow to the expiration date. Positive values indicate future expiration; zero or negative values indicate already expired or expiring today. Critical for renewal planning and expiration alerts.
    Example: 90

  - `mspEntitlementSummaries.remainingLicenses` (integer)
    Number of unassigned licenses remaining in this entitlement pool. Calculated as total quantity minus assigned licenses. Represents available capacity that can still be allocated to customers or devices. Zero or negative values indicate capacity exceeded and requiring attention.
    Example: 250

  - `mspEntitlementSummaries.trial` (boolean)
    Indicates whether this summary represents trial or temporary licenses. When true, the summary aggregates trial entitlements which are temporary evaluation licenses. When false, represents standard purchased licenses. Helps distinguish between production capacity and evaluation licenses.

  - `mspEntitlements` (array)
    List of detailed MSP entitlement records retrieved from the external license system. Each entitlement represents a license pool with complete details including SKU, quantity, dates, and device associations. This is the primary data refreshed during synchronization operations.

  - `mspEntitlements.alm` (boolean)
    Indicates whether this is an ALM (advanced license management) entitlement. ALM entitlements have additional features and management capabilities compared to standard entitlements. When true, additional ALM fields like activation ID and sales order entitlement quantity may be populated.

  - `mspEntitlements.almActivationId` (string)
    Activation identifier for ALM (advanced license management) entitlements. This ID is used to track and manage ALM license activations. Only present and relevant when the 'alm' field is true.
    Example: "ALM-ACT-123456"

  - `mspEntitlements.almSoEntQuantity` (integer)
    SO (sales order) entitlement quantity for ALM licenses. Represents the quantity specified in the sales order for this ALM entitlement. Only populated for ALM entitlements when 'alm' field is true.
    Example: 500

  - `mspEntitlements.deviceSubType` (string)
    The specific subtype or variant within the device type category (e.g., Indoor AP, Outdoor AP). Provides granular categorization of devices covered by this entitlement. Derived from the licenseType.

  - `mspEntitlements.deviceType` (string)
    The category of device this entitlement applies to (e.g., AP for access points, SW for switches). This is a hierarchical categorization where device types can have multiple subtypes. Derived from the licenseType for database efficiency.
    Enum: "MSP_WIFI", "MSP_SWITCH", "MSP_EDGE", "MSP_APSW", "MSP_SLTN_TOKEN"

  - `mspEntitlements.effectiveDate` (string)
    Date and time when this entitlement becomes active and can start being used or assigned. Entitlements cannot be used before this date. Typically set to the purchase or contract start date.
    Example: "2024-01-01T00:00:00Z"

  - `mspEntitlements.expirationDate` (string)
    Date and time when this entitlement expires and can no longer be used or assigned. For API responses, this is returned as 23:59:59 on the expiration day (entitlements are valid all day on the expiration date). Internally stored as the exact date from the licensing system.
    Example: "2024-12-31T23:59:59Z"

  - `mspEntitlements.id` (string)

  - `mspEntitlements.isR1Sku` (string)
    This flag helps identify entitlements that are part of the ruckus one platform.
    Example: true

  - `mspEntitlements.isTrial` (boolean)
    Indicates whether this is a trial/temporary MSP entitlement. Trial entitlements are temporary evaluation licenses that allow MSPs to test functionality before purchasing full licenses. Determined by checking if the SKU ends with '-TEMP' or contains 'TMP090'. When true, this is a trial entitlement; when false, it's a standard purchased entitlement.

  - `mspEntitlements.lastNotificationDate` (string)
    Date when the most recent expiration notification was sent to the tenant for this entitlement. Used to track notification history and prevent duplicate notifications. Stored as date value without time in UTC timezone.
    Example: "2024-11-30"

  - `mspEntitlements.quantity` (integer)
    Total number of licenses available in this MSP entitlement pool. This represents the bulk quantity that the MSP can allocate to their customer tenants through assignments. Must be a positive number.
    Example: 1000

  - `mspEntitlements.r1Sku` (boolean)
    This flag helps identify entitlements that are part of the ruckus one platform.
    Example: true

  - `mspEntitlements.sku` (string)
    SKU (stock keeping unit) identifier for this entitlement as assigned by the licensing system. Used for product identification, ordering, and inventory management. May contain suffixes like '-TEMP' for trial licenses or 'TMP090' for temporary entitlements.
    Example: "APSW-MSP100-001"

  - `mspEntitlements.skuTier` (string)
    Service tier or level associated with this SKU (e.g., Bronze, Silver, Gold, Platinum). Indicates the service level and feature set included with the entitlement. Optional field that may not be present for all SKUs.
    Example: "Gold"

  - `mspEntitlements.status` (string)
    Enum: "FUTURE", "VALID", "EXPIRED"

## Response 202 fields (application/json):

  - `desc` (string)
    Human-readable description providing details about the accepted request, its purpose, and expected processing outcome.

  - `link` (string)
    URI link for tracking or retrieving the status of the accepted request.

  - `requestId` (string)
    Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs.