You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/adding-organizations.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -21,3 +21,7 @@ This will grant CodeRabbit access to the selected organization, allowing it to:
21
21
- Access user email addresses (read-only)
22
22
23
23
> Note: Organizations control which applications are allowed to access their private data. You may need organization admin approval to complete this process.
24
+
25
+
## What's next {#whats-next}
26
+
27
+
-[Manage your subscription](/getting-started/subscription-management)
Copy file name to clipboardExpand all lines: docs/guides/roles.md
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
---
2
2
title: Control administrative access
3
-
description: Using the role-based authorization feature (RBAC) of CodeRabbit
3
+
description: Using the role-based authorization features of CodeRabbit
4
4
---
5
5
6
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).
7
+
administrative features are available to your organization's user accounts by
8
+
assigning and updating account roles.
9
9
10
-
## Overview of CodeRabbit RBAC {#overview}
10
+
## Overview of CodeRabbit roles {#overview}
11
11
12
-
Every CodeRabbit account has exactly one RBAC role for each organization
12
+
Every CodeRabbit account has exactly one role for each organization
13
13
that account is associated with.
14
14
For example, if you belong to two GitHub-based organizations that use
15
-
CodeRabbit, then you have one CodeRabbit RBAC role set for each of those two
15
+
CodeRabbit, then you have one CodeRabbit role set for each of those two
16
16
organizations.
17
17
18
-
CodeRabbit RBAC roles determine your ability to read or change various
18
+
CodeRabbit roles determine your ability to read or change various
19
19
billing, account management, and other administrative functions related to
20
20
an organization. The roles are as follows:
21
21
@@ -25,74 +25,74 @@ an organization. The roles are as follows:
25
25
-**Billing Admin**: allows read/write access to features specific
26
26
to a subscription and billing management, and limited access to other administrative features.
27
27
28
-
CodeRabbit users with the **Admin** role can modify the RBAC roles of other users in the
28
+
CodeRabbit users with the **Admin** role can modify the roles of other users in the
29
29
organization.
30
30
31
31
For a complete list of the administrative functions available to each role, see
32
32
[Role permissions](#permissions).
33
33
34
34
### CodeRabbit roles and Git platform roles {#and-upstream}
35
35
36
-
Modifying an account's CodeRabbit RBAC role doesn't have any "upstream"
36
+
Modifying an account's CodeRabbit role doesn't have any "upstream"
37
37
effect on that account's role or permissions in your organization's Git platform.
38
38
Similarly, changes to an account's role on your organization's Git platform don't
39
-
affect that account's CodeRabbit RBAC role.
39
+
affect that account's CodeRabbit role.
40
40
41
41
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
42
42
permission or ownership level with your GitHub organization doesn't change as a result.
43
43
44
44
### CodeRabbit roles and developer features {#and-features}
45
45
46
-
CodeRabbit RBAC roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews.
46
+
CodeRabbit roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews.
47
47
48
48
For example, if an organization has a Pro-tier
49
-
CodeRabbit account, then any user account with a seat assigned to it can use Pro-tier features with the organization's private repositories, regardless of that account's RBAC role.
49
+
CodeRabbit account, then any user account with a seat assigned to it can use Pro-tier features with the organization's private repositories, regardless of that account's role.
50
50
51
51
For more information on seat and subscription management, see [Manage your subscription](/getting-started/subscription-management).
52
52
53
-
## Default RBAC roles {#defaults}
53
+
## Default roles {#defaults}
54
54
55
-
CodeRabbit assigns every user account in your organization a default RBAC role,
55
+
CodeRabbit assigns every user account in your organization a default role,
56
56
using the following metrics:
57
57
58
58
- If a user has an ownership-level role with the Git platform organization—for example,
59
59
**Admin** on GitHub, or **Owner** on Bitbucket—then that user receives the default
60
-
CodeRabbit RBAC role of **Admin**.
61
-
- Otherwise, the user receives the **Member**RBAC role by default.
60
+
CodeRabbit role of **Admin**.
61
+
- Otherwise, the user receives the **Member** role by default.
62
62
63
63
You can update a user's role from its default setting by following the steps detailed in the next section. This requires that your own account
64
-
has an **Admin**RBAC role with the organization.
64
+
has an **Admin** role with the organization.
65
65
66
-
CodeRabbit applies these defaults only when initially setting up RBAC for an
66
+
CodeRabbit applies these defaults only when initially setting up for an
67
67
account within an organization. Subsequent "upstream" role changes don't affect
68
68
an account's CodeRabbit role.
69
69
70
-
## View or set RBAC roles {#how-to}
70
+
## View or set roles {#how-to}
71
71
72
-
You can view and set RBAC roles from the CodeRabbit dashboard, as detailed in the
72
+
You can view and set roles from the CodeRabbit dashboard, as detailed in the
73
73
following sections.
74
74
75
75
### View roles {#view-roles}
76
76
77
-
To view a list of your organization's RBAC role assignments, follow these steps:
77
+
To view a list of your organization's role assignments, follow these steps:
78
78
79
79
1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories).
80
80
1. At the top of the sidebar, select the organization whose user roles you want to view.
81
81
1. On the sidebar, click **Subscription**.
82
82
83
83
This displays a table of all of the CodeRabbit **Admin** and **Member** accounts associated with the selected
84
-
organization. In this table, the **Role** column displays the CodeRabbit RBAC role for
84
+
organization. In this table, the **Role** column displays the CodeRabbit role for
85
85
each account.
86
86
87
87
To view a list of accounts with the **Billing Admin** role, click the **Billing Admins** tab located above the table of user accounts.
88
88
89
89
### Set roles {#set-roles}
90
90
91
91
:::note
92
-
To modify users' CodeRabbit accounts, your own account must have the **Admin**RBAC role within your organization.
92
+
To modify users' CodeRabbit accounts, your own account must have the **Admin** role within your organization.
93
93
:::
94
94
95
-
To change a user account's RBAC role, follow these steps:
95
+
To change a user account's CodeRabbit role, follow these steps:
96
96
97
97
1. Go to your organization's list of user accounts, as detailed in the previous section.
98
98
If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus.
@@ -115,7 +115,7 @@ This sends an email to the address that you specified. After the recipient compl
115
115
## Role permissions {#permissions}
116
116
117
117
The following table lists the CodeRabbit administrative functionality
0 commit comments