GitHub Apps에 대한 REST API 엔드포인트

GitHub Apps

정보

앱을 GitHub Actions와 함께 사용 중이고 워크플로 파일을 수정하려는 경우 workflow 범위가 포함된 OAuth 토큰을 사용하여 사용자를 대신하여 인증해야 합니다. 사용자에게는 워크플로 파일이 포함된 리포지토리에 대한 관리자 또는 쓰기 권한이 있어야 합니다. 자세한 내용은 "OAuth 앱에 대한 범위.

이 페이지에는 GitHub App로 인증하는 동안 액세스할 수 있는 엔드포인트가 나열됩니다. 자세한 정보는 "GitHub 앱으로 인증"을(를) 참조하세요.

GitHub App 설치로 인증이 필요한 엔드포인트 목록은 "GitHub App 설치에 대한 REST API 엔드포인트"을(를) 참조하세요.

Get the authenticated app

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.

You must use a JWT to access this endpoint.

"Get the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK

"Get the authenticated app"에 대한 코드 샘플

요청 예제

get/app

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app

Response

Status: 200

{
  "id": 1,
  "slug": "octoapp",
  "node_id": "MDExOkludGVncmF0aW9uMQ==",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "name": "Octocat App",
  "description": "",
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/octoapp",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "permissions": {
    "metadata": "read",
    "contents": "read",
    "issues": "write",
    "single_file": "write"
  },
  "events": [
    "push",
    "pull_request"
  ]
}

Create a GitHub App from a manifest

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

"Create a GitHub App from a manifest"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Create a GitHub App from a manifest"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`code` string Required

"Create a GitHub App from a manifest"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Create a GitHub App from a manifest"에 대한 코드 샘플

요청 예제

post/app-manifests/{code}/conversions

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app-manifests/CODE/conversions

Response

Status: 201

{
  "id": 1,
  "slug": "octoapp",
  "node_id": "MDxOkludGVncmF0aW9uMQ==",
  "owner": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://api.github.com/orgs/github",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "events_url": "https://api.github.com/orgs/github/events",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": true
  },
  "name": "Octocat App",
  "description": "",
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/octoapp",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "permissions": {
    "metadata": "read",
    "contents": "read",
    "issues": "write",
    "single_file": "write"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "client_id": "Iv1.8a61f9b3a7aba766",
  "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
  "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
  "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
}

List installation requests for the authenticated app

Lists all the pending installation requests for the authenticated GitHub App.

"List installation requests for the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"List installation requests for the authenticated app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

쿼리 매개 변수
이름, Type, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`

"List installation requests for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	List of integration installation requests
`304`	Not modified
`401`	Requires authentication

"List installation requests for the authenticated app"에 대한 코드 샘플

요청 예제

get/app/installation-requests

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installation-requests

List of integration installation requests

Status: 200

[
  {
    "id": 25381,
    "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==",
    "account": {
      "login": "octo-org",
      "id": 6811672,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
      "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octo-org",
      "html_url": "https://github.com/octo-org",
      "followers_url": "https://api.github.com/users/octo-org/followers",
      "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
      "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
      "organizations_url": "https://api.github.com/users/octo-org/orgs",
      "repos_url": "https://api.github.com/users/octo-org/repos",
      "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octo-org/received_events",
      "type": "Organization",
      "site_admin": false
    },
    "requester": {
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2022-07-08T16:18:44-04:00"
  }
]

List installations for the authenticated app

The permissions the installation has are included under the permissions key.

You must use a JWT to access this endpoint.

"List installations for the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"List installations for the authenticated app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

쿼리 매개 변수
이름, Type, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`
`since` string Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`outdated` string

"List installations for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	The permissions the installation has are included under the `permissions` key.

"List installations for the authenticated app"에 대한 코드 샘플

요청 예제

get/app/installations

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations

The permissions the installation has are included under the `permissions` key.

Status: 200

[
  {
    "id": 1,
    "account": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
    "repositories_url": "https://api.github.com/installation/repositories",
    "html_url": "https://github.com/organizations/github/settings/installations/1",
    "app_id": 1,
    "target_id": 1,
    "target_type": "Organization",
    "permissions": {
      "checks": "write",
      "metadata": "read",
      "contents": "read"
    },
    "events": [
      "push",
      "pull_request"
    ],
    "single_file_name": "config.yaml",
    "has_multiple_single_files": true,
    "single_file_paths": [
      "config.yml",
      ".github/issue_TEMPLATE.md"
    ],
    "repository_selection": "selected",
    "created_at": "2017-07-08T16:18:44-04:00",
    "updated_at": "2017-07-08T16:18:44-04:00",
    "app_slug": "github-actions",
    "suspended_at": null,
    "suspended_by": null
  }
]

Get an installation for the authenticated app

Enables an authenticated GitHub App to find an installation's information using the installation id.

You must use a JWT to access this endpoint.

"Get an installation for the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get an installation for the authenticated app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`installation_id` integer Required The unique identifier of the installation.

"Get an installation for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`404`	Resource not found

"Get an installation for the authenticated app"에 대한 코드 샘플

요청 예제

get/app/installations/{installation_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations/1

Response

Status: 200

{
  "id": 1,
  "account": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "single_file_name": "config.yaml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "repository_selection": "selected",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}

Delete an installation for the authenticated app

Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "Suspend an app installation" endpoint.

You must use a JWT to access this endpoint.

"Delete an installation for the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Delete an installation for the authenticated app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`installation_id` integer Required The unique identifier of the installation.

"Delete an installation for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	No Content
`404`	Resource not found

"Delete an installation for the authenticated app"에 대한 코드 샘플

요청 예제

delete/app/installations/{installation_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations/1

Response

Status: 204

Create an installation access token for an app

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.

You must use a JWT to access this endpoint.

"Create an installation access token for an app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Create an installation access token for an app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`installation_id` integer Required The unique identifier of the installation.

이름, Type, 설명

repositories array of strings

List of repository names that the token should have access to

repository_ids array of integers

List of repository IDs that the token should have access to

permissions object

The permissions granted to the user access token.

Properties of permissions

이름, Type, 설명
`actions` string The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. 다음 중 하나일 수 있습니다.: `read`, `write`
`administration` string The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. 다음 중 하나일 수 있습니다.: `read`, `write`
`checks` string The level of permission to grant the access token for checks on code. 다음 중 하나일 수 있습니다.: `read`, `write`
`codespaces` string The level of permission to grant the access token to create, edit, delete, and list Codespaces. 다음 중 하나일 수 있습니다.: `read`, `write`
`contents` string The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. 다음 중 하나일 수 있습니다.: `read`, `write`
`dependabot_secrets` string The leve of permission to grant the access token to manage Dependabot secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`deployments` string The level of permission to grant the access token for deployments and deployment statuses. 다음 중 하나일 수 있습니다.: `read`, `write`
`environments` string The level of permission to grant the access token for managing repository environments. 다음 중 하나일 수 있습니다.: `read`, `write`
`issues` string The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. 다음 중 하나일 수 있습니다.: `read`, `write`
`metadata` string The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. 다음 중 하나일 수 있습니다.: `read`, `write`
`packages` string The level of permission to grant the access token for packages published to GitHub Packages. 다음 중 하나일 수 있습니다.: `read`, `write`
`pages` string The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. 다음 중 하나일 수 있습니다.: `read`, `write`
`pull_requests` string The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_custom_properties` string The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_hooks` string The level of permission to grant the access token to manage the post-receive hooks for a repository. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_projects` string The level of permission to grant the access token to manage repository projects, columns, and cards. 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`secret_scanning_alerts` string The level of permission to grant the access token to view and manage secret scanning alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`secrets` string The level of permission to grant the access token to manage repository secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`security_events` string The level of permission to grant the access token to view and manage security events like code scanning alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`single_file` string The level of permission to grant the access token to manage just a single file. 다음 중 하나일 수 있습니다.: `read`, `write`
`statuses` string The level of permission to grant the access token for commit statuses. 다음 중 하나일 수 있습니다.: `read`, `write`
`vulnerability_alerts` string The level of permission to grant the access token to manage Dependabot alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`workflows` string The level of permission to grant the access token to update GitHub Actions workflow files. 값: `write`
`members` string The level of permission to grant the access token for organization teams and members. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_administration` string The level of permission to grant the access token to manage access to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_roles` string The level of permission to grant the access token for custom repository roles management. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_org_roles` string The level of permission to grant the access token for custom organization roles management. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_properties` string The level of permission to grant the access token for custom property management. 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`organization_copilot_seat_management` string The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. 값: `write`
`organization_announcement_banners` string The level of permission to grant the access token to view and manage announcement banners for an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_events` string The level of permission to grant the access token to view events triggered by an activity in an organization. 값: `read`
`organization_hooks` string The level of permission to grant the access token to manage the post-receive hooks for an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_personal_access_tokens` string The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_personal_access_token_requests` string The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_plan` string The level of permission to grant the access token for viewing an organization's plan. 값: `read`
`organization_projects` string The level of permission to grant the access token to manage organization projects and projects beta (where available). 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`organization_packages` string The level of permission to grant the access token for organization packages published to GitHub Packages. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_secrets` string The level of permission to grant the access token to manage organization secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_self_hosted_runners` string The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_user_blocking` string The level of permission to grant the access token to view and manage users blocked by the organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`team_discussions` string The level of permission to grant the access token to manage team discussions and related comments. 다음 중 하나일 수 있습니다.: `read`, `write`
`email_addresses` string The level of permission to grant the access token to manage the email addresses belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`followers` string The level of permission to grant the access token to manage the followers belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`git_ssh_keys` string The level of permission to grant the access token to manage git SSH keys. 다음 중 하나일 수 있습니다.: `read`, `write`
`gpg_keys` string The level of permission to grant the access token to view and manage GPG keys belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`interaction_limits` string The level of permission to grant the access token to view and manage interaction limits on a repository. 다음 중 하나일 수 있습니다.: `read`, `write`
`profile` string The level of permission to grant the access token to manage the profile settings belonging to a user. 값: `write`
`starring` string The level of permission to grant the access token to list and manage repositories a user is starring. 다음 중 하나일 수 있습니다.: `read`, `write`

"Create an installation access token for an app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	Created
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Create an installation access token for an app"에 대한 코드 샘플

요청 예제

post/app/installations/{installation_id}/access_tokens

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations/1/access_tokens \
  -d '{"repositories":["Hello-World"],"permissions":{"issues":"write","contents":"read"}}'

Response

Status: 201

{
  "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a",
  "expires_at": "2016-07-11T22:14:10Z",
  "permissions": {
    "issues": "write",
    "contents": "read"
  },
  "repository_selection": "selected",
  "repositories": [
    {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World",
      "full_name": "octocat/Hello-World",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://api.github.com/repos/octocat/Hello-World",
      "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
      "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
      "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
      "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
      "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
      "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
      "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
      "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
      "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
      "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World.git",
      "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
      "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
      "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
      "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
      "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
      "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
      "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
      "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World.git",
      "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
      "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
      "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
      "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
      "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
      "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
      "clone_url": "https://github.com/octocat/Hello-World.git",
      "mirror_url": "git:git.example.com/octocat/Hello-World",
      "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
      "svn_url": "https://svn.github.com/octocat/Hello-World",
      "homepage": "https://github.com",
      "language": null,
      "forks_count": 9,
      "stargazers_count": 80,
      "watchers_count": 80,
      "size": 108,
      "default_branch": "master",
      "open_issues_count": 0,
      "is_template": true,
      "topics": [
        "octocat",
        "atom",
        "electron",
        "api"
      ],
      "has_issues": true,
      "has_projects": true,
      "has_wiki": true,
      "has_pages": false,
      "has_downloads": true,
      "archived": false,
      "disabled": false,
      "visibility": "public",
      "pushed_at": "2011-01-26T19:06:43Z",
      "created_at": "2011-01-26T19:01:12Z",
      "updated_at": "2011-01-26T19:14:43Z",
      "permissions": {
        "admin": false,
        "push": false,
        "pull": true
      },
      "allow_rebase_merge": true,
      "template_repository": null,
      "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
      "allow_squash_merge": true,
      "allow_auto_merge": false,
      "delete_branch_on_merge": true,
      "allow_merge_commit": true,
      "subscribers_count": 42,
      "network_count": 0,
      "license": {
        "key": "mit",
        "name": "MIT License",
        "url": "https://api.github.com/licenses/mit",
        "spdx_id": "MIT",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "html_url": "https://github.com/licenses/mit"
      },
      "forks": 1,
      "open_issues": 1,
      "watchers": 1
    }
  ]
}

Suspend an app installation

Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a JWT to access this endpoint.

"Suspend an app installation"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Suspend an app installation"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`installation_id` integer Required The unique identifier of the installation.

"Suspend an app installation"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	No Content
`404`	Resource not found

"Suspend an app installation"에 대한 코드 샘플

요청 예제

put/app/installations/{installation_id}/suspended

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations/1/suspended

Response

Status: 204

Unsuspend an app installation

Removes a GitHub App installation suspension.

You must use a JWT to access this endpoint.

"Unsuspend an app installation"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Unsuspend an app installation"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`installation_id` integer Required The unique identifier of the installation.

"Unsuspend an app installation"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	No Content
`404`	Resource not found

"Unsuspend an app installation"에 대한 코드 샘플

요청 예제

delete/app/installations/{installation_id}/suspended

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/installations/1/suspended

Response

Status: 204

Create a scoped access token

Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token.

Invalid tokens will return 404 NOT FOUND.

You must use Basic Authentication when accessing this endpoint, using the client_id and client_secret of the GitHub App as the username and password.

"Create a scoped access token"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Create a scoped access token"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`client_id` string Required The client ID of the GitHub app.

이름, Type, 설명

access_token string Required

The access token used to authenticate to the GitHub API.

target string

The name of the user or organization to scope the user access token to. Required unless target_id is specified.

target_id integer

The ID of the user or organization to scope the user access token to. Required unless target is specified.

repositories array of strings

The list of repository names to scope the user access token to. repositories may not be specified if repository_ids is specified.

repository_ids array of integers

The list of repository IDs to scope the user access token to. repository_ids may not be specified if repositories is specified.

permissions object

The permissions granted to the user access token.

Properties of permissions

이름, Type, 설명
`actions` string The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. 다음 중 하나일 수 있습니다.: `read`, `write`
`administration` string The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. 다음 중 하나일 수 있습니다.: `read`, `write`
`checks` string The level of permission to grant the access token for checks on code. 다음 중 하나일 수 있습니다.: `read`, `write`
`codespaces` string The level of permission to grant the access token to create, edit, delete, and list Codespaces. 다음 중 하나일 수 있습니다.: `read`, `write`
`contents` string The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. 다음 중 하나일 수 있습니다.: `read`, `write`
`dependabot_secrets` string The leve of permission to grant the access token to manage Dependabot secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`deployments` string The level of permission to grant the access token for deployments and deployment statuses. 다음 중 하나일 수 있습니다.: `read`, `write`
`environments` string The level of permission to grant the access token for managing repository environments. 다음 중 하나일 수 있습니다.: `read`, `write`
`issues` string The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. 다음 중 하나일 수 있습니다.: `read`, `write`
`metadata` string The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. 다음 중 하나일 수 있습니다.: `read`, `write`
`packages` string The level of permission to grant the access token for packages published to GitHub Packages. 다음 중 하나일 수 있습니다.: `read`, `write`
`pages` string The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. 다음 중 하나일 수 있습니다.: `read`, `write`
`pull_requests` string The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_custom_properties` string The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_hooks` string The level of permission to grant the access token to manage the post-receive hooks for a repository. 다음 중 하나일 수 있습니다.: `read`, `write`
`repository_projects` string The level of permission to grant the access token to manage repository projects, columns, and cards. 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`secret_scanning_alerts` string The level of permission to grant the access token to view and manage secret scanning alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`secrets` string The level of permission to grant the access token to manage repository secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`security_events` string The level of permission to grant the access token to view and manage security events like code scanning alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`single_file` string The level of permission to grant the access token to manage just a single file. 다음 중 하나일 수 있습니다.: `read`, `write`
`statuses` string The level of permission to grant the access token for commit statuses. 다음 중 하나일 수 있습니다.: `read`, `write`
`vulnerability_alerts` string The level of permission to grant the access token to manage Dependabot alerts. 다음 중 하나일 수 있습니다.: `read`, `write`
`workflows` string The level of permission to grant the access token to update GitHub Actions workflow files. 값: `write`
`members` string The level of permission to grant the access token for organization teams and members. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_administration` string The level of permission to grant the access token to manage access to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_roles` string The level of permission to grant the access token for custom repository roles management. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_org_roles` string The level of permission to grant the access token for custom organization roles management. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_custom_properties` string The level of permission to grant the access token for custom property management. 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`organization_copilot_seat_management` string The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. 값: `write`
`organization_announcement_banners` string The level of permission to grant the access token to view and manage announcement banners for an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_events` string The level of permission to grant the access token to view events triggered by an activity in an organization. 값: `read`
`organization_hooks` string The level of permission to grant the access token to manage the post-receive hooks for an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_personal_access_tokens` string The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_personal_access_token_requests` string The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_plan` string The level of permission to grant the access token for viewing an organization's plan. 값: `read`
`organization_projects` string The level of permission to grant the access token to manage organization projects and projects beta (where available). 다음 중 하나일 수 있습니다.: `read`, `write`, `admin`
`organization_packages` string The level of permission to grant the access token for organization packages published to GitHub Packages. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_secrets` string The level of permission to grant the access token to manage organization secrets. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_self_hosted_runners` string The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`organization_user_blocking` string The level of permission to grant the access token to view and manage users blocked by the organization. 다음 중 하나일 수 있습니다.: `read`, `write`
`team_discussions` string The level of permission to grant the access token to manage team discussions and related comments. 다음 중 하나일 수 있습니다.: `read`, `write`
`email_addresses` string The level of permission to grant the access token to manage the email addresses belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`followers` string The level of permission to grant the access token to manage the followers belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`git_ssh_keys` string The level of permission to grant the access token to manage git SSH keys. 다음 중 하나일 수 있습니다.: `read`, `write`
`gpg_keys` string The level of permission to grant the access token to view and manage GPG keys belonging to a user. 다음 중 하나일 수 있습니다.: `read`, `write`
`interaction_limits` string The level of permission to grant the access token to view and manage interaction limits on a repository. 다음 중 하나일 수 있습니다.: `read`, `write`
`profile` string The level of permission to grant the access token to manage the profile settings belonging to a user. 값: `write`
`starring` string The level of permission to grant the access token to list and manage repositories a user is starring. 다음 중 하나일 수 있습니다.: `read`, `write`

"Create a scoped access token"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Create a scoped access token"에 대한 코드 샘플

요청 예제

post/applications/{client_id}/token/scoped

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/applications/Iv1.8a61f9b3a7aba766/token/scoped \
  -d '{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a","target":"octocat","permissions":{"metadata":"read","issues":"write","contents":"read"}}'

Response

Status: 200

{
  "id": 1,
  "url": "https://api.github.com/authorizations/1",
  "scopes": [],
  "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
  "token_last_eight": "Ae178B4a",
  "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
  "app": {
    "url": "http://my-github-app.com",
    "name": "my github app",
    "client_id": "Iv1.8a61f9b3a7aba766"
  },
  "note": "optional note",
  "note_url": "http://optional/note/url",
  "updated_at": "2011-09-06T20:39:23Z",
  "created_at": "2011-09-06T17:26:27Z",
  "fingerprint": "jklmnop12345678",
  "expires_at": "2011-09-08T17:26:27Z",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "installation": {
    "permissions": {
      "metadata": "read",
      "issues": "write",
      "contents": "read"
    },
    "repository_selection": "selected",
    "single_file_name": ".github/workflow.yml",
    "repositories_url": "https://api.github.com/user/repos",
    "account": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "has_multiple_single_files": false,
    "single_file_paths": []
  }
}

Get an app

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

"Get an app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 토큰 형식에서 작동합니다.:

토큰에 어떤 권한도 필요하지 않습니다.

공용 리소스만 요청되는 경우 인증 없이 이 엔드포인트를 사용할 수 있습니다.

"Get an app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`app_slug` string Required

"Get an app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`403`	Forbidden
`404`	Resource not found

"Get an app"에 대한 코드 샘플

요청 예제

get/apps/{app_slug}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/apps/APP_SLUG

Response

Status: 200

{
  "id": 1,
  "slug": "octoapp",
  "node_id": "MDExOkludGVncmF0aW9uMQ==",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "name": "Octocat App",
  "description": "",
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/octoapp",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "permissions": {
    "metadata": "read",
    "contents": "read",
    "issues": "write",
    "single_file": "write"
  },
  "events": [
    "push",
    "pull_request"
  ]
}

Get an organization installation for the authenticated app

Enables an authenticated GitHub App to find the organization's installation information.

You must use a JWT to access this endpoint.

"Get an organization installation for the authenticated app"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get an organization installation for the authenticated app"에 대한 매개 변수

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`org` string Required The organization name. The name is not case sensitive.

"Get an organization installation for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK

"Get an organization installation for the authenticated app"에 대한 코드 샘플

요청 예제

get/orgs/{org}/installation

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/installation

Response

Status: 200

{
  "id": 1,
  "account": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/orgs/github",
    "html_url": "https://github.com/github",
    "followers_url": "https://api.github.com/users/github/followers",
    "following_url": "https://api.github.com/users/github/following{/other_user}",
    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
    "organizations_url": "https://api.github.com/users/github/orgs",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "events_url": "https://api.github.com/orgs/github/events",
    "received_events_url": "https://api.github.com/users/github/received_events",
    "type": "Organization",
    "site_admin": false
  },
  "repository_selection": "all",
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "created_at": "2018-02-09T20:51:14Z",
  "updated_at": "2018-02-09T20:51:14Z",
  "single_file_name": "config.yml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`owner` string Required The account owner of the repository. The name is not case sensitive.
`repo` string Required The name of the repository without the `.git` extension. The name is not case sensitive.

"Get a repository installation for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`301`	Moved permanently
`404`	Resource not found

"Get a repository installation for the authenticated app"에 대한 코드 샘플

요청 예제

get/repos/{owner}/{repo}/installation

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/installation

Response

Status: 200

{
  "id": 1,
  "account": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/orgs/github",
    "html_url": "https://github.com/github",
    "followers_url": "https://api.github.com/users/github/followers",
    "following_url": "https://api.github.com/users/github/following{/other_user}",
    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
    "organizations_url": "https://api.github.com/users/github/orgs",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "events_url": "https://api.github.com/orgs/github/events",
    "received_events_url": "https://api.github.com/users/github/received_events",
    "type": "Organization",
    "site_admin": false
  },
  "repository_selection": "all",
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "created_at": "2018-02-09T20:51:14Z",
  "updated_at": "2018-02-09T20:51:14Z",
  "single_file_name": "config.yml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}

헤더
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`username` string Required The handle for the GitHub user account.

"Get a user installation for the authenticated app"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK

"Get a user installation for the authenticated app"에 대한 코드 샘플

요청 예제

get/users/{username}/installation

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/users/USERNAME/installation

Response

Status: 200

{
  "id": 1,
  "account": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/orgs/github",
    "html_url": "https://github.com/github",
    "followers_url": "https://api.github.com/users/github/followers",
    "following_url": "https://api.github.com/users/github/following{/other_user}",
    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
    "organizations_url": "https://api.github.com/users/github/orgs",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "events_url": "https://api.github.com/orgs/github/events",
    "received_events_url": "https://api.github.com/users/github/received_events",
    "type": "Organization",
    "site_admin": false
  },
  "repository_selection": "all",
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "created_at": "2018-02-09T20:51:14Z",
  "updated_at": "2018-02-09T20:51:14Z",
  "single_file_name": "config.yml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}

GitHub Apps에 대한 REST API 엔드포인트

요청 예제

Response

요청 예제

Response

요청 예제

List of integration installation requests

요청 예제

The permissions the installation has are included under the permissions key.

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

요청 예제

Response

The permissions the installation has are included under the `permissions` key.