Skip to content

MSP Services (V0.3.3)

Documentation for Dashboard API

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/

Managed-Tenant Operations

Managed-Tenant Operations

Operations

Tenant Delegation Management

Operations

Resend email Invitation

Operations

Admin Delegation Management

Operations

Retrieve Administrator

Request

Retrieve an administrator.

Path
tenantIdstringrequired
adminIdstringrequired
No request payload

Responses

Ok

Body
emailstring

The email address of MSP EC administrator.

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

The user name of MSP EC administrator.

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

The full name of MSP EC administrator.

Example: "John Wang"
first_namestring or null

The first name of MSP EC administrator.

Example: "John"
last_namestring or null

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.

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

The email address of the MSP EC administrator.

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

The user name of the MSP EC administrator.

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

The full name of the MSP EC administrator.

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

The first name of the MSP EC administrator.

Example: "John"
last_namestring or null[ 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

Revoke Administrator

Request

Revoke an administrator.

Path
tenantIdstringrequired
adminIdstringrequired
No request payload

Responses

No Content

Body
Response
null

Retrieve Active Relationships Between Designated Administrators and Their Assigned Tenants

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 Active Relationships Between Designated Administrators and Their Managed Tenant

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
tenantIdstring
Response
{
  "requestId": "string",
  "tenantId": "string"
}

Assign Administrators

Request

Add designated administrators to manage assigned tenants.

Body
required
associationsArray of objects(MspAdmin)[ 1 .. 200 ] itemsunique
{
  "associations": [
    { … }
  ]
}

Responses

Accepted

Body
string
Response
"string"

Retrieve Administrators

Request

Retrieve administrators.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
string
Response
"string"

Reactivation

Operations

Reactivation and Deactivation

Operations

Deactivation

Operations

Support Team assistance

Operations

Enable Support Team Assistance

Operations

Support Team Assistance

Operations

Disable Support Team Assistance

Operations

Brand Settings

Operations

Manage Firmware Upgrade Schedules

Operations