サード パーティからの GitHub App のインストール

GitHub Apps のインストールについて

この記事では、GitHub Marketplace からではなく、アプリ所有者から直接 GitHub App をインストールする方法について説明します。 GitHub Marketplace からの GitHub Apps のインストールの詳細については、「個人向けアカウント用に GitHub Marketplace から GitHub アプリをインストールする」と「Organization の GitHub Marketplace から GitHub アプリをインストールする」を参照してください。 自分が所有する GitHub Apps のインストールについては、「独自の GitHub App のインストール」を参照してください。

リソースで GitHub App を使うには、Enterprise、organization、または個人用アカウントにアプリをインストールする必要があります。 同じ GitHub App を複数のアカウントにインストールできます。 たとえば、自分の個人アカウントと、自分が所有するいくつかの組織にアプリをインストールした場合は、個人リポジトリ、アプリをインストールした組織、それらの組織が所有するリポジトリで、そのアプリを使用できます。

アプリをインストールすると、要求された Enterprise または organization およびリポジトリ リソースにアクセスするアクセス許可がアプリに付与されます。 インストール プロセス中、GitHub App によって要求されたアクセス許可が GitHub によって通知されます。 これらのアクセス許可で GitHub App が実行できる REST API 要求の詳細については、「GitHub Appに必要な権限」を参照してください。

リポジトリ アクセス許可を要求するアプリをインストールするときに、GitHub App にアクセス権限を付与するリポジトリも選びます。

GitHub App のインストール前に、GitHub App の所有者を信頼するようにしてください。 また、GitHub App から要求されているアクセス許可を見て、そうした許可を与えることに問題がないことを確認してください。 これらのアクセス許可で GitHub App が実行できる REST API 要求の詳細については、「GitHub Appに必要な権限」を参照してください。

インストールできるアプリの数に上限はありません。

インストールと認可の違い

GitHub App のインストール後、アプリの認可を求められることもあります。

アカウントまたは組織に GitHub App をインストールするときに、アプリが要求した組織とリポジトリのリソースにアクセスするためのアクセス許可をアプリに付与します。 また、アプリからアクセスできるリポジトリも指定します。 インストール プロセス中、GitHub App により、付与するリポジトリと組織のアクセス許可が示されます。 さまざまなアクセス許可により GitHub App で実行可能となることの詳細については、「GitHub アプリのアクセス許可を選択する」を参照してください。

たとえば、GitHub App にリポジトリのメタデータの読み取り、イシューを書き込む権限を付与し、GitHub App にすべてのリポジトリへのアクセス権を付与できます。

GitHub App を承認する際に、アプリが要求したアカウントのアクセス許可に基づいて、GitHub アカウントへのアクセス権をそのアプリに付与します。 承認プロセス中に、アプリによりアプリがアカウントでアクセスできるリソースが示されます。 GitHub App を承認したら、ユーザーに代わって動作するアプリのアクセス許可も付与します。

たとえば、GitHub App に、メール アドレスを読み取ったり、gist を書き込んだりするアクセス許可を付与できます。

アプリを承認しなくても、GitHub App をインストールできます。 同様に、アプリをインストールしなくてもアプリを承認できます。

GitHub Apps の認可の詳細については、「GitHub App の承認」を参照してください。

GitHub App をインストールするための要件

Enterprise Managed User でない限り、誰でも自分の個人用アカウントに GitHub Apps をインストールできます。

Organization 所有者は、organization に GitHub Apps をインストールできます。

アプリケーションから Enterprise アクセス許可が要求され、Enterprise またはその organization のいずれかが所有している場合、Enterprise 所有者は Enterprise アカウントに GitHub Apps をインストールできます。

組織が所有しているリポジトリの管理者は、自分が管理者であるリポジトリへのアクセスのみをアプリに許可する場合、且つアプリが組織の権限または "リポジトリ管理" 権限を要求しない場合に、組織に GitHub Apps をインストールすることもできます。　 組織所有者は、リポジトリ管理者である外部コラボレーターが GitHub Apps をインストールできないようにすることができます。

Organization 所有者でもリポジトリ管理者でもない Organization メンバーは引き続き、インストール プロセス中に Organization を選ぶことができます。 アプリをインストールする代わりに、GitHub では Organization 所有者に通知を送信し、Organization 所有者にアプリのインストールを要求します。

"アプリ マネージャー" ロールを割り当てられたユーザーには、organization または Enterprise に GitHub App をインストールする権限は付与されません。 「GitHub App マネージャーについて」を参照してください。

GitHub App のインストール

インストール プロセス中に、アプリ所有者は、GitHub App をインストールする GitHub URL に誘導します。 URL は https://github.com/apps/APP-NAME/installations/new のようになります。ここで、APP-NAME は GitHub App の名前です。

1. GitHub App をインストールする場所を選びます。 個人用アカウントまたは所属する organization を選択できます。Enterprise 所有者である場合、アプリが Enterprise をサポートしていれば、Enterprise にアプリをインストールすることもできます。

   メモ

   Organization で SAML SSO を使用しており、Organization が一覧表示されない場合、Organization のアクティブな SAML セッションを開始することが必要な場合があります。 詳しくは、「SAML と GitHub Apps」をご覧ください。

2. アプリでリポジトリのアクセス許可が必要な場合は、 [すべてのリポジトリ] または [選択したレポジトリのみ] を選びます。 アプリは常に、GitHub 上のすべてのパブリック リポジトリへの読み取り専用アクセス権を持つようになります。

   アプリでリポジトリのアクセス許可が必要ない場合、これらのオプションは省略されます。

3. 前の手順で [選択したリポジトリのみ] を選んだ場合は、 [リポジトリの選択] ドロップダウンで、アプリでアクセスするリポジトリを選びます。

   アプリによって何らかのリポジトリが作成される場合、それらのリポジトリにアクセスする権限もアプリに自動的に与えられます。

4. アプリが要求しているアクセス許可を確認します。 これらのアクセス許可で GitHub App が実行できる REST API 要求の詳細については、「GitHub Appに必要な権限」を参照してください。

5. [インストール] 、 [インストールと要求] 、または [要求] をクリックします。 そのアプリに対して要求されたアクセス権について、organization 所有者の承認が不要か、一部のみ必要か、すべて必要かに応じて、表示されるボタンは変わります。Enterprise インストールを要求することはできません。アプリは Enterprise 所有者が直接インストールする必要があります。詳細については、「GitHub App をインストールするための要件」を参照してください。