Skip to content

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

Get User Profile

Request

Get user profile.

No request payload

Responses

OK

Body
regionstring
allowedRegionsArray of objects(Region)unique

Regions are the continents to which the user is allowed. Currently permitted regions are North America, European Union and Asia.

externalIdstring
pverstringread-only
companyNamestring
delegatedDogfoodboolean

Delegation to a dog food account (internal RUCKUS test accounts, named per the saying, eat your own dog food).

firstNamestring
lastNamestring
usernamestring
rolesArray of stringsunique
detailLevelstringrequired
Enum"ba""it""su""debug"
dateFormatstringrequired
Enum"mm/dd/yyyy""dd/mm/yyyy""yyyy/mm/dd"
newDateFormatstring
emailstring
varboolean
tenantIdstring
varTenantIdstring
adminIdstring
supportbooleanread-only
dogfoodbooleanread-only
edgeBetastring
alphaStatusstring
phoneNumberstring
customRoleNamestring
customRoleTypestring
privilegeGroupNamestring
privilegeGroupTypestring
scopesArray of stringsunique
preferredLanguagestring
preferredNotificationsobject(PreferredNotifications)
rolestringDeprecated
Response
{
  "region": "string",
  "allowedRegions": [
    { … }
  ],
  "externalId": "string",
  "pver": "string",
  "companyName": "string",
  "delegatedDogfood": true,
  "firstName": "string",
  "lastName": "string",
  "username": "string",
  "role": "string",
  "roles": [
    "string"
  ],
  "detailLevel": "ba",
  "dateFormat": "mm/dd/yyyy",
  "newDateFormat": "string",
  "email": "string",
  "var": true,
  "tenantId": "string",
  "varTenantId": "string",
  "adminId": "string",
  "support": true,
  "dogfood": true,
  "edgeBeta": "string",
  "alphaStatus": "string",
  "phoneNumber": "string",
  "customRoleName": "string",
  "customRoleType": "string",
  "privilegeGroupName": "string",
  "privilegeGroupType": "string",
  "scopes": [
    "string"
  ],
  "preferredLanguage": "string",
  "preferredNotifications": {
    "emailPreferences": true,
    "smsPreferences": true
  }
}

Update User Profile

Request

Update user profile.

Body
required
regionstring
allowedRegionsArray of objects(Region)unique

Regions are the continents to which the user is allowed. Currently permitted regions are North America, European Union and Asia.

externalIdstring
companyNamestring
delegatedDogfoodboolean

Delegation to a dog food account (internal RUCKUS test accounts, named per the saying, eat your own dog food).

firstNamestring
lastNamestring
usernamestring
rolesArray of stringsunique
detailLevelstringrequired
Enum"ba""it""su""debug"
dateFormatstringrequired
Enum"mm/dd/yyyy""dd/mm/yyyy""yyyy/mm/dd"
newDateFormatstring
emailstring
varboolean
tenantIdstring
varTenantIdstring
adminIdstring
edgeBetastring
alphaStatusstring
phoneNumberstring
customRoleNamestring
customRoleTypestring
privilegeGroupNamestring
privilegeGroupTypestring
scopesArray of stringsunique
preferredLanguagestring
preferredNotificationsobject(PreferredNotifications)
rolestringDeprecated
{
  "region": "string",
  "allowedRegions": [
    { … }
  ],
  "externalId": "string",
  "companyName": "string",
  "delegatedDogfood": true,
  "firstName": "string",
  "lastName": "string",
  "username": "string",
  "role": "string",
  "roles": [
    "string"
  ],
  "detailLevel": "ba",
  "dateFormat": "mm/dd/yyyy",
  "newDateFormat": "string",
  "email": "string",
  "var": true,
  "tenantId": "string",
  "varTenantId": "string",
  "adminId": "string",
  "edgeBeta": "string",
  "alphaStatus": "string",
  "phoneNumber": "string",
  "customRoleName": "string",
  "customRoleType": "string",
  "privilegeGroupName": "string",
  "privilegeGroupType": "string",
  "scopes": [
    "string"
  ],
  "preferredLanguage": "string",
  "preferredNotifications": {
    "emailPreferences": true,
    "smsPreferences": true
  }
}

Responses

Accepted

Body
requestIdstring
responseobject(UserProfile)
Response
{
  "requestId": "string",
  "response": {
    "region": "string",
    "allowedRegions": [ … ],
    "externalId": "string",
    "pver": "string",
    "companyName": "string",
    "delegatedDogfood": true,
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "role": "string",
    "roles": [ … ],
    "detailLevel": "ba",
    "dateFormat": "mm/dd/yyyy",
    "newDateFormat": "string",
    "email": "string",
    "var": true,
    "tenantId": "string",
    "varTenantId": "string",
    "adminId": "string",
    "support": true,
    "dogfood": true,
    "edgeBeta": "string",
    "alphaStatus": "string",
    "phoneNumber": "string",
    "customRoleName": "string",
    "customRoleType": "string",
    "privilegeGroupName": "string",
    "privilegeGroupType": "string",
    "scopes": [ … ],
    "preferredLanguage": "string",
    "preferredNotifications": { … }
  }
}

Get Account

Request

Get account details.

No request payload

Responses

OK

Bodyapplication/json
organizationstring
addressstring
citystring
stateOrProvincestring
zipstring
countrystring
Response
application/json
{
  "organization": "string",
  "address": "string",
  "city": "string",
  "stateOrProvince": "string",
  "zip": "string",
  "country": "string"
}

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations