Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getExperiment
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

auth0.getExperiment

auth0 logo auth0 logo
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

    Data source to retrieve a specific Experiment Center experiment by id. (EA only)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

// An existing Experiment Center experiment loaded using its ID.
const loginUiTest = auth0.getExperiment({
    id: "exp_XXXXXXXXXXXXXXX",
});

    import pulumi
import pulumi_auth0 as auth0

# An existing Experiment Center experiment loaded using its ID.
login_ui_test = auth0.get_experiment(id="exp_XXXXXXXXXXXXXXX")

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// An existing Experiment Center experiment loaded using its ID.
		_, err := auth0.GetExperiment(ctx, &auth0.LookupExperimentArgs{
			Id: "exp_XXXXXXXXXXXXXXX",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    // An existing Experiment Center experiment loaded using its ID.
    var loginUiTest = Auth0.GetExperiment.Invoke(new()
    {
        Id = "exp_XXXXXXXXXXXXXXX",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Auth0Functions;
import com.pulumi.auth0.inputs.GetExperimentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // An existing Experiment Center experiment loaded using its ID.
        final var loginUiTest = Auth0Functions.getExperiment(GetExperimentArgs.builder()
            .id("exp_XXXXXXXXXXXXXXX")
            .build());

    }
}

    variables:
  # An existing Experiment Center experiment loaded using its ID.
  loginUiTest:
    fn::invoke:
      function: auth0:getExperiment
      arguments:
        id: exp_XXXXXXXXXXXXXXX

    terraform {
  required_providers {
    auth0 = {
      source = "pulumi/auth0"
    }
  }
}

data "auth0_experiment" "loginUiTest" {
  id = "exp_XXXXXXXXXXXXXXX"
}

# An existing Experiment Center experiment loaded using its ID.

    Using getExperiment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getExperiment(args: GetExperimentArgs, opts?: InvokeOptions): Promise<GetExperimentResult>
function getExperimentOutput(args: GetExperimentOutputArgs, opts?: InvokeOutputOptions): Output<GetExperimentResult>
    def get_experiment(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetExperimentResult
def get_experiment_output(id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetExperimentResult]
    func LookupExperiment(ctx *Context, args *LookupExperimentArgs, opts ...InvokeOption) (*LookupExperimentResult, error)
func LookupExperimentOutput(ctx *Context, args *LookupExperimentOutputArgs, opts ...InvokeOption) LookupExperimentResultOutput

    > Note: This function is named LookupExperiment in the Go SDK.

    public static class GetExperiment 
{
    public static Task<GetExperimentResult> InvokeAsync(GetExperimentArgs args, InvokeOptions? opts = null)
    public static Output<GetExperimentResult> Invoke(GetExperimentInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetExperimentResult> Invoke(GetExperimentInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
public static Output<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
public static Output<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: auth0:index/getExperiment:getExperiment
  arguments:
    # arguments dictionary
    data "auth0_get_experiment" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The ID of the experiment.
    Id string
    The ID of the experiment.
    id string
    The ID of the experiment.
    id String
    The ID of the experiment.
    id string
    The ID of the experiment.
    id str
    The ID of the experiment.
    id String
    The ID of the experiment.

    getExperiment Result

    The following output properties are available:

    AllocationStrategy string
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    Allocations List<GetExperimentAllocation>
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    AuthenticationFlow string
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    CreatedAt string
    The ISO 8601 formatted date the experiment was created.
    CurrentLevel int
    The current ramp level, if levels are configured.
    DefaultConfig string
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    Description string
    Description of the experiment.
    EditableFields List<string>
    Fields that the API reports as editable.
    EndedAt string
    The ISO 8601 formatted date the experiment was completed.
    FeatureFlagId string
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    FeatureFlagName string
    The name of the feature flag evaluated by this experiment.
    FeatureFlagSnapshot string
    The snapshot of the feature flag.
    Id string
    The ID of the experiment.
    IsValid bool
    Whether the experiment is ready to activate.
    Levels List<int>
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    Name string
    The name of the experiment.
    StartedAt string
    The ISO 8601 formatted date the experiment was first activated.
    Status string
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    UpdatedAt string
    The ISO 8601 formatted date the experiment was updated.
    AllocationStrategy string
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    Allocations []GetExperimentAllocation
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    AuthenticationFlow string
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    CreatedAt string
    The ISO 8601 formatted date the experiment was created.
    CurrentLevel int
    The current ramp level, if levels are configured.
    DefaultConfig string
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    Description string
    Description of the experiment.
    EditableFields []string
    Fields that the API reports as editable.
    EndedAt string
    The ISO 8601 formatted date the experiment was completed.
    FeatureFlagId string
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    FeatureFlagName string
    The name of the feature flag evaluated by this experiment.
    FeatureFlagSnapshot string
    The snapshot of the feature flag.
    Id string
    The ID of the experiment.
    IsValid bool
    Whether the experiment is ready to activate.
    Levels []int
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    Name string
    The name of the experiment.
    StartedAt string
    The ISO 8601 formatted date the experiment was first activated.
    Status string
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    UpdatedAt string
    The ISO 8601 formatted date the experiment was updated.
    allocation_strategy string
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    allocations list(object)
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    authentication_flow string
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    created_at string
    The ISO 8601 formatted date the experiment was created.
    current_level number
    The current ramp level, if levels are configured.
    default_config string
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    description string
    Description of the experiment.
    editable_fields list(string)
    Fields that the API reports as editable.
    ended_at string
    The ISO 8601 formatted date the experiment was completed.
    feature_flag_id string
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    feature_flag_name string
    The name of the feature flag evaluated by this experiment.
    feature_flag_snapshot string
    The snapshot of the feature flag.
    id string
    The ID of the experiment.
    is_valid bool
    Whether the experiment is ready to activate.
    levels list(number)
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    name string
    The name of the experiment.
    started_at string
    The ISO 8601 formatted date the experiment was first activated.
    status string
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    updated_at string
    The ISO 8601 formatted date the experiment was updated.
    allocationStrategy String
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    allocations List<GetExperimentAllocation>
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    authenticationFlow String
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    createdAt String
    The ISO 8601 formatted date the experiment was created.
    currentLevel Integer
    The current ramp level, if levels are configured.
    defaultConfig String
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    description String
    Description of the experiment.
    editableFields List<String>
    Fields that the API reports as editable.
    endedAt String
    The ISO 8601 formatted date the experiment was completed.
    featureFlagId String
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    featureFlagName String
    The name of the feature flag evaluated by this experiment.
    featureFlagSnapshot String
    The snapshot of the feature flag.
    id String
    The ID of the experiment.
    isValid Boolean
    Whether the experiment is ready to activate.
    levels List<Integer>
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    name String
    The name of the experiment.
    startedAt String
    The ISO 8601 formatted date the experiment was first activated.
    status String
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    updatedAt String
    The ISO 8601 formatted date the experiment was updated.
    allocationStrategy string
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    allocations GetExperimentAllocation[]
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    authenticationFlow string
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    createdAt string
    The ISO 8601 formatted date the experiment was created.
    currentLevel number
    The current ramp level, if levels are configured.
    defaultConfig string
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    description string
    Description of the experiment.
    editableFields string[]
    Fields that the API reports as editable.
    endedAt string
    The ISO 8601 formatted date the experiment was completed.
    featureFlagId string
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    featureFlagName string
    The name of the feature flag evaluated by this experiment.
    featureFlagSnapshot string
    The snapshot of the feature flag.
    id string
    The ID of the experiment.
    isValid boolean
    Whether the experiment is ready to activate.
    levels number[]
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    name string
    The name of the experiment.
    startedAt string
    The ISO 8601 formatted date the experiment was first activated.
    status string
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    updatedAt string
    The ISO 8601 formatted date the experiment was updated.
    allocation_strategy str
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    allocations Sequence[GetExperimentAllocation]
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    authentication_flow str
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    created_at str
    The ISO 8601 formatted date the experiment was created.
    current_level int
    The current ramp level, if levels are configured.
    default_config str
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    description str
    Description of the experiment.
    editable_fields Sequence[str]
    Fields that the API reports as editable.
    ended_at str
    The ISO 8601 formatted date the experiment was completed.
    feature_flag_id str
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    feature_flag_name str
    The name of the feature flag evaluated by this experiment.
    feature_flag_snapshot str
    The snapshot of the feature flag.
    id str
    The ID of the experiment.
    is_valid bool
    Whether the experiment is ready to activate.
    levels Sequence[int]
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    name str
    The name of the experiment.
    started_at str
    The ISO 8601 formatted date the experiment was first activated.
    status str
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    updated_at str
    The ISO 8601 formatted date the experiment was updated.
    allocationStrategy String
    The traffic allocation strategy. One of percentage, segment. Changing this replaces the experiment.
    allocations List<Property Map>
    The ordered traffic allocations. At least one is required when configured. Removing all allocations replaces the experiment.
    authenticationFlow String
    The authentication flow targeted by the experiment. One of authentication, mfaenrollment, mfachallenge, passwordreset, passkeyenrollment, all.
    createdAt String
    The ISO 8601 formatted date the experiment was created.
    currentLevel Number
    The current ramp level, if levels are configured.
    defaultConfig String
    The configuration source for an Auth0-managed feature flag. One of tenant, flag. Removing it replaces the experiment.
    description String
    Description of the experiment.
    editableFields List<String>
    Fields that the API reports as editable.
    endedAt String
    The ISO 8601 formatted date the experiment was completed.
    featureFlagId String
    The ID of the feature flag evaluated by this experiment. Changing this replaces the experiment.
    featureFlagName String
    The name of the feature flag evaluated by this experiment.
    featureFlagSnapshot String
    The snapshot of the feature flag.
    id String
    The ID of the experiment.
    isValid Boolean
    Whether the experiment is ready to activate.
    levels List<Number>
    The ordered ramp levels. Only for the percentage strategy. Removing them replaces the experiment.
    name String
    The name of the experiment.
    startedAt String
    The ISO 8601 formatted date the experiment was first activated.
    status String
    The lifecycle status of the experiment. One of draft, active, paused, completed, archived. A non-draft status on creation is applied internally after the experiment is created as a draft. If the status update fails, Terraform marks the entire resource tainted and plans to replace it on the next apply. An active experiment cannot be deleted.
    updatedAt String
    The ISO 8601 formatted date the experiment was updated.

    Supporting Types

    GetExperimentAllocation

    IsControl bool
    Whether this allocation is the control variation. At most one allocation can be the control.
    IsFallback bool
    Whether this allocation is the fallback. Only for the segment strategy.
    Priority int
    The evaluation priority of this allocation. Only for the segment strategy.
    SegmentId string
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    SegmentName string
    The name of the targeted segment.
    SegmentSnapshot string
    The snapshot of the segment.
    VariationId string
    The ID of the feature flag variation assigned to this allocation.
    VariationName string
    The name of the assigned variation.
    VariationSnapshot string
    The snapshot of the variation.
    Weight int
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    IsControl bool
    Whether this allocation is the control variation. At most one allocation can be the control.
    IsFallback bool
    Whether this allocation is the fallback. Only for the segment strategy.
    Priority int
    The evaluation priority of this allocation. Only for the segment strategy.
    SegmentId string
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    SegmentName string
    The name of the targeted segment.
    SegmentSnapshot string
    The snapshot of the segment.
    VariationId string
    The ID of the feature flag variation assigned to this allocation.
    VariationName string
    The name of the assigned variation.
    VariationSnapshot string
    The snapshot of the variation.
    Weight int
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    is_control bool
    Whether this allocation is the control variation. At most one allocation can be the control.
    is_fallback bool
    Whether this allocation is the fallback. Only for the segment strategy.
    priority number
    The evaluation priority of this allocation. Only for the segment strategy.
    segment_id string
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    segment_name string
    The name of the targeted segment.
    segment_snapshot string
    The snapshot of the segment.
    variation_id string
    The ID of the feature flag variation assigned to this allocation.
    variation_name string
    The name of the assigned variation.
    variation_snapshot string
    The snapshot of the variation.
    weight number
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    isControl Boolean
    Whether this allocation is the control variation. At most one allocation can be the control.
    isFallback Boolean
    Whether this allocation is the fallback. Only for the segment strategy.
    priority Integer
    The evaluation priority of this allocation. Only for the segment strategy.
    segmentId String
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    segmentName String
    The name of the targeted segment.
    segmentSnapshot String
    The snapshot of the segment.
    variationId String
    The ID of the feature flag variation assigned to this allocation.
    variationName String
    The name of the assigned variation.
    variationSnapshot String
    The snapshot of the variation.
    weight Integer
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    isControl boolean
    Whether this allocation is the control variation. At most one allocation can be the control.
    isFallback boolean
    Whether this allocation is the fallback. Only for the segment strategy.
    priority number
    The evaluation priority of this allocation. Only for the segment strategy.
    segmentId string
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    segmentName string
    The name of the targeted segment.
    segmentSnapshot string
    The snapshot of the segment.
    variationId string
    The ID of the feature flag variation assigned to this allocation.
    variationName string
    The name of the assigned variation.
    variationSnapshot string
    The snapshot of the variation.
    weight number
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    is_control bool
    Whether this allocation is the control variation. At most one allocation can be the control.
    is_fallback bool
    Whether this allocation is the fallback. Only for the segment strategy.
    priority int
    The evaluation priority of this allocation. Only for the segment strategy.
    segment_id str
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    segment_name str
    The name of the targeted segment.
    segment_snapshot str
    The snapshot of the segment.
    variation_id str
    The ID of the feature flag variation assigned to this allocation.
    variation_name str
    The name of the assigned variation.
    variation_snapshot str
    The snapshot of the variation.
    weight int
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.
    isControl Boolean
    Whether this allocation is the control variation. At most one allocation can be the control.
    isFallback Boolean
    Whether this allocation is the fallback. Only for the segment strategy.
    priority Number
    The evaluation priority of this allocation. Only for the segment strategy.
    segmentId String
    The segment targeted by this allocation. Only for the segment strategy. Omit for the fallback allocation.
    segmentName String
    The name of the targeted segment.
    segmentSnapshot String
    The snapshot of the segment.
    variationId String
    The ID of the feature flag variation assigned to this allocation.
    variationName String
    The name of the assigned variation.
    variationSnapshot String
    The snapshot of the variation.
    weight Number
    The percentage weight of this allocation. Only for the percentage strategy. Omit when using levels.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo auth0 logo
    Viewing docs for Auth0 v3.56.0
    published on Friday, Nov 6, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-auth0

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial