@auth0/auth0-acul-react - v1.11.0
    Preparing search index...

    Interface PendingConsentMembers

    Interface describing the members of the Pending Consent screen.

    This screen is a waiting room shown during Rich Authorization Requests (RAR) flows when no customized-consent prompt is configured. The user approves or denies the request off-browser through the My Account experience while this screen polls for the outcome.

    interface PendingConsentMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        screen: ScreenMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        continue(payload?: CustomOptions): Promise<void>;
        pollingManager(options: MfaPollingOptions): MfaPushPollingControl;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding: BrandingMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    transaction: TransactionMembers
    untrustedData: UntrustedDataMembers

    Methods

    • Returns Error[]

    • Continues the flow once the pending consent has been resolved off-browser.

      Posts the transaction state with no action. Auth0 reads the approve/deny outcome from the consent status, not from the request body. If the consent is still pending, Auth0 renders this screen again instead of redirecting.

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      Returns Promise<void>

    • Polls the pending-consent status until the consent is resolved off-browser.

      onCompleted fires when the consent has been approved or denied. Call continue() from it to advance the flow.

      Parameters

      Returns MfaPushPollingControl

      An object to control the polling process.