Skip to content
MSP Services/
/
List Tenant Administrator...

MSP Services (V0.3.3)

Overview

The MSP API provides comprehensive management capabilities for managing multiple MSP managed tenant accounts. This API enables you to manage tenant accounts, control administrator access, customize branding, and schedule firmware upgrades.

The API is designed for managed service providers that manage multiple customer tenant accounts and need to control access delegation, branding customization, and device management operations.

What This API Does

  • MSP Tenant Management: Create, retrieve, update, and delete MSP managed tenant accounts and configuration settings
  • MSP Tenant Queries: Query and retrieve MSP customer or tech partner data
  • MSP Administrator Access Control: Grant or revoke MSP administrator access with role based permissions, delegation capabilities, and cross tenant access control
  • MSP Tenant Activation Management: Control MSP tenant status including activation, deactivation, and temporary support team access for troubleshooting
  • MSP Branding Customization: Configure custom branding for MSP tenants including logo uploads and brand settings
  • MSP Firmware Upgrade Scheduling: Schedule and manage firmware upgrades across managed devices
  • MSP Tenant Delegations: Establish and manage delegation relationships between MSP accounts, technology partners, and customer tenants
  • MSP Administrator Delegations: Manage administrator assignments and access permissions for MSP tenant accounts
  • MSP Administrator Invitations: Send email invitations to MSP administrators for tenant access and onboarding

Key Capabilities

  • Multi Tenant Operations: Manage multiple isolated MSP tenant accounts with independent configurations and administrator assignments
  • MSP Delegation Support: Support delegation between MSP accounts, integrators, installers, and tenant administrators
  • Role Based Access: Assign MSP administrators with specific roles and privilege groups for granular access control
  • MSP Tenant Management: Complete MSP tenant management from creation through deactivation and deletion
  • Support Access Control: Enable or disable temporary support team access to MSP tenants for assistance
  • Custom Branding: Upload and manage custom logos and branding configurations for MSP service delivery
  • Scheduled Upgrades: Configure firmware upgrade schedules with recurring or one time scheduling options for MSP managed devices
  • Query Capabilities: Retrieve MSP tenant data

Authentication & Authorization

This API uses bearer token authentication with role based access control. MSP administrators must have appropriate permissions to perform operations on tenant accounts and delegation relationships.

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
URL
http://support.ruckuswireless.com
Support Team
support@ruckuswireless.com
License
RUCKUS Cloud Privacy Policy
Languages
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

Tenant Activation Management

Supports the activation and deactivation of a managed tenant. Control support team access for managed tenants.

Operations

View MSP

View MSP and VAR information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

Firmware Upgrade Scheduling

Manages firmware upgrade schedules for access points and switches. Supports recurring automated upgrades and one time manual scheduling options.

Operations

Query Inventory Information

Retrieves inventory information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Query Delegation Information

Retrieves delegation information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Query MSP Customer Information

Retrieves customer information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Tenant Delegation Management

Manages delegation relationships between service provider accounts, technology partners, installers, and tenant accounts. Supports assigning tenant accounts to technology partners and controlling organizational access permissions.

Operations

Administrator Access Control

Manages administrator assignments and access control for MSP tenant accounts. Supports assigning or removing administrators, configuring role based permissions and privilege groups, and managing cross tenant administrator access.

Operations

Get Administrator Details

Request

Retrieve detailed information for a specific administrator, including their assigned roles, permissions, and contact information.

Path
tenantIdstringrequired
adminIdstringrequired
No request payload

Responses

Ok

Body
emailstring

The email address of MSP EC administrator.

Example: "john.wang@sampledomain.com"
user_namestring

The user name of MSP EC administrator.

Example: "JohnWang or john.wang@sampledomain.com"
full_namestring

The full name of MSP EC administrator.

Example: "John Wang"
first_namestring

The first name of MSP EC administrator.

Example: "John"
last_namestring

The last name of MSP EC administrator.

Example: "Wang"
Response
{
  "email": "john.wang@sampledomain.com",
  "user_name": "JohnWang or john.wang@sampledomain.com",
  "full_name": "John Wang",
  "first_name": "John",
  "last_name": "Wang"
}

Assign Administrator

Request

Assign an administrator to the tenant account with specified roles and permissions, enabling them to manage tenant resources.

Path
tenantIdstringrequired
adminIdstringrequired
Bodyapplication/jsonrequired
emailstring[ 0 .. 255 ] charactersrequired

The email address of the MSP EC administrator.

Example: "john.wang@sampledomain.com"
user_namestring[ 0 .. 255 ] charactersrequired

The user name of the MSP EC administrator.

Example: "JohnWang or john.wang@sampledomain.com"
full_namestring[ 0 .. 255 ] characters

The full name of the MSP EC administrator.

Example: "John Wang"
first_namestring[ 0 .. 64 ] charactersrequired

The first name of the MSP EC administrator.

Example: "John"
last_namestring[ 0 .. 64 ] characters

The last name of the MSP EC administrator.

Example: "Wang"
application/json
{
  "email": "john.wang@sampledomain.com",
  "user_name": "JohnWang or john.wang@sampledomain.com",
  "full_name": "John Wang",
  "first_name": "John",
  "last_name": "Wang"
}

Responses

No Content

Body
Response
null

Remove Administrator

Request

Remove an administrator's access from the tenant account, revoking all their roles and permissions.

Path
tenantIdstringrequired
adminIdstringrequired
No request payload

Responses

No Content

Body
Response
null

Retrieve Admin Delegations

Request

Retrieve active relationships between designated administrators and their assigned tenants.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
Array [
msp_admin_idstringrequired

The admin ID of MSP tenant.

Example: "4c2b196a205d11ea978f-2e728ce88125"
msp_admin_rolestring[ 0 .. 255 ] charactersrequired

The admin role of the first MSP administrator.

Example: "PRIME_ADMIN"
]
Response
[
  {
    "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
    "msp_admin_role": "PRIME_ADMIN"
  }
]

Update Admin Delegations

Request

Update active relationships between designated administrators and their managed tenant.

Path
tenantIdstringrequired
Body
required
mspec_listArray of objects(MspAdminRole)

List of MSP EC admins to be assigned.

delegation_typestringrequired

The type of MSP EC delegated tenant.

Example: "delegationtype"
privilege_group_idsArray of stringsunique

Privilege groups to manage accounts.

{
  "mspec_list": [
    { … }
  ],
  "delegation_type": "delegationtype",
  "privilege_group_ids": [
    "string"
  ]
}

Responses

Accepted

Body
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response
{
  "requestId": "string",
  "tenantId": "string"
}

Assign Administrators

Request

Add designated administrators to manage assigned tenants.

Body
required
associationsArray of objects(MspAdmin)[ 1 .. 200 ] itemsunique

Set of MSP administrator associations to create or modify for customer accounts.

{
  "associations": [
    { … }
  ]
}

Responses

Accepted

Body
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response
{
  "requestId": "string",
  "tenantId": "string"
}

List Tenant Administrators

Request

Retrieve a complete list of all administrators assigned to the tenant account, including their roles and permissions.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response
{
  "requestId": "string",
  "tenantId": "string"
}

Tenant Account Management

Manages tenant accounts including creation, retrieval, updates, and deletion. Supports sending email invitations to tenant administrators and managing account configurations.

Operations

Brand Customization

Manages branding customization for managed service provider accounts. Supports uploading logo images, configuring contact information and portal settings such as custom domain names and support URLs.

Operations