1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. TenantAttribute
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 tenant custom attribute definition in a Descope project.

    Create TenantAttribute Resource

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

    Constructor syntax

    new TenantAttribute(name: string, args: TenantAttributeArgs, opts?: CustomResourceOptions);
    @overload
    def TenantAttribute(resource_name: str,
                        args: TenantAttributeArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def TenantAttribute(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project_id: Optional[str] = None,
                        tenant_attribute_id: Optional[str] = None,
                        type: Optional[str] = None,
                        authorization: Optional[TenantAttributeAuthorizationArgs] = None,
                        name: Optional[str] = None,
                        select_options: Optional[Sequence[str]] = None)
    func NewTenantAttribute(ctx *Context, name string, args TenantAttributeArgs, opts ...ResourceOption) (*TenantAttribute, error)
    public TenantAttribute(string name, TenantAttributeArgs args, CustomResourceOptions? opts = null)
    public TenantAttribute(String name, TenantAttributeArgs args)
    public TenantAttribute(String name, TenantAttributeArgs args, CustomResourceOptions options)
    
    type: descope:TenantAttribute
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_tenant_attribute" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TenantAttributeArgs
    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 TenantAttributeArgs
    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 TenantAttributeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantAttributeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantAttributeArgs
    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 tenantAttributeResource = new Descope.TenantAttribute("tenantAttributeResource", new()
    {
        ProjectId = "string",
        TenantAttributeId = "string",
        Type = "string",
        Authorization = new Descope.Inputs.TenantAttributeAuthorizationArgs
        {
            ViewPermissions = new[]
            {
                "string",
            },
        },
        Name = "string",
        SelectOptions = new[]
        {
            "string",
        },
    });
    
    example, err := descope.NewTenantAttribute(ctx, "tenantAttributeResource", &descope.TenantAttributeArgs{
    	ProjectId:         pulumi.String("string"),
    	TenantAttributeId: pulumi.String("string"),
    	Type:              pulumi.String("string"),
    	Authorization: &descope.TenantAttributeAuthorizationArgs{
    		ViewPermissions: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	SelectOptions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "descope_tenant_attribute" "tenantAttributeResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id          = "string"
      tenant_attribute_id = "string"
      type                = "string"
      authorization = {
        view_permissions = ["string"]
      }
      name           = "string"
      select_options = ["string"]
    }
    
    var tenantAttributeResource = new TenantAttribute("tenantAttributeResource", TenantAttributeArgs.builder()
        .projectId("string")
        .tenantAttributeId("string")
        .type("string")
        .authorization(TenantAttributeAuthorizationArgs.builder()
            .viewPermissions("string")
            .build())
        .name("string")
        .selectOptions("string")
        .build());
    
    tenant_attribute_resource = descope.TenantAttribute("tenantAttributeResource",
        project_id="string",
        tenant_attribute_id="string",
        type="string",
        authorization={
            "view_permissions": ["string"],
        },
        name="string",
        select_options=["string"])
    
    const tenantAttributeResource = new descope.TenantAttribute("tenantAttributeResource", {
        projectId: "string",
        tenantAttributeId: "string",
        type: "string",
        authorization: {
            viewPermissions: ["string"],
        },
        name: "string",
        selectOptions: ["string"],
    });
    
    type: descope:TenantAttribute
    properties:
        authorization:
            viewPermissions:
                - string
        name: string
        projectId: string
        selectOptions:
            - string
        tenantAttributeId: string
        type: string
    

    TenantAttribute 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 TenantAttribute resource accepts the following input properties:

    ProjectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    TenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    Type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    Authorization Descope.TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    Name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    SelectOptions List<string>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    ProjectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    TenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    Type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    Authorization TenantAttributeAuthorizationArgs
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    Name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    SelectOptions []string
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    project_id string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    tenant_attribute_id string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization object
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    select_options list(string)
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    projectId String
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    tenantAttributeId String
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type String
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name String
    The display name of the attribute. This value is called Display Name in the Descope console.
    selectOptions List<String>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    projectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    tenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    selectOptions string[]
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    project_id str
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    tenant_attribute_id str
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type str
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorizationArgs
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name str
    The display name of the attribute. This value is called Display Name in the Descope console.
    select_options Sequence[str]
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    projectId String
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    tenantAttributeId String
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type String
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization Property Map
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name String
    The display name of the attribute. This value is called Display Name in the Descope console.
    selectOptions List<String>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TenantAttribute 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 TenantAttribute Resource

    Get an existing TenantAttribute 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?: TenantAttributeState, opts?: CustomResourceOptions): TenantAttribute
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorization: Optional[TenantAttributeAuthorizationArgs] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            select_options: Optional[Sequence[str]] = None,
            tenant_attribute_id: Optional[str] = None,
            type: Optional[str] = None) -> TenantAttribute
    func GetTenantAttribute(ctx *Context, name string, id IDInput, state *TenantAttributeState, opts ...ResourceOption) (*TenantAttribute, error)
    public static TenantAttribute Get(string name, Input<string> id, TenantAttributeState? state, CustomResourceOptions? opts = null)
    public static TenantAttribute get(String name, Output<String> id, TenantAttributeState state, CustomResourceOptions options)
    resources:  existingTenantAttribute:    type: descope:TenantAttribute    get:      id: ${id}
    import {
      to = descope_tenant_attribute.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 TenantAttributeState
    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 TenantAttributeState
    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 TenantAttributeState
    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 TenantAttributeState
    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:
    Authorization Descope.TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    Name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    ProjectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    SelectOptions List<string>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    TenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    Type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    Authorization TenantAttributeAuthorizationArgs
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    Name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    ProjectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    SelectOptions []string
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    TenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    Type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization object
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    project_id string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    select_options list(string)
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    tenant_attribute_id string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name String
    The display name of the attribute. This value is called Display Name in the Descope console.
    projectId String
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    selectOptions List<String>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    tenantAttributeId String
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type String
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorization
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name string
    The display name of the attribute. This value is called Display Name in the Descope console.
    projectId string
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    selectOptions string[]
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    tenantAttributeId string
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type string
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization TenantAttributeAuthorizationArgs
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name str
    The display name of the attribute. This value is called Display Name in the Descope console.
    project_id str
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    select_options Sequence[str]
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    tenant_attribute_id str
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type str
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.
    authorization Property Map
    Determines the permissions users are required to have to access this attribute. Tenant attributes are view-only and do not support edit permissions.
    name String
    The display name of the attribute. This value is called Display Name in the Descope console.
    projectId String
    The ID of the project that this tenant attribute belongs to. Changing this value will require the resource to be deleted and recreated.
    selectOptions List<String>
    The list of options to choose from when the attribute type is "singleselect" or "multiselect".
    tenantAttributeId String
    The immutable machine name that identifies the attribute. This value is called Machine Name in the Descope console. Changing this value will require the resource to be deleted and recreated.
    type String
    The type of the attribute. Choose one of "string", "number", "boolean", "singleselect", "multiselect", "date", "monthday". Changing this value will require the resource to be deleted and recreated.

    Supporting Types

    TenantAttributeAuthorization, TenantAttributeAuthorizationArgs

    ViewPermissions List<string>
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    ViewPermissions []string
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    view_permissions list(string)
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    viewPermissions List<String>
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    viewPermissions string[]
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    view_permissions Sequence[str]
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
    viewPermissions List<String>
    The names of the permissions users are required to have to view this attribute. An empty set means no restriction.

    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