Interface ObservableMfaApiClient

Observable-based MFA API client exposed by AuthService.mfa.

This is the Angular counterpart of MfaApiClient from @auth0/auth0-spa-js. All methods return Observable instead of Promise.

interface ObservableMfaApiClient {
    challenge(
        params: ChallengeAuthenticatorParams,
    ): Observable<ChallengeResponse>;
    enroll(params: EnrollParams): Observable<EnrollmentResponse>;
    getAuthenticators(mfaToken: string): Observable<Authenticator[]>;
    getEnrollmentFactors(mfaToken: string): Observable<EnrollmentFactor[]>;
    verify(params: VerifyParams): Observable<TokenEndpointResponse>;
}

Index

Methods

challenge enroll getAuthenticators getEnrollmentFactors verify

Methods

challenge

challenge(params: ChallengeAuthenticatorParams): Observable<ChallengeResponse>
Initiates an MFA challenge, sending an OOB code via SMS, email, or push, or preparing for OTP entry. Required for all factor types except OTP, where it is optional.
Parameters
- params: ChallengeAuthenticatorParams
Returns Observable<ChallengeResponse>

Throws
- Defined in projects/auth0-angular/src/lib/interfaces.ts:48

enroll

enroll(params: EnrollParams): Observable<EnrollmentResponse>
Enrolls a new MFA authenticator (OTP, SMS, Voice, Email, or Push).
Parameters
- params: EnrollParams
Returns Observable<EnrollmentResponse>

Throws
- Defined in projects/auth0-angular/src/lib/interfaces.ts:40

getAuthenticators

getAuthenticators(mfaToken: string): Observable<Authenticator[]>
Returns the list of enrolled MFA authenticators for the current user, filtered by the challenge types stored in the MFA context.
Parameters
- mfaToken: string
Returns Observable<Authenticator[]>

Throws
- Defined in projects/auth0-angular/src/lib/interfaces.ts:34

getEnrollmentFactors

getEnrollmentFactors(mfaToken: string): Observable<EnrollmentFactor[]>
Returns the available enrollment factors from the stored MFA context. A non-empty result means the user must enroll before they can authenticate.
Parameters
- mfaToken: string
Returns Observable<EnrollmentFactor[]>

Throws
- Defined in projects/auth0-angular/src/lib/interfaces.ts:57

verify

verify(params: VerifyParams): Observable<TokenEndpointResponse>
Verifies an MFA challenge and returns raw tokens. The grant type is inferred automatically from the provided field: otp, oobCode, or recoveryCode. Angular auth state (isAuthenticated$, user$) is not updated automatically — call getAccessTokenSilently() afterwards to reflect the new session.
Parameters
- params: VerifyParams
Returns Observable<TokenEndpointResponse>

Throws
- Defined in projects/auth0-angular/src/lib/interfaces.ts:66

Settings

Member Visibility

Theme