記事のバージョン： Enterprise Server 2.17
OAuth アプリケーションの認可
GitHub Enterpriseのアイデンティティを、OAuth を使うサードパーティのアプリケーションに接続できます。 OAuthアプリケーションを認可する際には、そのアプリケーションを信頼することを確認し、誰が開発したのかをレビューし、そのアプリケーションがどういった種類の情報にアクセスしたいのかをレビューしなければなりません。
OAuthアプリケーションが GitHub Enterpriseアカウントであなたを識別したい場合、そのアプリケーションの開発者の連絡先情報と、リクエストされている情報のリストのページが表示されます。
OAuthアプリケーションのアクセス
OAuthアプリケーションは GitHub Enterpriseのデータへの読み取りまたは書き込みアクセスを持つことができます。
- 読み取りアクセスがアプリケーションに許すのは、データを見ることだけです。
- 書き込みアクセスは、アプリケーションに対してデータを変更することを許します。
ヒント: 定期的に認可されたインテグレーションをレビューすることをおすすめします。 しばらくの間使われていないアプリケーションやトークンは削除してください。 詳しい情報については「認可されたインテグレーションのレビュー」を参照してください。
OAuth のスコープについて
スコープは、OAuthアプリケーションがパブリックおよび非パブリックのデータにアクセスするためにリクエストできる権限の名前付きグループです。
GitHub Enterpriseと統合される OAuthアプリケーションを使用したい場合、そのアプリケーションはデータに対してどういった種類のアクセスが必要になるのかを知らせてきます。 アプリケーションにアクセスを許可すれば、アプリケーションはあなたの代わりにデータの読み取りや変更といったアクションを行えるようになります。 たとえば user:email スコープをリクエストするアプリケーションを使用したい場合、そのアプリケーションはあなたのプライベートのメールアドレスに対してリードオンリーのアクセスを持つことになります。 詳しい情報については GitHub 開発者ドキュメンテーション内の OAuthアプリケーションのスコープについてを参照してください。
メモ: 現時点では、ソースコードへのアクセスのスコープをリードオンリーにすることはできません。
リクエストされるデータの種類
OAuthアプリケーションがリクエストできるデータにはいくつかの種類があります。
| データの種類 | 説明 |
|---|---|
| コミットのステータス | アプリケーションにコミットのステータスをレポートするためのアクセスを許可できます。 コミットステータスのアクセスがあれば、アプリケーションはビルドが特定のコミットに対して成功したかどうかを判定できます。 アプリケーションはコードへのアクセスは持ちませんが、特定のコミットに対するステータス情報を読み書きできます。 |
| デプロイメント | デプロイメントのステータスへアクセスできれば、アプリケーションはパブリック及びプライベートのリポジトリの特定のコミットに対してデプロイメントが成功したかを判断できます。 アプリケーションはコードにはアクセスできません。 |
| Gist | Gist アクセスがあれば、アプリケーションはあなたのパブリックおよびシークレット Gist の双方を読み書きできます。 |
| フック | webhook アクセスがあれば、アプリケーションはあなたが管理するリポジトリ上のフックの設定を読み書きできます。 |
| 通知 | 通知アクセスがあれば、アプリケーションは Issue やプルリクエストへのコメントなど、あなたの GitHub Enterprise通知を読むことができます。 しかし、アプリケーションはリポジトリ内へはアクセスできないままです。 |
| Organization および Team | Organization および Team のアクセスがあれば、アプリケーションは Organization および Team のメンバー構成へのアクセスと管理ができます。 |
| 個人ユーザデータ | ユーザデータには、名前、メールアドレス、所在地など、ユーザプロファイル内の情報が含まれます。 |
| リポジトリ | リポジトリ情報には、コントリビュータの名前、あなたが作成したブランチ、リポジトリ内の実際のファイルなどが含まれます。 アプリケーションはユーザ単位のレベルでパブリックあるいはプライベートリポジトリへのアクセスをリクエストできます。 |
| リポジトリの削除 | アプリケーションはあなたが管理するリポジトリの削除をリクエストできますが、コードにアクセスすることはできません。 |
更新された権限のリクエスト
OAuthアプリケーションが新しいアクセス権限をリクエストする際には、現在の権限と新しい権限との違いを知らせてくれます。