# Entitlements

Overview

The Manage Entitlement API provides comprehensive capabilities for managing entitlements within the RUCKUS One platform. Entitlements represent the authorization and rights to use RUCKUS products and services, encompassing licenses, subscriptions. This API enables you to manage these entitlements, track their usage, control assignments to partners and customers, and monitor compliance.

The API is designed for organizations that need to manage entitlements including licenses and subscriptions, track device usage, allocate entitlements to customers or partners, and maintain compliance with subscription agreements.

What This API Does

- Entitlement Management: Retrieve and query detailed entitlement information including purchased licenses, assigned licenses, entitlement types
- Usage and Utilization: Access real-time usage statistics, track license usage
- Entitlement Availability: Calculate available entitlement capacity, determine allocation availability based on current usage, and access banner notifications for entitlements requiring attention
- Assignment Management: Create, retrieve, update, and delete entitlement assignments
- Synchronization: Synchronize entitlement data from latest purchase
- Query Operations: Retrieve entitlement and assignment data with pagination, sorting, and filtering capabilities
- Compliance Monitoring: Monitor entitlement compliance status and identify licenses that exceed allocations or are underutilized

Common Use Cases

- Enterprise Entitlement Management: Track and manage entitlements across large organizations with multiple departments or business units
- MSP/VAR Operations: Allocate and manage entitlements for customer accounts.
- Usage Reporting: Generate periodic usage reports for capacity planning.
- Compliance Auditing: Monitor entitlement usage to ensure compliance with subscription terms and conditions

Technical Details

- API Version: v0.2.0
- Content Types: Supports application/json and application/vnd.ruckus.v1+json for v1 endpoints
- Regional Endpoints: Available in North America, Europe, and Asia Pacific regions

Authentication & Authorization

This API uses bearer token authentication with role based access control. Users must have appropriate permissions to perform operations on entitlements, assignments, and usage data.

Version: v0.2.0
License: RUCKUS Cloud Privacy Policy

## Servers

RUCKUS One API host for North American region.
```
https://api.ruckus.cloud
```

RUCKUS One API host for European region.
```
https://api.eu.ruckus.cloud
```

RUCKUS One API host for Asian region.
```
https://api.asia.ruckus.cloud
```

## Download OpenAPI description

[Entitlements](https://docs.ruckus.cloud/_bundle/deprecated_apis/entitlement-0.2.0.yaml)

## Entitlement

Entitlement management and license operations.

### Revoke Bulk Assignments (deprecated)

 - [DELETE /assignments](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/revokebulkassignment.md): Revoke multiple license assignments for MSP. This method will be removed no sooner than 08/31/2026. The following endpoint /tenants/{tenantId}/entitlements/assignments/query can be used for this content.

### Get Assignment Summaries (deprecated)

 - [GET /assignments/summaries](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/getassignmentssummary.md): Get summaries of MSP license assignments by device type and device subtype. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/utilizations/query can be used for this content.

### Get Banners (deprecated)

 - [GET /banners](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/getbanners_1.md): Retrieves entitlement banner notifications for the authenticated tenant. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/banners/query can be used for this content.

### Get Entitlements (deprecated)

 - [GET /entitlements](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/getentitlements_1.md): Retrieves the list of device entitlements for the authenticated tenant. This method will be removed no sooner than 08/31/2026.  The following /entitlements/query can be used for this content.

### Get Entitlement Summaries (deprecated)

 - [GET /entitlements/summaries](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/getsummary_1.md): Retrieves summarized entitlement utilization data for the authenticated tenant, providing an overview of license usage and availability. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/utilizations/query can be used for this content.

### Retrieve MSP bulk license pools (deprecated)

 - [GET /mspEntitlements](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/getmspentitlements.md): Retrieves all MSPs bulk entitlements for the authenticated tenant. MSP bulk entitlements are large license pools that MSPs purchase and can then allocate to their customer tenants through assignments. Each entitlement includes details such as device type, SKUs, quantity, effective date, expiration date, and trial status. The response returns a list of MspEntitlement objects containing all bulk licenses available to the MSP. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/query can be used for this content.

### Sync MSP entitlement summaries (deprecated)

 - [GET /mspEntitlements/summaries](https://docs.ruckus.cloud/deprecated_apis/entitlement-0.2.0/entitlement/syncmspentitlements.md): 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.