Skip to content
/
Get Notification Recipien...

Tenant Management API (v0.3.0)

Ruckus Network Technical Documents

Overview

This document provides information about Tenant management.

Rate Limit

For the Ptenant REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Languages
Servers
North American region

https://api.ruckus.cloud/

Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

Notification Recipient

Manage notification recipients.

Operations

Query Notification Recipients

Request

Query notification recipient list.

Bodyapplication/jsonrequired
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
Enum"name""email""mobile"
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
Items Enum"name""email""mobile"
searchStringstring
filtersobject
application/json
{
  "page": 0,
  "pageSize": 0,
  "sortField": "name",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "name"
  ],
  "searchString": "string",
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

Accepted

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(Sort)
pageableobject(PageableObject)
firstboolean
lastboolean
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "first": true,
  "last": 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)
emailPreferencesboolean
smsPreferencesboolean
privilegeGroupIdstring
recipientTypestring
]
Response
[
  {
    "id": "string",
    "description": "string",
    "endpoints": [ … ],
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroupId": "string",
    "recipientType": "string"
  }
]

Add Notification Recipient

Request

Add notification recipient.

Bodyapplication/jsonrequired
idstring
descriptionstring
endpointsArray of objects(NotificationEndpointDTO)
emailPreferencesboolean
smsPreferencesboolean
privilegeGroupIdstring
recipientTypestring
application/json
{
  "id": "string",
  "description": "string",
  "endpoints": [
    { … }
  ],
  "emailPreferences": true,
  "smsPreferences": true,
  "privilegeGroupId": "string",
  "recipientType": "string"
}

Responses

Accepted

Bodyapplication/json
requestIdstring
responseobject(NotificationRecipientRBACDTO)
Response
application/json
{
  "requestId": "string",
  "response": {
    "id": "string",
    "description": "string",
    "endpoints": [ … ],
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroupId": "string",
    "recipientType": "string"
  }
}

Delete Notification Recipient

Request

Delete notification recipient list.

Body
requiredArray [
idstring
descriptionstringrequired
emailPreferencesboolean
smsPreferencesboolean
privilegeGroupobject(PrivilegeGroup)
endpointsArray of EmailNotificationEndpoint (object) or MobilePushNotificationEndpoint (object) or SmsNotificationEndpoint (object)
]
[
  {
    "id": "string",
    "description": "string",
    "emailPreferences": true,
    "smsPreferences": true,
    "privilegeGroup": { … },
    "endpoints": [ … ]
  }
]

Responses

Accepted

Body
requestIdstring
responseobject
Response
{
  "requestId": "string",
  "response": {}
}

Tenant

Manage tenants.

Operations

Delegation

Manage delegations.

Operations

User Profile

Manage user profiles.

Operations

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations