No summary provided.
Constructs a new instance of the
OAuth2API class| Name | Type | Optional | Description |
|---|---|---|---|
| rest | REST | No | None |
Creates an OAuth2 authorization URL given the options
| Name | Type | Optional | Description |
|---|---|---|---|
| options | RESTOAuth2AuthorizationQuery | No | The options for creating the authorization URL |
Fetches the current authorization information
| Name | Type | Optional | Description |
|---|---|---|---|
| options | Pick<RequestData, 'signal'> | Yes | The options for the current authorization information request |
Fetches the current bot's application information
| Name | Type | Optional | Description |
|---|---|---|---|
| options | Pick<RequestData, 'signal'> | Yes | The options for the current bot application information request |
Fetches the bearer token for the current application
Remarks
This is primarily used for testing purposes| Name | Type | Optional | Description |
|---|---|---|---|
| body | RESTPostOAuth2ClientCredentialsURLEncodedData | No | The options for the client credentials grant request |
| options | Pick<RequestData, 'signal'> | Yes | The options for the client credentials grant request |
Refreshes an OAuth2 access token, giving you a new one
| Name | Type | Optional | Description |
|---|---|---|---|
| body | RESTPostOAuth2RefreshTokenURLEncodedData | No | The options for the refresh token request |
| options | Pick<RequestData, 'signal'> | Yes | The options for the refresh token request |
Revokes an OAuth2 token
| Name | Type | Optional | Description |
|---|---|---|---|
| applicationId | Snowflake | No | The application id |
| applicationSecret | string | No | The application secret |
| body | RESTPostOAuth2TokenRevocationQuery | No | The body of the token revocation request |
| options | Pick<RequestData, 'signal'> | Yes | The options for the token revocation request |
Performs an OAuth2 token exchange, giving you an access token
| Name | Type | Optional | Description |
|---|---|---|---|
| body | RESTPostOAuth2AccessTokenURLEncodedData | No | The body of the token exchange request |
| options | Pick<RequestData, 'signal'> | Yes | The options for the token exchange request |