Skip to content
Tenant Management/
/
Get Account

Tenant Management (v0.3.0)

Overview

The Tenant Management API provides comprehensive capabilities for managing tenant accounts, administrators, authentication methods, and access delegation in RUCKUS cloud. This API enables you to configure tenant settings, manage administrator access with role based permissions, control delegation relationships, and customize user preferences.

The API is designed for organizations that need to manage tenant configurations, control administrator assignments, configure authentication methods, and establish delegation relationships with support teams or value added reseller partners.

What This API Does

  • Tenant Configuration: Retrieve and update tenant information including organization details, service tier settings, and branding preferences
  • Administrator Management: Create, retrieve, update, and delete administrator accounts with role assignments, privilege group configurations, and granular permission control
  • Delegation Management: Manage delegation relationships with RUCKUS customer support, value added reseller partners, managed service providers, integrators, and installers for temporary or ongoing access
  • User Profile: Retrieve and update user profile settings including contact information, regional preferences, and application preferences
  • Authentication: Configure and manage OAuth and SAML authentication providers with domain mapping capabilities
  • Notifications: Configure notification recipients and delivery endpoints for email, SMS, and mobile push notifications
  • Query Operations: Retrieve administrator and notification recipient data with pagination, sorting, and filtering
  • Privacy Features: Manage privacy feature settings for compliance and data protection requirements
  • Beta Features: Enable or disable beta features for early access to new functionality
  • Account Information: Retrieve detailed account information including organization details and location data

Common Use Cases

  • Enterprise Tenant Management: Configure tenant settings and branding for large organizations with multiple administrators
  • Regional Deployment: Manage tenant configurations across North America, Europe, and Asia Pacific regions
  • Partner Support Access: Enable temporary or ongoing access for support teams and service providers
  • Compliance Management: Control privacy settings and data protection features to meet regulatory requirements

Technical Details

  • API Version: v0.3.0
  • Content Types: Supports application/json and application/vnd.ruckus.v1+json for v1 endpoints
  • Regional Endpoints: Available in North America, Europe, and Asia Pacific regions

Authentication & Authorization

This API uses bearer token authentication with role based access control. Administrators must have appropriate permissions to perform operations on tenant accounts, administrator records, and delegation relationships.

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 Asian region.
https://api.asia.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud

Notification Recipient

Manage notification recipient configurations for tenants.

Operations

Administrator

Manage administrator accounts and roles.

Operations

Delegation

Manage tenant delegation access rights.

Operations

Privacy Features

Manage tenant privacy feature settings.

Operations

User Profile

Manage administrator user profile settings.

Operations

Get User Profile

Request

Get user profile for the authenticated administrator.

No request payload

Responses

OK

Body
regionstring

Current geographic region for the user's API access.

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

External identifier for the user from the identity management system.

pverstringread-only

Protocol version for API compatibility.

companyNamestring

Company name associated with the administrator's account.

delegatedDogfoodboolean

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

firstNamestring

First name of the administrator user.

lastNamestring

Last name of the administrator user.

usernamestring

Username for the administrator account login.

rolesArray of stringsunique

Set of role names assigned to the administrator.

detailLevelstringrequired

Detail level for event log information displayed to the administrator.

Enum"ba""it""su""debug"
dateFormatstringrequired

Date format preference for displaying dates in the user interface.

Enum"mm/dd/yyyy""dd/mm/yyyy""yyyy/mm/dd"
newDateFormatstring

New date format string for customizing date display.

emailstring

Email address of the administrator user.

varboolean

Flag indicating whether the tenant is a value added reseller.

tenantIdstring

Tenant identifier for the administrator's primary tenant.

varTenantIdstring

Value added reseller tenant identifier if applicable.

adminIdstring

Administrator identifier unique to this administrator account.

supportbooleanread-only

Flag indicating whether this is a RUCKUS support account.

dogfoodbooleanread-only

Flag indicating whether this is a RUCKUS internal dog food account.

edgeBetastring

Edge beta feature access level for the administrator.

alphaStatusstring

Alpha feature access status for the administrator.

phoneNumberstring

Phone number associated with the administrator account.

customRoleNamestring

Custom role name assigned to the administrator.

customRoleTypestring

Custom role type defining the administrator's permissions.

privilegeGroupNamestring

Privilege group name defining the administrator's access level.

privilegeGroupTypestring

Privilege group type categorizing the administrator's permissions.

scopesArray of stringsunique

Set of permission scopes granted to the administrator.

preferredLanguagestring

Preferred language code for the user interface display.

preferredNotificationsobject(PreferredNotifications)

Preferred notification delivery methods for the administrator.

rolestringDeprecated

Deprecated administrator role name for backward compatibility.

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 settings for the authenticated administrator.

Body
required
regionstring

Current geographic region for the user's API access.

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

External identifier for the user from the identity management system.

companyNamestring

Company name associated with the administrator's account.

delegatedDogfoodboolean

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

firstNamestring

First name of the administrator user.

lastNamestring

Last name of the administrator user.

usernamestring

Username for the administrator account login.

rolesArray of stringsunique

Set of role names assigned to the administrator.

detailLevelstringrequired

Detail level for event log information displayed to the administrator.

Enum"ba""it""su""debug"
dateFormatstringrequired

Date format preference for displaying dates in the user interface.

Enum"mm/dd/yyyy""dd/mm/yyyy""yyyy/mm/dd"
newDateFormatstring

New date format string for customizing date display.

emailstring

Email address of the administrator user.

varboolean

Flag indicating whether the tenant is a value added reseller.

tenantIdstring

Tenant identifier for the administrator's primary tenant.

varTenantIdstring

Value added reseller tenant identifier if applicable.

adminIdstring

Administrator identifier unique to this administrator account.

edgeBetastring

Edge beta feature access level for the administrator.

alphaStatusstring

Alpha feature access status for the administrator.

phoneNumberstring

Phone number associated with the administrator account.

customRoleNamestring

Custom role name assigned to the administrator.

customRoleTypestring

Custom role type defining the administrator's permissions.

privilegeGroupNamestring

Privilege group name defining the administrator's access level.

privilegeGroupTypestring

Privilege group type categorizing the administrator's permissions.

scopesArray of stringsunique

Set of permission scopes granted to the administrator.

preferredLanguagestring

Preferred language code for the user interface display.

preferredNotificationsobject(PreferredNotifications)

Preferred notification delivery methods for the administrator.

rolestringDeprecated

Deprecated administrator role name for backward compatibility.

{
  "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

Unique identifier for tracking this API request.

responseobject(UserProfile)

Response payload containing the requested data or operation result.

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 for the authenticated administrator.

No request payload

Responses

OK

Body
userFullNamestring

Full name of the primary user associated with this account.

userEmailstring

Email address of the primary user associated with this account.

accountNamestring

Name of the account in the system.

accountSapIdstring

SAP identifier for the account.

assetSerialNumberstring

Serial number of the asset associated with this account.

organizationstring

Organization or company name for this account.

addressstring

Street address for the account location.

citystring

City for the account location.

stateOrProvincestring

State or province for the account location.

zipstring

Postal code or zip code for the account location.

countrystring

Country for the account location.

Response
{
  "userFullName": "string",
  "userEmail": "string",
  "accountName": "string",
  "accountSapId": "string",
  "assetSerialNumber": "string",
  "organization": "string",
  "address": "string",
  "city": "string",
  "stateOrProvince": "string",
  "zip": "string",
  "country": "string"
}

Tenant

Manage tenant accounts and configurations.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations