Class OAuth2ClientAbstract

OAuth 2.0 client.

Constructors

constructor

Methods

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

Constructors

constructor

Methods

StaticcreateAuthorizeUrl

StaticgetAuthCodeByIframe

  • getAuthCodeByIframe(options): 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

    Returns Promise<string>

StaticgetOAuth2Tokens

StaticgetUserInfo

StaticendSession

  • endSession(options?): Promise<void | Response>

  • 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

StaticrevokeToken

Private Staticrequest

  • request(endpoint, query?, includeToken?, init?, options?, logoutOptions?): Promise<Response>

  • Parameters

    • endpoint: keyof CustomPathConfig
    • Optionalquery: StringDict<undefined | string>
    • OptionalincludeToken: boolean
    • Optionalinit: RequestInit
    • Optionaloptions: ConfigOptions
    • OptionallogoutOptions: {
          redirect?: boolean;
          logoutRedirectUri?: string;
      }
      • Optionalredirect?: boolean
      • OptionallogoutRedirectUri?: string

    Returns Promise<Response>

Private StaticcontainsAuthCode

Private StaticcontainsAuthError

Private StaticgetBody

  • getBody<T>(response): Promise<string | T>

  • Type Parameters

    • T

    Parameters

    • response: Response

    Returns Promise<string | T>

Private StaticparseError

Private StaticgetUrl

Settings

Member Visibility

On This Page

Constructors
Methods