Skip to content

Commit 3e6b907

Browse files
authored
Merge pull request #2828 from sakshamarora-arch/rbac-doc-review-fixes
Update RBAC doc: add custom role assignment, update entity table
2 parents 9badd63 + 7d2acee commit 3e6b907

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

66.5 KB
Loading
44.4 KB
Loading

docs/rbac-roles-and-permissions.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ Navigate to **Organization Settings** > **Custom Roles & Permissions** from the
7373
| **Guest** | Read-only access across products with limited entity permissions. | List, Read only on entities |
7474

7575
:::tip
76-
Roles are auto-applied at login. Permission changes take effect the next time a user logs in.
76+
Roles are auto-applied at login.
7777
:::
7878

79-
## Create a Custom Role
79+
## Creating and Applying Custom Roles
8080

8181
Custom roles give you the flexibility to tailor access permissions to match your organization's specific needs. Unlike the default roles (Admin, User, Guest), which cannot be edited, custom roles allow you to define exactly which products, entities, and actions each team member can access. To set up custom permissions, you need to create a custom role.
8282

@@ -92,6 +92,16 @@ Custom roles give you the flexibility to tailor access permissions to match your
9292

9393
**Step 4:** Click **Create** to complete the process.
9494

95+
**Step 5:** Assign the custom role to users or teams based on your use case:
96+
97+
- **To assign to individual users:** Navigate to **Organization Settings** > **Members**, click on the user's row or the options menu, and assign the custom role.
98+
99+
<img loading="lazy" src={require('../assets/images/rbac-roles-and-permissions/apply-custom-roles.png').default} alt="Apply custom roles to users from the Members page" className="doc_img"/>
100+
101+
- **To assign to a team:** Navigate to **Organization Settings** > **Teams**, select a team, and assign the desired custom role. All members of the team will automatically inherit the same permissions.
102+
103+
<img loading="lazy" src={require('../assets/images/rbac-roles-and-permissions/team-custom-role-access.png').default} alt="Assign custom roles to teams" className="doc_img"/>
104+
95105
## Product Level Access
96106

97107
Product-level access lets you control which <BrandName /> products a user can see and interact with. This is the most impactful RBAC setting as it determines what shows up on a user's dashboard, sidebar, and which URLs they can visit.
@@ -124,9 +134,9 @@ Assign permissions to specific items within the platform:
124134

125135
| Entity | Description |
126136
|--------|-------------|
127-
| **Projects** | Grant access to specific Test Manager projects. |
128-
| **Workflows** | Grant access to specific workflows. |
129-
| **Test Runs** | Grant access to specific test runs. |
137+
| **Projects** | Grant access to Test Manager projects. |
138+
| **Test Runs** | Grant access to test runs. |
139+
| **Test Cases and Test Case Instances** | Grant access to Test Manager test cases and test case instances. |
130140

131141
### Granular Control <NewTag value="Coming Soon" bgColor="#ffec02" color="#000" />
132142

@@ -135,7 +145,7 @@ Configure fine-grained permissions within specific product areas:
135145
| Entity | Description |
136146
|--------|-------------|
137147
| **HyperExecute** | Control permissions for jobs, tasks, stages, and configurations within HyperExecute. |
138-
| **KaneAI and Test Manager** | Control permissions for test cases, test plans, builds, milestones, and other Test Manager entities. |
148+
| **KaneAI and Test Manager** | Control permissions for test plans, builds, milestones, and other Test Manager entities. |
139149
| **Automation** | Control permissions for builds, sessions, and automation-related resources. |
140150
| **Analytics** | Control permissions for dashboards, widgets, and reporting features. |
141151
| **Organization** | Control permissions for organization-level settings, user management, and team management. |

0 commit comments

Comments
 (0)