Skip to content
/Resident Portal Unit API

Resident Portal (v0)

RUCKUS One API Documentation

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 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
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
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

Resident Portal Login API

Manages resident portal access.

Operations

Resident Portal UI Configuration

Provides resident portal UI configuration.

Operations

Resident Portal Configuration

Manages resident portal configuration.

Operations

Resident Portal Unit API

Manages units associated to the resident portal.

Operations

Gets Unit Details

Request

Gets unit details for the authenticated unit.

Path
propertyIdstring(uuid)required

Property identifier.

No request payload

Responses

Ok

Bodyapplication/hal+json
guidstring

Unique identifier for the unit.

numberstringrequired

Name or number of the unit.

descriptionstring
contactobject(UnitContactDto)

Contact details for the resident.

statusstring

Current status of the unit.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Passphrase for the unit owner.

guestSecretstring[ 0 .. 63 ] characters

Passphrase for the unit guest.

_linksobject(Links)
Response
application/hal+json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Selectively Updates Unit Configurations

Request

Allows the user to selectively update unit configurations such as passphrase, contact details.

Path
propertyIdstring(uuid)required

Property identifier.

Bodyapplication/jsonrequired

Unit to edit

guidstring

Unique identifier for the unit.

numberstringrequired

Name or number of the unit.

descriptionstring
contactobject(UnitContactDto)

Contact details for the resident.

statusstring

Current status of the unit.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Passphrase for the unit owner.

guestSecretstring[ 0 .. 63 ] characters

Passphrase for the unit guest.

application/json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string"
}

Responses

Unit configuration updated

Bodyapplication/hal+json
guidstring

Unique identifier for the unit.

numberstringrequired

Name or number of the unit.

descriptionstring
contactobject(UnitContactDto)

Contact details for the resident.

statusstring

Current status of the unit.

Enum"DISABLED""ENABLED"
secretstring[ 0 .. 63 ] characters

Passphrase for the unit owner.

guestSecretstring[ 0 .. 63 ] characters

Passphrase for the unit guest.

_linksobject(Links)
Response
application/hal+json
{
  "guid": "string",
  "number": "string",
  "description": "string",
  "contact": {
    "contactName": "string",
    "email": "string",
    "phoneNumber": "string"
  },
  "status": "DISABLED",
  "secret": "string",
  "guestSecret": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Gets Unit Devices

Request

Allows the user to get all unit and guest devices with the given unit id.

Path
propertyIdstring(uuid)required

Property identifier.

Query
typestringrequired

Type of device.UNIT and GUEST are the possible values

No request payload

Responses

Ok

Bodyapplication/hal+json
contentsArray of objects(UnitDeviceDto)

List of device details.

_linksobject(Links)
Response
application/hal+json
{
  "contents": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Device

Request

Allows the user to selectively remove unit device on the specified unit and device MAC address.

Path
propertyIdstring(uuid)required

Property identifier.

deviceIdstringrequired

Device Identification

No request payload

Responses

Unit device removed

Response
No content

Resident Portal Unit Users API

Manages users of unit associated to the resident portal.

Operations