User Entity (2022/06)
0 min
All User entities are structured as follows:
entity:
- Id int read-only: A unique identifier for the user
- Person Person 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).
- Description string read-write: The customer-defined description of the user (for example, "Network Administrator"). The maximum length of this string is 256 characters.
- CreationDate DateTime read-only: The date when the network was created. See DateTime for more information about this data type.
- LastModifiedDate DateTime read-only: The date when the network was last modified. See DateTime for more information about this data type.
- LastLoginDate Nullable<DateTime> read-only: The last login date on the network, if available. See DateTime for more information about this data type.
- IsLockedOut bool read-write: Whether the user is locked out of the network. False is the default value.
- LastLockoutDate Nullable<DateTime> read-only: The last date on which the user was locked out, if applicable. See DateTime for more information about this data type.
- RoleName string read-write: The name of the role assigned to the user (for example, "Administrators")
- Permissions Permission[] read-write: A list of permission object instances representing permissions rules assigned to the user