Users data models

A registered end-user of a project.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
auth2FActivated	boolean	No	read-only (server-generated)	True if user has activated two-factor authentication.
creationTime	string	No	read-only (server-generated); format: date-time	The time when the user was created.
email	string	No	read-only (server-generated)	A valid email address. Present if project uses email addresses to uniquely identify users.
externalKey	string	No	read-only (server-generated)	If present, this is the unique key used in an external system to identify this user. This field is relevant only if project is using BYOU.
id	integer	Yes	read-only (server-generated)	This is a unique user ID assigned at time of creation.
managedExternally	boolean	No	read-only (server-generated)	True if user account is managed by an external ID provider such as Microsoft Entra ID.
name	string	Yes		Display name of the user.
password	string	No		A valid password. This is used only when creating or updating a user who logs in by email and password.
passwordUpdateTime	string	No	read-only (server-generated); format: date-time	The time when the password was last changed. Present only if user account is based on email/password.
phoneNumber	string	No	read-only (server-generated); pattern: ^(\+)([0-9]{5,})$	A valid phone number with country code (beginning with the '+' symbol). Present if project uses phone numbers to uniquely identify users.
projectId	integer	Yes	read-only (server-generated)	The project ID that this user belongs to.
verified	boolean	No	read-only (server-generated)	Displays true if the user has verified their account.

Entry in an HTTP access log.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
clientIp	string	No	read-only (server-generated)	IP address of caller.
latency	integer	No	read-only (server-generated)	Elapsed time of call in nanoseconds.
method	string	No	read-only (server-generated)	HTTP method.
path	string	No	read-only (server-generated)	URI path of HTTP request.
statusCode	integer	No	read-only (server-generated)	Returned status code of HTTP request.
timestamp	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.

A key-value pair stored for a home.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
key	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$	Must be unique within each home. Must 1 to 256 characters and must contain alphanumeric characters; dashes ('-'), underscores ('_') and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
modificationTime	string	No	read-only (server-generated); format: date-time	Timestamp of creation or last modification.
value	boolean | string | number | array | object	Yes		An arbitrary piece of data assigned to the given key.

Entry in a general-purpose log.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
caller	object	No		Information about the caller (id, type, display name, sudoer).
level	integer	No	read-only (server-generated)	Log level of entry.
source	string	No		Source from where the message was generated.
text	string	No	read-only (server-generated)	Text of log message.
timestamp	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.

Represents a permission of user.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
actions	object	Yes	read-only (server-generated)	Resource IDs on which the user can perform actions. If the user has all objects access for the resource type, it contains “*” or “root” instead of listing all resource IDs.
Properties of actions Property Type Required Constraints Description create array No read-only (server-generated) A list of resource IDs delete array No read-only (server-generated) A list of resource IDs managePermissions array No read-only (server-generated) A list of resource IDs read array No read-only (server-generated) A list of resource IDs update array No read-only (server-generated) A list of resource IDs
resourceType	string	Yes	read-only (server-generated); one of: all, accessControlGroup, user, userLog, home, homeKeyValue, homeLog, homeDevice, homeSmartModuleREST, homeEvent, homeAlert, entityClass, entity, entityMetric, entityBlob, entityAlert, entityAlertRule, entityAssistant, entityScheduledReportConfiguration, entityScheduledReportExecution, entityAppProxy, entityCustomLog, alertRule, projectLog, projectAlert	Resource type