Class AuthService<TAppState>

Type Parameters

Implements

  • OnDestroy

Constructors

constructor

Properties

appState$ error$ idTokenClaims$ isAuthenticated$ isLoading$ user$

Methods

getAccessTokenSilently getAccessTokenWithPopup handleRedirectCallback loginWithPopup loginWithRedirect logout ngOnDestroy

Constructors

constructor

Properties

Readonly appState$

appState$: Observable<TAppState> = ...

Emits the value (if any) that was passed to the loginWithRedirect method call but only after handleRedirectCallback is first called

Readonly error$

error$: Observable<Error> = ...

Emits errors that occur during login, or when checking for an active session on startup.

Readonly idTokenClaims$

idTokenClaims$: Observable<undefined | null | IdToken> = ...

Emits ID token claims when authenticated, or null if not authenticated.

Readonly isAuthenticated$

isAuthenticated$: Observable<boolean> = ...

Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated. This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.

Readonly isLoading$

isLoading$: Observable<boolean> = ...

Emits boolean values indicating the loading state of the SDK.

Readonly user$

user$: Observable<undefined | null | User> = ...

Emits details about the authenticated user, or null if not authenticated.

Methods

getAccessTokenSilently

getAccessTokenWithPopup

  • getAccessTokenWithPopup(options?): Observable<undefined | string> 
  • getTokenWithPopup(options).subscribe(token => ...)

    Get an access token interactively.

    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 Observable<undefined | string>

handleRedirectCallback

  • handleRedirectCallback(url?): Observable<RedirectLoginResult<TAppState>> 
  • handleRedirectCallback(url).subscribe(result => ...)

    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.

    Calling this method also refreshes the authentication and user states.

    Parameters

    • Optional url: string

      The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.

    Returns Observable<RedirectLoginResult<TAppState>>

loginWithPopup

  • loginWithPopup(options?, config?): Observable<void> 
  • await loginWithPopup(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.

    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 Observable<void>

loginWithRedirect

  • loginWithRedirect(options?): Observable<void> 
  • 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 Observable<void>

logout

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

    Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session. If the federated option is specified it also clears the Identity Provider session. If the openUrl option is set to false, it only clears the application session. It is invalid to set both the federated to true and openUrl to false, and an error will be thrown if you do. Read more about how Logout works at Auth0.

    Parameters

    Returns Observable<void>

ngOnDestroy

Settings

Member Visibility

Theme

On This Page