エンタープライズ向けのGitHub アプリの作成

Enterprise 向けに GitHub App を作成する方法について説明します。

この機能を使用できるユーザーについて

Enterprise owners.

この記事で

Enterprise アカウントの下に GitHub App を作成できます。 アプリは、Enterprise 内の organization にのみインストールできます。また、Enterprise のメンバーのみが認可できます。 アプリをユーザー アカウントにインストールすることはできません。

手順 1: GitHub App の登録

GitHub App を作成するには、まずアプリを登録する必要があります。 「GitHub アプリの登録」を参照してください。

アプリは、メンバーまたは organization から Enterprise に譲渡することもできます。 アプリを譲渡する方法については、「GitHub アプリの所有権の譲渡」を参照してください。

手順 2: GitHub App の作成

GitHub App を登録した後は、GitHub App に何かを実行させるコードを書くことになります。 コードを書く方法の例については、次を参照してください。

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/quickstart)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)

ベスト プラクティスに従うようにする必要があります。 「GitHub アプリを作成するためのベスト プラクティス」を参照してください。

手順 3: GitHub App の認可またはインストール

GitHub App を登録したら、アプリの目的に応じて、認可またはインストールを通じて使用できるようにする必要があります。

Enterprise 所有者は、Enterprise が所有するアプリのアクセス許可をいつでも変更できます。 アクセス許可の変更は、Enterprise 内の organization によって自動的に承認されます。

手順 3a: GitHub App の認可

Copilot の拡張機能など、一部の GitHub Apps には認可が必要ですが、組織にインストールする必要はありません。 Enterprise のユーザーは、組織内のリソースにアクセスするアプリを認可できます。 ただし、アプリがアクセスできるのは、アプリのインストール先にある GitHub リソースのみです。 「GitHub アプリの承認」を参照してください。

手順 3b: インストール リンクを使用した GitHub App の共有

インストールを機能させる必要があるアプリの場合は、組織のオーナーにインストール リンクを提供できます。 インストールされると、アプリが組織のリソースにアクセスできるようになります。 「GitHub App の共有」を参照してください。

手順 4: GitHub App のインストール (必要な場合)

GitHub App で (認可だけでなく) インストールが必要な場合、組織のオーナーはインストール リンクを使って組織にアプリをインストールできます。 「サードパーティ製 GitHub App のインストール」を参照してください。