DoorLock API

DoorLock API
More information: https://openapi-generator.tech
Contact Info: dev@obodo.app
Version: 1.0.0
BasePath:
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AccessManager

App

Assembler

Dev

Doorlock

Installer

Live

Owner

Portal

Support

Todo

Tools

User

AccessManager

Up 
post /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(addUserToUserGroup)
Add a user to a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

added user to user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/groups
(createUserGroup)
Create a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateUserGroupInput CreateUserGroupInput (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}
(deleteUserGroup)
Delete a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}
(getUserGroup)
Get a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups
(listUserGroups)
List user groups for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user groups UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}/users
(listUsersForGroup)
List all users for a user group

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "users" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got users for user group UserListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(removeUserFromUserGroup)
Remove a user from a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

removed user from user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}
(updateLock)
Update lock name

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockWritable LockWritable (required)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/groups/{userGroupId}
(updateUserGroup)
Update a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserGroupWritable UserGroupWritable (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

App

Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users
(getMe)
Get user's own record

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}
(getUser)
Get a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices/{userDeviceId}
(getUserDevice)
Get a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices
(listUserDevices)
List devices for a user; page token is not supported for this operation all user devices are returned every time

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserDeviceListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "devices" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user devices UserDeviceListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /users/{userId}/devices
(provisionUserDevice)
Provision a new device for a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionUserDeviceInput ProvisionUserDeviceInput (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

provisioned user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}/sync
(syncUserDevice)
Update device metadata and get updated access keys

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SignedUserDeviceSyncInput SignedUserDeviceSyncInput (required)
Body Parameter —

Return type

UserDeviceSyncOutput

Example data

Content-Type: application/json
{
  "data" : {
    "encryptedUserAccessMapEntries" : [ null, null ],
    "userAccessMapVersion" : "userAccessMapVersion"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

synced user device UserDeviceSyncOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}
(updateUser)
Update a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user updated UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}
(updateUserDevice)
Update a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserDeviceWritable UserDeviceWritable (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Assembler

Up 
delete /locks/{lockId}
(deprovisionLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deprovisioned lock EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks
(listLocks)

Query parameters

pageToken (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null

Return type

LockListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "locks" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

lock list LockListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /locks
(provisionLock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

provisioned lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Dev

Up 
put /firmware/{version}/assign
(assignFirmwareVersion)
Assign a specific firmware version to a given lock, area, property or globally

Path parameters

version (required)
Path Parameter — default: null

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/areas
(createArea)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAreaInput CreateAreaInput (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties
(createProperty)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /users
(createUser)
Create a new user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user created UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/areas/{areaId}
(deleteArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted area EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}
(deleteProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted property EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}
(deleteUser)
Delete a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}/download
(downloadFirmwareVersion)
Download a specific version of the door lock firmware

Path parameters

version (required)
Path Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version File

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}
(getFirmwareVersion)
Get metadata about the firmware version

Path parameters

version (required)
Path Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users
(getMe)
Get user's own record

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}
(getUser)
Get a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}/install/{lockId}
(installLock)
Assigns a lock to this area and returns a signed message to send to the lock

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null
lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockInstallInput LockInstallInput (required)
Body Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

installed String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}/logs
(listLockAccessLogs)
List the access logs for this lock; paginated, newest first

Path parameters

lockId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

LockAccessLogListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "accessLogs" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed access logs LockAccessLogListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /locks
(provisionLock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

provisioned lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /firmware/unassign
(unassignFirmwareVersion)
Unassign an override firmware version from a given lock, area or property

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}/uninstall
(uninstallLock)
Disassociates this lock from an install area, property or owner and returns a signed message to send to the lock

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockUninstallInput LockUninstallInput (required)
Body Parameter —

Query parameters

uninstallMode (optional)
Query Parameter — default: area

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

uninstalled String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}
(updateArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AreaWritable AreaWritable (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}
(updateProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}
(updateUser)
Update a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user updated UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /firmware/{version}/upload
(uploadFirmwareVersion)
Upload a new door lock firmware version

Path parameters

version (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

firmware (optional)
Form Parameter — default: null format: binary

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

upload success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Doorlock

Up 
get /firmware/{version}/download
(downloadFirmwareVersion)
Download a specific version of the door lock firmware

Path parameters

version (required)
Path Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version File

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}/sync
(syncLock)
Pushes local access logs and pulls key changes, if any

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

synced String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Installer

Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}/install/{lockId}
(installLock)
Assigns a lock to this area and returns a signed message to send to the lock

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null
lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockInstallInput LockInstallInput (required)
Body Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

