メモ
エンタープライズインストールの GitHub Apps は パブリック プレビュー であり、変更される可能性があります。
企業への GitHub Apps のインストールについて
エンタープライズインストール GitHub Apps は、エンタープライズ レベルのアクセス許可を要求し、エンタープライズ アカウントに対して操作を実行できるアプリです。 組織またはユーザーのインストールとは異なり、組織またはリポジトリのいかなる権限にもアクセスできず、エンタープライズ自体のみを管理します。
エンタープライズ所有者が企業に GitHub App をインストールすると、アプリには、要求されたエンタープライズアクセス許可が付与されます。 これらのアクセス許可により、アプリは Enterprise 内での organization の作成、organization 全体へのアプリケーションのインストール、SCIM プロビジョニングの管理などの操作を実行できます。
企業に GitHub App をインストールするための要件
GitHub Appは、エンタープライズ レベルのアクセス許可を要求する必要があります。 他のアクセス許可も要求できますが、インストール時には Enterprise アクセス許可のみが付与されます。
アプリは、お客様の企業またはお客様の企業内の組織によって所有されている必要があります。 Enterprise 外のアカウントが所有するアプリをインストールすることはできません。
企業への GitHub App のインストール
企業にアプリをインストールするには、 GitHub App インストール ページに移動します。 これは、アプリ開発者によってインストール リンクとして提供される場合や、また、アプリの登録情報に記載されている場合があります。 URL は https://github.com/apps/APP-NAME/installations/new のようになります。ここで、 APP-NAME は GitHub Appの名前です。
アプリをインストールできる場合は、使用できるインストール場所の一覧に Enterprise が含まれます。 アプリをインストールする組織を選択できます。
インストール後、アプリで Enterprise 用のインストール トークンを作成したり、Enterprise レベルで Enterprise メンバーに代わって操作するために Enterprise メンバーをサインインしたりできるようになります。 ユーザーに代わって操作するには、ユーザーが Enterprise 内で目的の操作を実行できる必要があります。 たとえば、アプリがユーザーを Enterprise に招待する必要がある場合、ユーザーには Enterprise にメンバーを招待するアクセス許可も必要です。
Enterprise インストール アプリでできること
エンタープライズインストールGitHub Appsでは、すべてのエンタープライズ API を呼び出すことはできませんが、GitHub Apps をサポートするためにいくつかの API が既に更新されています。 これらの API と GraphQL のミューテーションには次のものが含まれます。
- エンタープライズ内の組織の一覧表示と作成
- Enterprise 内のユーザーを管理する
- 組織での GitHub App インストールの作成と管理
- Enterprise カスタム リポジトリのプロパティを管理する
- Enterprise SCIM API を呼び出す
新しい API とのアクセス許可の更新に関する変更ログを確認してください。
使用できるアクセス許可と API エンドポイントの詳細については、「GitHub Apps に必要なアクセス許可」を参照してください。
エンタープライズインストールのレート制限 GitHub Apps
エンタープライズにインストールされた GitHub Apps のインストール トークンには、 GitHub Enterprise Cloud 組織と同じレート制限があります。 レート制限はインストールごとに適用されます。 たとえば、アプリが Enterprise と 2 つの organization にインストールされている場合、それらにアクセスするには 3 つのインストール トークンが必要になり、インストールごとに完全な独立したレート制限予算が設定されます。 詳細については、「REST API のレート制限」および「GraphQL API のレート制限とクエリ制限」を参照してください。
現在の制限
エンタープライズ環境にインストールされたGitHub Appsは現在パブリック プレビューであり、以下の制限があります。
API のサポート
一部の API では、エンタープライズインストール GitHub Apps はまだサポートされていません。 より多くのアクセス許可が構築され、API が更新されるにつれて、サポートはさらに拡大されます。 エンタープライズインストールの GitHub Appsをサポートする API とアクセス許可の詳細については、「 GitHub Apps に必要なアクセス許可」を参照してください。
Webhook のサポート
現在、Enterprise インストールでは、Webhook はサポートされていません。 Enterprise レベルでインストールされたアプリは、Enterprise レベルのアクティビティの Webhook イベントを受け取ることができません。 対象のリソースの Webhook イベントを受け取るには、Organization またはリポジトリにインストールしてください。
組織へのアクセス
エンタープライズ インストールには、組織インストール API を除き、エンタープライズ内の組織またはリポジトリへのアクセスは付与されません。 Organization またはリポジトリのリソースにアクセスするには、アクセス権が必要な organization ごとにアプリを個別にインストールする必要があります。
次のステップ
GitHub Appsを使用してプロセスを自動化したので、GitHub のサポートについて学習し、必要なときにサポートを受けることができます。 「Enterprise サポートの概要」を参照してください。