Entitlements (v0.2.0)

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.