Role Entity (2020/10)

Owned by BrightSign TechDocs
Last updated: Jun 30, 2023
1 min read

All role entities are structured as follows:

entity:

  • Id int: The unique identifier for the role instance

  • IsCustom bool: Whether or not the role is custom

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

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

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

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

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

    • Login string: The login information for the user

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