The following table describes the type of businesses (aka organizations) that use these API endpoints. Not all endpoints are useful for every business entity.
| Abbreviation | Description |
|---|---|
| REC | RUCKUS end customer. RUCKUS end customers use API endpoints to manage their own account and networks. |
| VAR | Value-added reseller. VARs can manage the account (including networks) of specific RECs. In order for a VAR to manage an REC's account, the REC must first invite the VAR to manage their account and the VAR must accept the invitation. A successful invitation and acceptance process is modeled by a delegation resource. API endpoints in the "Delegation" API group are used to manage these delegations. In order for a VAR to manage (configure and monitor) an REC’s account using API endpoints, the VAR’s API client must log into their own account and then identify the tenant they are acting on by providing the "x-rks-tenantid" to identify the tenant. All API calls will need to include the JWT and the customer header. When a VAR is managing an REC’s network, the VAR may need to install devices in that network on behalf of the REC. Entitlements which the REC has purchased and activated are used for this purpose. VAR accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the VAR’s account (including networks) in the same way endpoints are used to manage an REC’s account. A VAR must have their own entitlements to install devices in their own network. |
| MSP | Managed service provider. MSPs have their own customers, referred to as MSP-ECs, which are not known to RUCKUS. MSPs manage the accounts (including networks) of all their MSP-ECs. MSP-ECs and the resources that represent them are "created" by an MSP. These resources are not visible to any other business entity. MSPs use the endpoints defined in "MSP Services" to configure and brand their business as well as to create and manage MSP-EC resources. Note that MSP to MSP-EC relationships are modeled as a delegation resource (as is done for VARs and RECs). However, MSP to MSP-EC delegation resources are created automatically, requiring no action on the part of an MSP-EC. Moreover, an MSP to MSP-EC delegation cannot be revoked by the MSP-EC. In order for an MSP to manage (configure and monitor) an MSP-EC’s account using API endpoints, the MSP’s API client must obtain an API token for that MSP-EC; an endpoint in the "Manage API Client Authentication" group is used for this purpose (refer to Platform APIs and Model Documentation). MSPs use MSP entitlements (aka bulk licenses) to enable the installation of networking devices in MSP-EC networks. In order to install a networking device, one or more MSP entitlements are assigned to an MSP-EC; this action creates an assignment resource. Once assignment resources are created, devices can be installed. MSP API clients use the endpoints in the "MSP Entitlement" API group to manage their MSP entitlements and assignments. MSP accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the MSP’s account (including networks) in the same way endpoints are used to manage an REC’s account. Note that entitlements (that is, not MSP entitlements) purchased by the MSP are used to install devices in their own networks. |
| MSP-EC | MSPs end customer. MSP-ECs can use API endpoints to manage their own networks, if permitted by their MSP. |
Entitlements (aka licenses) are purchased by an account holder and entitle that account to install networking devices in their venues. After purchase, entitlements must be "activated" using the RUCKUS Support website before becoming effective for device installation. There are two classes of entitlements:
- Device entitlements, simply referred to as "entitlements", which entitle an account to provision/install one networking device per entitlement.
- MSP entitlements, used only by MSPs, are assigned to MSP-EC accounts, enabling the provision/installation of one networking device per assignment in an MSP-EC network.