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

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations

Get Authentications

Request

Get all authentication configurations for the tenant.

Query

withExtendedRoleboolean

Default false

No request payload

Responses

Body

Array [

idstring

clientIDstring

OAuth client identifier used for authentication.

clientSecretstring

OAuth client secret for secure authentication.

scopesstring

OAuth scopes defining the level of access requested.

tokenURLstring

URL for obtaining OAuth tokens.

authorizationURLstring

URL for OAuth authorization endpoint.

authenticationTypestringrequired

Type of authentication method (e.g., OAuth, SAML, local).

Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"

samlFileURLstring

URL to the SAML metadata or configuration file.

namestringnon-emptyrequired

Name of the authentication configuration.

clientIDStatusstring

Status of the client ID configuration.

Enum"ACTIVE""REVOKED"

samlFileTypestring

Type of SAML file (metadata or certificate).

Enum"DIRECT_URL""FILE"

domainsArray of strings

List of email domains associated with this authentication configuration.

samlSignatureEnabledboolean

Indicates whether SAML signature validation is enabled.

samlEncryptionCertificateIdstring

Identifier for the certificate used for SAML encryption.

parentTenantIdstring

Parent tenant identifier for hierarchical authentication configuration.

samlEncryptionPublicCertificatestring

Public certificate content for SAML encryption.

samlEncryptionPrivateKeystring

Private key content for SAML encryption.

]

Response

[
  {
    "id": "string",
    "clientID": "string",
    "clientSecret": "string",
    "scopes": "string",
    "tokenURL": "string",
    "authorizationURL": "string",
    "authenticationType": "IDM",
    "samlFileURL": "string",
    "name": "string",
    "clientIDStatus": "ACTIVE",
    "samlFileType": "DIRECT_URL",
    "domains": [ … ],
    "samlSignatureEnabled": true,
    "samlEncryptionCertificateId": "string",
    "parentTenantId": "string",
    "samlEncryptionPublicCertificate": "string",
    "samlEncryptionPrivateKey": "string"
  }
]

Add Authentication

Request

Add a new authentication configuration for the tenant.

Body

required

idstring

clientIDstring

OAuth client identifier used for authentication.

clientSecretstring

OAuth client secret for secure authentication.

scopesstring

OAuth scopes defining the level of access requested.

tokenURLstring

URL for obtaining OAuth tokens.

authorizationURLstring

URL for OAuth authorization endpoint.

authenticationTypestringrequired

Type of authentication method (e.g., OAuth, SAML, local).

Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"

samlFileURLstring

URL to the SAML metadata or configuration file.

namestringnon-emptyrequired

Name of the authentication configuration.

clientIDStatusstring

Status of the client ID configuration.

Enum"ACTIVE""REVOKED"

samlFileTypestring

Type of SAML file (metadata or certificate).

Enum"DIRECT_URL""FILE"

domainsArray of strings

List of email domains associated with this authentication configuration.

samlSignatureEnabledboolean

Indicates whether SAML signature validation is enabled.

samlEncryptionCertificateIdstring

Identifier for the certificate used for SAML encryption.

parentTenantIdstring

Parent tenant identifier for hierarchical authentication configuration.

samlEncryptionPublicCertificatestring

Public certificate content for SAML encryption.

samlEncryptionPrivateKeystring

Private key content for SAML encryption.

{
  "id": "string",
  "clientID": "string",
  "clientSecret": "string",
  "scopes": "string",
  "tokenURL": "string",
  "authorizationURL": "string",
  "authenticationType": "IDM",
  "samlFileURL": "string",
  "name": "string",
  "clientIDStatus": "ACTIVE",
  "samlFileType": "DIRECT_URL",
  "domains": [
    "string"
  ],
  "samlSignatureEnabled": true,
  "samlEncryptionCertificateId": "string",
  "parentTenantId": "string",
  "samlEncryptionPublicCertificate": "string",
  "samlEncryptionPrivateKey": "string"
}

Responses

Body

idstring

clientIDstring

OAuth client identifier used for authentication.

clientSecretstring

OAuth client secret for secure authentication.

scopesstring

OAuth scopes defining the level of access requested.

tokenURLstring

URL for obtaining OAuth tokens.

authorizationURLstring

URL for OAuth authorization endpoint.

authenticationTypestringrequired

Type of authentication method (e.g., OAuth, SAML, local).

Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"

samlFileURLstring

URL to the SAML metadata or configuration file.

namestringnon-emptyrequired

Name of the authentication configuration.

clientIDStatusstring

Status of the client ID configuration.

Enum"ACTIVE""REVOKED"

samlFileTypestring

Type of SAML file (metadata or certificate).

Enum"DIRECT_URL""FILE"

domainsArray of strings

List of email domains associated with this authentication configuration.

samlSignatureEnabledboolean

Indicates whether SAML signature validation is enabled.

samlEncryptionCertificateIdstring

Identifier for the certificate used for SAML encryption.

parentTenantIdstring

Parent tenant identifier for hierarchical authentication configuration.

samlEncryptionPublicCertificatestring

Public certificate content for SAML encryption.

samlEncryptionPrivateKeystring

Private key content for SAML encryption.

Response

{
  "id": "string",
  "clientID": "string",
  "clientSecret": "string",
  "scopes": "string",
  "tokenURL": "string",
  "authorizationURL": "string",
  "authenticationType": "IDM",
  "samlFileURL": "string",
  "name": "string",
  "clientIDStatus": "ACTIVE",
  "samlFileType": "DIRECT_URL",
  "domains": [
    "string"
  ],
  "samlSignatureEnabled": true,
  "samlEncryptionCertificateId": "string",
  "parentTenantId": "string",
  "samlEncryptionPublicCertificate": "string",
  "samlEncryptionPrivateKey": "string"
}