installed String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks
(listLocks)

Query parameters

pageToken (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null

Return type

LockListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "locks" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

lock list LockListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}/uninstall
(uninstallLock)
Disassociates this lock from an install area, property or owner and returns a signed message to send to the lock

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockUninstallInput LockUninstallInput (required)
Body Parameter —

Query parameters

uninstallMode (optional)
Query Parameter — default: area

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

uninstalled String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}
(updateLock)
Update lock name

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockWritable LockWritable (required)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Live

Up 
get /events
(listEvents)

Query parameters

eventSource (required)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null
userGroupId (optional)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
userId (optional)
Query Parameter — default: null
apiKeyId (optional)
Query Parameter — default: null
firmwareVersion (optional)
Query Parameter — default: null
keyId (optional)
Query Parameter — default: null

Return type

EventListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "events" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of relevant events EventListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /events/{eventId}/process
(triggerEventProcessing)

Path parameters

eventId (required)
Path Parameter — default: null

Return type

EventOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

event processing triggered EventOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Owner

Up 
post /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(addUserToUserGroup)
Add a user to a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

added user to user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/areas
(createArea)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAreaInput CreateAreaInput (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties
(createProperty)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/groups
(createUserGroup)
Create a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateUserGroupInput CreateUserGroupInput (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/areas/{areaId}
(deleteArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted area EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}
(deleteProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted property EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}
(deleteUserGroup)
Delete a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}
(getUserGroup)
Get a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups
(listUserGroups)
List user groups for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user groups UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}/users
(listUsersForGroup)
List all users for a user group

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "users" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got users for user group UserListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(removeUserFromUserGroup)
Remove a user from a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

removed user from user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}
(updateArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AreaWritable AreaWritable (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}
(updateProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/groups/{userGroupId}
(updateUserGroup)
Update a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserGroupWritable UserGroupWritable (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Portal

Up 
post /properties/{propertyId}/areas
(createArea)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAreaInput CreateAreaInput (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties
(createProperty)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/areas/{areaId}
(deleteArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted area EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}
(deleteProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted property EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /events
(listEvents)

Query parameters

eventSource (required)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null
userGroupId (optional)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
userId (optional)
Query Parameter — default: null
apiKeyId (optional)
Query Parameter — default: null
firmwareVersion (optional)
Query Parameter — default: null
keyId (optional)
Query Parameter — default: null

Return type

EventListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "events" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of relevant events EventListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}/logs
(listLockAccessLogs)
List the access logs for this lock; paginated, newest first

Path parameters

lockId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

LockAccessLogListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "accessLogs" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed access logs LockAccessLogListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /events/{eventId}/process
(triggerEventProcessing)

Path parameters

eventId (required)
Path Parameter — default: null

Return type

EventOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

event processing triggered EventOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}
(updateArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AreaWritable AreaWritable (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}
(updateProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Support

Up 
post /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(addUserToUserGroup)
Add a user to a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

added user to user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /firmware/{version}/assign
(assignFirmwareVersion)
Assign a specific firmware version to a given lock, area, property or globally

Path parameters

version (required)
Path Parameter — default: null

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/areas
(createArea)

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateAreaInput CreateAreaInput (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties
(createProperty)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PropertyWritable PropertyWritable (required)
Body Parameter —

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /users
(createUser)
Create a new user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user created UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/groups
(createUserGroup)
Create a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateUserGroupInput CreateUserGroupInput (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/areas/{areaId}
(deleteArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted area EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}
(deleteUser)
Delete a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}
(deleteUserGroup)
Delete a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}/devices/{userDeviceId}
(deprovisionUserDevice)
Deprovision a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}/download
(downloadFirmwareVersion)
Download a specific version of the door lock firmware

Path parameters

version (required)
Path Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version File

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}
(getFirmwareVersion)
Get metadata about the firmware version

Path parameters

version (required)
Path Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}
(getUser)
Get a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices/{userDeviceId}
(getUserDevice)
Get a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}
(getUserGroup)
Get a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /events
(listEvents)

Query parameters

eventSource (required)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null
userGroupId (optional)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
userId (optional)
Query Parameter — default: null
apiKeyId (optional)
Query Parameter — default: null
firmwareVersion (optional)
Query Parameter — default: null
keyId (optional)
Query Parameter — default: null

Return type

EventListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "events" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of relevant events EventListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/groups
(listGroupsForUser)
List all groups across all properties for a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups across all properties for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}/logs
(listLockAccessLogs)
List the access logs for this lock; paginated, newest first

Path parameters

lockId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

LockAccessLogListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "accessLogs" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed access logs LockAccessLogListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks
(listLocks)

Query parameters

pageToken (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null

Return type

LockListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "locks" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

lock list LockListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices
(listUserDevices)
List devices for a user; page token is not supported for this operation all user devices are returned every time

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserDeviceListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "devices" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user devices UserDeviceListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups
(listUserGroups)
List user groups for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user groups UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}/users
(listUsersForGroup)
List all users for a user group

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "users" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got users for user group UserListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(removeUserFromUserGroup)
Remove a user from a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

removed user from user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /events/{eventId}/process
(triggerEventProcessing)

Path parameters

eventId (required)
Path Parameter — default: null

Return type

EventOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

event processing triggered EventOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /firmware/unassign
(unassignFirmwareVersion)
Unassign an override firmware version from a given lock, area or property

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/areas/{areaId}
(updateArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

AreaWritable AreaWritable (required)
Body Parameter —

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}
(updateLock)
Update lock name

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockWritable LockWritable (required)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}
(updateUser)
Update a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user updated UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}
(updateUserDevice)
Update a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserDeviceWritable UserDeviceWritable (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/groups/{userGroupId}
(updateUserGroup)
Update a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserGroupWritable UserGroupWritable (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /firmware/{version}/upload
(uploadFirmwareVersion)
Upload a new door lock firmware version

Path parameters

version (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

firmware (optional)
Form Parameter — default: null format: binary

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

upload success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Todo

Up 
post /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(addUserToUserGroup)
Add a user to a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

added user to user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/groups
(createUserGroup)
Create a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateUserGroupInput CreateUserGroupInput (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}
(deleteUserGroup)
Delete a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}/devices/{userDeviceId}
(deprovisionUserDevice)
Deprovision a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices/{userDeviceId}
(getUserDevice)
Get a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}
(getUserGroup)
Get a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/groups
(listGroupsForUser)
List all groups across all properties for a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups across all properties for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks
(listLocks)

Query parameters

pageToken (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null

Return type

LockListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "locks" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

lock list LockListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices
(listUserDevices)
List devices for a user; page token is not supported for this operation all user devices are returned every time

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserDeviceListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "devices" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user devices UserDeviceListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups
(listUserGroups)
List user groups for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user groups UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}/users
(listUsersForGroup)
List all users for a user group

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "users" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got users for user group UserListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /users/{userId}/devices
(provisionUserDevice)
Provision a new device for a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ProvisionUserDeviceInput ProvisionUserDeviceInput (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

provisioned user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(removeUserFromUserGroup)
Remove a user from a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

removed user from user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}/sync
(syncLock)
Pushes local access logs and pulls key changes, if any

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

synced String

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}/sync
(syncUserDevice)
Update device metadata and get updated access keys

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SignedUserDeviceSyncInput SignedUserDeviceSyncInput (required)
Body Parameter —

Return type

UserDeviceSyncOutput

Example data

Content-Type: application/json
{
  "data" : {
    "encryptedUserAccessMapEntries" : [ null, null ],
    "userAccessMapVersion" : "userAccessMapVersion"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

synced user device UserDeviceSyncOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}
(updateLock)
Update lock name

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockWritable LockWritable (required)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}
(updateUserDevice)
Update a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserDeviceWritable UserDeviceWritable (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/groups/{userGroupId}
(updateUserGroup)
Update a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserGroupWritable UserGroupWritable (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Tools

Up 
post /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(addUserToUserGroup)
Add a user to a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

added user to user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /firmware/{version}/assign
(assignFirmwareVersion)
Assign a specific firmware version to a given lock, area, property or globally

Path parameters

version (required)
Path Parameter — default: null

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /users
(createUser)
Create a new user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user created UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /properties/{propertyId}/groups
(createUserGroup)
Create a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CreateUserGroupInput CreateUserGroupInput (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

created user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}
(deleteUser)
Delete a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}
(deleteUserGroup)
Delete a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /locks/{lockId}
(deprovisionLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deprovisioned lock EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /users/{userId}/devices/{userDeviceId}
(deprovisionUserDevice)
Deprovision a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

deleted user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}/download
(downloadFirmwareVersion)
Download a specific version of the door lock firmware

Path parameters

version (required)
Path Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version File

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /firmware/{version}
(getFirmwareVersion)
Get metadata about the firmware version

Path parameters

version (required)
Path Parameter — default: null

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

downloaded version FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}
(getUser)
Get a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices/{userDeviceId}
(getUserDevice)
Get a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}
(getUserGroup)
Get a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/areas
(listAreas)

