published on Sunday, Oct 11, 2026 by Descope
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:
- 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 stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Descope.
Tenant Attribute Authorization - 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 Namein the Descope console. - Select
Options List<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 stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization Args - 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 Namein the Descope console. - Select
Options []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_ stringid - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
- 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 Namein the Descope console. - select_
options list(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 StringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization - 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 Namein the Descope console. - select
Options List<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 stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization - 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 Namein the Descope console. - select
Options 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_ strid - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization Args - 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 Namein the Descope console. - select_
options Sequence[str] - 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 StringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
- 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 Namein the Descope console. - select
Options 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) -> TenantAttributefunc 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.
-
Descope.
Tenant Attribute Authorization - 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 Namein 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 stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization Args - 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 Namein 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 []string - The list of options to choose from when the attribute type is "singleselect" or "multiselect".
- Tenant
Attribute stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
- 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 Namein 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_ stringid - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization - 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 Namein 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 StringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization - 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 Namein 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 string[] - The list of options to choose from when the attribute type is "singleselect" or "multiselect".
- tenant
Attribute stringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
-
Tenant
Attribute Authorization Args - 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 Namein 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_ strid - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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.
- 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 Namein 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 StringId - The immutable machine name that identifies the attribute. This value is called
Machine Namein 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
- View
Permissions List<string> - The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
- View
Permissions []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.
- view
Permissions List<String> - The names of the permissions users are required to have to view this attribute. An empty set means no restriction.
- view
Permissions 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.
- view
Permissions 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
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope