User Entity (2022/06)
1 min
all user entities are structured as follows entity id \<font color="#704ae0">int\</font> \<font color="#01a0af">read only\</font> a unique identifier for the user person \<font color="#704ae0">person\</font> \<font color="#01a0af">read only\</font> 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 docid\ vuywmgvg7yrdyb0atzg5k ) description \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the customer defined description of the user (for example, "network administrator") the maximum length of this string is 256 characters creationdate \<font color="#704ae0">datetime\</font> \<font color="#01a0af">read only\</font> the date when the network was created see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate \<font color="#704ae0">datetime\</font> \<font color="#01a0af"> read only\</font> the date when the network was last modified see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastlogindate \<font color="#704ae0">nullable\<datetime\>\</font> \<font color="#01a0af">read only\</font> the last login date on the network, if available see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type islockedout \<font color="#704ae0">bool\</font> \<font color="#01a0af">read write\</font> whether the user is locked out of the network false is the default value lastlockoutdate \<font color="#704ae0">nullable\<datetime\>\</font> \<font color="#01a0af">read only\</font> the last date on which the user was locked out, if applicable see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type rolename \<font color="#704ae0">string\</font> \<font color="#01a0af">read write\</font> the name of the role assigned to the user (for example, "administrators") permissions \<font color="#704ae0">permission\[]\</font> \<font color="#01a0af">read write\</font> a list of permission object instances representing permissions rules assigned to the user