Path parameters

propertyId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

AreaListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

area list AreaListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /events
(listEvents)

Query parameters

eventSource (required)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null
userGroupId (optional)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
userId (optional)
Query Parameter — default: null
apiKeyId (optional)
Query Parameter — default: null
firmwareVersion (optional)
Query Parameter — default: null
keyId (optional)
Query Parameter — default: null

Return type

EventListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "events" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of relevant events EventListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/groups
(listGroupsForUser)
List all groups across all properties for a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups across all properties for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}/logs
(listLockAccessLogs)
List the access logs for this lock; paginated, newest first

Path parameters

lockId (required)
Path Parameter — default: null

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

LockAccessLogListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "accessLogs" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed access logs LockAccessLogListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks
(listLocks)

Query parameters

pageToken (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null

Return type

LockListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "locks" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

lock list LockListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties
(listProperties)

Query parameters

pageToken (optional)
Query Parameter — default: null

Return type

PropertyListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "properties" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

property list PropertyListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/devices
(listUserDevices)
List devices for a user; page token is not supported for this operation all user devices are returned every time

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserDeviceListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "devices" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user devices UserDeviceListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups
(listUserGroups)
List user groups for a property

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

listed user groups UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}/groups/{userGroupId}/users
(listUsersForGroup)
List all users for a user group

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Return type

UserListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "pageToken" : "pageToken",
    "users" : [ null, null ]
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got users for user group UserListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /locks
(provisionLock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

provisioned lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
delete /properties/{propertyId}/groups/{userGroupId}/users/{userId}
(removeUserFromUserGroup)
Remove a user from a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null
userId (required)
Path Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

removed user from user group EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /events/{eventId}/process
(triggerEventProcessing)

Path parameters

eventId (required)
Path Parameter — default: null

Return type

EventOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

event processing triggered EventOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /firmware/unassign
(unassignFirmwareVersion)
Unassign an override firmware version from a given lock, area or property

Query parameters

scope (required)
Query Parameter — default: null
lockId (optional)
Query Parameter — default: null
propertyId (optional)
Query Parameter — default: null
areaId (optional)
Query Parameter — default: null

Return type

EmptyOutput

Example data

Content-Type: application/json
{
  "data" : { },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

assignement success EmptyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /locks/{lockId}
(updateLock)
Update lock name

Path parameters

lockId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LockWritable LockWritable (required)
Body Parameter —

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated property SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}
(updateUser)
Update a user

Path parameters

userId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserWritable UserWritable (required)
Body Parameter —

Return type

UserOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

user updated UserOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /users/{userId}/devices/{userDeviceId}
(updateUserDevice)
Update a device for a user

Path parameters

userId (required)
Path Parameter — default: null
userDeviceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserDeviceWritable UserDeviceWritable (required)
Body Parameter —

Return type

UserDeviceOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user device UserDeviceOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
put /properties/{propertyId}/groups/{userGroupId}
(updateUserGroup)
Update a user group for a property

Path parameters

propertyId (required)
Path Parameter — default: null
userGroupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserGroupWritable UserGroupWritable (required)
Body Parameter —

Return type

UserGroupOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

updated user group UserGroupOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
post /firmware/{version}/upload
(uploadFirmwareVersion)
Upload a new door lock firmware version

Path parameters

version (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

firmware (optional)
Form Parameter — default: null format: binary

Return type

FirmwareVersionOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

upload success FirmwareVersionOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

User

Up 
get /properties/{propertyId}/areas/{areaId}
(getArea)

Path parameters

propertyId (required)
Path Parameter — default: null
areaId (required)
Path Parameter — default: null

Return type

AreaOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got area AreaOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /locks/{lockId}
(getLock)

Path parameters

lockId (required)
Path Parameter — default: null

Return type

SignedLockOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error",
  "signatures" : {
    "key" : "signatures"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got lock SignedLockOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /properties/{propertyId}
(getProperty)

Path parameters

propertyId (required)
Path Parameter — default: null

Return type

PropertyOutput

Example data

Content-Type: application/json
{
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got property PropertyOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/groups
(listGroupsForUser)
List all groups across all properties for a user

Path parameters

userId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups across all properties for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput
Up 
get /users/{userId}/properties/{propertyId}/groups
(listGroupsForUserAtProperty)
List all groups within a property for a user

Path parameters

userId (required)
Path Parameter — default: null
propertyId (required)
Path Parameter — default: null

Return type

UserGroupListOutput

Example data

Content-Type: application/json
{
  "data" : {
    "groups" : [ null, null ],
    "pageToken" : "pageToken"
  },
  "success" : true,
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

got groups within a property for a user UserGroupListOutput

400

invalid input ErrorOutput

401

authentication required ErrorOutput

403

insufficient permission ErrorOutput

404

entity not found ErrorOutput

Models

[ Jump to Methods ]

Table of Contents

  1. AccessListEntry -
  2. Address -
  3. ApiKey -
  4. ApiKeyReadOnly -
  5. ApiKeyWritable -
  6. Area -
  7. AreaListOutput -
  8. AreaListOutput_data -
  9. AreaOutput -
  10. AreaReadOnly -
  11. AreaReadOnly_private -
  12. AreaWritable -
  13. AreaWriteOnce -
  14. CreateAreaInput -
  15. CreateUserGroupInput -
  16. EmptyOutput -
  17. ErrorOutput -
  18. Event -
  19. EventListOutput -
  20. EventListOutput_data -
  21. EventOutput -
  22. ExternalRef -
  23. FirmwareVersion -
  24. FirmwareVersionOutput -
  25. FirmwareVersionReadOnly -
  26. FirmwareVersionScope -
  27. Key -
  28. KeyMapEntry -
  29. KeyReadOnly -
  30. KeyRef -
  31. KeyWritable -
  32. KeyWriteOnce -
  33. Lock -
  34. LockAccessLog -
  35. LockAccessLogListOutput -
  36. LockAccessLogListOutput_data -
  37. LockAccessLogReadOnly -
  38. LockAccessLogWriteOnce -
  39. LockInstallInput -
  40. LockListOutput -
  41. LockListOutput_data -
  42. LockReadOnly -
  43. LockReadOnly_private -
  44. LockSyncInput -
  45. LockUninstallInput -
  46. LockWritable -
  47. LucilleBase -
  48. NewApiKey -
  49. NewArea -
  50. NewEvent -
  51. NewFirmwareVersion -
  52. NewKey -
  53. NewLock -
  54. NewLockAccessLog -
  55. NewProperty -
  56. NewUser -
  57. NewUserDevice -
  58. NewUserGroup -
  59. OfflineAsymmetricKeyWriteOnce -
  60. OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey -
  61. OfflineSymmetricKeyWriteOnce -
  62. OfflineSymmetricKeyWriteOnce_offlineSymmetricKey -
  63. OnlineKeyWriteOnce -
  64. OnlineKeyWriteOnce_onlineKey -
  65. Property -
  66. PropertyListOutput -
  67. PropertyListOutput_data -
  68. PropertyOutput -
  69. PropertyReadOnly -
  70. PropertyReadOnly_private -
  71. PropertyWritable -
  72. ProvisionUserDeviceInput -
  73. SignedLockOutput -
  74. SignedLockSyncOutput -
  75. SignedLockSyncOutput_data -
  76. SignedUserDeviceSyncInput -
  77. User -
  78. UserAccessMapEntry -
  79. UserDevice -
  80. UserDeviceListOutput -
  81. UserDeviceListOutput_data -
  82. UserDeviceOutput -
  83. UserDeviceReadOnly -
  84. UserDeviceReadOnly_private -
  85. UserDeviceSyncOutput -
  86. UserDeviceSyncOutput_data -
  87. UserDeviceWritable -
  88. UserDeviceWriteOnce -
  89. UserGroup -
  90. UserGroupListOutput -
  91. UserGroupListOutput_data -
  92. UserGroupOutput -
  93. UserGroupReadOnly -
  94. UserGroupReadOnly_private -
  95. UserGroupWritable -
  96. UserGroupWriteOnce -
  97. UserListOutput -
  98. UserListOutput_data -
  99. UserOutput -
  100. UserPermission -
  101. UserReadOnly -
  102. UserWritable -
  103. UserWritable_private -

AccessListEntry - Up

accessType
String
Enum:
group
area
schedule
String
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

Address - Up

line1
String
line2 (optional)
String
line3 (optional)
String
city
String
state (optional)
String
country
String
postalCode
String

ApiKey - Up

apiKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
apiPermissions
array[UserPermission]
displayName
String
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

ApiKeyReadOnly - Up

apiKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
apiPermissions
array[UserPermission]

ApiKeyWritable - Up

displayName
String

Area - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaUserGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessListVersion
String
lockIds
array[String]
containingAreaIds (optional)
array[String] Areas containing this area (all ancestor areas; e.g. the parent of the parent of this area and so on)
subAreaIds
array[String] Areas directly contained by this area (does not include sub areas of these sub areas)
externalRefs
array[ExternalRef]
private (optional)
AreaReadOnly_private
displayName
String
accessList
set[AccessListEntry]
areaType
String
Enum:
resident
common
staff
parentAreaId (optional)
String
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

AreaListOutput - Up

data
AreaListOutput_data
error
String
success
Boolean

AreaListOutput_data - Up

properties
array[Area]
pageToken (optional)
String

AreaOutput - Up

data
Area
error
String
success
Boolean

AreaReadOnly - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaUserGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessListVersion
String
lockIds
array[String]
containingAreaIds (optional)
array[String] Areas containing this area (all ancestor areas; e.g. the parent of the parent of this area and so on)
subAreaIds
array[String] Areas directly contained by this area (does not include sub areas of these sub areas)
externalRefs
array[ExternalRef]
private (optional)
AreaReadOnly_private

AreaReadOnly_private - Up

Only returned to authorized users / systems
keyMapEntries
array[KeyMapEntry]
keyMapVersion
String
requiredFirmwareVersion (optional)
String

AreaWritable - Up

displayName
String
accessList
set[AccessListEntry]

AreaWriteOnce - Up

areaType
String
Enum:
resident
common
staff
parentAreaId (optional)
String

CreateAreaInput - Up

displayName
String
areaType
String
Enum:
resident
common
staff
parentAreaId (optional)
String

CreateUserGroupInput - Up

displayName
String
groupType
String
Enum:
resident
staff

EmptyOutput - Up

error
String
data
Object
success
Boolean

ErrorOutput - Up

error
String will be non-null on error
data
Object
success
Boolean

Event - Up

eventName
String
eventId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
lockId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
keyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

EventListOutput - Up

data
EventListOutput_data
error
String
success
Boolean

EventListOutput_data - Up

events
array[Event]
pageToken (optional)
String

EventOutput - Up

data
Event
error
String
success
Boolean

ExternalRef - Up

id
String
source
String
syncDirection
String
Enum:
fromExternalToInternal
fromInternalToExternal
syncStatus
String
Enum:
disabled
pending
failed
synced
syncSchedule (optional)
String
lastSyncDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"

FirmwareVersion - Up

firmwareVersion
String alpha-numeric, dash or period characters only
deviceType
String
Enum:
Lock
s3Bucket
String
s3Key
String
scopes
array[FirmwareVersionScope]
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

FirmwareVersionOutput - Up

data
FirmwareVersion
error
String
success
Boolean

FirmwareVersionReadOnly - Up

firmwareVersion
String alpha-numeric, dash or period characters only
deviceType
String
Enum:
Lock
s3Bucket
String
s3Key
String
scopes
array[FirmwareVersionScope]

FirmwareVersionScope - Up

scope
String
Enum:
lock
area
property
global
lockId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

Key - Up

keyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String
ownerType
String
keyMode
String
Enum:
ENCRYPT_DECRYPT
SIGN_VERIFY
onlineKey
OnlineKeyWriteOnce_onlineKey
offlineSymmetricKey
OfflineSymmetricKeyWriteOnce_offlineSymmetricKey
offlineAsymmetricKey
OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey
typeState
String
type
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

KeyMapEntry - Up

accessKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
schedule
String
userGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
publicKey (optional)
String

KeyReadOnly - Up

keyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

KeyRef - Up

keyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String
ownerType
String
keyMode
String
Enum:
ENCRYPT_DECRYPT
SIGN_VERIFY
onlineKey
OnlineKeyWriteOnce_onlineKey
offlineSymmetricKey
OfflineSymmetricKeyWriteOnce_offlineSymmetricKey
offlineAsymmetricKey
OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey
typeState
String
type
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

KeyWritable - Up

typeState
String
Enum:
active
inactive
deleted

KeyWriteOnce - Up

ownerId
String
ownerType
String
keyMode
String
Enum:
ENCRYPT_DECRYPT
SIGN_VERIFY

Lock - Up

lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
ownerId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
purchaseDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
installDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
private (optional)
LockReadOnly_private
displayName
String
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

LockAccessLog - Up

lockAccessLogId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignatureFailure
String
lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessDate
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignature (optional)
String
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

LockAccessLogListOutput - Up

data
LockAccessLogListOutput_data
error
String
success
Boolean

LockAccessLogListOutput_data - Up

accessLogs
array[LockAccessLog]
pageToken (optional)
String

LockAccessLogReadOnly - Up

lockAccessLogId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignatureFailure
String

LockAccessLogWriteOnce - Up

lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessDate
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignature (optional)
String
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

LockInstallInput - Up

wifiName
String
wifiPassword
String

LockListOutput - Up

data
LockListOutput_data
error
String
success
Boolean

LockListOutput_data - Up

locks
array[Lock]
pageToken (optional)
String

LockReadOnly - Up

lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
ownerId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
purchaseDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
installDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
private (optional)
LockReadOnly_private

LockReadOnly_private - Up

Only returned to authorized users / systems
apiKey
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
lockKey
KeyRef
currentKeyMapVersion
String
currentFirmwareVersion
String
lastKnownAccessDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastKnownSyncDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
requiredFirmwareVersion (optional)
String

LockSyncInput - Up

syncDate
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
currentFirmwareVersion
String
currentKeyMapVersion
String
encryptedAccessLogs
array[String]

LockUninstallInput - Up

wifiName
String
wifiPassword
String

LockWritable - Up

displayName
String

LucilleBase - Up

type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

NewApiKey - Up

apiKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
apiPermissions
array[UserPermission]
displayName
String

NewArea - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaUserGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessListVersion
String
lockIds
array[String]
containingAreaIds (optional)
array[String] Areas containing this area (all ancestor areas; e.g. the parent of the parent of this area and so on)
subAreaIds
array[String] Areas directly contained by this area (does not include sub areas of these sub areas)
externalRefs
array[ExternalRef]
private (optional)
AreaReadOnly_private
displayName
String
accessList
set[AccessListEntry]
areaType
String
Enum:
resident
common
staff
parentAreaId (optional)
String

NewEvent - Up

eventName
String
eventId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
lockId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
keyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

NewFirmwareVersion - Up

firmwareVersion
String alpha-numeric, dash or period characters only
deviceType
String
Enum:
Lock
s3Bucket
String
s3Key
String
scopes
array[FirmwareVersionScope]

NewKey - Up

keyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String
ownerType
String
keyMode
String
Enum:
ENCRYPT_DECRYPT
SIGN_VERIFY
typeState
String
Enum:
active
inactive
deleted
onlineKey
OnlineKeyWriteOnce_onlineKey
offlineSymmetricKey
OfflineSymmetricKeyWriteOnce_offlineSymmetricKey
offlineAsymmetricKey
OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey

NewLock - Up

lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
ownerId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
purchaseDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
installDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
private (optional)
LockReadOnly_private
displayName
String

NewLockAccessLog - Up

lockAccessLogId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignatureFailure
String
lockId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
accessDate
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
deviceSignature (optional)
String
propertyId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"

NewProperty - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
PropertyReadOnly_private
displayName
String
address
Address
accessManagerIds
array[String]

NewUser - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userPermissions
array[UserPermission]
deviceIds
array[String]
externalRefs
array[ExternalRef]
displayName
String
private (optional)
UserWritable_private

NewUserDevice - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
UserDeviceReadOnly_private
deviceType
String
makeModel
String
displayName
String

NewUserGroup - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
groupSource
String
Enum:
property
area
custom
externalRefs
array[ExternalRef]
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
private (optional)
UserGroupReadOnly_private
displayName
String
groupType
String
Enum:
resident
common
staff

OfflineAsymmetricKeyWriteOnce - Up

offlineAsymmetricKey
OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey

OfflineAsymmetricKeyWriteOnce_offlineAsymmetricKey - Up

algorithm
String
publicKey
String
privateKey (optional)
String
encryptedPrivateKey (optional)
String

OfflineSymmetricKeyWriteOnce - Up

offlineSymmetricKey
OfflineSymmetricKeyWriteOnce_offlineSymmetricKey

OfflineSymmetricKeyWriteOnce_offlineSymmetricKey - Up

algorithm
String
privateKey (optional)
String
encryptedPrivateKey (optional)
String

OnlineKeyWriteOnce - Up

onlineKey
OnlineKeyWriteOnce_onlineKey

OnlineKeyWriteOnce_onlineKey - Up

algorithm
String
keyArn
String

Property - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
PropertyReadOnly_private
displayName
String
address
Address
accessManagerIds
array[String]
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

PropertyListOutput - Up

data
PropertyListOutput_data
error
String
success
Boolean

PropertyListOutput_data - Up

properties
array[Property]
pageToken (optional)
String

PropertyOutput - Up

data
Property
error
String
success
Boolean

PropertyReadOnly - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
ownerId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
PropertyReadOnly_private

PropertyReadOnly_private - Up

Only returned to authorized users / systems
propertyKey
KeyRef
requiredFirmwareVersion (optional)
String

PropertyWritable - Up

displayName
String
address
Address
accessManagerIds
array[String]

ProvisionUserDeviceInput - Up

deviceType
String
Enum:
iOS
Android
makeModel
String
displayName
String

SignedLockOutput - Up

data
Lock
error
String
signatures
map[String, String]
success
Boolean

SignedLockSyncOutput - Up

data
SignedLockSyncOutput_data
error
String
signatures
map[String, String]
success
Boolean

SignedLockSyncOutput_data - Up

requiredFirmwareVersion (optional)
String
keyMapVersion (optional)
String
encryptedKeyMapEntries (optional)
array[String]

SignedUserDeviceSyncInput - Up

syncDate
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
deviceType
String
makeModel
String
currentOsVersion
String
currentAppVersion
String
currentUserAccessMapVersion
String
deviceSignature
String

User - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userPermissions
array[UserPermission]
deviceIds
array[String]
externalRefs
array[ExternalRef]
displayName
String
private (optional)
UserWritable_private
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

UserAccessMapEntry - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
areaId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
schedule
String
accessKeyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
lockId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
privateKey (optional)
String

UserDevice - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
UserDeviceReadOnly_private
deviceType
String
makeModel
String
displayName
String
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

UserDeviceListOutput - Up

data
UserDeviceListOutput_data
error
String
success
Boolean

UserDeviceListOutput_data - Up

devices
array[UserDevice]

UserDeviceOutput - Up

data
UserDevice
error
String
success
Boolean

UserDeviceReadOnly - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userDeviceId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
externalRefs
array[ExternalRef]
private (optional)
UserDeviceReadOnly_private

UserDeviceReadOnly_private - Up

deviceAccessKey
KeyRef
deviceSyncKey
KeyRef
currentUserAccessMapVersion
String
currentOsVersion
String
currentAppVersion
String
lastKnownSyncDate (optional)
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"

UserDeviceSyncOutput - Up

data
UserDeviceSyncOutput_data
error
String
success
Boolean

UserDeviceSyncOutput_data - Up

userAccessMapVersion (optional)
String
encryptedUserAccessMapEntries (optional)
array[String]

UserDeviceWritable - Up

displayName
String

UserDeviceWriteOnce - Up

deviceType
String
makeModel
String

UserGroup - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
groupSource
String
Enum:
property
area
custom
externalRefs
array[ExternalRef]
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
private (optional)
UserGroupReadOnly_private
displayName
String
groupType
String
Enum:
resident
common
staff
type
String
typeState
String
createdAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedAt
String ISO_8601 UTC date time string in the format YYYY-MM-DDThh:mm:ss.sssZ; e.g. "2022-07-14T17:25:03Z"
lastModifiedBy
String

UserGroupListOutput - Up

data
UserGroupListOutput_data
error
String
success
Boolean

UserGroupListOutput_data - Up

groups
array[UserGroup]
pageToken (optional)
String

UserGroupOutput - Up

data
UserGroup
error
String
success
Boolean

UserGroupReadOnly - Up

propertyId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userGroupId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
groupSource
String
Enum:
property
area
custom
externalRefs
array[ExternalRef]
areaId (optional)
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
private (optional)
UserGroupReadOnly_private

UserGroupReadOnly_private - Up

accessKey
KeyRef

UserGroupWritable - Up

displayName
String

UserGroupWriteOnce - Up

groupType
String
Enum:
resident
common
staff

UserListOutput - Up

data
UserListOutput_data
error
String
success
Boolean

UserListOutput_data - Up

users
array[User]
pageToken (optional)
String

UserOutput - Up

data
User
error
String
success
Boolean

UserPermission - Up

permission
String
Enum:
me
owner
provision-lock
install-lock
manage-access
manage-firmware
support
userId (optional)
String Optional scoping for this permission
propertyId (optional)
String Optional scoping for this permission

UserReadOnly - Up

userId
String 36 character UUID; e.g. "7a449a59-a391-420d-b4a5-6e67e36da39d"
userPermissions
array[UserPermission]
deviceIds
array[String]
externalRefs
array[ExternalRef]

UserWritable - Up

displayName
String
private (optional)
UserWritable_private

UserWritable_private - Up

firstName
String
lastName
String
email
String
phoneNumber
String
billingAddress
Address