用于 OAuth 应用授权的 REST API 终结点

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.14

Enterprise Server 3.15

Free, Pro, & Team

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

域名

谁可以使用此功能？

操作

需要多个权限，或者可以使用不同的权限。 有关权限的更多信息，请参阅此终结点的文档。

输入搜索词以在 GitHub 文档中找到它。

用于 OAuth 应用授权的 REST API 终结点 - GitHub Enterprise Server 3.15 Docs

使用 REST API 管理 OAuth apps 对你的帐户的访问权限。

快速入门

REST API 简介

比较 GitHub 的 API

API 版本

重大更改

OpenAPI 描述

入门

速率限制

分页

Libraries

最佳做法

故障排除

时区

CORS 与 JSONP

议题事件类型

GitHub 事件类型

使用 REST API

身份验证

确保 API 凭据安全

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

使用 JavaScript 编写脚本

使用 Ruby 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

构建 CI 服务器

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行器组

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

组织

公告横幅

GitHub Apps

安装

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

代码扫描

配置

代码安全设置

行为准则

协作者

邀请

提交

提交注释

提交状态

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖关系图

部署密钥

部署分支策略

部署

环境

保护规则

部署状态

表情符号

管理统计

公告

审核日志

代码安全性和分析

全局 Webhook

LDAP

许可证

管理 GHES

组织预接收挂钩

预接收环境

预接收挂钩

存储库预接收挂钩

SCIM

用户

企业管理

Gists

Blob

参考

标记

Trees

Git 数据库

Gitignore

问题

受理人

里程碑

时间线

Markdown

元数据

统计信息

指标

迁移

OAuth 应用授权

自定义属性

自定义角色

成员

组织角色

外部协作者

个人访问令牌

规则套件

规则

安全管理员

Boards

卡片

Projects (classic)

拉取请求

评价注释

审查请求

审阅

反应

发行版本

发布资产

自动链接

前叉

Git LFS

存储库

Search

机密扫描

全局安全公告

安全通知

Teams

讨论评论

讨论

外部组

电子邮件

关注者

GPG 密钥

Git SSH 密钥

社交帐户

SSH 签名密钥

my github app

The authorization associated with an OAuth Access.

Application Grant

<div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p>
<p>
<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href="https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href="https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/">blog post</a>.</p>
</div>
<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href="https://github.com/settings/applications#authorized">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>["repo", "user"]</code>.</p>

<p>The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."</p>

per_page

<p>The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."</p>

page

client_id

List your grants

<div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p>
<p>
<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href="https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href="https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/">blog post</a>.</p>
</div>

<p>The unique identifier of the grant.</p>

grant_id

Get a single grant

<div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p>
<p>
<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href="https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href="https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/">blog post</a>.</p>
</div>
<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href="https://github.com/settings/applications#authorized">the application authorizations settings screen within GitHub</a>.</p>

Delete a grant

My personal access token

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

Authorization

List your authorizations

<p>A list of scopes that this authorization is in.</p>

scopes

<p>A note to remind you what the OAuth token is for.</p>

note

<div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p>
<p>
<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href="https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations">OAuth Authorizations API</a> will be removed on November 13 2020. For more information, including scheduled brownouts, see the <a href="https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/">blog post</a>.</p>
</div>
<div class="ghd-alert ghd-alert-attention"><p class="ghd-alert-title"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</p>
<p>
Apps must use the <a href="https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href="https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api">blog post</a>.</p>
</div>
<p>Creates OAuth tokens using <a href="https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication">Working with two-factor authentication</a>."</p>
<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>
<p>You can also create tokens on GitHub Enterprise Server from the <a href="https://github.com/settings/tokens">personal access tokens settings</a> page. Read more about these tokens in <a href="https://docs.github.com/enterprise-server@3.15/articles/creating-an-access-token-for-command-line-use">the GitHub Help documentation</a>.</p>
<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on">About identity and access management with SAML single sign-on</a>" in the GitHub Enterprise Cloud documentation.</p>

Create a new authorization