User

Represents a User on the UniKey CORE Platform (e.g. an owner of a Kwikset Kevo or ERA TouchKey)

The User object

Attributes
Name Type Description
id UUID The ID of the User
name String The User’s full name

Available APIs

GET /me

Returns information about the current User

Request Properties

None

Response Properties

Returns a User object

Example Request
GET /me
Example Response
HTTP/1.1 200 OK

{
    "id": "f726aa74-d1db-4ee9-ac00-3d3e77721512",
    "name": "Phil Dumas"
}

GET /users/{user_id}

Returns information about the User with the given ID

Request Properties
Name Type Description
user_id UUID Required The ID of the User
Response Properties

Returns a User object

Example Request
GET /users/f726aa74-d1db-4ee9-ac00-3d3e77721512
Example Response
HTTP/1.1 200 OK

{
    "id": "f726aa74-d1db-4ee9-ac00-3d3e77721512",
    "name": "Phil Dumas"
}

GET /user/{user_id}/locks

Returns all Locks owned by the given User

Request Properties
Name Type Description
user_id UUID Required The ID of the desired User
Response Properties
Name Type Description
locks Array A list of all the requested User’s Lock objects
Example Request
GET /users/f726aa74-d1db-4ee9-ac00-3d3e77721512/locks
Example Response
HTTP/1.1 200 OK

{
  "locks": [
    {
      "id": "23934B44-53F1-42FB-A912-7E6BC4BCEB67",
      "name": "Home - Front Door",
      "bolt_state": "locked",
      "online_status": "online"
    },
    {
      "id": "FD0BC2ED-56E3-4683-A4D6-426435DD6036",
      "name": "Home - Garage Door",
      "bolt_state": "locked",
      "online_status": "offline"
    },
    {
      "id": "46658238-8108-4107-A62B-1FF3FA34072A",
      "name": "Office Door",
      "bolt_state": "unlocked",
      "online_status": "online"
    }
  ]
}