Skip to content
Resident Portal/
/
Get unit user details

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

Resident Portal Unit Users API

Manages users of unit associated to the resident portal.

Operations

Get unit user details

Request

Gets unit user details for the requested user.

Path
userIdstring(uuid)required

User Id

propertyIdstring(uuid)required

Property Id

No request payload

Responses

Ok

Body
userIdstring(uuid)

Unique identifier for the unit user.

userNamestring

Display name of the unit user.

emailstring[ 0 .. 255 ] characters

Email address of the unit user.

phoneNumberstring[ 0 .. 16 ] characters

Unit user phone number.

passphrasestring

Unit user passphrase. For resetting passphrase please provide empty string in request.

statusstring

Unit user status.

Enum"BLOCKED""ACTIVE"
typestring

Unit user type.

Enum"UNIT""GUEST""LINKED"
_linksobject(Links)
Response
{
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "userName": "string",
  "email": "string",
  "phoneNumber": "string",
  "passphrase": "string",
  "status": "BLOCKED",
  "type": "UNIT",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Updates Unit User

Request

Enables update of unit user.

Path
propertyIdstring(uuid)required

Property Id

userIdstring(uuid)required

User Id

Body
required
userIdstring(uuid)

Unique identifier for the unit user.

userNamestring

Display name of the unit user.

emailstring[ 0 .. 255 ] characters

Email address of the unit user.

phoneNumberstring[ 0 .. 16 ] characters

Unit user phone number.

passphrasestring

Unit user passphrase. For resetting passphrase please provide empty string in request.

statusstring

Unit user status.

Enum"BLOCKED""ACTIVE"
typestring

Unit user type.

Enum"UNIT""GUEST""LINKED"
{
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "userName": "string",
  "email": "string",
  "phoneNumber": "string",
  "passphrase": "string",
  "status": "BLOCKED",
  "type": "UNIT"
}

Responses

ok

Body*/*
personaUpdateIdstring

Identifier for persona update request.

dpskUpdateIdstring

Identifier for DPSK update request.

clientAliasIdstring

Identifier for client alias request.

Query Unit Users

Request

Gets the list of unit users using the specified query.

Path
propertyIdstring(uuid)required

Property Id

Body

Search criteria and pagination details

sortDirectionstring

Direction for sorting results (ASC/DESC).

Enum"ASC""DESC"
pageinteger(int32)

Page number. If not specified the first page will be returned.

pageSizeinteger(int32)

Number of records in a page.If not specified default page size of 20 will be applied.

userIdstring(uuid)

Unique identifier for the unit user.

sortFieldsArray of strings

Fields to sort results by.

{
  "sortDirection": "ASC",
  "page": 0,
  "pageSize": 0,
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "sortFields": "userId"
}

Responses

ok

Body
totalPagesinteger(int32)

Total number of pages available.

totalElementsinteger(int64)

Total number of elements across all pages.

pageableobject(Pageablenull)

Pagination parameters used for the request.

numberOfElementsinteger(int32)

Number of elements in the current page.

firstboolean

Indicates if this is the first page.

lastboolean

Indicates if this is the last page.

sizeinteger(int32)
contentArray of objects(EntityModelUnitUserDto)

List of unit user details in this page.

numberinteger(int32)

Current page number starting from zero.

sortobject(Sortnull)

Sorting information for the request.

emptyboolean

Indicates if the page has no content.

Response
{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": { … }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    { … }
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "empty": true
}

Get unit user devices

Request

Gets unit user devices for the requested user.

Path
userIdstring(uuid)required

User Id

propertyIdstring(uuid)required

Property Id

No request payload

Responses

Ok

Body
contentsArray of objects(UnitDeviceDto)

List of device details.

_linksobject(Links)
Response
{
  "contents": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Unit User Device

Request

Allows the user to selectively remove a device.

Path
propertyIdstring(uuid)required

Property identifier.

deviceIdstringrequired

Device Identification

userIdstring(uuid)required

User Id

No request payload

Responses

Device removed

Response
No content