Role Entity (2022/06)

All role entities are structured as follows:

entity:

  • Id int read-only: The unique identifier for the role instance

  • IsCustom bool read-write: Whether or not the role is custom

  • Name string read-write: The name associated with the role instance (for example, "Custom Administrators"). The maximum length of this string is 50 characters.

  • Description string read-write: The customer-defined description of the role. The maximum length of this string is 256 characters.

  • CreationDate DateTime read-only: The date that the role was created. See DateTime for more information about this data type.

  • UserCount ushort read-only: The number of users for the role instance

  • Users UserInfo[] read-only: An array of the following information for each user assigned to the role instance:

    • Login string read-only: The login information for the user

  • Permissions Permission[] read-write: A list of permission object instances representing permissions rules assigned to the user