Get Tenant

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

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

Tenant

Manage tenant accounts and configurations.

Operations

Get Tenant

Request

Get tenant by identifier.

Query

deepboolean

No request payload

Responses

Body

idstring

createdDatestring(date-time)read-only

Timestamp when this entity was created.

updatedDatestring(date-time)read-only

Timestamp when this entity was last updated.

entitlementIdstringread-only

Entitlement identifier for license and subscription management.

externalModifiedDatestring(date-time)

Date when the tenant record was last modified in the external system.

namestring

Display name of the tenant or organization.

externalIdstringrequired

External identifier for this tenant from the source system.

adminsArray of objects(Admin)

List of administrators who have access to manage this tenant.

notificationRecipientsArray of objects(NotificationRecipient)

List of notification recipients configured for this tenant.

authenticationsArray of objects(Authentication)

List of authentication configurations available for this tenant.

almActivatedboolean

Indicates whether this tenant is activated in the analytic and logging module.

almActivationDatestring(date-time)

Date when analytic and logging module was activated for this tenant.

almSysAccountIdstring

System account identifier for analytic and logging module.

almMigrationFlagboolean

Indicates whether this tenant has been migrated from analytic and logging module.

almMigrationDatestring(date-time)

Date when analytic and logging module migration was performed.

accountTierstring

Service tier level for this tenant account (e.g., bronze, silver, gold, premium).

accountVerticalstring

Industry vertical or business category for this tenant account.

obsoleteboolean

Tenant is no longer used or active.

oemNamestring

Original equipment manufacturer name if this tenant is OEM branded.

mspobject(Msp)

Managed service provider branding and configuration settings.

MspEcServiceDatesobject(MspEc)

Managed service provider end customer service dates and parent information.

tenantMFAobject(TenantMFA)

Multifactor authentication configuration for this tenant.

serviceAccountboolean

Indicates whether this is a service account tenant.

mspPingOrgIdstring

Ping identity organization identifier for this managed service provider.

aggregateNotificationsboolean

Indicates whether notification aggregation is enabled for this tenant.

excludeecforAggregationboolean

Indicates whether end customers are excluded from notification aggregation.

pingMigratedboolean

Indicates whether this tenant has been migrated to ping identity.

inMaintenanceboolean

Indicates whether this tenant is currently in maintenance mode.

accountobject(Account)

Account information including address and contact details for this tenant.

extendedTrialboolean

Indicates whether this tenant has an extended trial period.

propertyCodestring

Property code for hospitality or venue based tenants.

expirationEnforcementboolean

Indicates whether license expiration enforcement is enabled for this tenant.

expirationEnforcementDatestring(date-time)

Date when license expiration enforcement becomes effective.

preferencesstring

User preferences and settings stored in JSON format.

isActivatedboolean

Indicates whether this tenant is activated and operational.

ruckusUserboolean

Indicates whether this is a RUCKUS internal user tenant.

delegationsToArray of objects(Delegation)

List of delegation relationships where this tenant is the recipient.

parentIdstringread-only

Identifier of the parent entity in the hierarchy.

statusstring

Tenant status.

Enum	Meaning
active	The account is active.
suspended	The account has been administratively suspended for an indefinite period of time; while in this state, login are disabled.
maintenance	The account is temporarily undergoing maintenance; while in this state, login are disabled.
deleted	The account has been deleted; although a record of the account exists, all other Network management configuration and data has been deleted.

Enum"active""suspended""deleted""maintenance"

tenantTypestring

Tenant type.

Enum	Meaning
REC	RUCKUS end customer.
VAR	Value added reseller.
MSP	Managed service provider.
MSP_EC	MSP's end customer.
MSP_NON_VAR	This value is reserved for RUCKUS purposes.
MSP_INSTALLER	Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR	Installer organization which administratively reports to an MSP.
UNKNOWN	Unknown.

Enum"REC""MSP""MSP_EC""VAR""MSP_NON_VAR""UNKNOWN""MSP_INSTALLER""MSP_INTEGRATOR""MSP_REC"

subscribesstring

Notification subscription preferences configured for this tenant.

maintenanceStatebooleanDeprecatedread-only

Indicates whether the tenant is in maintenance mode.

maintenanceDatestring(date-time)Deprecatedread-only

Date when maintenance mode was last activated.

upgradeGroupstringDeprecatedread-only

Deprecated upgrade group identifier for tenant grouping.

