Cloud APIs
...
Data Types (2022/06)
Custom Data Types (2022/06)
User Entity (2022/06)
1min
all user entities are structured as follows entity id int int read only read only a unique identifier for the user person person person read only read only a single entity instance for a given customer (there can be only one person per network, but there can be 0 to an infinite number of users) this is a complex entity with its own set of properties (see person entity (2022/06) docid\ vuywmgvg7yrdyb0atzg5k ) description string string read write read write the customer defined description of the user (for example, "network administrator") the maximum length of this string is 256 characters creationdate datetime datetime read only read only the date when the network was created see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate datetime datetime read only read only the date when the network was last modified see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastlogindate nullable\<datetime> nullable\<datetime> read only read only the last login date on the network, if available see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type islockedout bool bool read write read write whether the user is locked out of the network false is the default value lastlockoutdate nullable\<datetime> nullable\<datetime> read only read only the last date on which the user was locked out, if applicable see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type rolename string string read write read write the name of the role assigned to the user (for example, "administrators") permissions permission\[] permission\[] read write read write a list of permission object instances representing permissions rules assigned to the user