Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebAuth

Hierarchy

  • WebAuth

Index

Constructors

constructor

Properties

client

crossOriginAuthentication

crossOriginAuthentication: CrossOriginAuthentication

popup

popup: Popup

redirect

redirect: Redirect

Methods

authorize

  • Redirects to the hosted login page (/authorize) in order to initialize a new authN/authZ transaction

    Parameters

    Returns void

changePassword

checkSession

crossOriginAuthenticationCallback

  • crossOriginAuthenticationCallback(): void
  • Runs the callback code for the cross origin authentication call. This method is meant to be called by the cross origin authentication callback url.

    deprecated

    Use crossOriginVerification instead.

    Returns void

crossOriginVerification

  • crossOriginVerification(): void
  • Runs the callback code for the cross origin authentication call. This method is meant to be called by the cross origin authentication callback url.

    Returns void

login

  • Logs in the user with username and password using the cross origin authentication (/co/authenticate) flow. You can use either username or email to identify the user, but username will take precedence over email.

    This only works when 3rd party cookies are enabled in the browser. After the /co/authenticate call, you'll have to use the parseHash function at the redirectUri specified in the constructor.

    Parameters

    Returns void

logout

  • Redirects to the auth0 logout endpoint

    If you want to navigate the user to a specific URL after the logout, set that URL at the returnTo parameter. The URL should be included in any the appropriate Allowed Logout URLs list:

    • If the client_id parameter is included, the returnTo URL must be listed in the Allowed Logout URLs set at the client level (see Setting Allowed Logout URLs at the App Level).
    • If the client_id parameter is NOT included, the returnTo URL must be listed in the Allowed Logout URLs set at the account level (see Setting Allowed Logout URLs at the Account Level).
    see

    https://auth0.com/docs/api/authentication#logout

    Parameters

    Returns void

parseHash

  • Parse the url hash and extract the returned tokens depending on the transaction.

    Only validates id_tokens signed by Auth0 using the RS256 algorithm using the public key exposed by the /.well-known/jwks.json endpoint. Id tokens signed with other algorithms will not be accepted.

    Parameters

    Returns void

  • Parse the url hash and extract the returned tokens depending on the transaction.

    Only validates id_tokens signed by Auth0 using the RS256 algorithm using the public key exposed by the /.well-known/jwks.json endpoint. Id tokens signed with other algorithms will not be accepted.

    Parameters

    Returns void

passwordlessLogin

passwordlessStart

passwordlessVerify

renderCaptcha

renewAuth

  • Executes a silent authentication transaction under the hood in order to fetch a new tokens for the current session. This method requires that all Auth is performed with authorize Watch out! If you're not using the hosted login page to do social logins, you have to use your own social connection keys. If you use Auth0's dev keys, you'll always get login_required as an error when calling this method.

    Parameters

    Returns void

signup

signupAndAuthorize

  • Signs up a new user, automatically logs the user in after the signup and returns the user token. The login will be done using /oauth/token with password-realm grant type.

    Parameters

    Returns void

validateToken

  • Decodes the id_token and verifies the nonce.

    Parameters

    Returns void

Generated using TypeDoc