Response

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "entitlementId": "string",
  "externalModifiedDate": "2019-08-24T14:15:22Z",
  "maintenanceState": true,
  "maintenanceDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "externalId": "string",
  "admins": [
    { … }
  ],
  "notificationRecipients": [
    { … }
  ],
  "authentications": [
    { … }
  ],
  "almActivated": true,
  "almActivationDate": "2019-08-24T14:15:22Z",
  "almSysAccountId": "string",
  "almMigrationFlag": true,
  "almMigrationDate": "2019-08-24T14:15:22Z",
  "accountTier": "string",
  "accountVertical": "string",
  "obsolete": true,
  "oemName": "string",
  "upgradeGroup": "string",
  "msp": {
    "mspLabel": "string",
    "mspFQDN": "string",
    "logoUUID": "string",
    "alarmNotificationLogoUUID": "string",
    "pingNotificationLogoUUID": "string",
    "mlisaLogoUUID": "string",
    "pingLoginLogoUUID": "string",
    "defaultLogoUUID": "string",
    "contactSupportUrl": "string",
    "contractSupportBehavior": "string",
    "openCaseUrl": "string",
    "openCaseBehavior": "string",
    "myOpenCaseUrl": "string",
    "myOpenCaseBehavior": "string",
    "changePasswordUrl": "string",
    "phone": "string",
    "email": "string",
    "website": "string",
    "isDisableNotification": true
  },
  "MspEcServiceDates": {
    "parentMspId": "string",
    "serviceExpirationDate": "2019-08-24T14:15:22Z",
    "serviceEffectiveDate": "2019-08-24T14:15:22Z"
  },
  "tenantMFA": {
    "mfaStatus": "string",
    "recoveryCodes": "string"
  },
  "serviceAccount": true,
  "mspPingOrgId": "string",
  "aggregateNotifications": true,
  "excludeecforAggregation": true,
  "pingMigrated": true,
  "inMaintenance": true,
  "account": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "streetAddress": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "city": "string",
    "type": "string",
    "mappingURL": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "parentId": "string"
  },
  "extendedTrial": true,
  "propertyCode": "string",
  "expirationEnforcement": true,
  "expirationEnforcementDate": "2019-08-24T14:15:22Z",
  "preferences": "string",
  "isActivated": true,
  "ruckusUser": true,
  "delegationsTo": [
    { … }
  ],
  "parentId": "string",
  "status": "active",
  "tenantType": "REC",
  "subscribes": "string"
}

Update a Tenant

Request

Update tenant information such as tenant name, tenant type, and external identifier.

Body

required

newIdmIdstring

New identity management identifier for the tenant.

varboolean

Indicates whether this tenant is a value added reseller.

tenantNamestring

Name of the tenant or organization.

enableMfastring

Indicates whether multifactor authentication is enabled for the tenant.

enableSaboolean

Indicates whether service account functionality is enabled.

enableBetaboolean

Indicates whether beta features are enabled for this tenant.

enableAlphaboolean

Indicates whether alpha features are enabled for this tenant.

entitlementIdstring

Entitlement identifier for license and subscription management.

subscribesstring

Notification subscription preferences for the tenant.

requestIdstring

Unique identifier for tracking this API request.

responsestring

Response message or status from the operation.

userNamestring

Username of the person performing the operation.

missingAdminIdsArray of strings

List of administrator IDs that were not found during the operation.

{
  "newIdmId": "string",
  "var": true,
  "tenantName": "string",
  "enableMfa": "string",
  "enableSa": true,
  "enableBeta": true,
  "enableAlpha": true,
  "entitlementId": "string",
  "subscribes": "string",
  "requestId": "string",
  "response": "string",
  "userName": "string",
  "missingAdminIds": [
    "string"
  ]
}

Responses

Body

requestIdstring

Unique identifier for tracking this API request.

Response

{
  "requestId": "string"
}

Get Beta Feature Identifiers

Request

Get list of beta features.

No request payload

Responses

Body

betaFeaturesArray of objects(BetaFeature)

List of beta features with their enabled status.

errorMessagestring

Error message if the beta feature operation failed.

invalidFeatureIdsArray of strings

List of feature identifiers that were invalid or not found.

Response

{
  "betaFeatures": [
    { … }
  ],
  "errorMessage": "string",
  "invalidFeatureIds": [
    "string"
  ]
}

Update Beta Feature Identifiers

Request

Update beta feature identifiers.

Body

required

betaFeatureIdsArray of stringsunique

Set of beta feature identifiers to configure.

{
  "betaFeatureIds": [
    "string"
  ]
}

Responses

Body

betaFeaturesArray of objects(BetaFeature)

List of beta features with their enabled status.

errorMessagestring

Error message if the beta feature operation failed.

invalidFeatureIdsArray of strings

List of feature identifiers that were invalid or not found.

Response

{
  "betaFeatures": [
    { … }
  ],
  "errorMessage": "string",
  "invalidFeatureIds": [
    "string"
  ]
}

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations