---
title: Role Entity (2022/06)
slug: develop/role-entity-202206
docTags: 
createdAt: 2025-03-11T07:03:30.743Z
---

All Role entities are structured as follows:

`entity`:

- `Id` <font color="#704ae0">int</font> <font color="#01a0af">read-only</font>: The unique identifier for the role instance
- `IsCustom` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not the role is custom
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name associated with the role instance (for example, "Custom Administrators"). The maximum length of this string is 50 characters.
- `Description` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The customer-defined description of the role. The maximum length of this string is 256 characters.
- `CreationDate` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: The date that the role was created. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `UserCount` <font color="#704ae0">ushort</font> <font color="#01a0af">read-only</font>: The number of users for the role instance
- `Users` <font color="#704ae0">UserInfo[]</font> <font color="#01a0af">read-only</font>: An array of the following information for each user assigned to the role instance:
  - `Login` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The login information for the user
- `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