1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. List
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a single list of allowed or denied values in a Descope project. A list holds either plain text values, IP addresses and CIDR ranges, or an arbitrary JSON object, and can be referenced from flows.

    Create List Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new List(name: string, args: ListArgs, opts?: CustomResourceOptions);
    @overload
    def List(resource_name: str,
             args: ListArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def List(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             project_id: Optional[str] = None,
             description: Optional[str] = None,
             ips: Optional[Sequence[str]] = None,
             json: Optional[str] = None,
             name: Optional[str] = None,
             texts: Optional[Sequence[str]] = None)
    func NewList(ctx *Context, name string, args ListArgs, opts ...ResourceOption) (*List, error)
    public List(string name, ListArgs args, CustomResourceOptions? opts = null)
    public List(String name, ListArgs args)
    public List(String name, ListArgs args, CustomResourceOptions options)
    
    type: descope:List
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_list" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ListArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var listResource = new Descope.List("listResource", new()
    {
        ProjectId = "string",
        Description = "string",
        Ips = new[]
        {
            "string",
        },
        Json = "string",
        Name = "string",
        Texts = new[]
        {
            "string",
        },
    });
    
    example, err := descope.NewList(ctx, "listResource", &descope.ListArgs{
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Ips: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Json: pulumi.String("string"),
    	Name: pulumi.String("string"),
    	Texts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "descope_list" "listResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id  = "string"
      description = "string"
      ips         = ["string"]
      json        = "string"
      name        = "string"
      texts       = ["string"]
    }
    
    var listResource = new List("listResource", ListArgs.builder()
        .projectId("string")
        .description("string")
        .ips("string")
        .json("string")
        .name("string")
        .texts("string")
        .build());
    
    list_resource = descope.List("listResource",
        project_id="string",
        description="string",
        ips=["string"],
        json="string",
        name="string",
        texts=["string"])
    
    const listResource = new descope.List("listResource", {
        projectId: "string",
        description: "string",
        ips: ["string"],
        json: "string",
        name: "string",
        texts: ["string"],
    });
    
    type: descope:List
    properties:
        description: string
        ips:
            - string
        json: string
        name: string
        projectId: string
        texts:
            - string
    

    List Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The List resource accepts the following input properties:

    ProjectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    Description string
    An optional description for the list. Defaults to an empty string if not provided.
    Ips List<string>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    Json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    Name string
    The name of the list. Maximum length is 100 characters.
    Texts List<string>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    ProjectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    Description string
    An optional description for the list. Defaults to an empty string if not provided.
    Ips []string
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    Json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    Name string
    The name of the list. Maximum length is 100 characters.
    Texts []string
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    project_id string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the list. Defaults to an empty string if not provided.
    ips list(string)
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name string
    The name of the list. Maximum length is 100 characters.
    texts list(string)
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    projectId String
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the list. Defaults to an empty string if not provided.
    ips List<String>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json String
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name String
    The name of the list. Maximum length is 100 characters.
    texts List<String>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    projectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the list. Defaults to an empty string if not provided.
    ips string[]
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name string
    The name of the list. Maximum length is 100 characters.
    texts string[]
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    project_id str
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    description str
    An optional description for the list. Defaults to an empty string if not provided.
    ips Sequence[str]
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json str
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name str
    The name of the list. Maximum length is 100 characters.
    texts Sequence[str]
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    projectId String
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the list. Defaults to an empty string if not provided.
    ips List<String>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json String
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name String
    The name of the list. Maximum length is 100 characters.
    texts List<String>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the List resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing List Resource

    Get an existing List resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ListState, opts?: CustomResourceOptions): List
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            ips: Optional[Sequence[str]] = None,
            json: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            texts: Optional[Sequence[str]] = None) -> List
    func GetList(ctx *Context, name string, id IDInput, state *ListState, opts ...ResourceOption) (*List, error)
    public static List Get(string name, Input<string> id, ListState? state, CustomResourceOptions? opts = null)
    public static List get(String name, Output<String> id, ListState state, CustomResourceOptions options)
    resources:  existingList:    type: descope:List    get:      id: ${id}
    import {
      to = descope_list.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state ListState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ListState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state ListState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state ListState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    Description string
    An optional description for the list. Defaults to an empty string if not provided.
    Ips List<string>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    Json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    Name string
    The name of the list. Maximum length is 100 characters.
    ProjectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    Texts List<string>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    Description string
    An optional description for the list. Defaults to an empty string if not provided.
    Ips []string
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    Json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    Name string
    The name of the list. Maximum length is 100 characters.
    ProjectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    Texts []string
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    description string
    An optional description for the list. Defaults to an empty string if not provided.
    ips list(string)
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name string
    The name of the list. Maximum length is 100 characters.
    project_id string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    texts list(string)
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    description String
    An optional description for the list. Defaults to an empty string if not provided.
    ips List<String>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json String
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name String
    The name of the list. Maximum length is 100 characters.
    projectId String
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    texts List<String>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    description string
    An optional description for the list. Defaults to an empty string if not provided.
    ips string[]
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json string
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name string
    The name of the list. Maximum length is 100 characters.
    projectId string
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    texts string[]
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    description str
    An optional description for the list. Defaults to an empty string if not provided.
    ips Sequence[str]
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json str
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name str
    The name of the list. Maximum length is 100 characters.
    project_id str
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    texts Sequence[str]
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.
    description String
    An optional description for the list. Defaults to an empty string if not provided.
    ips List<String>
    A set of IP addresses and CIDR ranges. Each value must be a valid IP address or CIDR range. Exactly one of texts, ips or json must be set.
    json String
    An arbitrary JSON object, given as a JSON string. Exactly one of texts, ips or json must be set. The document is compared by content, so reindenting it or reordering its keys is not a change.
    name String
    The name of the list. Maximum length is 100 characters.
    projectId String
    The ID of the project that this list belongs to. Changing this value will require the resource to be deleted and recreated.
    texts List<String>
    A set of text values. Exactly one of texts, ips or json must be set, and which one is set determines the kind of list. Duplicate values are collapsed by the set, matching the backend which stores each value once.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial