Roles Overview - Permission Management Guide
Roles define what actions users can perform within the workspace. The Roles page allows you to create custom roles, configure permissions, and manage access control. Roles can be assigned to individual users or groups, providing a flexible way to manage permissions across your workspace.
Understanding Roles
Roles are collections of permissions that determine what users can do in the workspace. There are two types of roles:
Workspace Roles
Workspace roles apply to the entire workspace and control access to workspace-level features such as:
- User management
- Group management
- Workspace settings
- Project creation
- Workspace-level configurations
Project Roles
Project roles apply to specific projects and control access to project-level features such as:
- Test case management
- Test execution
- Defect tracking
- Project settings
- Project-specific configurations
System vs Custom Roles
System Roles: Pre-defined roles that come with the workspace (e.g., Owner, Administrator, Workspace Manager). These roles cannot be edited or deleted.
Custom Roles: User-created roles that can be customized with specific permissions. These roles can be edited and deleted.
Accessing Roles
To access the Roles page:
-
Navigate to the workspace by clicking on it from the Workspaces page.
-
In the workspace sidebar, click on “Roles” or navigate to
/workspace/:workspaceId/roles. -
As a result, you’ll see the Roles page with a list of all roles in the workspace.
Viewing Roles
The Roles page displays all roles in the workspace in a list format. Each role card shows:
- Role Avatar: A colored avatar with the role’s initial
- Role Name: The name of the role
- Description: A brief description of the role’s purpose (if provided)
- Type Badge: Indicates whether it’s a “workspace” or “project” role
- Custom Badge: Indicates whether it’s a “Custom” or “System” role
Role Badges
- Workspace (green badge): Role applies to workspace-level features
- Project (blue badge): Role applies to project-level features
- Custom (indigo badge): User-created role that can be edited
- System (gray badge): Pre-defined role that cannot be modified
Filtering Roles
You can filter the roles list to find specific roles:
Search by Name or Description:
- Use the search bar to type a role’s name or description
- Search is case-insensitive and matches partial text
- Results update as you type
Filter by Project (workspace context only):
- Use the project dropdown to filter project roles by project assignment
- Select a specific project to see only roles assigned to that project
- Roles with “All Projects” scope will also appear
- Clear the filter to show all roles
Clear Filters:
- Click the “Clear” button to remove all active filters
- The button is only enabled when filters are active
Role Properties
Each role has the following properties:
- Role ID: Unique identifier automatically assigned
- Role Name: User-defined name
- Role Description: Optional details about the role
- Role Type: Workspace or Project
- Custom Role: Whether it’s a custom or system role
- Project Scope: For project roles, whether it applies to all projects or selected projects
- Projects: For project roles with selected scope, the list of projects
- Permissions: Set of permissions granted to the role
Next Steps
- Learn how to Create Roles to set up custom roles
- Explore Understanding Permissions to configure role permissions
- Check out Managing Roles to edit and delete roles
- Review Assigning Roles to assign roles to users and groups
Was this page helpful?