OAuth App から お使いの GitHub Enterprise Server インスタンス のアカウントによる識別を求められた場合、アプリの開発者の連絡先情報と要求されている特定のデータのリストが記載されたページが表示されます。
OAuth Appのアクセス
OAuth Apps は、ユーザーの GitHub Enterprise Server データへの "読み取り" アクセスまたは "書き込み" アクセスを行うことができます。
- 読み取りアクセスでは、ユーザーのデータの "閲覧" のみ可能です。
- 書き込みアクセスでは、ユーザーのデータの "変更" が可能です。
ヒント: 認可されたインテグレーションを定期的にレビューすることをおすすめします。 しばらくの間使われていないアプリケーションやトークンは削除してください。 詳しくは、「GitHub Apps の承認の確認と取り消し」を参照してください。
OAuth のスコープについて
"スコープ" は、権限の名前付きグループです。これは、OAuth App がパブリック データと非パブリック データへのアクセスをリクエストできるという権限です。
GitHub Enterprise Serverと統合される OAuth Appを使用したい場合、そのアプリケーションはデータに対してどういった種類のアクセスが必要になるのかを知らせてきます。 アプリケーションにアクセスを許可すれば、アプリケーションはあなたの代わりにデータの読み取りや変更といったアクションを行えるようになります。 たとえば、user:email
スコープを要求するアプリを使用する必要がある場合、アプリは個人用メール アドレスへの読み取り専用アクセス権を持つことになります。 詳しくは、「OAuth Appのスコープ」を参照してください。
注: 現在、ソース コード アクセスを読み取り専用にスコープすることはできません。
ユーザ/アプリケーション/スコープの組み合わせごとに、発行できるトークン数には10という上限があります。 アプリケーションで同じユーザーと同じスコープに対して 10 個を超えるトークンが作成された場合、同じユーザー/アプリケーション/スコープの組み合わせを持つ最も古いトークンが取り消されます。
リクエストされるデータの種類
OAuth Apps がリクエストできるデータは、数種類あります。
データの種類 | 説明 |
---|---|
コミットのステータス | アプリケーションにコミットのステータスをレポートするためのアクセスを許可できます。 コミットステータスのアクセスがあれば、アプリケーションはビルドが特定のコミットに対して成功したかどうかを判定できます。 アプリケーションはコードへのアクセスは持ちませんが、特定のコミットに対するステータス情報を読み書きできます。 |
デプロイメント | デプロイメントのステータスへアクセスできれば、アプリケーションはパブリック及びプライベートのリポジトリの特定のコミットに対してデプロイメントが成功したかを判断できます。 アプリケーションはコードにはアクセスできません。 |
Gists | Gist アクセスでは、ユーザーのパブリック Gist とシークレット Gist の両方への、アプリによる読み取りや書き込みが可能です。 |
フック | Webhook アクセスでは、管理するリポジトリのフック構成への、アプリによる読み取りや書き込みが可能です。 |
通知 | 通知アクセスがあれば、アプリケーションは Issue やプルリクエストへのコメントなど、あなたの GitHub Enterprise Server通知を読むことができます。 しかし、アプリケーションはリポジトリ内へはアクセスできないままです。 |
組織とチーム | Organization および Team のアクセスがあれば、アプリケーションは Organization および Team のメンバー構成へのアクセスと管理ができます。 |
ユーザーの個人データ | ユーザデータには、名前、メールアドレス、所在地など、ユーザプロファイル内の情報が含まれます。 |
リポジトリ | リポジトリ情報には、コントリビュータの名前、あなたが作成したブランチ、リポジトリ内の実際のファイルなどが含まれます。 アプリケーションはユーザ単位のレベルでパブリックあるいはプライベートリポジトリへのアクセスをリクエストできます。 |
リポジトリの削除 | アプリケーションはあなたが管理するリポジトリの削除をリクエストできますが、コードにアクセスすることはできません。 |
更新された権限のリクエスト
OAuth Apps によって新しいアクセス権限がリクエストされると、現在の権限と新しい権限の違いが知らされます。