Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。
現在、GitHub AE は限定的リリースです。

Modifying a GitHub App registration

GitHub App を作成した後に変更を加えることができます。

About GitHub App modifications

You can modify your 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 GitHub App, see "Registering a GitHub App."

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 GitHub App. For more information, see "Activating optional features for GitHub Apps."

To modify a GitHub App, first navigate to the app settings page.

  1. アカウント設定にアクセスしてください。

    • 個人アカウントが所有する GitHub App の場合、任意のページの右上でプロファイル写真をクリックしてから、 [設定] をクリックします。
    • 組織が所有する GitHub App の場合、任意のページの右上でプロファイル写真をクリックしてから、 Your organizations をクリックします。 次に、組織の右側にある [設定] をクリックします。
  2. 左側のサイドバーで [ 開発者設定] をクリックします。

  3. 左側のサイドバーで、 [GitHub App] をクリックします。 GitHub の [開発者向け設定] ページのスクリーンショット。 [GitHub Apps] というオプションが濃いオレンジ色の枠線で囲まれています。

  4. 変更する GitHub App の右で [編集] をクリックします。

Changing the basic information of a GitHub App

You can change the basic information of your GitHub App, like the name of the app, the description of the app, and the homepage URL of the app.

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Under "Basic information," modify the GitHub App information that you'd like to change.
  3. Click Save changes.

Requesting user authorization (OAuth) during installation

You can prompt users to authorize your 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. For more information, see "GitHub アプリのユーザー アクセス トークンの生成."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Under "Identifying and authorizing users," select or deselect Request user authorization (OAuth) during installation.
  3. Under "Callback URL," enter the full URL to redirect to after a user authorizes the installation.

Enabling or disabling the device flow

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 GitHub Apps, see "GitHub アプリのユーザー アクセス トークンの生成."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Under "Identifying and authorizing users," select or deselect Enable Device Flow.

Adding or updating a setup URL

You can redirect people to a specific URL after they install your app. For more information, see "Registering a GitHub App."

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. For more information, see "About the user authorization callback URL."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Under "Post installation," in the "Setup URL" field, enter the URL where you'd like to redirect users after they install your app.
  3. 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.

Changing the permissions of a GitHub App

You can change the access permissions that are granted to your 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. 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. For more information, see "Choosing permissions for a GitHub App."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. In the GitHub Apps settings sidebar, click Permissions & events.
  3. 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. For more information, see "Choosing permissions for a GitHub App."
  4. Optionally, under "Add a note to users," add a note telling your users why you are changing the permissions that your GitHub App requests.
  5. Click Save changes.

Activating or deactivating the GitHub App webhook

You can configure your GitHub App to receive webhooks for specific events on GitHub and automatically take action on them. For more information, see "Using webhooks with GitHub Apps."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Under "Webhook," to enable or disable the webhook, select or deselect Active.
  3. If you selected Active in the previous step, under "Webhook URL," enter the URL that GitHub should send webhook events to.
  4. Optionally, if you selected Active in the previous step, under "Webhook secret," enter a secret token to secure your webhooks. GitHub highly recommends that you set a webhook secret.

Changing the webhook event subscriptions of a GitHub App

You can change the webhook events that a GitHub App subscribes to using the following steps.

アプリ設定で選択できる特定の Webhook イベントは、アプリに対して選択したアクセス許可の種類によって決まります。 まず、アプリに付与するアクセス許可を選択する必要があります。これで、そのアクセス許可のセットに関連する Webhook イベントにアプリをサブスクライブできます。 For more information, see "Using webhooks with GitHub Apps."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. Activate the GitHub App webhook. For more information, see "Activating or deactivating the GitHub App webhook" in this article.
  3. In the GitHub Apps settings sidebar, click Permissions & events.
  4. Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. For more information, see "Changing the permissions of a GitHub App."
  5. Under "Subscribe to Events," select the webhook events you would like your GitHub App to receive.
  6. Click Save changes.

Changing the visibility of a GitHub App

You can change the visibility settings of your GitHub App to control who can install it. Public apps cannot be made private if they're installed on other accounts. For more information, see "Making a GitHub App public or private."

  1. 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
  2. 左側のサイドバーで、 [詳細設定] をクリックします。
  3. Under "Danger zone," depending on the current visibility of your GitHub App, click either Make public or Make private.