Interface Auth0ContextInterface<TUser>

interface Auth0ContextInterface<TUser> {
    authorize: ((parameters?, options?) => Promise<undefined | Credentials>);
    authorizeWithEmail: ((parameters) => Promise<undefined | Credentials>);
    authorizeWithOOB: ((parameters) => Promise<undefined | Credentials>);
    authorizeWithOTP: ((parameters) => Promise<undefined | Credentials>);
    authorizeWithRecoveryCode: ((parameters) => Promise<undefined | Credentials>);
    authorizeWithSMS: ((parameters) => Promise<undefined | Credentials>);
    clearCredentials: (() => Promise<void>);
    clearSession: ((parameters?, options?) => Promise<void>);
    error: null | Error;
    getCredentials: ((scope?, minTtl?, parameters?, forceRefresh?) => Promise<undefined | Credentials>);
    hasValidCredentials: ((minTtl?) => Promise<boolean>);
    isLoading: boolean;
    sendEmailCode: ((parameters) => Promise<void>);
    sendMultifactorChallenge: ((parameters) => Promise<void>);
    sendSMSCode: ((parameters) => Promise<void>);
    user: null | TUser;
}

Type Parameters

Hierarchy (view full)

Properties

authorize authorizeWithEmail authorizeWithOOB authorizeWithOTP authorizeWithRecoveryCode authorizeWithSMS clearCredentials clearSession error getCredentials hasValidCredentials isLoading sendEmailCode sendMultifactorChallenge sendSMSCode user

Properties

authorize

authorize: ((parameters?, options?) => Promise<undefined | Credentials>)

Authorize the user using Auth0 Universal Login. See WebAuth#authorize

Type declaration

    • (parameters?, options?): Promise<undefined | Credentials>

    • Parameters

      • Optional parameters: WebAuthorizeParameters

        The parameters that are sent to the /authorize endpoint.

      • Optional options: WebAuthorizeOptions

        Options for customizing the SDK's handling of the authorize call

      Returns Promise<undefined | Credentials>

authorizeWithEmail

authorizeWithEmail: ((parameters) => Promise<undefined | Credentials>)

Authorize the user using an email code. See Auth#loginWithEmail

Type declaration

authorizeWithOOB

authorizeWithOOB: ((parameters) => Promise<undefined | Credentials>)

Authorize the user using an Out Of Band authentication code. See Auth#loginWithOOB

Type declaration

authorizeWithOTP

authorizeWithOTP: ((parameters) => Promise<undefined | Credentials>)

Autohrize the user using a One Time Password code. See Auth#loginWithOTP.

Type declaration

authorizeWithRecoveryCode

authorizeWithRecoveryCode: ((parameters) => Promise<undefined | Credentials>)

Authorize the user using a multi-factor authentication Recovery Code. See Auth#loginWithRecoveryCode

Type declaration

authorizeWithSMS

authorizeWithSMS: ((parameters) => Promise<undefined | Credentials>)

Authorize the user using a SMS code. See Auth#loginWithSMS

Type declaration

clearCredentials

clearCredentials: (() => Promise<void>)

Clears the user's credentials without clearing their web session and logs them out.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

clearSession

clearSession: ((parameters?, options?) => Promise<void>)

Clears the user's web session, credentials and logs them out. See WebAuth#clearSession

Type declaration

    • (parameters?, options?): Promise<void>

    • Parameters

      Returns Promise<void>

error

error: null | Error

An object representing the last exception

getCredentials

getCredentials: ((scope?, minTtl?, parameters?, forceRefresh?) => Promise<undefined | Credentials>)

Gets the user's credentials from the native credential store. If credentials have expired, they are automatically refreshed by default. See CredentialsManager#getCredentials

Type declaration

    • (scope?, minTtl?, parameters?, forceRefresh?): Promise<undefined | Credentials>

    • Parameters

      • Optional scope: string

        The scopes used to get the credentials

      • Optional minTtl: number

        The minimum time in seconds that the access token should last before expiration

      • Optional parameters: Record<string, unknown>

        Any additional parameters to send in the request to refresh expired credentials.

      • Optional forceRefresh: boolean

        If true, credentials are always refreshed regardless of their expiry, provided a valid refresh token is available.

      Returns Promise<undefined | Credentials>

Returns

hasValidCredentials

hasValidCredentials: ((minTtl?) => Promise<boolean>)

Whether the SDK currently holds valid, unexpired credentials.

Type declaration

    • (minTtl?): Promise<boolean>

    • Parameters

      • Optional minTtl: number

        The minimum time in seconds that the access token should last before expiration

      Returns Promise<boolean>

Returns

true if there are valid credentials. Otherwise, false.

isLoading

isLoading: boolean

A flag that is true until the state knows that a user is either logged in or not

sendEmailCode

sendEmailCode: ((parameters) => Promise<void>)

Start the passwordless email login flow. See Auth#passwordlessWithEmail

Type declaration

sendMultifactorChallenge

sendMultifactorChallenge: ((parameters) => Promise<void>)

Send a challenge for multi-factor authentication. See Auth#multifactorChallenge

Type declaration

sendSMSCode

sendSMSCode: ((parameters) => Promise<void>)

Start the passwordless SMS login flow. See Auth#passwordlessWithSMS

Type declaration

user

user: null | TUser

The user profile as decoded from the ID token after authentication

Settings

Member Visibility

Theme

On This Page

authorize authorizeWithEmail authorizeWithOOB authorizeWithOTP authorizeWithRecoveryCode authorizeWithSMS clearCredentials clearSession error getCredentials hasValidCredentials isLoading sendEmailCode sendMultifactorChallenge sendSMSCode user