Revoke Access

Tenant Management API (v0.3.0)

Ruckus Network Technical Documents

Overview

This document provides information about Tenant management.

Rate Limit

For the Ptenant REST API the following will be true:

Limits are applied to each tenant.
A maximum of 200 calls can be made per second.
Each second 100 calls will be returned to be used.

Download OpenAPI description

Download PDF

Servers

North American region

https://api.ruckus.cloud/

Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

Notification Recipient

Manage notification recipients.

Operations

Tenant

Manage tenants.

Operations

Delegation

Manage delegations.

Operations

Get Delegation

Request

Get delegation by ID.

Path

delegationIdstringrequired

No request payload

Responses

Body

idstring

createdDatestring(date-time)read-only

updatedDatestring(date-time)read-only

delegatedTostring

typestring

Enum	Meaning
VAR	Return delegations to this VAR.
SUPPORT	Return delegations to RUCKUS customer support.
MSP	Return the MSP's MSP-ECs.
SUPPORT_EC	Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER	Return the MSP's installers.
MSP_INTEGRATOR	Return the MSP's integrators.
UNKNOWN	Unknown.

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

statusstring

Enum"INVITED""ACCEPTED""REJECTED""REVOKED"

delegatedBystring

expiryDatestring(date-time)

delegatedToNamestring

parentIdstringread-only

isValidboolean

delegatedToAdminstringDeprecated

Response

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "delegatedTo": "string",
  "type": "VAR",
  "status": "INVITED",
  "delegatedBy": "string",
  "expiryDate": "2019-08-24T14:15:22Z",
  "delegatedToName": "string",
  "delegatedToAdmin": "string",
  "parentId": "string",
  "isValid": true
}

Respond to Delegation

Request

A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.

Path

delegationIdstringrequired

Body

required

acceptbooleanrequired

fromTenantIdstringrequired

{
  "accept": true,
  "fromTenantId": "string"
}

Responses

Accepted

Body

requestIdstring

responseobject(Delegation)

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

Revoke VAR Delegation

Request

Revoke VAR delegation by ID.

Path

delegationIdstringrequired

No request payload

Responses

Accepted

Body

requestIdstring

responseobject

Response

{
  "requestId": "string",
  "response": {}
}

Grant Access

Request

Grant Ruckus customer support access to my account.

No request payload

Responses

Accepted

Bodyapplication/json

requestIdstring

responseobject(Delegation)

Response

application/json

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

Revoke Access

Request

Revoke Ruckus customer support's access to my account.

No request payload

Responses

Accepted

Bodyapplication/json

requestIdstring

responseobject

Response

application/json

{
  "requestId": "string",
  "response": {}
}

Get Delegations

Request

Get delegation list.

Query

typestring

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

No request payload

Responses

Body

Array [

idstring

createdDatestring(date-time)read-only

updatedDatestring(date-time)read-only

delegatedTostring

typestring

Enum	Meaning
VAR	Return delegations to this VAR.
SUPPORT	Return delegations to RUCKUS customer support.
MSP	Return the MSP's MSP-ECs.
SUPPORT_EC	Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER	Return the MSP's installers.
MSP_INTEGRATOR	Return the MSP's integrators.
UNKNOWN	Unknown.

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

statusstring

Enum"INVITED""ACCEPTED""REJECTED""REVOKED"

delegatedBystring

expiryDatestring(date-time)

delegatedToNamestring

parentIdstringread-only

isValidboolean

delegatedToAdminstringDeprecated

]

Response

[
  {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
]

Invite VAR

Request

Send invitation to VAR (aka delegate) to manage my account.This operation is not supported using client credentials.

Body

required

usernamestring

{
  "username": "string"
}

Responses

Accepted

Body

requestIdstring

responseobject(Delegation)

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

User Profile

Manage user profiles.

Operations

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations