User Entity (2020/10)

All user entities are structured as follows:

entity:

  • [int] Id: A unique identifier for the user

  • [Person] Person:  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). 

  • [string] Description: The customer-defined description of the user (for example, "Network Administrator"). The maximum length of this string is 256 characters.

  • [DateTime] CreationDate: The date when the network was created. See DateTime for more information about this data type.

  • [DateTime] LastModifiedDate: The date when the network was last modified. See DateTime for more information about this data type.

  • [Nullable<DateTime>] LastLoginDate: The last login date on the network, if available. See DateTime for more information about this data type.

  • [bool] IsLockedOut:  Whether the user is locked out of the network. False is the default value.

  • [Nullable<DateTime>] LastLockoutDate: The last date on which the user was locked out, if applicable. See DateTime for more information about this data type.

  • [string] RoleName: The name of the role assigned to the user (for example, "Administrators")

  • [List<Permission>] Permissions: A list of permission object instances representing permissions rules assigned to the user