About roles

Overview

A role is a collection of Permissions. To grant the permissions to a user, add the user to the role using the Add team member to a role endpoint.

📘

To learn about permissions, read About users and permissions.

Properties of the role object

• id (String): The role ID
• name (String): The role name
• description (String): Role description

Properties of the detailed role object

• id (String): The role ID
• name (String): The role name
• description (String): Role description
• permissions (Array): Array of permission IDs attributed to this role
• teamMembers (Array): Array of team member IDs. These are the members assigned to the role.