GitHub App の変更について
GitHub App 登録を変更することで、最初にアプリを登録した時に選択した設定を変更できます。 GitHub App の登録時に選択できる設定について詳しくは、「GitHub App の登録」を参照してください。
たとえば、アプリの名前と説明、アプリに付与されるアクセス許可、アプリがサブスクライブする Webhook、またはアプリの可視性を変更できます。
また、GitHub App の新しいオプション機能をテストすることもできます。 「GitHub アプリのオプション機能のアクティブ化」を参照してください。
GitHub App 設定への移動
GitHub App を変更するには、まずアプリの設定ページに移動します。
- GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。
- アカウント設定にアクセスしてください。
- 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
- 組織が所有するアプリの場合:
- [自分の組織] をクリックします。
- 組織の右側にある [設定] をクリックします。
- 左側のサイドバーで [ 開発者設定] をクリックします。
- 左側のサイドバーで、 [GitHub Apps] をクリックします。
- 変更する GitHub App の右で [編集] をクリックします。
GitHub App の基本情報の変更
アプリの名前、アプリの説明、アプリのホームページ URL など、GitHub App の基本情報を変更できます。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- [基本] で、変えたい GitHub App の情報を変更します。
- [変更を保存] をクリックします。
インストール時のユーザー認可 (OAuth) の要求
GitHub App をインストールし、ユーザー アクセス トークンを生成するときに、ユーザーに認可するように求めます。 インストール時にユーザー認可 (OAuth) を要求する場合、ユーザーがインストールを認可した後のリダイレクト先とするコールバック URL も指定する必要があります。 「GitHub アプリのユーザー アクセス トークンの生成」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- [ユーザーの識別と認可] で [インストール時にユーザー認可 (OAuth) を要求する] をオンまたはオフにします。
- [コールバック URL] に、ユーザーがインストールを認可した後のリダイレクト先とする URL を完全な形式で入力します。
デバイス フローの有効化または無効化
デバイス フローを使って、CLI ツールや Git 資格情報マネージャーなどのヘッドレス アプリのユーザーを認可できます。 GitHub Apps でのデバイス フローの使用の詳細については、「GitHub アプリのユーザー アクセス トークンの生成」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- [ユーザーの識別と認可] で [デバイス フローを有効にする] をオンまたはオフにします。
セットアップ URL の追加または更新
アプリをインストールした後、ユーザーを特定の URL にリダイレクトできます。 「GitHub App の登録」を参照してください。
[インストール時にユーザー認可 (OAuth) を要求する] を選んだ場合は、セットアップ URL を入力できません。 代わりに、ユーザーは承認フローの一部としてコールバック URL にリダイレクトされます。ここで、追加のセットアップを説明できます。 「ユーザー承認コールバック URL について」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- [インストール後] の [セットアップ URL] フィールドに、ユーザーがアプリをインストールした後のリダイレクト先とする URL を入力します。
- 必要に応じて、インストールの更新後にユーザーをセットアップ URL にリダイレクトする場合は、 [更新時にリダイレクト] を選択します。 更新には、インストール用のリポジトリの追加または削除が含まれます。 [セットアップ URL] が空白の場合、これは無視されます。
GitHub App のアクセス許可の変更
以下の手順を使って、GitHub App に付与されるアクセス許可を変更できます。
アプリのリポジトリまたは組織のアクセス許可を変更する場合、アプリがインストールされている各アカウントで、新しいアクセス許可を承認する必要があります。 アプリのアカウントのアクセス許可を変更する場合、アプリを認可した各ユーザーが、アクセス許可の変更を認可する必要があります。 どちらの場合も、GitHub は Organization のオーナーまたはユーザーに電子メールを送信し、アプリのアクセス許可を更新する要求を通知します。 新しいアクセス許可が承認されるまで、更新されたアクセス許可はインストールまたはユーザー認可に対して有効になりません。 インストール Webhook を使って、ユーザーがアプリの新しいアクセス許可を受け入れるタイミングを確認できます。
アプリのアクセス許可を変更すると、アプリがサブスクライブできる Webhook や、アプリが API を使って実行できるアクションも変わる場合があります。 「GitHub アプリのアクセス許可を選択する」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- GitHub Apps 設定サイドバーで、 [アクセス許可とイベント] をクリックします。
- セクション [リポジトリのアクセス許可]、[Organization のアクセス許可]、[アカウントのアクセス許可] で、変えたいアクセス許可を変更します。 アクセス許可の各タイプに、ドロップダウンから [読み取り専用]、[読み取りと書き込み]、[アクセスなし] のいずれかを選びます。 「GitHub アプリのアクセス許可を選択する」を参照してください。
- 必要に応じて、[ユーザーにメモを追加する] で、GitHub App が要求するアクセス許可を変更する理由をユーザーに伝えるメモを追加します。
- [変更を保存] をクリックします。
GitHub App Webhook のアクティブ化と非アクティブ化
GitHub で特定のイベントの Webhook を受け取り、それらに対して自動的にアクションを実行するように、GitHub App を構成することができます。 「GitHub Apps での Webhook の使用」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- [Webhook] で Webhook を有効または無効にするには、 [アクティブ] をオンまたはオフにします。
- 前の手順で [アクティブ] を選んだ場合は、[Webhook URL] に、GitHub から Webhook イベントを送信する先となる URL を入力します。
- 必要に応じて、前の手順で [アクティブ] を選んだ場合は、[Webhook シークレット] に、Webhook をセキュリティで保護するためのシークレット トークンを入力します。 GitHub では、Webhook シークレットを設定することを強くお勧めします。
GitHub App の Webhook イベント サブスクリプションの変更
以下の手順を実行して GitHub App がサブスクライブする Webhook イベントを変更できます。
GitHub App の登録で選択できる具体的な Webhook イベントは、アプリに対して選択したアクセス許可の種類によって決まります。 まず、アプリに付与するアクセス許可を選択する必要があります。これで、そのアクセス許可のセットに関連する Webhook イベントにアプリをサブスクライブできます。 「GitHub Apps での Webhook の使用」をご覧ください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- GitHub App Webhook をアクティブ化します。 この記事の「GitHub App のアクティブ化と非アクティブ化」を参照してください。
- GitHub Apps 設定サイドバーで、 [アクセス許可とイベント] をクリックします。
- セクション [リポジトリのアクセス許可]、[組織のアクセス許可]、[アカウントのアクセス許可] で、アプリがサブスクライブするイベントに必要なアクセス許可を選びます。 「GitHub App のアクセス許可の変更」を参照してください。
- [イベントにサブスクライブする] で、GitHub App で受け取りたい Webhook イベントを選びます。
- [変更を保存] をクリックします。
GitHub App の可視性の変更
GitHub App の可視性設定を変更して、インストールできるユーザーを制御できます。 パブリック アプリは、他のアカウントにインストールされている場合、非公開にすることはできません。 「GitHub Appをパブリックまたはプライベートにする」を参照してください。
- 変更するアプリの設定ページに移動します。 詳細については、この記事の「GitHub App 設定への移動」を参照してください。
- 左側のサイドバーで、 [詳細設定] をクリックします。
- [危険ゾーン] で、GitHub App の現在の可視性に応じて、 [公開する] または [非公開にする] のいずれかをクリックします。