@auth0/auth0-angular
    Preparing search index...

    Interface ObservableMyAccountApiClient

    Observable-based MyAccount API client exposed by AuthService.myAccount.

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

    interface ObservableMyAccountApiClient {
        deleteAuthenticationMethod(id: string): Observable<void>;
        enrollmentChallenge(
            options: EnrollmentChallengeOptions,
        ): Observable<EnrollmentChallengeResponse>;
        enrollmentVerify(
            options: EnrollmentVerifyOptions,
        ): Observable<AuthenticationMethod>;
        getAuthenticationMethod(id: string): Observable<AuthenticationMethod>;
        getAuthenticationMethods(
            type?: AuthenticationMethodType,
        ): Observable<AuthenticationMethod[]>;
        getFactors(): Observable<Factor[]>;
        getUserProfile(options?: GetUserProfileOptions): Observable<UserProfile>;
        updateAuthenticationMethod(
            id: string,
            data: UpdateAuthenticationMethodRequest,
        ): Observable<AuthenticationMethod>;
        updateUserProfile(data: UpdateUserProfileRequest): Observable<UserProfile>;
    }
    Index
    • Returns the current user's profile, including profile_policy with per-field edit permissions. Requires the read:me:profile scope.

      Pass fields to return only those fields, or set includeFields: false to exclude them instead.

      This feature is currently in Beta. It might change before General Availability, and Auth0 does not support beta functionality for production use. The feature must be enabled for your tenant.

      Parameters

      Returns Observable<UserProfile>

    • Updates the current user's profile. Only the fields you send are changed. Returns the full updated profile. Requires the update:me:profile scope. Angular auth state (user$, idTokenClaims$) is not updated automatically — call getAccessTokenSilently({ cacheMode: 'off' }) afterwards to get a new ID token with the updated profile.

      This feature is currently in Beta. It might change before General Availability, and Auth0 does not support beta functionality for production use. The feature must be enabled for your tenant.

      Parameters

      Returns Observable<UserProfile>