Enterprise installations for GitHub Apps and enterprise app managers (#56338)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: isaacmbrown <isaacmbrown@github.com>
This commit is contained in:
Hirsch Singhal
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Adding and removing GitHub App managers in your enterprise
|
||||
intro: 'Enterprise owners can grant or revoke access for a user to manage individual {% data variables.product.prodname_github_apps %} owned by the enterprise.'
|
||||
versions:
|
||||
feature: enterprise-app-manager
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- GitHub Apps
|
||||
permissions: Enterprise owners.
|
||||
shortTitle: Enterprise App managers
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_github_app %} managers
|
||||
|
||||
Enterprise owners can designate other users in their enterprise as {% data variables.product.prodname_github_app %} managers for individual apps. {% data variables.product.prodname_github_app %} managers can manage the settings of specific {% data variables.product.prodname_github_app %} registrations that are owned by the enterprise. The {% data variables.product.prodname_github_app %} manager role does not grant recipients access to install and uninstall {% data variables.product.prodname_github_apps %} on an enterprise or organization. For more information about the specific app settings that {% data variables.product.prodname_github_app %} managers can control, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app).
|
||||
|
||||
When an enterprise app manager adds permissions to a {% data variables.product.prodname_github_app %}, the update is automatically accepted in all organizations where the app manager is also an organization owner. When an enterprise owner adds permissions to a {% data variables.product.prodname_github_app %}, the update is automatically accepted in all organizations regardless of their organization membership.
|
||||
|
||||
## Granting the ability to manage an individual {% data variables.product.prodname_github_app %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.github-apps-tab %}
|
||||
|
||||
1. Under "{% data variables.product.prodname_github_apps %}", click on the avatar of the app you'd like to add a {% data variables.product.prodname_github_app %} manager for.
|
||||
1. In the left sidebar, click **App managers**.
|
||||
1. At the bottom of the "App managers" section, in the search field, type the username of the person you want to designate as a GitHub App manager for the app, then click **Grant**.
|
||||
|
||||
The user must be a member of the enterprise to be granted {% data variables.product.prodname_github_app %} manager permissions.
|
||||
|
||||
## Removing managers from an individual {% data variables.product.prodname_github_app %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.github-apps-tab %}
|
||||
|
||||
1. Under "{% data variables.product.prodname_github_apps %}", click on the avatar of the app you'd like to remove a {% data variables.product.prodname_github_app %} manager from.
|
||||
1. In the left sidebar, click **App managers**.
|
||||
1. Under "App managers", next to the person you want to remove {% data variables.product.prodname_github_app %} manager permissions from, click **Revoke**.
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/admin/managing-your-enterprise-account/creating-github-apps-for-your-enterprise)
|
||||
* [AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Creating GitHub Apps for your enterprise
|
||||
intro: 'Learn how to create a {% data variables.product.prodname_github_app %} for organizations within your enterprise.'
|
||||
intro: 'Learn how to create a {% data variables.product.prodname_github_app %} for your enterprise.'
|
||||
versions:
|
||||
feature: enterprise-apps-public-beta
|
||||
type: how_to
|
||||
@@ -10,13 +10,18 @@ permissions: Enterprise owners.
|
||||
shortTitle: Create a GitHub App
|
||||
---
|
||||
|
||||
You can create a {% data variables.product.prodname_github_app %} under your enterprise account. The app can only be installed on organizations within your enterprise, and can only be authorized by members of your enterprise. The app can't be installed on user accounts.
|
||||
You can create a {% data variables.product.prodname_github_app %} under your enterprise account. The app can only be installed on{% ifversion enterprise-installed-apps %} your enterprise or{% endif %} organizations within your enterprise, and can only be authorized by members of your enterprise. The app can't be installed on user accounts.
|
||||
|
||||
## Step 1: Registering a {% data variables.product.prodname_github_app %}
|
||||
|
||||
To create a {% data variables.product.prodname_github_app %}, you must first register the app. See [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/registering-a-github-app).
|
||||
|
||||
Apps can also be transferred to an enterprise from a member or organization. To transfer an app, see [AUTOTITLE](/apps/maintaining-github-apps/transferring-ownership-of-a-github-app).
|
||||
{%- ifversion enterprise-app-manager %}
|
||||
|
||||
### Step 1a: Adding an enterprise app manager
|
||||
|
||||
Enterprise owners can add enterprise members to an app as an app manager. App managers can manage the app's settings and credentials, but cannot install the app. For more information, see [AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers).{% endif %}
|
||||
|
||||
## Step 2: Building a {% data variables.product.prodname_github_app %}
|
||||
|
||||
@@ -30,11 +35,11 @@ After registering a {% data variables.product.prodname_github_app %}, you will w
|
||||
|
||||
You should aim to follow best practices. See [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app).
|
||||
|
||||
## Step 3: Authorizing or sharing your {% data variables.product.prodname_github_app %}
|
||||
## Step 3: Authorizing or installing your {% data variables.product.prodname_github_app %}
|
||||
|
||||
Once your {% data variables.product.prodname_github_app %} is registered, you'll need to make it available to organizations in your enterprise, either through **authorization** or **installation**, depending on the app’s purpose.
|
||||
Once your {% data variables.product.prodname_github_app %} is registered, you'll need to make it available for use, either through **authorization** or **installation**, depending on the app’s purpose.
|
||||
|
||||
Enterprise owners can modify the permissions for apps owned by their enterprise at any time. Permissions changes will be automatically accepted by organizations in the enterprise.
|
||||
Enterprise owners {% ifversion enterprise-app-manager %}and app managers {% endif %}can modify the permissions for apps owned by their enterprise at any time. Permissions changes will be automatically accepted by organizations in the enterprise{% ifversion enterprise-app-manager %} if the change was made by the enterprise owner. Otherwise, the changes will be accepted only where the app manager is also an organization owner, and an organization owner must accept the update request for all other organizations{% endif %}.
|
||||
|
||||
### Step 3a: Authorizing your {% data variables.product.prodname_github_app %}
|
||||
|
||||
@@ -47,3 +52,5 @@ For apps that require installation to function, you can provide organization own
|
||||
## Step 4: Installing your {% data variables.product.prodname_github_app %} (if required)
|
||||
|
||||
If your {% data variables.product.prodname_github_app %} requires installation (not just authorization), organization owners can use the install link to install the app on their organization. See [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party).
|
||||
|
||||
{% ifversion enterprise-installed-apps %}If your app uses enterprise permissions, you can install it on your enterprise. To find the installation link, go to the app's settings page in your enterprise account. See [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-on-your-enterprise).{% endif %}
|
||||
|
||||
@@ -11,5 +11,6 @@ children:
|
||||
- /deleting-an-enterprise-account
|
||||
- /changing-the-url-for-your-enterprise
|
||||
- /creating-github-apps-for-your-enterprise
|
||||
- /adding-and-removing-github-app-managers-in-your-enterprise
|
||||
shortTitle: Manage enterprise account
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user