Class UpdateExperimentRequestParameters

Namespace

Auth0.ManagementApi.Experimentation

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record UpdateExperimentRequestParameters : IEquatable<UpdateExperimentRequestParameters>

Inheritance

object

UpdateExperimentRequestParameters

Implements

IEquatable<UpdateExperimentRequestParameters>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

Allocations

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

[JsonPropertyName("allocations")]
public IEnumerable<AllocationRequestItem>? Allocations { get; set; }

Property Value

IEnumerable<AllocationRequestItem>

AuthenticationFlow

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.

[JsonPropertyName("authentication_flow")]
public AuthenticationFlowEnum? AuthenticationFlow { get; set; }

Property Value

AuthenticationFlowEnum?

DefaultConfig

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.

[JsonPropertyName("default_config")]
public DefaultConfigEnum? DefaultConfig { get; set; }

Property Value

DefaultConfigEnum?

Description

A description of the experiment

[JsonPropertyName("description")]
public Optional<string?> Description { get; set; }

Property Value

Optional<string>

Levels

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

[JsonPropertyName("levels")]
public IEnumerable<int>? Levels { get; set; }

Property Value

IEnumerable<int>

Name

A human-readable name for the experiment

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

Status

[JsonPropertyName("status")]
public ExperimentTransitionStatusEnum? Status { get; set; }

Property Value

ExperimentTransitionStatusEnum?

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.