Skip to content

Commit 5de8b2b

Browse files
committed
Small changes to RBAC documentation
1 parent 9e66579 commit 5de8b2b

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

docs/guides/rbac.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ title: Control administrative access
33
description: Using the role-based authorization feature (RBAC) of CodeRabbit
44
---
55

6-
CodeRabbit uses role-based authorization control (RBAC) to control which
7-
administrative features are available to your organization's user accounts.
6+
You can control which CodeRabbit
7+
administrative features are available to your organization's user accounts by using
8+
role-based access control (RBAC).
89

910
## Overview of CodeRabbit RBAC {#overview}
1011

11-
Every CodeRabbit account has exactly one CodeRabbit RBAC role for each organization
12+
Every CodeRabbit account has exactly one RBAC role for each organization
1213
that account is associated with.
1314
For example, if you belong to two GitHub-based organizations that use
1415
CodeRabbit, then you have one CodeRabbit RBAC role set for each of those two
@@ -30,14 +31,6 @@ organization.
3031
For a complete list of the administrative functions available to each role, see
3132
[Role permissions](#permissions).
3233

33-
### RBAC roles and CodeRabbit features {#and-features}
34-
35-
RBAC roles have no effect on using CodeRabbit features, such
36-
as automated code reviews. In other words, if an organization has a Pro-tier
37-
CodeRabbit account, then all its users can use Pro-tier features when working
38-
with that organization's repositories, regardless of their CodeRabbit RBAC roles with
39-
that organization.
40-
4134
### CodeRabbit roles and Git platform roles {#and-upstream}
4235

4336
Modifying an account's CodeRabbit RBAC role doesn't have any "upstream"
@@ -48,9 +41,15 @@ affect that account's CodeRabbit RBAC role.
4841
For example, if you have CodeRabbit integrated with a GitHub organization, and you change an account's CodeRabbit role from **Member** to **Admin**, then that account's
4942
permission or ownership level with your GitHub organization doesn't change as a result.
5043

44+
### CodeRabbit roles and developer features {#and-features}
45+
46+
CodeRabbit RBAC roles have no effect on using CodeRabbit developer features, such
47+
as automated code reviews. In other words, if an organization has a Pro-tier
48+
CodeRabbit account, then all developers working with its repositories can use Pro-tier features, regardless of RBAC.
49+
5150
## Default RBAC roles {#defaults}
5251

53-
CodeRabbit assigns every user in your Git platform organization a default RBAC role,
52+
CodeRabbit assigns every user account in your organization a default RBAC role,
5453
using the following metrics:
5554

5655
- If a user has an ownership-level role with the Git platform organization—for example,
@@ -75,9 +74,7 @@ following sections.
7574
To view a list of your organization's RBAC role assignments, follow these steps:
7675

7776
1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories).
78-
7977
1. At the top of the sidebar, select the organization whose user roles you want to view.
80-
8178
1. On the sidebar, click **Subscription**.
8279

8380
This displays a table of all of the CodeRabbit **Admin** and **Member** accounts associated with the selected
@@ -96,7 +93,6 @@ To change a user account's RBAC role, follow these steps:
9693

9794
1. Go to your organization's list of user accounts, as detailed in the previous section.
9895
If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus.
99-
10096
1. Click the menu in the user's **Role** column, and select the appropriate role from
10197
the list.
10298

@@ -108,9 +104,7 @@ You can't grant the **Billing Admin** role to an existing user account. To add a
108104
To add a CodeRabbit user account with the **Billing Admin** role, follow these steps:
109105

110106
1. Go to your organization's list of user accounts, as detailed in [View roles](#view-roles).
111-
112107
1. Click **Invite Billing Admin**.
113-
114108
1. Enter the name and email address of the billing administrator who you want to invite to the organization.
115109

116110
This sends an email to the address that you specified. After the recipient completes the process of joining your organization in CodeRabbit, then their record appears in the user accounts list, under the **Billing Admins** tab.

0 commit comments

Comments
 (0)