Class OAuth2ClientAbstract

OAuth 2.0 client.

Constructors

Methods

  • 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

    Returns Promise<string>

  • Invokes the OIDC end session endpoint. Can result in a redirect to /signoff if using PingOne It's best to explicitly provide the logout redirect URL in options

    Parameters

    Returns Promise<void | Response>

    Function

    endSession - call authorization server to end associated session

  • Parameters

    • endpoint: keyof CustomPathConfig
    • Optional query: StringDict<undefined | string>
    • Optional includeToken: boolean
    • Optional init: RequestInit
    • Optional options: ConfigOptions
    • Optional logoutOptions: {
          redirect?: boolean;
          logoutRedirectUri?: string;
      }
      • Optional redirect?: boolean
      • Optional logoutRedirectUri?: string

    Returns Promise<Response>

  • Type Parameters

    • T

    Parameters

    • response: Response

    Returns Promise<string | T>