API Docs / Schemas / RoleInfo

RoleInfo

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

Properties

Name Type Description
namestring

The display name of the user's role within this tenant

The display name of the user's role within this tenant

typeenum

System Custom

System Custom

isOwnerboolean

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.

isClientManagerboolean

Whether the user is a client manager within the tenant

Whether the user is a client manager within the tenant

isPartnerboolean

Whether the user is a partner within the tenant

Whether the user is a partner within the tenant

isAssociateboolean

Whether the user is an associate within the tenant

Whether the user is an associate within the tenant

permissionsobject

Dictionary of permissions for each permissible entity (Clients, Tasks, etc.) within the tenant

Dictionary of permissions for each permissible entity (Clients, Tasks, etc.) within the tenant

JSON Example

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

Contained in Schemas