Skip to content
/
Add Managed Tenants

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

Retrieve Managed Tenant

Request

Retrieve a managed tenant.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
msp_labelstring

The MSP label.

Example: "msp-label"
namestring

The name of MSP-EC account.

Example: "Acme Sales"
street_addressstring or null

The street address of MSP-EC account.

Example: "350 West Java st"
statestring or null

The state of MSP-EC account.

Example: "CA"
countrystring or null

The country of MSP-EC account.

Example: "US"
postal_codestring or null

The postal code of MSP-EC account.

Example: "95089"
phone_numberstring or null

The phone number of MSP-EC account.

Example: "650-123-4567"
fax_numberstring or null

The fax number of MSP-EC account.

Example: "650-123-9999"
citystring or null

The city of MSP-EC account.

Example: "Sunnyvale"
mapping_urlstring or null

The map URL of MSP-EC account.

Example: "https//map.gogle.com/zsdweews"
service_effective_datestring

The effective date of MSP-EC account.

Example: "2019-09-14 01:12:51Z"
service_expiration_datestring

The expiration date of MSP-EC account.

Example: "2020-09-14 01:12:51Z"
is_activestring or null

Active state of MSP-EC account.

Example: "true"
tenant_idstring

Tenant ID.

Example: "6173ca160495421c95be47b42b349067"
parent_tenant_idstring

Parent tenant ID.

Example: "6173ca160495421c95be47b42b349067"
tenant_typestring

The tenant type of the MSP EC administrator.

Example: "MSP, MSP_INTEGRATOR, MSP_INSTALLER"
account_idstring

Account ID.

Example: "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS"
tierstring

Account ID.

Example: "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS"
logo_urlstring
privacyFeaturesArray of objects(PrivacyFeatureResponse)unique

Privacy features

Response
{
  "msp_label": "msp-label",
  "name": "Acme Sales",
  "street_address": "350 West Java st",
  "state": "CA",
  "country": "US",
  "postal_code": "95089",
  "phone_number": "650-123-4567",
  "fax_number": "650-123-9999",
  "city": "Sunnyvale",
  "mapping_url": "https//map.gogle.com/zsdweews",
  "service_effective_date": "2019-09-14 01:12:51Z",
  "service_expiration_date": "2020-09-14 01:12:51Z",
  "is_active": "true",
  "tenant_id": "6173ca160495421c95be47b42b349067",
  "parent_tenant_id": "6173ca160495421c95be47b42b349067",
  "tenant_type": "MSP, MSP_INTEGRATOR, MSP_INSTALLER",
  "account_id": "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS",
  "tier": "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS",
  "logo_url": "string",
  "privacyFeatures": [
    { … }
  ]
}

Update Managed Tenant

Request

Update a managed tenant.

Path
tenantIdstringrequired
Body
required
namestring[ 0 .. 255 ] charactersrequired

The name of the MSP-EC account.

Example: "Acme Sales"
street_addressstring or null[ 0 .. 255 ] characters

The street address of the MSP-EC account.

Example: "350 West Java st"
statestring or null[ 0 .. 255 ] characters

The state of the MSP-EC account.

Example: "CA"
countrystring or null[ 0 .. 255 ] characters

The country of the MSP-EC account.

Example: "US"
postal_codestring or null[ 0 .. 255 ] characters

The postal code of the MSP-EC account.

Example: "95089"
phone_numberstring or null[ 0 .. 255 ] characters

The phone number of the MSP-EC account.

Example: "650-123-4567"
fax_numberstring or null[ 0 .. 255 ] characters

The fax number of the MSP-EC account.

Example: "650-123-9999"
citystring or null[ 0 .. 255 ] characters

The city of the MSP-EC account.

Example: "Sunnyvale"
mapping_urlstring or null[ 0 .. 255 ] characters

The map URL of the MSP-EC account.

Example: "https//map.gogle.com/zsdweews"
service_effective_datestringrequired

The effective date of the MSP-EC account.

Example: "2019-09-14 01:12:51.805Z"
service_expiration_datestringrequired

The expiration date of the MSP-EC account.

Example: "2020-09-14 01:12:51.805Z"
licensesobject(License)

license information

tierstring

MSP-EC tier info

Example: "GOLD, PLATINUM"
privacyFeaturesArray of objects(PrivacyFeatureRequest)[ 0 .. 1 ] itemsunique

Privacy features

{
  "name": "Acme Sales",
  "street_address": "350 West Java st",
  "state": "CA",
  "country": "US",
  "postal_code": "95089",
  "phone_number": "650-123-4567",
  "fax_number": "650-123-9999",
  "city": "Sunnyvale",
  "mapping_url": "https//map.gogle.com/zsdweews",
  "service_effective_date": "2019-09-14 01:12:51.805Z",
  "service_expiration_date": "2020-09-14 01:12:51.805Z",
  "licenses": {
    "trialAction": "ACTIVATE",
    "assignments": [ … ],
    "subscription_start_date": "string",
    "subscription_end_date": "string"
  },
  "tier": "GOLD, PLATINUM",
  "privacyFeatures": [
    { … }
  ]
}

Responses

Accepted

Body
requestIdstringrequired
tenantIdstring
Response
{
  "requestId": "string",
  "tenantId": "string"
}

Remove Managed Tenant

Request

Remove a managed tenant.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
requestIdstringrequired
tenantIdstring
Response
{
  "requestId": "string",
  "tenantId": "string"
}

Add Managed Tenants

Request

Add managed tenants.

Body
required
dataArray of objects(AddMspEcRequestV1_4)[ 1 .. 100 ] itemsunique
{
  "data": [
    { … }
  ]
}

Responses

Accepted

Body
dataArray of objects(ResponseBo)required
data[].​requestIdstringrequired
data[].​tenantIdstring
Response
{
  "data": [
    { … }
  ]
}

Tenant Delegation Management

Operations

Resend email Invitation

Operations

Admin Delegation Management

Operations

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

tenant-device-query-controller

Operations

Manage Firmware Upgrade Schedules

Operations