Class OAuth2Client`Abstract`

OAuth 2.0 client.

Hierarchy

OAuth2Client

Index

Methods

createAuthorizeUrl getAuthCodeByIframe getOAuth2Tokens getUserInfo endSession revokeToken request containsAuthCode containsAuthError getBody parseError getUrl

Constructors

Methods

`Static` createAuthorizeUrl

createAuthorizeUrl(options: GetAuthorizationUrlOptions): Promise<string>
Parameters
- options: GetAuthorizationUrlOptions
Returns Promise<string>
- Defined in oauth2-client/index.ts:58

`Static` getAuthCodeByIframe

getAuthCodeByIframe(options: GetAuthorizationUrlOptions): Promise<string>
Calls the authorize URL with an iframe. If successful, it returns the callback URL with authentication code, optionally using PKCE. Method renamed in v3. Original Name: getAuthorizeUrl New Name: getAuthCodeByIframe
Parameters
- options: GetAuthorizationUrlOptions
Returns Promise<string>
- Defined in oauth2-client/index.ts:95

`Static` getOAuth2Tokens

getOAuth2Tokens(options: GetOAuth2TokensOptions): Promise<OAuth2Tokens>
Exchanges an authorization code for OAuth tokens.
Parameters
- options: GetOAuth2TokensOptions
Returns Promise<OAuth2Tokens>
- Defined in oauth2-client/index.ts:145

`Static` getUserInfo

getUserInfo(options?: ConfigOptions): Promise<unknown>
Gets OIDC user information.
Parameters
- Optional options: ConfigOptions
Returns Promise<unknown>
- Defined in oauth2-client/index.ts:201

`Static` endSession

endSession(options?: ConfigOptions): Promise<Response>
Invokes the OIDC end session endpoint.
Parameters
- Optional options: ConfigOptions
Returns Promise<Response>
- Defined in oauth2-client/index.ts:214

`Static` revokeToken

revokeToken(options?: ConfigOptions): Promise<Response>
Immediately revokes the stored access token.
Parameters
- Optional options: ConfigOptions
Returns Promise<Response>
- Defined in oauth2-client/index.ts:233

`Static` `Private` request

request(endpoint: keyof CustomPathConfig, query?: StringDict<string>, includeToken?: boolean, init?: RequestInit, options?: ConfigOptions): Promise<Response>
Parameters
- endpoint: keyof CustomPathConfig
- Optional query: StringDict<string>
- Optional includeToken: boolean
- Optional init: RequestInit
- Optional options: ConfigOptions
Returns Promise<Response>
- Defined in oauth2-client/index.ts:260

`Static` `Private` containsAuthCode

containsAuthCode(url: string): boolean
Parameters
- url: string
Returns boolean
- Defined in oauth2-client/index.ts:300

`Static` `Private` containsAuthError

containsAuthError(url: string): boolean
Parameters
- url: string
Returns boolean
- Defined in oauth2-client/index.ts:304

`Static` `Private` getBody

getBody<T>(response: Response): Promise<string | T>
Type Parameters
- T
Parameters
- response: Response
Returns Promise<string | T>
- Defined in oauth2-client/index.ts:308

`Static` `Private` parseError

parseError(json: StringDict<unknown>): string
Parameters
- json: StringDict<unknown>
Returns string
- Defined in oauth2-client/index.ts:316

`Static` `Private` getUrl

getUrl(endpoint: keyof CustomPathConfig, query?: StringDict<string>, options?: ConfigOptions): string
Parameters
- endpoint: keyof CustomPathConfig
- Optional query: StringDict<string>
- Optional options: ConfigOptions
Returns string
- Defined in oauth2-client/index.ts:328

Constructors

constructor

new OAuth2Client(): OAuth2Client
Returns OAuth2Client