Auth0 Node.js SDK - v7.6.0
    Preparing search index...

    Interface UpdateExperimentRequestParameters

    {}
    interface UpdateExperimentRequestParameters {
        name?: string;
        description?: string | null;
        authentication_flow?: Management.AuthenticationFlowEnum;
        allocations?: AllocationRequestItem[];
        default_config?: Management.DefaultConfigEnum;
        levels?: number[];
        status?: Management.ExperimentTransitionStatusEnum;
    }
    Index
    name? description? authentication_flow? allocations? default_config? levels? status?
    name?: string

    A human-readable name for the experiment

    description?: string | null

    A description of the experiment

    authentication_flow?: Management.AuthenticationFlowEnum

    Specifies the target authentication flow for this experiment. This field can only be modified on draft experiments. Must be one of: authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, or all. Note that the all value targets every flow at once, but requires that this is the only active experiment.

    allocations?: AllocationRequestItem[]

    Replaces all traffic allocations. Cannot be modified while the experiment is active.

    default_config?: Management.DefaultConfigEnum

    Applies only to Auth0-managed flags. Controls where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config, 'flag' uses the flag's frozen defaults. Can only be modified on draft experiments. Rejected for customer-defined flags.

    levels?: number[]

    Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100]. Can only be modified on draft experiments.

    status?: Management.ExperimentTransitionStatusEnum

    Settings
    Member Visibility

    On This Page
    Properties