| title | shortTitle | intro | redirect_from | versions | topics | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Modifying a GitHub App registration |
Modify app settings |
{% data reusables.shortdesc.modifying_github_apps %} |
|
|
|
You can modify your {% data variables.product.prodname_github_app %} registration to change any of the settings that were selected when the app was initially registered. For more information about the settings you can select while registering a {% data variables.product.prodname_github_app %}, see "AUTOTITLE."
For example, you can change the name and description of your app, the permissions granted to your app, the webhooks your app subscribes to, or the visibility of your app.
You can also choose to test new optional features for your {% data variables.product.prodname_github_app %}. See "AUTOTITLE."
To modify a {% data variables.product.prodname_github_app %}, first navigate to the app settings page.
{% data reusables.apps.settings-step %} {% data reusables.apps.enterprise-apps-steps %} {% data reusables.user-settings.modify_github_app %}
You can change the basic information of your {% data variables.product.prodname_github_app %}, like the name of the app, the description of the app, and the homepage URL of the app.
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Under "Basic information," modify the {% data variables.product.prodname_github_app %} information that you'd like to change.
- Click Save changes.
You can prompt users to authorize your {% data variables.product.prodname_github_app %} when they install it and generate a user access token. When you request user authorization (OAuth) during installation, you must also provide a callback URL where the user will be redirected after they authorize the installation. See "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Under "Identifying and authorizing users," select or deselect Request user authorization (OAuth) during installation.
- Under "Callback URL," enter the full URL to redirect to after a user authorizes the installation.
You can use the device flow to authorize users for a headless app like a CLI tool or Git credential manager. For more information about using the device flow with {% data variables.product.prodname_github_apps %}, see "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Under "Identifying and authorizing users," select or deselect Enable Device Flow.
You can redirect people to a specific URL after they install your app. See "AUTOTITLE."
If you select Request user authorization (OAuth) during installation, you will not be able to enter a setup URL. Users will instead be redirected to the Callback URL as part of the authorization flow, where you can describe additional setup. See "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Under "Post installation," in the "Setup URL" field, enter the URL where you'd like to redirect users after they install your app.
- Optionally, if you want to redirect users to the setup URL after they update an installation, select Redirect on update. An update includes adding or removing a repository for an installation. If "Setup URL" is blank, this will be ignored.
You can change the access permissions that are granted to your {% data variables.product.prodname_github_app %} using the following steps.
When you change the repository or organization permissions of an app, each account where the app is installed will need to approve the new permissions. When you change the account permissions of an app, each user that has authorized the app will need to approve the permission changes. In both cases, {% data variables.product.prodname_dotcom %} will send an email to each organization owner or user, notifying them of the request to update the app's permissions. Updated permissions won't take effect on an installation or user authorization until the new permissions are approved. You can use the installation webhook to find out when people accept new permissions for your app.
Changing the permissions of an app may also change the webhooks that your app can subscribe to and the actions that your app can take with the API. See "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- In the {% data variables.product.prodname_github_apps %} settings sidebar, click Permissions & events.
- Under the sections "Repository permissions," "Organization permissions," and "Account permissions," modify the permissions you'd like to change. For each type of permission, select either "Read-only," "Read and write," or "No access" from the dropdown. See "AUTOTITLE."
- Optionally, under "Add a note to users," add a note telling your users why you are changing the permissions that your {% data variables.product.prodname_github_app %} requests.
- Click Save changes.
You can configure your {% data variables.product.prodname_github_app %} to receive webhooks for specific events on {% data variables.product.prodname_dotcom %} and automatically take action on them. See "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Under "Webhook," to enable or disable the webhook, select or deselect Active.
- If you selected Active in the previous step, under "Webhook URL," enter the URL that {% data variables.product.prodname_dotcom %} should send webhook events to.
- Optionally, if you selected Active in the previous step, under "Webhook secret," enter a secret token to secure your webhooks. {% data variables.product.prodname_dotcom %} highly recommends that you set a webhook secret.
You can change the webhook events that a {% data variables.product.prodname_github_app %} subscribes to using the following steps.
{% data reusables.apps.webhooks-and-apps %} See "AUTOTITLE."
{% data reusables.apps.navigate-to-app-settings-this-article %}
- Activate the {% data variables.product.prodname_github_app %} webhook. See "Activating or deactivating the {% data variables.product.prodname_github_app %} webhook" in this article.
- In the {% data variables.product.prodname_github_apps %} settings sidebar, click Permissions & events.
- Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. See "Changing the permissions of a {% data variables.product.prodname_github_app %}."
- Under "Subscribe to Events," select the webhook events you would like your {% data variables.product.prodname_github_app %} to receive.
- Click Save changes.
You can change the visibility settings of your {% data variables.product.prodname_github_app %} to control who can install it. Public apps cannot be made private if they're installed on other accounts. See "AUTOTITLE."
{% ifversion enterprise-apps-public-beta %} You can't change the visibility of an {% data variables.product.prodname_github_app %} owned by an enterprise. {% data variables.product.prodname_github_apps %} owned by an enterprise can only be installed on organizations within the enterprise. {% endif %}
{% data reusables.apps.navigate-to-app-settings-this-article %} {% data reusables.user-settings.github_apps_advanced %}
- Under "Danger zone," depending on the current visibility of your {% data variables.product.prodname_github_app %}, click either Make public or Make private.