Manages resident portal access.
Resident Portal//
- Gets Resident Portal Icon File
Gets Resident Portal Styles
Gets Portal Access Details
Gets Resident Portal Icon...
Resident Portal (v0)
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 secrets associated. The APIs also support updates of contact details and DPSK secrets. APIs are authenticated using a specific token associated to the unit. These tokens are generated as the unit is created.
Download OpenAPI description
Overview
License
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud
- RUCKUS One API host for North American region.https://api.ruckus.cloud/residents/properties/{propertyId}/styles
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/residents/properties/{propertyId}/styles
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/residents/properties/{propertyId}/styles
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payload- RUCKUS One API host for North American region.https://api.ruckus.cloud/residents/properties/{propertyId}/files/favicons
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/residents/properties/{propertyId}/files/favicons
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/residents/properties/{propertyId}/files/favicons
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payload- RUCKUS One API host for North American region.https://api.ruckus.cloud/residents/properties/{propertyId}/access
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/residents/properties/{propertyId}/access
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/residents/properties/{propertyId}/access
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "loginText": "string", "portalAllowed": true }