Skip to content
/
Updates Unit User

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

Get Unit User Details for Specific User

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)

Unit user identifier.

userNamestring

Unit user name.

emailstring[ 0 .. 255 ] characters

Unit user email.

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)

Unit user identifier.

userNamestring

Unit user name.

emailstring[ 0 .. 255 ] characters

Unit user email.

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
dpskUpdateIdstring

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

Sort direction.

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)

Unit user identifier.

sortFieldsArray of strings

Sort by

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

Responses

ok

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
firstboolean
lastboolean
sizeinteger(int32)
contentArray of objects(EntityModelUnitUserDto)
numberinteger(int32)
sortobject(SortObject)
numberOfElementsinteger(int32)
pageableobject(PageableObject)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    { … }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "empty": true
}

Get Unit User Devices for Specific User

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)
_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

Resident Portal Configuration

Manages Resident Portal configuration.

Operations

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