GitHub Appの権限について
GitHub Appsは、一連の権限を付けて作成されます。 GitHub AppがAPIを介してアクセスできるリソースが、権限によって決まります。 詳しくは、「GitHub アプリのアクセス許可を選択する」をご覧ください。
REST API 応答で 受け取る X-Accepted-GitHub-Permissions
ヘッダーで、適切なアクセス許可を選択するための情報が得られます。 このヘッダーは、エンドポイントにアクセスするために必要なアクセス許可を示します。 詳しくは、「REST API のトラブルシューティング」を参照してください。
これらのアクセス許可は、プライベート リソースにアクセスするために必要です。 一部のエンドポイントは、これらのアクセス許可なしでパブリック リソースにアクセスするためにも使用できます。 エンドポイントがアクセス許可なしでパブリック リソースにアクセスできるかどうかを確認するには、そのエンドポイントのドキュメントを参照してください。
一部のエンドポイントは、複数のアクセス許可が必要な場合があります。 他のエンドポイントは、一連のアクセス許可のうち、任意の 1 つのアクセス許可で動作します。 このような場合は、[追加のアクセス許可] 列にチェックマークが含まれます。 エンドポイントを使用するために必要なアクセス許可の詳細については、そのエンドポイントのドキュメントを参照してください。
Organization permissions for "Administration"
Organization permissions for "Custom organization roles"
Organization permissions for "Custom properties"
Organization permissions for "Custom repository roles"
Organization permissions for "Events"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
GET /users/{username}/events/orgs/{org} | read | UAT |
Organization permissions for "Members"
Organization permissions for "Organization announcement banners"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
PATCH /orgs/{org}/announcement | write | UAT IAT | |
DELETE /orgs/{org}/announcement | write | UAT IAT | |
GET /orgs/{org}/announcement | read | UAT IAT |
Organization permissions for "Organization dependabot secrets"
Organization permissions for "Personal access token requests"
Organization permissions for "Personal access tokens"
Organization permissions for "Pre-receive hooks"
Organization permissions for "Projects"
Organization permissions for "Secrets"
Organization permissions for "Self-hosted runners"
Organization permissions for "Team discussions"
Organization permissions for "Variables"
Organization permissions for "Webhooks"
Repository permissions for "Actions"
Repository permissions for "Administration"
Repository permissions for "Checks"
Repository permissions for "Code scanning alerts"
Repository permissions for "Commit statuses"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
POST /repos/{owner}/{repo}/statuses/{sha} | write | UAT IAT | |
GET /repos/{owner}/{repo}/commits/{ref}/status | read | UAT IAT | |
GET /repos/{owner}/{repo}/commits/{ref}/statuses | read | UAT IAT |
Repository permissions for "Contents"
Repository permissions for "Custom properties"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
PATCH /repos/{owner}/{repo}/properties/values | write | UAT IAT |
Repository permissions for "Dependabot alerts"
Repository permissions for "Dependabot secrets"
Repository permissions for "Deployments"
Repository permissions for "Environments"
Repository permissions for "Issues"
Repository permissions for "Metadata"
Repository permissions for "Pages"
Repository permissions for "Pre-receive hooks"
Repository permissions for "Projects"
Repository permissions for "Pull requests"
Repository permissions for "Secret scanning alerts"
Repository permissions for "Secrets"
Repository permissions for "Variables"
Repository permissions for "Webhooks"
Repository permissions for "Workflows"
User permissions for "Email addresses"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
POST /user/emails | write | UAT | |
DELETE /user/emails | write | UAT | |
GET /user/emails | read | UAT | |
GET /user/public_emails | read | UAT |
User permissions for "Followers"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
PUT /user/following/{username} | write | UAT | |
DELETE /user/following/{username} | write | UAT | |
GET /user/followers | read | UAT | |
GET /user/following | read | UAT | |
GET /user/following/{username} | read | UAT |
User permissions for "GPG keys"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
POST /user/gpg_keys | write | UAT | |
DELETE /user/gpg_keys/{gpg_key_id} | write | UAT | |
GET /user/gpg_keys | read | UAT | |
GET /user/gpg_keys/{gpg_key_id} | read | UAT |
User permissions for "Gists"
User permissions for "Git SSH keys"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
POST /user/keys | write | UAT | |
DELETE /user/keys/{key_id} | write | UAT | |
GET /user/keys | read | UAT | |
GET /user/keys/{key_id} | read | UAT | |
GET /users/{username}/keys | read | UAT IAT |
User permissions for "Notifications"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
GET /notifications | read | UAT | 複数のアクセス許可が必要な場合や、別のアクセス許可が使用される場合があります。 アクセス許可の詳細については、このエンドポイントのドキュメントを参照してください。 |
User permissions for "Profile"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
PATCH /user | write | UAT | |
POST /user/social_accounts | write | UAT | |
DELETE /user/social_accounts | write | UAT |
User permissions for "SSH signing keys"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
POST /user/ssh_signing_keys | write | UAT | |
DELETE /user/ssh_signing_keys/{ssh_signing_key_id} | write | UAT | |
GET /user/ssh_signing_keys | read | UAT | |
GET /user/ssh_signing_keys/{ssh_signing_key_id} | read | UAT |
User permissions for "Starring"
User permissions for "Watching"
エンドポイント | Access | トークンの種類 | 追加の権限 |
---|---|---|---|
GET /user/subscriptions | read | UAT | |
GET /users/{username}/subscriptions | read | UAT IAT |