Skip to content
/
Add Administrator

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
Languages
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

User Profile

Manage user profiles.

Operations

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

Get Administrator

Request

Get list of administrators.

Query
withExternalIdboolean
Default false
No request payload

Responses

OK

Body
Array [
idstring
externalIdstring
emailstringrequired
namestring
lastNamestring
phoneNumberstring
rolestringrequired
delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
Enum"ba""it""su""debug"
authenticationIdstring
]
Response
[
  {
    "id": "string",
    "externalId": "string",
    "email": "string",
    "name": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "role": "string",
    "delegateToAllECs": true,
    "delegatedECs": [ … ],
    "detailLevel": "ba",
    "authenticationId": "string"
  }
]

Update Administrator

Request

Update administrator.

Query
updateSwuIdboolean
Default false
Body
required
idstring
externalIdstring
emailstringrequired
namestring
lastNamestring
phoneNumberstring
rolestringrequired
delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
Enum"ba""it""su""debug"
authenticationIdstring
{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "string",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Responses

Accepted

Body
requestIdstring
responseobject(Admin)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "detailLevel": "ba",
    "externalId": "string",
    "adminRoles": [ … ],
    "adminAppSettings": [ … ],
    "dateFormat": "mm/dd/yyyy",
    "username": "string",
    "authentication": { … },
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "local": true,
    "defaultTenant": "string",
    "parentId": "string"
  }
}

Add Administrator

Request

Add administrator.

Body
required
idstring
externalIdstring
emailstringrequired
namestring
lastNamestring
phoneNumberstring
rolestringrequired
delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
Enum"ba""it""su""debug"
authenticationIdstring
{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "string",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Responses

Accepted

Body
requestIdstring
responseobject(Admin)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "detailLevel": "ba",
    "externalId": "string",
    "adminRoles": [ … ],
    "adminAppSettings": [ … ],
    "dateFormat": "mm/dd/yyyy",
    "username": "string",
    "authentication": { … },
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "local": true,
    "defaultTenant": "string",
    "parentId": "string"
  }
}

Delete Administrators

Request

Delete administrators in bulk.

Body
requiredArray [
string
]
[
  "string"
]

Responses

Accepted

Body
requestIdstring
responseobject
Response
{
  "requestId": "string",
  "response": {}
}

Get Administrator

Request

Get list of administrators.

Query
withExternalIdboolean
Default false
Bodyapplication/jsonrequired
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
Enum"name""username""role""authenticationType"
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
Items Enum"name""username"
searchStringstring
filtersobject
application/json
{
  "page": 0,
  "pageSize": 0,
  "sortField": "name",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "name"
  ],
  "searchString": "string",
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

OK

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(Sort)
pageableobject(PageableObject)
firstboolean
lastboolean
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

Get Administrator

Request

Get administrator by identifier.

Path
adminIdstringrequired
No request payload

Responses

OK

Body
idstring
externalIdstring
emailstringrequired
namestring
lastNamestring
phoneNumberstring
rolestringrequired
delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
Enum"ba""it""su""debug"
authenticationIdstring
Response
{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "string",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Delete Administrator

Request

Delete administrator by identifier.

Path
adminIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring
responseobject
Response
{
  "requestId": "string",
  "response": {}
}

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations