Get Delegation

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

Get Delegation

Request

Get delegation by ID.

Path

delegationIdstringrequired

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.

delegatedTostring

Identifier of the tenant receiving the delegation.

typestring

Enum	Meaning
VAR	Return delegations to this VAR.
SUPPORT	Return delegations to RUCKUS customer support.
MSP	Return the MSP's MSP-ECs.
SUPPORT_EC	Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER	Return the MSP's installers.
MSP_INTEGRATOR	Return the MSP's integrators.
UNKNOWN	Unknown.

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

statusstring

Enum"INVITED""ACCEPTED""REJECTED""REVOKED"

delegatedBystring

Username of the administrator who initiated the delegation.

expiryDatestring(date-time)

Expiration date for time limited delegations such as support access.

delegatedToNamestring

Name of the tenant or organization receiving the delegation.

parentIdstringread-only

Identifier of the parent entity in the hierarchy.

isValidboolean

Indicates whether the delegation is currently valid and not expired.

delegatedToAdminstringDeprecated

Email address of the administrator at the delegated organization.

Response

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "delegatedTo": "string",
  "type": "VAR",
  "status": "INVITED",
  "delegatedBy": "string",
  "expiryDate": "2019-08-24T14:15:22Z",
  "delegatedToName": "string",
  "delegatedToAdmin": "string",
  "parentId": "string",
  "isValid": true
}

Respond to Delegation

Request

A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.

Path

delegationIdstringrequired

Body

required

acceptbooleanrequired

Indicates whether to accept or reject the delegation request.

fromTenantIdstringnon-emptyrequired

Identifier of the tenant requesting the delegation.

{
  "accept": true,
  "fromTenantId": "string"
}

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseobject(Delegation)

Response payload containing the requested data or operation result.

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

Revoke VAR Delegation

Request

Revoke VAR delegation by ID.

Path

delegationIdstringrequired

No request payload

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseany

Response payload containing the requested data or operation result.

Response

{
  "requestId": "string",
  "response": null
}

Grant Access

Request

Grant RUCKUS customer support access to my account.

No request payload

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseobject(Delegation)

Response payload containing the requested data or operation result.

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

Revoke Access

Request

Revoke RUCKUS customer support's access to my account.

No request payload

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseany

Response payload containing the requested data or operation result.

Response

{
  "requestId": "string",
  "response": null
}

Get Delegations

Request

Get delegation list for the authenticated tenant.

Query

typestring

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

No request payload

Responses

Body

Array [

idstring

createdDatestring(date-time)read-only

Timestamp when this entity was created.

updatedDatestring(date-time)read-only

Timestamp when this entity was last updated.

delegatedTostring

Identifier of the tenant receiving the delegation.

typestring

Enum	Meaning
VAR	Return delegations to this VAR.
SUPPORT	Return delegations to RUCKUS customer support.
MSP	Return the MSP's MSP-ECs.
SUPPORT_EC	Return MSP-EC delegations to RUCKUS customer support.
MSP_INSTALLER	Return the MSP's installers.
MSP_INTEGRATOR	Return the MSP's integrators.
UNKNOWN	Unknown.

Enum"VAR""SUPPORT""MSP""SUPPORT_EC""MSP_INSTALLER""MSP_INTEGRATOR""UNKNOWN"

statusstring

Enum"INVITED""ACCEPTED""REJECTED""REVOKED"

delegatedBystring

Username of the administrator who initiated the delegation.

expiryDatestring(date-time)

Expiration date for time limited delegations such as support access.

delegatedToNamestring

Name of the tenant or organization receiving the delegation.

parentIdstringread-only

Identifier of the parent entity in the hierarchy.

isValidboolean

Indicates whether the delegation is currently valid and not expired.

delegatedToAdminstringDeprecated

Email address of the administrator at the delegated organization.

]

Response

[
  {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
]

Invite VAR

Request

Send invitation to VAR (aka delegate) to manage my account.This operation is not supported using client credentials.

Body

required

usernamestring

Username or email address of the VAR to invite.

{
  "username": "string"
}

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseobject(Delegation)

Response payload containing the requested data or operation result.

Response

{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "delegatedTo": "string",
    "type": "VAR",
    "status": "INVITED",
    "delegatedBy": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "delegatedToName": "string",
    "delegatedToAdmin": "string",
    "parentId": "string",
    "isValid": true
  }
}

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