Skip to main content

GitHub App を作成する

個人アカウントの下で、あるいは管理アクセス権を持っているOrganizationの下で、GitHub Appを作成し、登録できます。

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

    • 個人アカウントが所有する GitHub App の場合、任意のページの右上でプロファイル写真をクリックしてから、 [設定] をクリックします。 ユーザバーの [Settings(設定)] アイコン
    • 組織が所有する GitHub App の場合、任意のページの右上でプロファイル写真をクリックしてから、 [Your organizations](自分の組織) をクリックします。 次に、組織の右側にある [設定] をクリックします。 プロファイル メニューの [Your organizations](自分の組織) [設定] ボタン
  2. In the left sidebar, click Developer settings.

  3. 左側のサイドバーで、 [GitHub アプリ] をクリックします。 [GitHub アプリ] セクション

  4. [新しい GitHub アプリ] をクリックします。 新しい GitHub アプリを作成するためのボタン

  5. [GitHub App name] に、アプリケーションの名前を入力します。 GitHub アプリの名前を入力するフィールド

    アプリケーションには簡潔で明快な名前を付けましょう。 アプリケーションの名前は、既存の GitHub アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名や Organization 名である場合は例外です。 インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。

  6. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Description] に入力します。 GitHub アプリの説明を入力するフィールド

  7. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 GitHub アプリのホームページの URL を入力するフィールド

  8. [Callback URL] に、ユーザがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。

    [コールバック URL の追加] を使用して、最大 10 個のコールバック URL を追加できます。

    コールバック URL を追加するためのボタンとコールバック URL を入力するフィールド

  9. デフォルトでは、アプリケーションのセキュリティを高めるため、アプリケーションは期限付きのユーザ認可トークンを使用します。 期限付きのユーザトークンの使用をオプトアウトするには、[Expire user authorization tokens] の選択を解除する必要があります。 更新トークン フローの設定とユーザー トークンの期限設定の利点の詳細については、「ユーザーからサーバーへのアクセス トークンの更新」を参照してください。 GitHub アプリのセットアップ時にユーザー トークンの期限設定をオプトインするためのオプション

  10. アプリが OAuth フローを使用してユーザーを認可する場合は、 [インストール時にユーザーの認可 (OAuth) を要求する] を選択して、ユーザーがアプリをインストール時に認可するように設定できます。 このオプションを選択した場合、[Setup URL] が利用できなくなり、アプリケーションのインストール後にユーザはあなたが設定した [User authorization callback URL] にリダイレクトされます。 詳細については、「インストール中のユーザーの認可」を参照してください。 インストール時のユーザーの認可の要求

  11. GitHub アプリでデバイス フローを使用してユーザーを特定および認可する場合は、 [デバイス フローを有効にする] をクリックします。 デバイス フローの詳細については、「OAuth アプリを認可する」を参照してください。 デバイス フローを有効にするためのフィールドを示すスクリーンショット

  12. インストール後に追加の設定が必要な場合、[Setup URL] を追加して、アプリケーションをインストールした後にユーザをリダイレクトします。 GitHub アプリのセットアップ URL を入力するフィールド

    注: 前の手順で [インストール時にユーザーの認可 (OAuth) を要求する] を選択した場合は、このフィールドを使用できません。ユーザーはアプリのインストール後に [ユーザー認可のコールバック URL] にリダイレクトされます。

  13. [Webhook URL] に、イベントが POST する URL を入力します。 各アプリケーションは、アプリケーションがインストールまたは変更されたり、アプリケーションがサブスクライブしているその他のイベントが発生したりするたびに、アプリケーションで設定した webhook を受信します。 GitHub アプリの Webhook URL を入力するフィールド

  14. 必要に応じて、webhook を保護するための、オプションのシークレットトークンを [Webhook Secret] に入力します。 Webhook のシークレット トークンを追加するためのフィールド

    注: シークレット トークンを設定することを強くお勧めします。 詳細については、「webhook のセキュリティ保護」をご覧ください。

  15. [Permissions] で、アプリケーションが要求する権限を選択します。 アクセス許可の種類ごとに、ドロップダウン メニューを使用して [読み取り専用][読み取りおよび書き込み] 、または [アクセス権なし] をクリックします。 GitHub アプリのさまざまなアクセス許可

  16. [Subscribe to events] で、アプリケーションが受け取るイベントを選択します。

  17. アプリをインストールできる場所を選択するには、 [このアカウントのみ] または [任意のアカウント] を選択します。 インストール オプションの詳細については、「GitHub アプリをパブリックまたはプライベートにする」を参照してください。 GitHub アプリのインストール オプション

  18. [GitHub アプリの作成] をクリックします。 GitHub アプリを作成するためのボタン