1. Registry
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getExperimentFeatureFlag
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi
auth0 logo auth0 logo
Viewing docs for Auth0 v3.56.0
published on Friday, Nov 6, 2026 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    // An Auth0 Experiment Center feature flag loaded using its ID.
    const myFlag = auth0.getExperimentFeatureFlag({
        id: "flg_XXXXXXXXXXXXXXX",
    });
    export const treatmentVariationId = myFlag.then(myFlag => myFlag.variationIds?.treatment);
    
    import pulumi
    import pulumi_auth0 as auth0
    
    # An Auth0 Experiment Center feature flag loaded using its ID.
    my_flag = auth0.get_experiment_feature_flag(id="flg_XXXXXXXXXXXXXXX")
    pulumi.export("treatmentVariationId", my_flag.variation_ids["treatment"])
    
    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 Auth0 Experiment Center feature flag loaded using its ID.
    		myFlag, err := auth0.GetExperimentFeatureFlag(ctx, &auth0.LookupExperimentFeatureFlagArgs{
    			Id: "flg_XXXXXXXXXXXXXXX",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("treatmentVariationId", myFlag.VariationIds.Treatment)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        // An Auth0 Experiment Center feature flag loaded using its ID.
        var myFlag = Auth0.GetExperimentFeatureFlag.Invoke(new()
        {
            Id = "flg_XXXXXXXXXXXXXXX",
        });
    
        return new Dictionary<string, object?>
        {
            ["treatmentVariationId"] = myFlag.Apply(getExperimentFeatureFlagResult => getExperimentFeatureFlagResult.VariationIds?.Treatment),
        };
    });
    
    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.GetExperimentFeatureFlagArgs;
    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 Auth0 Experiment Center feature flag loaded using its ID.
            final var myFlag = Auth0Functions.getExperimentFeatureFlag(GetExperimentFeatureFlagArgs.builder()
                .id("flg_XXXXXXXXXXXXXXX")
                .build());
    
            ctx.export("treatmentVariationId", myFlag.variationIds().treatment());
        }
    }
    
    variables:
      # An Auth0 Experiment Center feature flag loaded using its ID.
      myFlag:
        fn::invoke:
          function: auth0:getExperimentFeatureFlag
          arguments:
            id: flg_XXXXXXXXXXXXXXX
    outputs:
      # The ID of a variation of the feature flag, looked up by its name.
      treatmentVariationId: ${myFlag.variationIds.treatment}
    
    terraform {
      required_providers {
        auth0 = {
          source = "pulumi/auth0"
        }
      }
    }
    
    data "auth0_experiment_feature_flag" "myFlag" {
      id = "flg_XXXXXXXXXXXXXXX"
    }
    
    # An Auth0 Experiment Center feature flag loaded using its ID.
    # The ID of a variation of the feature flag, looked up by its name.
    output "treatmentVariationId" {
      value = data.auth0_experiment_feature_flag.myFlag.variation_ids["treatment"]
    }
    

    Using getExperimentFeatureFlag

    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 getExperimentFeatureFlag(args: GetExperimentFeatureFlagArgs, opts?: InvokeOptions): Promise<GetExperimentFeatureFlagResult>
    function getExperimentFeatureFlagOutput(args: GetExperimentFeatureFlagOutputArgs, opts?: InvokeOutputOptions): Output<GetExperimentFeatureFlagResult>
    def get_experiment_feature_flag(id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetExperimentFeatureFlagResult
    def get_experiment_feature_flag_output(id: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetExperimentFeatureFlagResult]
    func LookupExperimentFeatureFlag(ctx *Context, args *LookupExperimentFeatureFlagArgs, opts ...InvokeOption) (*LookupExperimentFeatureFlagResult, error)
    func LookupExperimentFeatureFlagOutput(ctx *Context, args *LookupExperimentFeatureFlagOutputArgs, opts ...InvokeOption) LookupExperimentFeatureFlagResultOutput

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

    public static class GetExperimentFeatureFlag 
    {
        public static Task<GetExperimentFeatureFlagResult> InvokeAsync(GetExperimentFeatureFlagArgs args, InvokeOptions? opts = null)
        public static Output<GetExperimentFeatureFlagResult> Invoke(GetExperimentFeatureFlagInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetExperimentFeatureFlagResult> Invoke(GetExperimentFeatureFlagInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetExperimentFeatureFlagResult> getExperimentFeatureFlag(GetExperimentFeatureFlagArgs args, InvokeOptions options)
    public static Output<GetExperimentFeatureFlagResult> getExperimentFeatureFlag(GetExperimentFeatureFlagArgs args, InvokeOptions options)
    public static Output<GetExperimentFeatureFlagResult> getExperimentFeatureFlag(GetExperimentFeatureFlagArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: auth0:index/getExperimentFeatureFlag:getExperimentFeatureFlag
      arguments:
        # arguments dictionary
    data "auth0_get_experiment_feature_flag" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The ID of the feature flag.
    Id string
    The ID of the feature flag.
    id string
    The ID of the feature flag.
    id String
    The ID of the feature flag.
    id string
    The ID of the feature flag.
    id str
    The ID of the feature flag.
    id String
    The ID of the feature flag.

    getExperimentFeatureFlag Result

    The following output properties are available:

    CreatedAt string
    The ISO 8601 formatted date the feature flag was created.
    Description string
    Description of the feature flag. Min length 3 when present.
    Id string
    The ID of the feature flag.
    Name string
    The name of the feature flag.
    Parameters List<GetExperimentFeatureFlagParameter>
    The parameters carried by the feature flag.
    Status string
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    Type string
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    UpdatedAt string
    The ISO 8601 formatted date the feature flag was updated.
    VariationIds Dictionary<string, string>
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    Variations List<GetExperimentFeatureFlagVariation>
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    CreatedAt string
    The ISO 8601 formatted date the feature flag was created.
    Description string
    Description of the feature flag. Min length 3 when present.
    Id string
    The ID of the feature flag.
    Name string
    The name of the feature flag.
    Parameters []GetExperimentFeatureFlagParameter
    The parameters carried by the feature flag.
    Status string
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    Type string
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    UpdatedAt string
    The ISO 8601 formatted date the feature flag was updated.
    VariationIds map[string]string
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    Variations []GetExperimentFeatureFlagVariation
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    created_at string
    The ISO 8601 formatted date the feature flag was created.
    description string
    Description of the feature flag. Min length 3 when present.
    id string
    The ID of the feature flag.
    name string
    The name of the feature flag.
    parameters list(object)
    The parameters carried by the feature flag.
    status string
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    type string
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    updated_at string
    The ISO 8601 formatted date the feature flag was updated.
    variation_ids map(string)
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    variations list(object)
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    createdAt String
    The ISO 8601 formatted date the feature flag was created.
    description String
    Description of the feature flag. Min length 3 when present.
    id String
    The ID of the feature flag.
    name String
    The name of the feature flag.
    parameters List<GetExperimentFeatureFlagParameter>
    The parameters carried by the feature flag.
    status String
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    type String
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    updatedAt String
    The ISO 8601 formatted date the feature flag was updated.
    variationIds Map<String,String>
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    variations List<GetExperimentFeatureFlagVariation>
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    createdAt string
    The ISO 8601 formatted date the feature flag was created.
    description string
    Description of the feature flag. Min length 3 when present.
    id string
    The ID of the feature flag.
    name string
    The name of the feature flag.
    parameters GetExperimentFeatureFlagParameter[]
    The parameters carried by the feature flag.
    status string
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    type string
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    updatedAt string
    The ISO 8601 formatted date the feature flag was updated.
    variationIds {[key: string]: string}
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    variations GetExperimentFeatureFlagVariation[]
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    created_at str
    The ISO 8601 formatted date the feature flag was created.
    description str
    Description of the feature flag. Min length 3 when present.
    id str
    The ID of the feature flag.
    name str
    The name of the feature flag.
    parameters Sequence[GetExperimentFeatureFlagParameter]
    The parameters carried by the feature flag.
    status str
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    type str
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    updated_at str
    The ISO 8601 formatted date the feature flag was updated.
    variation_ids Mapping[str, str]
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    variations Sequence[GetExperimentFeatureFlagVariation]
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.
    createdAt String
    The ISO 8601 formatted date the feature flag was created.
    description String
    Description of the feature flag. Min length 3 when present.
    id String
    The ID of the feature flag.
    name String
    The name of the feature flag.
    parameters List<Property Map>
    The parameters carried by the feature flag.
    status String
    The lifecycle status of the feature flag. One of draft, active, archived. Defaults to draft when omitted on creation.
    type String
    The type of the feature flag: self for user-created flags or auth0 for built-in flags.
    updatedAt String
    The ISO 8601 formatted date the feature flag was updated.
    variationIds Map<String>
    A map of variation names to variation IDs. Use it to reference a variation by ID, for example in an experiment allocation, because the variations blocks do not include IDs. An ID stays the same when you change the description or overrides of a variation. A variation gets a new ID when you rename it, remove and add it again, or when the feature flag is replaced.
    variations List<Property Map>
    The variations of the feature flag. Each variation overrides parameter values of the feature flag.

    Supporting Types

    GetExperimentFeatureFlagParameter

    Description string
    Description of the parameter.
    Name string
    The key of the parameter.
    Type string
    The value type of the parameter. One of boolean, string, number, array, object
    Value string
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    Description string
    Description of the parameter.
    Name string
    The key of the parameter.
    Type string
    The value type of the parameter. One of boolean, string, number, array, object
    Value string
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    description string
    Description of the parameter.
    name string
    The key of the parameter.
    type string
    The value type of the parameter. One of boolean, string, number, array, object
    value string
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    description String
    Description of the parameter.
    name String
    The key of the parameter.
    type String
    The value type of the parameter. One of boolean, string, number, array, object
    value String
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    description string
    Description of the parameter.
    name string
    The key of the parameter.
    type string
    The value type of the parameter. One of boolean, string, number, array, object
    value string
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    description str
    Description of the parameter.
    name str
    The key of the parameter.
    type str
    The value type of the parameter. One of boolean, string, number, array, object
    value str
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.
    description String
    Description of the parameter.
    name String
    The key of the parameter.
    type String
    The value type of the parameter. One of boolean, string, number, array, object
    value String
    The default value of the parameter, as a string. For type = "object" or type = "array" supply a JSON-encoded string; for boolean/number supply the literal value as a string.

    GetExperimentFeatureFlagVariation

    Description string
    Description of the variation. Must contain 3 to 1024 characters when set.
    Name string
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    Overrides List<GetExperimentFeatureFlagVariationOverride>
    Parameter overrides for the variation. Omit for a control variation.
    Description string
    Description of the variation. Must contain 3 to 1024 characters when set.
    Name string
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    Overrides []GetExperimentFeatureFlagVariationOverride
    Parameter overrides for the variation. Omit for a control variation.
    description string
    Description of the variation. Must contain 3 to 1024 characters when set.
    name string
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    overrides list(object)
    Parameter overrides for the variation. Omit for a control variation.
    description String
    Description of the variation. Must contain 3 to 1024 characters when set.
    name String
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    overrides List<GetExperimentFeatureFlagVariationOverride>
    Parameter overrides for the variation. Omit for a control variation.
    description string
    Description of the variation. Must contain 3 to 1024 characters when set.
    name string
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    overrides GetExperimentFeatureFlagVariationOverride[]
    Parameter overrides for the variation. Omit for a control variation.
    description str
    Description of the variation. Must contain 3 to 1024 characters when set.
    name str
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    overrides Sequence[GetExperimentFeatureFlagVariationOverride]
    Parameter overrides for the variation. Omit for a control variation.
    description String
    Description of the variation. Must contain 3 to 1024 characters when set.
    name String
    The name of the variation. Must be unique within the feature flag and contain 3 to 255 characters without surrounding whitespace. Changing the name deletes the variation and creates a new one with a new ID.
    overrides List<Property Map>
    Parameter overrides for the variation. Omit for a control variation.

    GetExperimentFeatureFlagVariationOverride

    Name string
    The name of a parameter on the feature flag. Each name can appear once.
    Type string
    The type of the parameter value. One of boolean, string, number, array, object.
    Value string
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    Name string
    The name of a parameter on the feature flag. Each name can appear once.
    Type string
    The type of the parameter value. One of boolean, string, number, array, object.
    Value string
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    name string
    The name of a parameter on the feature flag. Each name can appear once.
    type string
    The type of the parameter value. One of boolean, string, number, array, object.
    value string
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    name String
    The name of a parameter on the feature flag. Each name can appear once.
    type String
    The type of the parameter value. One of boolean, string, number, array, object.
    value String
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    name string
    The name of a parameter on the feature flag. Each name can appear once.
    type string
    The type of the parameter value. One of boolean, string, number, array, object.
    value string
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    name str
    The name of a parameter on the feature flag. Each name can appear once.
    type str
    The type of the parameter value. One of boolean, string, number, array, object.
    value str
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.
    name String
    The name of a parameter on the feature flag. Each name can appear once.
    type String
    The type of the parameter value. One of boolean, string, number, array, object.
    value String
    The override value as a string. For object and array values, provide JSON; for boolean and number values, provide their literal text.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial