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. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

You must use a JWT to access this endpoint.

curl --location --request POST 'https://api.github.com/app/installations//access_tokens' \ --header 'Content-Type: application/json' \ --data-raw '{ "permissions": { "contents": "read", "deployments": "write", "issues": "read", "single_file": "read" }, "repositories": [ "rails" ], "repository_ids": [ 1 ] }'

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

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

installation_id

integer

必需

installation_id parameter

Body 参数application/json

permissions

object (App Permissions)

可选

The permissions granted to the user-to-server access token.

示例值:

{"contents":"read","deployments":"write","issues":"read","single_file":"read"}

actions

enum<string>

可选

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: read or write.

枚举值:

readwrite

administration

enum<string>

可选

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: read or write.

枚举值:

readwrite

checks

enum<string>

可选

The level of permission to grant the access token for checks on code. Can be one of: read or write.

枚举值:

readwrite

content_references

enum<string>

可选

The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: read or write.

枚举值:

readwrite

contents

enum<string>

可选

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: read or write.

枚举值:

readwrite

deployments

enum<string>

可选

The level of permission to grant the access token for deployments and deployment statuses. Can be one of: read or write.

枚举值:

readwrite

environments

enum<string>

可选

The level of permission to grant the access token for managing repository environments. Can be one of: read or write.

枚举值:

readwrite

issues

enum<string>

可选

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: read or write.

枚举值:

readwrite

members

enum<string>

可选

The level of permission to grant the access token for organization teams and members. Can be one of: read or write.

枚举值:

readwrite

metadata

enum<string>

可选

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: read or write.

枚举值:

readwrite

organization_administration

enum<string>

可选

The level of permission to grant the access token to manage access to an organization. Can be one of: read or write.

枚举值:

readwrite

organization_hooks

enum<string>

可选

The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: read or write.

枚举值:

readwrite

organization_plan

enum<string>

可选

The level of permission to grant the access token for viewing an organization's plan. Can be one of: read.

枚举值:

read

organization_projects

enum<string>

可选

The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: read, write, or admin.

枚举值:

readwriteadmin

organization_secrets

enum<string>

可选

The level of permission to grant the access token to manage organization secrets. Can be one of: read or write.

枚举值:

readwrite

organization_self_hosted_runners

enum<string>

可选

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: read or write.

枚举值:

readwrite

organization_user_blocking

enum<string>

可选

The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: read or write.

枚举值:

readwrite

packages

enum<string>

可选

The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: read or write.

枚举值:

readwrite

pages

enum<string>

可选

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: read or write.

枚举值:

readwrite

pull_requests

enum<string>

可选

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: read or write.

枚举值:

readwrite

repository_hooks

enum<string>

可选

The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: read or write.

枚举值:

readwrite

repository_projects

enum<string>

可选

The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: read, write, or admin.

枚举值:

readwriteadmin

secret_scanning_alerts

enum<string>

可选

The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: read or write.

枚举值:

readwrite

secrets

enum<string>

可选

The level of permission to grant the access token to manage repository secrets. Can be one of: read or write.

枚举值:

readwrite

security_events

enum<string>

可选

The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: read or write.

枚举值:

readwrite

single_file

enum<string>

可选

The level of permission to grant the access token to manage just a single file. Can be one of: read or write.

枚举值:

readwrite

statuses

enum<string>

可选

The level of permission to grant the access token for commit statuses. Can be one of: read or write.

枚举值:

readwrite

team_discussions

enum<string>

可选

The level of permission to grant the access token to manage team discussions and related comments. Can be one of: read or write.

枚举值:

readwrite

vulnerability_alerts

enum<string>

可选

The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: read.

枚举值:

read

workflows

enum<string>

可选

The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: write.

枚举值:

write

repositories

array[string]

可选

List of repository names that the token should have access to

repository_ids

array[integer]

可选

List of repository IDs that the token should have access to

示例值:

[1]

示例

返回响应

🟢201Response

application/json

Body

Authentication token for a GitHub App installed on a user or org.

expires_at

string

必需

has_multiple_single_files

boolean

可选

示例值:

true

permissions

object

可选

contents

string

可选

issues

string

可选

metadata

string

可选

示例值:

read

single_file

string

可选

示例值:

read

repositories

array[object (Repository) {88}]

可选

allow_merge_commit

boolean

可选

Whether to allow merge commits for pull requests.

默认值:

true

示例值:

true

allow_rebase_merge

boolean

可选

Whether to allow rebase merges for pull requests.

默认值:

true

示例值:

true

allow_squash_merge

boolean

可选

Whether to allow squash merges for pull requests.

默认值:

true

示例值:

true

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

必需

Whether the repository is archived.

默认值:

false

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

必需

示例值:

https://github.com/octocat/Hello-World.git

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time> | null

必需

示例值:

2011-01-26T19:01:12Z

default_branch

string

必需

The default branch of the repository.

示例值:

master

delete_branch_on_merge

boolean

可选

Whether to delete head branches when pull requests are merged

默认值:

false

示例值:

false

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

必需

Returns whether or not this repository disabled.

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

必需

forks_count

integer

必需

示例值:

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

必需

示例值:

git:github.com/octocat/Hello-World.git

has_downloads

boolean

必需

Whether downloads are enabled.

默认值:

true

示例值:

true

has_issues

boolean

必需

Whether issues are enabled.

默认值:

true

示例值:

true

has_pages

boolean

必需

has_projects

boolean

必需

Whether projects are enabled.

默认值:

true

示例值:

true

has_wiki

boolean

必需

Whether the wiki is enabled.

默认值:

true

示例值:

true

homepage

string <uri> | null

必需

示例值:

https://github.com

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

Unique identifier of the repository

示例值:

is_template

boolean

可选

Whether this repository acts as a template that can be used to generate new repositories.

默认值:

false

示例值:

true

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

必需

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

null | allOf {1}

必需

master_branch

string

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string <uri> | null

必需

示例值:

git:git.example.com/octocat/Hello-World

name

string

必需

The name of the repository.

示例值:

Team Environment

network_count

integer

可选

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

必需

open_issues_count

integer

必需

示例值:

organization

null

可选

Simple User

owner

null

必需

Simple User

permissions

object

可选

private

boolean

必需

Whether the repository is private or public.

默认值:

false

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time> | null

必需

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

必需

示例值:

108

ssh_url

string

必需

示例值:

git@github.com:octocat/Hello-World.git

stargazers_count

integer

必需

示例值:

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

starred_at

string

可选

示例值:

"2020-07-09T00:17:42Z"

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

可选

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string <uri>

必需

示例值:

https://svn.github.com/octocat/Hello-World

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string

可选

template_repository

object | null

可选

topics

array[string]

可选

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time> | null

必需

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

The repository visibility: public, private, or internal.

默认值:

public

watchers

integer

必需

watchers_count

integer

必需

示例值:

repository_selection

enum<string>

可选

枚举值:

allselected

single_file

string

可选

示例值:

README.md

single_file_paths

array[string]

可选

示例值:

["config.yml",".github/issue_TEMPLATE.md"]

token

string

必需

🟠401401

🟠403403

🟠404404

🟠415415

🟠422422