Enterprise 向け GitHub Apps の作成

You can create a GitHub App under your enterprise account. The app can only be installed on your enterprise or organizations within your enterprise, and can only be authorized by members of your enterprise. The app can't be installed on user accounts.

Step 1: Registering a GitHub App

To create a GitHub App, you must first register the app. See GitHub App の登録.

Apps can also be transferred to an enterprise from a member or organization. To transfer an app, see GitHub Appの所有権を移譲する.

Step 1a: Adding an enterprise app manager

Enterprise owners can add enterprise members to an app as an app manager. App managers can manage the app's settings and credentials, but cannot install the app. For more information, see GitHub App マネージャーについて.

Step 2: Building a GitHub App

After registering a GitHub App, you will want to write code to make your GitHub App do something. For examples of how to write code, see:

You should aim to follow best practices. See GitHub App を作成するためのベストプラクティス.

Step 3: Authorizing or installing your GitHub App

Once your GitHub App is registered, you'll need to make it available for use, either through authorization or installation, depending on the app’s purpose.

Enterprise owners and app managers can modify the permissions for apps owned by their enterprise at any time. Permissions changes will be automatically accepted by organizations in the enterprise if the change was made by the enterprise owner. Otherwise, the changes will be accepted only where the app manager is also an organization owner, and an organization owner must accept the update request for all other organizations.

Step 3a: Authorizing your GitHub App

Some GitHub Apps, like Copilot extensions, require authorization but do not need to be installed on an organization. Users in your enterprise can authorize the app to access resources within organizations. However, the app will only have access to GitHub resources where it is installed. See GitHub App の承認.

For apps that require installation to function, you can provide organization owners with an installation link. Once the app is installed, it will have access to the organization's resources. See GitHub App の共有.

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

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

多くの組織で同じアプリをインストールする必要がある場合は、API を使用してこれを自動化できます。「企業の組織でのアプリのインストールの自動化」を参照してください。

アプリでエンタープライズアクセス許可を使用している場合は、それを企業にインストールできます。インストールリンクを見つけるには、Enterprise アカウントのアプリの設定ページに移動します。「Enterprise に GitHub アプリをインストールする」を参照してください。