Interface Auth0VueClient

interface Auth0VueClient {
    error: Ref<any>;
    idTokenClaims: Ref<undefined | IdToken>;
    isAuthenticated: Ref<boolean>;
    isLoading: Ref<boolean>;
    user: Ref<undefined | User>;
    checkSession(options?): Promise<void>;
    getAccessTokenSilently(options): Promise<GetTokenSilentlyVerboseResponse>;
    getAccessTokenSilently(options?): Promise<string>;
    getAccessTokenWithPopup(options?, config?): Promise<undefined | string>;
    handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>;
    loginWithPopup(options?, config?): Promise<void>;
    loginWithRedirect(options?): Promise<void>;
    logout(options?): Promise<void>;
}

Properties

error idTokenClaims isAuthenticated isLoading user

Methods

checkSession getAccessTokenSilently getAccessTokenWithPopup handleRedirectCallback loginWithPopup loginWithRedirect logout

Properties

error

error: Ref<any>

Contains an error that occured in the SDK

idTokenClaims

idTokenClaims: Ref<undefined | IdToken>

Contains all claims from the id_token if available.

isAuthenticated

isAuthenticated: Ref<boolean>

The authentication state, true if the user is authenticated, false if not.

isLoading

isLoading: Ref<boolean>

The loading state of the SDK, true if the SDK is still processing the PKCE flow, false if the SDK has finished processing the PKCE flow.

user

user: Ref<undefined | User>

Contains the information of the user if available.

Methods

checkSession

  • checkSession(options?): Promise<void>
  • await checkSession();

    Check if the user is logged in using getTokenSilently. The difference with getTokenSilently is that this doesn't return a token, but it will pre-fill the token cache.

    This method also heeds the auth0.{clientId}.is.authenticated cookie, as an optimization to prevent calling Auth0 unnecessarily. If the cookie is not present because there was no previous login (or it has expired) then tokens will not be refreshed.

    Parameters

    Returns Promise<void>

getAccessTokenSilently

getAccessTokenWithPopup

  • getAccessTokenWithPopup(options?, config?): Promise<undefined | string>
  • const token = await getTokenWithPopup(options);

    Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

    Parameters

    Returns Promise<undefined | string>

handleRedirectCallback

  • handleRedirectCallback(url?): Promise<RedirectLoginResult<AppState>>

  • After the browser redirects back to the callback page, call handleRedirectCallback to handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.

    Note: The Auth0-Vue SDK handles this for you, unless you set skipRedirectCallback to true. In that case, be sure to explicitly call handleRedirectCallback yourself.

    Parameters

    • Optional url: string

    Returns Promise<RedirectLoginResult<AppState>>

loginWithPopup

  • loginWithPopup(options?, config?): Promise<void>
  • try {
     await loginWithPopup(options);
    } catch(e) {
     if (e instanceof PopupCancelledError) {
       // Popup was closed before login completed
     }
    }

    Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

    IMPORTANT: This method has to be called from an event handler that was started by the user like a button click, for example, otherwise the popup will be blocked in most browsers.

    Parameters

    Returns Promise<void>

loginWithRedirect

  • loginWithRedirect(options?): Promise<void>
  • await loginWithRedirect(options);

    Performs a redirect to /authorize using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated.

    Parameters

    Returns Promise<void>

logout

  • logout(options?): Promise<void>
  • logout();

    Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session.

    Note: If you are using a custom cache, and specifying localOnly: true, and you want to perform actions or read state from the SDK immediately after logout, you should await the result of calling logout.

    If the federated option is specified it also clears the Identity Provider session. If the localOnly option is specified, it only clears the application session. It is invalid to set both the federated and localOnly options to true, and an error will be thrown if you do. Read more about how Logout works at Auth0.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page