title | intro | versions | topics | shortTitle | permissions | product | |||
---|---|---|---|---|---|---|---|---|---|
About custom organization roles |
You can control access to your {% ifversion org-custom-role-with-repo-permissions %}organization's settings and repositories{% else %}organization's settings{% endif %} with custom organization roles. |
|
|
Custom organization roles |
Organization owners and users with the "Manage custom organization roles" permission |
Organizations on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghes %} and {% data variables.product.prodname_ghe_server %}{% endif %} |
{% data reusables.organizations.custom-org-roles-intro %}
You can create and assign custom organization roles in your organization's settings. You can also manage custom roles using the REST API. See "AUTOTITLE."
{% ifversion org-custom-role-with-repo-permissions %}
You can also create a custom organization role that includes permissions for repositories. Repository permissions grant access to all current and future repositories in the organization.
There are several ways to combine permissions for repositories and organizations.
- You can create a role that includes permissions for organization settings, a base role for repository access, or both.
- If you add a base role for repository access, you can also include additional repository permissions. You can't add repository permissions without a base repository role.
Without repository permissions or a base repository role, the organization role doesn't grant access to any repositories.
[!NOTE] Adding repository permissions to a custom organization role is currently in {% data variables.release-phases.public_preview %} and subject to change.
{% endif %}
To grant access to specific repositories in your organization, you can create a custom repository role. See "AUTOTITLE."
When you include a permission in a custom organization role, any users with that role will have access to the corresponding settings via both the web browser and API. In the organization's settings in the browser, users will see only the pages for settings they can access.
Organization permissions do not grant read, write, or administrator access to any repositories. Some permissions may implicitly grant visibility of repository metadata, as marked in the table below.
{% rowheaders %}
Permission | Description | More information |
---|---|---|
Manage custom organization roles | Access to create, view, update, and delete custom organization roles within the organization. This permission does not allow a user to assign custom roles. | "AUTOTITLE" |
View organization roles | Access to view the organization's custom organization roles. | "AUTOTITLE" |
Manage custom repository roles | Access to create, view, update, and delete the organization's custom repository roles. | "AUTOTITLE" |
View custom repository roles | Access to view the organization's custom repository roles. | "AUTOTITLE" |
Manage organization webhooks | Access to register and manage webhooks for the organization. Users with this permission will be able to view webhook payloads, which may contain metadata for repositories in the organization. | "AUTOTITLE" |
{% ifversion ghec %} | ||
Manage organization OAuth app policies | Access to the "OAuth app policy" settings for the organization. | "AUTOTITLE" |
{% endif %} | ||
{% ifversion repository-properties %} | ||
Edit custom properties values at the organization level | Access to set custom property values on all repositories in the organization. | "AUTOTITLE" |
Manage the organization's custom properties definitions | Access to create and edit custom property definitions for the organization. | "AUTOTITLE" |
{% endif %} | ||
{% ifversion repo-rules-enterprise %} | ||
Manage organization ref update rules and rulesets | Access to manage rulesets and view ruleset insights at the organization level. | "AUTOTITLE" |
{% endif %} | ||
View organization audit log | Access to the audit log for the organization. The audit log may contain metadata for repositories in the organization. | "AUTOTITLE" |
Manage organization Actions policies | Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. | "AUTOTITLE" |
Manage organization runners and runner groups | Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. | "AUTOTITLE" "AUTOTITLE" |
Manage organization Actions secrets | Access to create and manage Actions organization secrets. | "AUTOTITLE" |
Manage organization Actions variables | Access to create and manage Actions organization variables. | "AUTOTITLE" |
{% ifversion actions-metrics %} | ||
View organization Actions metrics | View {% data variables.product.prodname_actions %} metrics for your organization. | "AUTOTITLE" |
{% endif %} | ||
{% ifversion push-protection-bypass-fine-grained-permissions %} | ||
Review and manage {% data variables.product.prodname_secret_scanning %} bypass requests | Review and manage {% data variables.product.prodname_secret_scanning %} bypass requests for your organization. | "AUTOTITLE" |
{% endif %} |
{% endrowheaders %}
{% ifversion org-custom-role-with-repo-permissions %}
The base repository role determines the initial set of permissions included in the custom role. Repository access is granted across all current and future repositories in the organization.
The base repository roles are:
- Read: Grants read access to all repositories in the organization.
- Write: Grants write access to all repositories in the organization.
- Triage: Grants triage access to all repositories in the organization.
- Maintain: Grants maintenance access to all repositories in the organization.
- Admin: Grants admin access to all repositories in the organization.
After choosing a base repository role, you can select additional permissions for your custom organization role.
You can only choose an additional permission if it's not already included in the base repository role. For example, if the base role offers Write access to a repository, then the "Close a pull request" permission will already be included in the base role.
{% data reusables.organizations.additional-permissions %}
{% data reusables.organizations.precedence-for-different-levels %}
{% endif %}