Overview
A role is a collection of permissions.
To allow a user to perform specific actions within their organization, you must assign the user's account one or more roles.
For more details, read How to manage access rights.
To learn about FanHero user roles, read our guide on Roles & Permissions.
Role object properties
| Name | Type | Description |
|---|---|---|
name | String | Role name |
description | String | Role description |
public | Boolean | If True, this role is available to all users, including those that are not logged in. |
default | Boolean | If True, this user role is granted to any newly created account. |
permissions | Array | An array of permissions. This can be a string array containing permission IDs or an object array containing Permission objects. |