Delete Administrator

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

Get Administrator

Request

Get list of administrators.

Query

withExternalIdboolean

Default false

No request payload

Responses

Body

Array [

idstring

Unique identifier for the administrator account.

externalIdstring

External identifier from RUCKUS cloud authentication system.

emailstringnon-emptyrequired

Email address used as the administrator's login username.

namestring

First name of the administrator.

lastNamestring

Last name of the administrator.

phoneNumberstring

Contact phone number for the administrator.

rolestringnon-emptyrequired

Role assigned to the administrator, such as prime admin, admin, or readonly.

Example: "PRIME_ADMIN, ADMIN, READ_ONLY"

delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring

Detail level for events.

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

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

authenticationIdstring

Identifier for the authentication method associated with this administrator.

]

Response

[
  {
    "id": "string",
    "externalId": "string",
    "email": "string",
    "name": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "role": "PRIME_ADMIN, ADMIN, READ_ONLY",
    "delegateToAllECs": true,
    "delegatedECs": [ … ],
    "detailLevel": "ba",
    "authenticationId": "string"
  }
]

Update Administrator

Request

Update administrator role and settings for the tenant.

Query

updateSwuIdboolean

Default false

Body

required

idstring

Unique identifier for the administrator account.

externalIdstring

External identifier from RUCKUS cloud authentication system.

emailstringnon-emptyrequired

Email address used as the administrator's login username.

namestring

First name of the administrator.

lastNamestring

Last name of the administrator.

phoneNumberstring

Contact phone number for the administrator.

rolestringnon-emptyrequired

Role assigned to the administrator, such as prime admin, admin, or readonly.

Example: "PRIME_ADMIN, ADMIN, READ_ONLY"

delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring

Detail level for events.

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

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

authenticationIdstring

Identifier for the authentication method associated with this administrator.

{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "PRIME_ADMIN, ADMIN, READ_ONLY",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseobject(Admin)

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",
    "detailLevel": "ba",
    "externalId": "string",
    "adminRoles": [ … ],
    "adminAppSettings": [ … ],
    "dateFormat": "mm/dd/yyyy",
    "username": "string",
    "authentication": { … },
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "local": true,
    "defaultTenant": "string",
    "parentId": "string"
  }
}

Add Administrator

Request

Add a new administrator to the tenant.

Body

required

idstring

Unique identifier for the administrator account.

externalIdstring

External identifier from RUCKUS cloud authentication system.

emailstringnon-emptyrequired

Email address used as the administrator's login username.

namestring

First name of the administrator.

lastNamestring

Last name of the administrator.

phoneNumberstring

Contact phone number for the administrator.

rolestringnon-emptyrequired

Role assigned to the administrator, such as prime admin, admin, or readonly.

Example: "PRIME_ADMIN, ADMIN, READ_ONLY"

delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring

Detail level for events.

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

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

authenticationIdstring

Identifier for the authentication method associated with this administrator.

{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "PRIME_ADMIN, ADMIN, READ_ONLY",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Responses

Accepted

Body

requestIdstring

Unique identifier for tracking this API request.

responseobject(Admin)

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",
    "detailLevel": "ba",
    "externalId": "string",
    "adminRoles": [ … ],
    "adminAppSettings": [ … ],
    "dateFormat": "mm/dd/yyyy",
    "username": "string",
    "authentication": { … },
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "local": true,
    "defaultTenant": "string",
    "parentId": "string"
  }
}

Delete Administrators

Request

Delete administrators in bulk.

Body

requiredArray [

string

]

[
  "string"
]

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 Administrator

Request

Get list of administrators.

Query

withExternalIdboolean

Default false

Body

required

pageinteger(int32)

Page number for pagination starting from 0.

pageSizeinteger(int32)

Number of records per page for pagination.

sortFieldstring

Field by which to sort the administrator results.

Enum"name""username""role""authenticationType"

sortOrderstring

Sort order direction (ascending or descending).

Enum"ASC""DESC"

searchTargetFieldsArray of strings

List of fields to search within when filtering administrators.

Items Enum"name""username"

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

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 Administrator

Request

Get administrator by identifier.

Path

adminIdstringrequired

No request payload

Responses

Body

idstring

Unique identifier for the administrator account.

externalIdstring

External identifier from RUCKUS cloud authentication system.

emailstringnon-emptyrequired

Email address used as the administrator's login username.

namestring

First name of the administrator.

lastNamestring

Last name of the administrator.

phoneNumberstring

Contact phone number for the administrator.

rolestringnon-emptyrequired

Role assigned to the administrator, such as prime admin, admin, or readonly.

Example: "PRIME_ADMIN, ADMIN, READ_ONLY"

delegateToAllECsboolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECsArray of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevelstring

Detail level for events.

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

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

authenticationIdstring

Identifier for the authentication method associated with this administrator.

Response

{
  "id": "string",
  "externalId": "string",
  "email": "string",
  "name": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "role": "PRIME_ADMIN, ADMIN, READ_ONLY",
  "delegateToAllECs": true,
  "delegatedECs": [
    "string"
  ],
  "detailLevel": "ba",
  "authenticationId": "string"
}

Delete Administrator

Request

Delete administrator by identifier.

Path

adminIdstringrequired

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
}

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

Tenant Management (v0.3.0)

Notification Recipient

Administrator

Get Administrator

Request

Responses

Update Administrator

Request

Responses

Add Administrator

Request

Responses

Delete Administrators

Request

Responses

Get Administrator

RequestExpand all

Responses

Get Administrator

Request

Responses

Delete Administrator

Request

Responses

Delegation

Privacy Features

User Profile

Tenant

acx-mobile-push-notification-endpoint-controller

authentication-controller

Request