Sample - GitHub REST API
POST/applications/{client_id}/token

Check a token

OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
client_idstringrequired
The client ID of the GitHub app.
access_tokenstringrequired
The access_token of the OAuth or GitHub application.

3 status codes
200Response
idintegerrequired
urlstringrequired
scopesarray<string>required
A list of scopes that this authorization is in.
tokenstringrequired
token_last_eightstringrequired
hashed_tokenstringrequired
appobjectrequired
notestringrequired
note_urlstringrequired
updated_atstringrequired
created_atstringrequired
fingerprintstringrequired
userobjectoptional
A GitHub user.
installationobjectoptional
expires_atstringrequired
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.