外部コンテンツのインデックス作成用に GitHub Enterprise Cloud を構成する

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：6分

    • GitHub Enterprise Cloud 外部コンテンツコネクタが GitHub Enterprise Cloud コンテンツにアクセスできるように、GitHubアプリを作成して承認します。

    始める前に

    次のすべてが必要です。

    必要なロール：なし

    このタスクについて

    GitHub Enterprise クラウド外部コンテンツコネクタは、GitHub REST API を使用して、GitHub Enterpriseクラウドソースシステムのパブリックリポジトリと内部リポジトリで見つかったコミット、問題、およびプル要求から検索可能なコンテンツとメタデータを取得します。

    コネクタが REST API を介して GitHub Enterprise Cloud ソースシステムにアクセスできるようにするには、GitHub Enterprise Cloud で組織の GitHub アプリを構成して承認する必要があります。コネクタアドミンは、GitHub アプリからコピーした設定を使用して、ソースシステムに適切に接続できるように GitHub Enterprise Cloud 外部コネクタを構成できます。

    手順

    1. GitHub Enterprise Cloud 外部コンテンツコネクタの新しい GitHub アプリを作成します。
      1. https://github.com/に移動し、GitHub Enterprise Cloud 認証情報でログインします。
      2. プロファイル画像を選択し、コンテキストメニューから [ あなたの会社 ] を選択します。
        エンタープライズ マネージド ユーザーを使用しない場合は、[ エンタープライズ] を選択し、[ 設定] を選択します。
      3. メニューで、次の場所に移動します 設定 > 開発者設定 > GitHub アプリ.
      4. [ 新しい GitHub アプリ] を選択します。
      5. [新しい GitHub アプリを登録 (Register new App)] ページで、新しい GitHub アプリの名前を入力します。
        たとえば、「 外部コンテンツコネクタ」と入力します。
        注:
        アプリ名の長さは 34 文字を超えることはできません。
      6. [ ホームページ URL ] フィールドに、組織の GitHub アカウントの URL を入力します。
        たとえば、「 https://github.com/example」と入力します。
      7. [Webhook] セクションで、[ アクティブ] オプションをオフにします。
      8. [アクセス許可] セクションで、[リポジトリのアクセス許可] リストを展開し、これらの各アクセス許可の [読み取り専用 アクセス] を選択します。
        • コミットステータス
        • コンテンツ
        • ディスカッション
        • 問題
        • キューを結合
        • プル要求
      9. [アクセス許可] セクションで、[組織のアクセス許可] リストを展開し、[メンバー] アクセス許可の [読み取り専用アクセス] を選択します。
      10. [ この GitHub アプリをどこにインストールできますか? (Where can this App be install?)] フィールドで、[ このアカウントのみ] オプションを選択します。
      11. [アプリを作成] GitHubを選択します。
      新しい GitHub アプリが正常に登録されたことを示すメッセージが表示され、全般的な設定ページに移動します。
    2. 全般設定ページから新しい GitHub アプリのクライアント ID と秘密鍵を取得します。
      1. [関連情報] セクションで、新しい GitHub アプリのクライアント ID をコピーし、安全な場所に保存します。
        重要:
        外部コンテンツコネクタアドミンは、 GitHub Enterprise クラウド外部コンテンツコネクタを構成するときにこのクライアント ID を必要とします。
      2. [秘密鍵] セクションで、[ 秘密鍵の生成] を選択します。
      3. プロンプトが表示されたら、PEM 形式の秘密鍵証明書ファイルを安全な場所にダウンロードします。
        重要:
        外部コンテンツコネクタアドミンは、 GitHub Enterprise クラウド外部コンテンツコネクタを構成するときに、この PEM 形式の秘密キー証明書ファイルを必要とします。
    3. 新しい GitHub アプリをインストールします。
      1. 新しい GitHub アプリのメニューで、[ アプリのインストール] を選択します。
      2. GitHub組織アカウントのエントリで、[インストール] を選択します。
      3. 新しい GitHub アプリの [インストール] ページで、外部コンテンツコネクタがアクセスできるようにするリポジトリを選択します。
        • 組織が所有するすべてのリポジトリへのアクセス権を外部コンテンツコネクタに付与するには、 [ すべてのリポジトリ] を選択します。
        • 組織が所有するリポジトリの指定されたセットへの外部コンテンツコネクタのアクセス権を付与するには、[ リポジトリのみを選択 (Only select repositories)] を選択し、[ リポジトリを選択 (Select repositories )] ドロップダウンリストを使用して、コネクタにアクセス権を付与するリポジトリを検索して選択します。
      4. [Install (インストール)] を選択します。
    4. 新しい GitHub アプリのアプリインストール ID を取得します。
      1. GitHub組織ページの URL からGitHub組織の識別子を取得します。
        組織の識別子は、 GitHub 組織ページの URL の 3 番目のスラッシュの後の URL 要素です。たとえば、 GitHub 組織ページの URL が https://github.com/example の場合、組織の識別子は example です。
      2. 新しい GitHub アプリの JSON Web トークン (JWT) を生成します。
        Ruby、Python、bash、または PowerShell を使用して GitHub アプリの JWT を生成する方法の詳細については、 https://docs.github.com/en/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app GitHub ドキュメントリソースを参照してください。

        JWT を生成するには、ステップ 2.a でコピーしたクライアント ID と、ステップ 2.c でダウンロードした PEM 形式のクライアントシークレット証明書ファイルが必要です。

        重要:
        JWT は作成から 10 分後に期限切れになります。次の手順を実行する前に有効期限が切れた場合は、この手順を繰り返して新しい JWT を生成します。
      3. 次の curl コマンドを実行し、 <org> を GitHub 組織の識別子に置き換え、 <json-web-token> を生成した JWT に置き換えます。 
        curl --request GET \
  --url "https://api.github.com/orgs/<org>/installation" \
  --header "Accept: application/vnd.github+json" \
  --header "Authorization: Bearer <json-web-token>" \
  --header "X-GitHub-Api-Version: 2022-11-28"
      4. JSON 応答オブジェクトで、アプリケーションインストールの ID キーと値のペアを見つけ、その値をコピーして安全な場所に保存します。
        重要:
        外部コンテンツコネクタアドミンは、 GitHub Enterprise クラウド外部コンテンツコネクタを構成するときにこのアプリのインストール ID を必要とします。

    次のタスク

    コネクタアドミンに次のアイテムを提供します。
    • ステップ 2.a でコピーしたクライアント ID。
    • ステップ 2.c でダウンロードした PEM 形式の秘密鍵証明書ファイル。
    • ステップ 4.d でコピーしたアプリのインストール ID。

    コネクタアドミンは、GitHub Enterprise Cloud ソースシステムからアイテムとセキュリティプリンシパルを取得する GitHub Enterprise Cloud 外部コンテンツコネクタを構成するために、これらのアイテムを必要とします。

    GitHub Enterprise Cloud 外部コンテンツコネクタの作成と構成の詳細については、「GitHub Enterpriseクラウド外部コンテンツコネクタの作成」を参照してください。