Models

User

object

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

Example

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Docs by Sourcey