Skip to content

User Management

User Management

Save or Update Users

Sends a list of users to a specific device.

  • Topic: <company-code>/<serial-number>/users/save
  • Message: An array of user objects. 
    [
  {
    "user_id": "string",
    "user_role": "Admin" | "Manager" | "User",
    "name": "string",
    "department": "string",
    "pin": "string-of-numbers",
    "account_enabled": true,
    "has_access": true,
    "has_access_on_holidays": false,
    "schedules_restricted": true
  }
]

Update a Single User (All Devices)

Updates a user's profile on every device where they exist.

  • Topic: <company-code>/server/<user-id>/user/save
  • Message: An array containing a single user object. 
    [
  {
    "user_id": "101",
    "name": "Jane D. Smith",
    "account_enabled": false
  }
]

Delete Users

  • Delete specific users from one device:
    • Topic: <company-code>/<serial-number>/users/delete
    • Message: ["101", "102"]
  • Delete one user from all devices:
    • Topic: <company-code>/server/<user-id>/user/delete
    • Message: ["101"]
  • Delete all users from one device:
    • Topic: <company-code>/<serial-number>/users/clear
    • Message: (Empty)