List your grants

Deprecated

**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/[email protected]/rest/reference/oauth-authorizations/), 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](https://docs.github.com/[email protected]/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/[email protected]/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). 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](https://docs.github.com/[email protected]/rest/reference/oauth-authorizations#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](https://github.com/settings/applications#authorized). 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/applications/grants

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Query Parameters

per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.
client_id string optional: The client ID of your GitHub app.

Responses

application/json array[Application Grant object]

Response

Headers

Link string

Example:

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

items Application Grant object

The authorization associated with an OAuth Access.

app object

required

client_id string

required

name string

required

url string<uri>

required

created_at string<date-time>

required

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

id integer

required

Example: 1

scopes array[string]

required

Example:

[
  "public_repo"
]

updated_at string<date-time>

required

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

url string<uri>

required

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

user Simple User object

optionalnullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

Response Example: 200 application/json

[
  {
    "app": {
      "client_id": "abcde12345fghij67890",
      "name": "my github app",
      "url": "http://my-github-app.com"
    },
    "created_at": "2011-09-06T17:26:27Z",
    "id": 1,
    "scopes": [
      "public_repo"
    ],
    "updated_at": "2011-09-06T20:39:23Z",
    "url": "https://api.github.com/applications/grants/1"
  }
]

Not modified

application/json Basic Error object

Requires authentication

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Forbidden

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

per_page

Results per page (max 100)

page

Page number of the results to fetch.

client_id

The client ID of your GitHub app.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/applications/grants