Skip to content
Tenant Management/
/
Delete Notification Recip...

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

Query Notification Recipients

Request

Query notification recipient list.

Body
required
pageinteger(int32)
pageSizeinteger(int32)

Number of records per page for pagination.

sortFieldstring

Field by which to sort the notification recipient results.

Enum"name""email""mobile"
sortOrderstring

Sort order direction (ascending or descending).

Enum"ASC""DESC"
searchTargetFieldsArray of strings

List of fields to search within when filtering notification recipients.

Items Enum"name""email""mobile"
searchStringstring

Search text string to match against target fields.

filtersobject

Additional filter criteria as key value pairs for refined searching.

{
  "page": 0,
  "pageSize": 0,
  "sortField": "name",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "name"
  ],
  "searchString": "string",
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

Accepted

Body
totalPagesinteger(int32)

Total number of pages available.

totalElementsinteger(int64)

Total number of elements across all pages.

pageableobject(PageableObject)

Pagination parameters used for this page.

firstboolean

Indicates whether this is the first page.

lastboolean

Indicates whether this is the last page.

sizeinteger(int32)
contentArray of any

List of items in the current page.

numberinteger(int32)

Current page number starting from 0.

sortobject(SortObject)

Sort order configuration for paginated results.

numberOfElementsinteger(int32)

Number of elements in the current page.

emptyboolean

Indicates whether the page has no content.

Response
{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": { … },
    "unpaged": true
  },
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "empty": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "empty": true
}

Get Notification Recipients

Request

Get notification recipient list.

No request payload

Responses

OK

Body
Array [
idstring
descriptionstring
endpointsArray of objects(NotificationEndpointDTO)

List of notification endpoints configured for this recipient.

emailPreferencesboolean

Indicates whether email notifications are enabled for this recipient.

smsPreferencesboolean

Indicates whether SMS notifications are enabled for this recipient.

privilegeGroupIdstring

Identifier of the privilege group associated with this notification recipient.

recipientTypestring

Type of notification recipient such as privilege group or global.

Example: "PRIVILEGE_GROUP, GLOBAL"
]
Response
[
  {
    "id": "string",
    "description": "string",
    "endpoints": [ … ],
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroupId": "string",
    "recipientType": "PRIVILEGE_GROUP, GLOBAL"
  }
]

Add Notification Recipient

Request

Add a new notification recipient to the tenant.

Body
required
idstring
descriptionstring
endpointsArray of objects(NotificationEndpointDTO)

List of notification endpoints configured for this recipient.

emailPreferencesboolean

Indicates whether email notifications are enabled for this recipient.

smsPreferencesboolean

Indicates whether SMS notifications are enabled for this recipient.

privilegeGroupIdstring

Identifier of the privilege group associated with this notification recipient.

recipientTypestring

Type of notification recipient such as privilege group or global.

Example: "PRIVILEGE_GROUP, GLOBAL"
{
  "id": "string",
  "description": "string",
  "endpoints": [
    { … }
  ],
  "emailPreferences": true,
  "smsPreferences": true,
  "privilegeGroupId": "string",
  "recipientType": "PRIVILEGE_GROUP, GLOBAL"
}

Responses

Accepted

Body
requestIdstring

Unique identifier for tracking this API request.

responseobject(NotificationRecipientRBACDTO)

Response payload containing the requested data or operation result.

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "description": "string",
    "endpoints": [ … ],
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroupId": "string",
    "recipientType": "PRIVILEGE_GROUP, GLOBAL"
  }
}

Delete Notification Recipient

Request

Delete notification recipient list.

Body
requiredArray [
idstring
descriptionstringrequired
emailPreferencesboolean

Indicates whether email notifications are enabled for this recipient.

smsPreferencesboolean

Indicates whether SMS notifications are enabled for this recipient.

privilegeGroupobject(PrivilegeGroup)

Privilege group associated with this notification recipient.

endpointsArray of EmailNotificationEndpoint (object) or MobilePushNotificationEndpoint (object) or SmsNotificationEndpoint (object)

List of notification endpoints configured for this recipient.

]
[
  {
    "id": "string",
    "description": "string",
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroup": { … },
    "endpoints": [ … ]
  }
]

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
}

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