Owners and Guests

Every user on a lock has an access level — owner or guest. Each access level has a different set of permissions.

• When a user sets up a lock using the August app, they are automatically added to the lock as an owner.
• When a user adds another user to a lock using the August app, they can add them as an owner or a guest.

Keep in mind that a user might be a guest on one lock and an owner on another.

Owner

Lock owners have the most permissions. You can call every endpoint in the August API with the access token of an owner.

Guest

Lock guests have fewer permissions than owners. With the access token of a guest, you cannot do these things:

• Remote operate
• PIN management

Getting a user's access level

Use the GET /users/locks/mine endpoint to get a list of the locks a user is on and what access level they have.

Owner

This is an example of a lock owner. When UserType is superuser then the person is an owner of the lock.

{
  ":LockID": {
    "HouseID": ":HouseID",
    "HouseName": "August HQ",
    "LockName": "Main Interior",
    "UserType": "superuser", // <--- means this is an Owner
    "macAddress": "mm.aa.cc.aa.dd.rr"
  },
  {...}
}

Guest

This is an example of a guest on a lock. When UserType is user then the person is a guest of the lock.

{
  ":LockID": {
    "HouseID": ":HouseID",
    "HouseName": "Andy's Desk Prod 2",
    "LockName": "roadhouse 2",
    "UserType": "user", // <--- means this is a Guest
    "macAddress": "mm.aa.cc.aa.dd.rr"
  }
}