RoleInfo

Information about a user's role within a tenant, including permissions and special designations

Properties

Name	Type	Description
code	string	The code of the custom role, when Type is Custom. Null for system roles.
The code of the custom role, when Type is Custom. Null for system roles.
name	string	The display name of the user's role within this tenant
The display name of the user's role within this tenant
type	enum	System Custom
System Custom
isOwner	boolean	Whether the user is the owner of the tenant. This is computed from Tenant.OwnerUserId.
Whether the user is the owner of the tenant. This is computed from Tenant.OwnerUserId.
isClientManager	boolean	Whether the user is a client manager within the tenant
Whether the user is a client manager within the tenant
isPartner	boolean	Whether the user is a partner within the tenant
Whether the user is a partner within the tenant
isAssociate	boolean	Whether the user is an associate within the tenant
Whether the user is an associate within the tenant
isRestrictedToTeamClients	boolean	Whether the user can only see clients belonging to their teams
Whether the user can only see clients belonging to their teams
isRestrictedToAssignedClients	boolean	Whether the user can only see clients where they are Manager, Partner, or Associate
Whether the user can only see clients where they are Manager, Partner, or Associate
isRestrictedToOwnTime	boolean	Whether the user can only see and edit their own time entries
Whether the user can only see and edit their own time entries
isPaidForTrackedTime	boolean	Whether the practice pays this user for their tracked time (contract basis) — puts them on the Unpaid Time pay surfaces
Whether the practice pays this user for their tracked time (contract basis) — puts them on the Unpaid Time pay surfaces
teams	array of CodeAndNameDto	Teams the user is a member of
Teams the user is a member of
permissions	object	The capabilities granted for each permissible entity (Clients, Tasks, etc.) within the tenant. Each entry lists the granted capabilities individually — there is no implicit hierarchy, so "Delete" does not imply "ViewAll". An entry containing "Admin" grants every capability. Entities the role grants nothing on are omitted.
The capabilities granted for each permissible entity (Clients, Tasks, etc.) within the tenant. Each entry lists the granted capabilities individually — there is no implicit hierarchy, so "Delete" does not imply "ViewAll". An entry containing "Admin" grants every capability. Entities the role grants nothing on are omitted.

JSON Example

{
  "code": "string",
  "name": "string",
  "type": "System",
  "isOwner": false,
  "isClientManager": false
}

Contained in Schemas

TenantInfo Information about a tenant that a user belongs to, including statistics and role information