GitHub App を作成する

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

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

    • ユーザアカウントが所有するGitHub Appの場合、任意のページの右上でプロフィール写真をクリックしてから、Settings(設定)をクリックしてください。 ユーザバーの [Settings(設定)] アイコン
    • Organizationが所有するGitHub Appの場合、任意のページの右上でプロフィール写真をクリックしてから、Your organizations(自分のOrganization)をクリックしてください。 そして、Organizationの右のSettings(設定)をクリックしてください。 プロフィールメニューのあなたのOrganization 設定ボタン
  2. 左サイドバーで [Developer settings] をクリックします。 Developer settings(開発者設定)セクション

  3. 左のサイドバーでGitHub Appsをクリックしてください。 GitHub Apps セクション

  4. [New GitHub App] をクリックします。 新しい GitHub App を作成するボタン

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

    アプリケーションには簡潔で明快な名前を付けましょう。 Your app cannot have the same name as an existing GitHub account, unless it is your own user or organization name. インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。

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

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

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

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

    [Add callback URL] のボタンと コールバック URL のフィールド

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

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

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

    注釈: 前のステップで [Request user authorization (OAuth) during installation] を選択した場合、このフィールドは利用できなくなり、アプリケーションのインストール後にユーザは [User authorization callback URL] にリダイレクトされます。

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

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

    注釈: シークレットトークンは、設定することを強くお勧めします。 詳しい情報については「webhookをセキュアにする」を参照してください。

  14. [Permissions] で、アプリケーションが要求する権限を選択します。 権限の各タイプで、ドロップダウンメニューを使用して [Read-only]、[Read & write]、または[No access] をクリックします。 GitHub App のさまざまな権限

  15. In "Subscribe to events", choose the events you want your app to receive.

  16. アプリケーションをインストールする場所を、[Only on this account] (このアカウントのみ) と [Any account] (すべてのアカウント) から選びます。 これらのオプションに関する詳しい情報については、「GitHub App をパブリックまたはプライベートにする」を参照してください。 GitHub App のインストールオプション

  17. [Create GitHub App] をクリックします。 GitHub App を作成するボタン

このドキュメントは役立ちましたか?プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