oauth_applications

Creates, updates, deletes, gets or lists an oauth_applications resource.

Overview

Name	oauth_applications
Type	Resource
Id	github.apps.oauth_applications

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete_token	delete	client_id		OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
check_token	exec	client_id, access_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.
reset_token	exec	client_id, access_token		OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
client_id	string	The client ID of the GitHub app.

DELETE examples

delete_token

OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.

DELETE FROM github.apps.oauth_applications
WHERE client_id = '{{ client_id }}' --required
;

Lifecycle Methods

check_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.

EXEC github.apps.oauth_applications.check_token 
@client_id='{{ client_id }}' --required 
@@json=
'{
"access_token": "{{ access_token }}"
}'
;

reset_token

OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

EXEC github.apps.oauth_applications.reset_token 
@client_id='{{ client_id }}' --required 
@@json=
'{
"access_token": "{{ access_token }}"
}'
;