|
| 1 | +--- |
| 2 | +title: Control administrative access |
| 3 | +description: Using the role-based authorization features of CodeRabbit |
| 4 | +--- |
| 5 | + |
| 6 | +You can control which CodeRabbit |
| 7 | +administrative features are available to your organization's user accounts by |
| 8 | +assigning and updating account roles. |
| 9 | + |
| 10 | +## Overview of CodeRabbit roles {#overview} |
| 11 | + |
| 12 | +Every CodeRabbit account has exactly one role for each organization |
| 13 | +that account is associated with. |
| 14 | +For example, if you belong to two GitHub-based organizations that use |
| 15 | +CodeRabbit, then you have one CodeRabbit role set for each of those two |
| 16 | +organizations. |
| 17 | + |
| 18 | +CodeRabbit roles determine your ability to read or change various |
| 19 | +billing, account management, and other administrative functions related to |
| 20 | +an organization. The roles are as follows: |
| 21 | + |
| 22 | +- **Admin**: allows full read/write access to all CodeRabbit administrative features. |
| 23 | +- **Member**: allows read-only access to a limited set of administrative settings. This role |
| 24 | + is appropriate for most developers in an organization. |
| 25 | +- **Billing Admin**: allows read/write access to features specific |
| 26 | + to a subscription and billing management, and limited access to other administrative features. |
| 27 | + |
| 28 | +CodeRabbit users with the **Admin** role can modify the roles of other users in the |
| 29 | +organization. |
| 30 | + |
| 31 | +For a complete list of the administrative functions available to each role, see |
| 32 | +[Role permissions](#permissions). |
| 33 | + |
| 34 | +### CodeRabbit roles and Git platform roles {#and-upstream} |
| 35 | + |
| 36 | +Modifying an account's CodeRabbit role doesn't have any "upstream" |
| 37 | +effect on that account's role or permissions in your organization's Git platform. |
| 38 | +Similarly, changes to an account's role on your organization's Git platform don't |
| 39 | +affect that account's CodeRabbit role. |
| 40 | + |
| 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 | +permission or ownership level with your GitHub organization doesn't change as a result. |
| 43 | + |
| 44 | +### CodeRabbit roles and developer features {#and-features} |
| 45 | + |
| 46 | +CodeRabbit roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews. |
| 47 | + |
| 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 role. |
| 50 | + |
| 51 | +For more information on seat and subscription management, see [Manage your subscription](/getting-started/subscription-management). |
| 52 | + |
| 53 | +## Default roles {#defaults} |
| 54 | + |
| 55 | +CodeRabbit assigns every user account in your organization a default role, |
| 56 | +using the following metrics: |
| 57 | + |
| 58 | +- If a user has an ownership-level role with the Git platform organization—for example, |
| 59 | + **Admin** on GitHub, or **Owner** on Bitbucket—then that user receives the default |
| 60 | + CodeRabbit role of **Admin**. |
| 61 | +- Otherwise, the user receives the **Member** role by default. |
| 62 | + |
| 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** role with the organization. |
| 65 | + |
| 66 | +CodeRabbit applies these defaults only when initially setting up for an |
| 67 | +account within an organization. Subsequent "upstream" role changes don't affect |
| 68 | +an account's CodeRabbit role. |
| 69 | + |
| 70 | +## View or set roles {#how-to} |
| 71 | + |
| 72 | +You can view and set roles from the CodeRabbit dashboard, as detailed in the |
| 73 | +following sections. |
| 74 | + |
| 75 | +### View roles {#view-roles} |
| 76 | + |
| 77 | +To view a list of your organization's role assignments, follow these steps: |
| 78 | + |
| 79 | +1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories). |
| 80 | +1. At the top of the sidebar, select the organization whose user roles you want to view. |
| 81 | +1. On the sidebar, click **Subscription**. |
| 82 | + |
| 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 role for |
| 85 | +each account. |
| 86 | + |
| 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 | + |
| 89 | +### Set roles {#set-roles} |
| 90 | + |
| 91 | +:::note |
| 92 | +To modify users' CodeRabbit accounts, your own account must have the **Admin** role within your organization. |
| 93 | +::: |
| 94 | + |
| 95 | +To change a user account's CodeRabbit role, follow these steps: |
| 96 | + |
| 97 | +1. Go to your organization's list of user accounts, as detailed in the previous section. |
| 98 | + If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus. |
| 99 | +1. Click the menu in the user's **Role** column, and select the appropriate role from |
| 100 | + the list. |
| 101 | + |
| 102 | +The only roles you can assign through this method are **Admin** and **Member**. |
| 103 | +You can't grant the **Billing Admin** role to an existing user account. To add an account with the **Billing Admin** role, see the next section. |
| 104 | + |
| 105 | +### Add billing admin accounts {#billing} |
| 106 | + |
| 107 | +:::note |
| 108 | +Billing Admin users don't require CodeRabbit seat licenses. You can add Billing Admin users regardless of how many seat licenses you have available. |
| 109 | +::: |
| 110 | + |
| 111 | +To add a CodeRabbit user account with the **Billing Admin** role, follow these steps: |
| 112 | + |
| 113 | +1. Go to your organization's list of user accounts, as detailed in [View roles](#view-roles). |
| 114 | +1. Click **Invite Billing Admin**. |
| 115 | +1. Enter the name and email address of the billing administrator who you want to invite to the organization. |
| 116 | + |
| 117 | +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. |
| 118 | + |
| 119 | +## Role permissions {#permissions} |
| 120 | + |
| 121 | +The following table lists the CodeRabbit administrative functionality |
| 122 | +available to each of the CodeRabbit roles. |
| 123 | + |
| 124 | +| Resource | Admin | Member | Billing Admin | |
| 125 | +| ----------------------- | ---------- | --------- | ------------- | |
| 126 | +| Learning Resources | Read/Write | Read-only | No access | |
| 127 | +| Metrics/Dashboard | Read/Write | No access | No access | |
| 128 | +| Reports | Read/Write | Read-only | No access | |
| 129 | +| Integrations | Read/Write | Read-only | No access | |
| 130 | +| Repository Settings | Read/Write | Read-only | No access | |
| 131 | +| Organization Settings | Read/Write | Read-only | No access | |
| 132 | +| User Management | Read/Write | Read-only | Read-only | |
| 133 | +| Subscription Management | Read/Write | Read-only | Read/Write | |
| 134 | +| Billing Management | Read/Write | No access | Read/Write | |
| 135 | + |
| 136 | +## What's next {#whats-next} |
| 137 | + |
| 138 | +- [Manage your subscription](/getting-started/subscription-management) |
0 commit comments