Class OAuth2Client

OAuth 2.0 client.

Hierarchy

OAuth2Client

Index

Methods

Methods

Static createAuthorizeUrl

createAuthorizeUrl(options: GetAuthorizationUrlOptions): Promise<string>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:47
Parameters
- options: GetAuthorizationUrlOptions
Returns Promise<string>

Static endSession

endSession(options?: ConfigOptions): Promise<Response>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:202
Invokes the OIDC end session endpoint.

Parameters
- Optional options: ConfigOptions
Returns Promise<Response>

Static getAuthCodeByIframe

getAuthCodeByIframe(options: GetAuthorizationUrlOptions): Promise<string>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:84
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>

Static getOAuth2Tokens

getOAuth2Tokens(options: GetOAuth2TokensOptions): Promise<OAuth2Tokens>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:133
Exchanges an authorization code for OAuth tokens.

Parameters
- options: GetOAuth2TokensOptions
Returns Promise<OAuth2Tokens>

Static getUserInfo

getUserInfo(options?: ConfigOptions): Promise<unknown>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:189
Gets OIDC user information.

Parameters
- Optional options: ConfigOptions
Returns Promise<unknown>

Static revokeToken

revokeToken(options?: ConfigOptions): Promise<Response>

- Defined in packages/javascript-sdk/src/oauth2-client/index.ts:220
Immediately revokes the stored access token.

Parameters
- Optional options: ConfigOptions
Returns Promise<Response>