Skip to content
/
Gets User Interface Confi...

Resident Portal REST API (v0)

Overview

Resident portals are provided to the unit owners to view and update unit details and secrets. The Resident portal APIs support these functions. These provide details on the property, units and dpsk passphrases associated. The APIs also supports updates of contact details and dpsk passphrases. APIs are authenticated using a specific token associated to the unit. These tokens are generated as the unit is created.

RateLimit

For the Resident portal REST APIs the following will be true:

  • Limits are applied to each property.
  • A maximum of 100 calls can be made per second.
  • Each second 80 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Resident Portal Unit Users API

Manages users of unit associated to the resident portal

Operations

Resident Portal Configuration

Manages Resident Portal configuration.

Operations

Gets Property Details

Request

Gets details of the property.

Path
propertyIdstring(uuid)required

Property identifier.

No request payload

Responses

Ok

Bodyapplication/hal+json
guidstring

Property identifier.

namestring

Property name.

addressstring

Property address.

descriptionstring

Description of property.

managementNamestring

Property management name.

managementPhonestring

Property management phone.

managementEmailstring

Property management email.

tenantPortalHelpTextstring

Help text defined for the property.

tenantPortalAnnouncementsstring

Announcement defined for the property.

allowSeparateGuestSecretboolean

Allow separate secret for guest users.

enforceMaxUnitsboolean

Restrict number of units.

maxUnitsinteger(int64)

Maximum units allowed.

sendEmailboolean

Send email notification.

sendSmsboolean

Send SMS notification.

ssidsArray of strings

List of networks.

_linksobject(Links)
Response
application/hal+json
{
  "guid": "string",
  "name": "string",
  "address": "string",
  "description": "string",
  "managementName": "string",
  "managementPhone": "string",
  "managementEmail": "string",
  "tenantPortalHelpText": "string",
  "tenantPortalAnnouncements": "string",
  "allowSeparateGuestSecret": true,
  "enforceMaxUnits": true,
  "maxUnits": 0,
  "sendEmail": true,
  "sendSms": true,
  "ssids": [
    "string"
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Gets User Interface Configurations

Request

Gets user interface configurations for the portal.

Path
propertyIdstring(uuid)required

Property identifier.

No request payload

Responses

Ok

Bodyapplication/hal+json
apiAllowedboolean

Allow access to resident portal interfaces.

tenantSetDpskboolean

Allow resident to set secrets.

logoFileNamestring

Name of logo file.

tenantTitlestring

Title displayed on resident portal.

tenantSubtitlestring

Sub-title displayed on resident portal.

announcementsstring

Announcements displayed on resident portal.

helpTextstring

Help text displayed on resident portal.

portalAllowedboolean

Allow resident portal for the unit.

mainColorstring

Main color of resident portal.

accentColorstring

Accent color of resident portal.

separatorColorstring

Separator color of resident portal.

textColorstring

Text color of resident portal.

iconFileNamestring

Icon file name.

loginTextstring

Login text displayed on resident portal.

_linksobject(Links)
Response
application/hal+json
{
  "apiAllowed": true,
  "tenantSetDpsk": true,
  "logoFileName": "string",
  "tenantTitle": "string",
  "tenantSubtitle": "string",
  "announcements": "string",
  "helpText": "string",
  "portalAllowed": true,
  "mainColor": "string",
  "accentColor": "string",
  "separatorColor": "string",
  "textColor": "string",
  "iconFileName": "string",
  "loginText": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Gets Resident Portal File

Request

Allows the user to download resident portal file with the given type.

Path
propertyIdstring(uuid)required

Property identifier.

typestringrequired

Resident Portal file type.

No request payload

Responses

Ok

Bodyimage/pngArray [
string(byte)
]
Response
No content

Resident Portal Login API

Manages Resident Portal access

Operations

Resident Portal Unit API

Manages units associated to the resident portal

Operations

Resident Portal UI Configuration

Provides resident portal UI configuration

Operations