class OAuth2API

export declare class OAuth2API
generateAuthorizationURL
getCurrentAuthorizationInformation
getCurrentBotApplicationInformation
getToken
refreshToken
revokeToken
tokenExchange

Constructors

constructor(
rest: REST
)

Constructs a new instance of the OAuth2API class

generateAuthorizationURL(
options: RESTOAuth2AuthorizationQuery
) : string

Creates an OAuth2 authorization URL given the options

See also: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-authorization-url-example

getCurrentAuthorizationInformation(
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIOAuth2CurrentAuthorizationResult>

Fetches the current authorization information

See also: https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information

getCurrentBotApplicationInformation(
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIOAuth2CurrentApplicationResult>

Fetches the current bot's application information

See also: https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information

getToken(
body: RESTPostOAuth2ClientCredentialsURLEncodedData
options?: Pick<RequestData, 'signal'>
) : Promise<RESTOAuth2ImplicitAuthorizationURLFragmentResult>

Fetches the bearer token for the current application

See also: https://discord.com/developers/docs/topics/oauth2#client-credentials-grant

refreshToken(
body: RESTPostOAuth2RefreshTokenURLEncodedData
options?: Pick<RequestData, 'signal'>
) : Promise<RESTPostOAuth2AccessTokenResult>

Refreshes an OAuth2 access token, giving you a new one

See also: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example

revokeToken(
applicationId: Snowflake
applicationSecret: string
body: RESTPostOAuth2TokenRevocationQuery
options?: Pick<RequestData, 'signal'>
) : Promise<void>

Revokes an OAuth2 token

See also: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-token-revocation-example

tokenExchange(
body: RESTPostOAuth2AccessTokenURLEncodedData
options?: Pick<RequestData, 'signal'>
) : Promise<RESTPostOAuth2AccessTokenResult>

Performs an OAuth2 token exchange, giving you an access token

See also: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-exchange-example