Skip to content
/Resident Portal Login 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

Access Resident Portal

Request

Enables user authentication and authorization.

Path
propertyIdstringrequired

Property identifier.

Bodyapplication/jsonrequired

HashedSecret

hashedSecretstring

Hashed secret used for login authentication.

application/json
{
  "hashedSecret": "string"
}

Responses

Ok

Bodyapplication/hal+json
unitGuidstringrequired

Unique identifier for the unit.

tokenstring

Authentication token for portal access.

serverVersionstring

Current version of the server.

expireDateTimestring(date-time)

Date and time when token expires.

Response
application/hal+json
{
  "unitGuid": "string",
  "token": "string",
  "serverVersion": "string",
  "expireDateTime": "2019-08-24T14:15:22Z"
}

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

Resident Portal Unit Users API

Manages users of unit associated to the resident portal.

Operations