Search
K
GitHub v3 REST API

oauth-authorizations

Manage access of OAuth applications

List your grants

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations 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 the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

get
http://HOSTNAME/api/v3/applications/grants

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

client_idstring

The client ID of your GitHub app.

Response

application/json

Response

The authorization associated with an OAuth Access.

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/applications/grants/1

appobjectrequired
Show Child Parameters
created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

scopesarray[string]required

Example:["public_repo"]

userobject | null

Simple User

Show Child Parameters
get/applications/grants
 
application/json

Get a single grant

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

get
http://HOSTNAME/api/v3/applications/grants/{grant_id}

Path Parameters

grant_idintegerrequired

grant_id parameter

Response

application/json

Response

Application Grant

The authorization associated with an OAuth Access.

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/applications/grants/1

appobjectrequired
Show Child Parameters
created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

scopesarray[string]required

Example:["public_repo"]

userobject | null

Simple User

Show Child Parameters
get/applications/grants/{grant_id}
 
application/json

Delete a grant

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

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 the application authorizations settings screen within GitHub.

delete
http://HOSTNAME/api/v3/applications/grants/{grant_id}

Path Parameters

grant_idintegerrequired

grant_id parameter

Response

Response

delete/applications/grants/{grant_id}
 

List your authorizations

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

get
http://HOSTNAME/api/v3/authorizations

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

client_idstring

The client ID of your GitHub app.

Response

application/json

Response

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

idintegerrequired
urlstring(uri)required
scopesarray | null[string]required

A list of scopes that this authorization is in.

tokenstringrequired
token_last_eightstring | nullrequired
hashed_tokenstring | nullrequired
appobjectrequired
Show Child Parameters
notestring | nullrequired
note_urlstring | null(uri)required
updated_atstring(date-time)required
created_atstring(date-time)required
fingerprintstring | nullrequired
userobject | null

Simple User

Show Child Parameters
installationobject | null
Show Child Parameters
get/authorizations
 
application/json