Interface IWebAuthProvider

Defines the contract for a provider that handles web-based authentication flows, such as redirecting to the Auth0 Universal Login page.

interface IWebAuthProvider {
    authorize(
        parameters: WebAuthorizeParameters,
        options?: NativeAuthorizeOptions | WebAuthorizeOptions,
    ): Promise<Credentials>;
    handleRedirectCallback(): Promise<void>;
    clearSession(
        parameters?: ClearSessionParameters,
        options?: NativeClearSessionOptions | WebClearSessionOptions,
    ): Promise<void>;
    getWebUser(): Promise<User | null>;
    checkWebSession(): Promise<void>;
    cancelWebAuth(): Promise<void>;
}

Index

Methods

authorize handleRedirectCallback clearSession getWebUser checkWebSession cancelWebAuth

Methods

authorize

authorize(
parameters: WebAuthorizeParameters,
options?: NativeAuthorizeOptions | WebAuthorizeOptions,
): Promise<Credentials>
Initiates the web-based authentication flow.
Parameters
- parameters: WebAuthorizeParameters
  The parameters to send to the /authorize endpoint.
- Optionaloptions: NativeAuthorizeOptions | WebAuthorizeOptions
  Platform-specific options to customize the authentication experience.
Returns Promise<Credentials>
A promise that resolves with the user's credentials upon successful authentication.

Remarks
This method will redirect the user to a browser to log in. The options parameter is generic to allow platform-specific configurations.
- Defined in core/interfaces/IWebAuthProvider.ts:31

handleRedirectCallback

handleRedirectCallback(): Promise<void>
Handles the redirect callback after authentication.

Returns Promise<void>
A promise that resolves when the redirect callback has been processed.

Remarks
Platform specific: This method is only available in the context of a web application.
- Defined in core/interfaces/IWebAuthProvider.ts:43

clearSession

clearSession(
parameters?: ClearSessionParameters,
options?: NativeClearSessionOptions | WebClearSessionOptions,
): Promise<void>
Clears the user's session, including any cookies stored in the browser.
Parameters
- Optionalparameters: ClearSessionParameters
  The parameters to send to the /v2/logout endpoint.
- Optionaloptions: NativeClearSessionOptions | WebClearSessionOptions
  Platform-specific options to customize the logout experience.
Returns Promise<void>
A promise that resolves when the session has been cleared.
- Defined in core/interfaces/IWebAuthProvider.ts:52

getWebUser

getWebUser(): Promise<User | null>
Retrives the authenticated user's profile information.

Returns Promise<User | null>
A promise that resolves with the user's profile information, or null if not authenticated.

Remarks
This method fetches the user's profile from the Auth0 session if available.
- Defined in core/interfaces/IWebAuthProvider.ts:65

checkWebSession

checkWebSession(): Promise<void>
Checks the user's session and updates the local state if the session is still valid.

Returns Promise<void>
- Defined in core/interfaces/IWebAuthProvider.ts:70

cancelWebAuth

cancelWebAuth(): Promise<void>
Cancels an ongoing web authentication transaction.

Returns Promise<void>
A promise that resolves when the operation is complete.

Remarks
Platform specific: This is primarily used on iOS to handle scenarios where the user manually dismisses the login modal. On other platforms, it may be a no-op.
- Defined in core/interfaces/IWebAuthProvider.ts:81