OAuth authorizations

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Actions

Enter a search term to find it in the GitHub Docs.

OAuth authorizations - GitHub Enterprise Server 3.6 Docs

Use the REST API to manage the access OAuth apps have to your account.

Quickstart

Comparing GitHub's APIs

Resources in the REST API

Rate limits

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

OpenAPI description

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Dependabot

Dependency review

Dependency Graph

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

LDAP

License

Management Console

Organization Pre-receive Hooks

Organizations

Pre-receive Environments

Pre-receive Hooks

Repository Pre-receive Hooks

SCIM

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Custom Repository Roles

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Emails

Followers

GPG Keys

Git SSH Keys

my github app

The authorization associated with an OAuth Access.

Application Grant

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.
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.6/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>.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

client_id

List your grants

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.

The unique identifier of the grant.

grant_id

Get a single grant

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.
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>.

Delete a grant

My personal access token

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

Authorization

List your authorizations

A list of scopes that this authorization is in.

scopes

A note to remind you what the OAuth token is for.

note

A URL to remind you what app the OAuth token is for.

note_url

The OAuth app client key for which to create the token.

The OAuth app client secret for which to create the token.

client_secret

A unique string to distinguish an authorization from others created for the same client ID and user.

fingerprint

A list of scopes that this authorization is in.

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.
Warning: Apps must use the <a href="https://docs.github.com/enterprise-server@3.6/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>.
Creates OAuth tokens using <a href="https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#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.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication">Working with two-factor authentication</a>."
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.
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.6/articles/creating-an-access-token-for-command-line-use">the GitHub Help documentation</a>.
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.6/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.

Validation failed, or the endpoint has been spammed.

Create a new authorization

Create an authorization for an app 1: Status Code 200

Create an authorization for an app 2: Status Code 201

Deprecation Notice: GitHub will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.
Warning: Apps must use the <a href="https://docs.github.com/enterprise-server@3.6/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>.
Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
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.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication">Working with two-factor authentication</a>."
Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.

Get-or-create an authorization for a specific app

Create an authorization for an app and fingerprint 1: Status Code 200

Create an authorization for an app and fingerprint 2: Status Code 201

Deprecation Notice: GitHub Enterprise Server will discontinue the <a href="https://docs.github.com/enterprise-server@3.6/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.6/developers/apps/authorizing-oauth-apps#web-application-flow">web application flow</a>. The <a href="https://docs.github.com/enterprise-server@3.6/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>.
Warning: Apps must use the <a href="https://docs.github.com/enterprise-server@3.6/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>.
This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
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.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication">Working with two-factor authentication</a>."

Get-or-create an authorization for a specific app and fingerprint

The unique identifier of the authorization.

authorization_id

Get a single authorization