published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages the project-level embedded link authentication settings. This is a singleton resource, and its id is always the project ID.
Create EmbeddedlinkSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EmbeddedlinkSettings(name: string, args: EmbeddedlinkSettingsArgs, opts?: CustomResourceOptions);@overload
def EmbeddedlinkSettings(resource_name: str,
args: EmbeddedlinkSettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EmbeddedlinkSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
disabled: Optional[bool] = None,
expiration_time: Optional[str] = None)func NewEmbeddedlinkSettings(ctx *Context, name string, args EmbeddedlinkSettingsArgs, opts ...ResourceOption) (*EmbeddedlinkSettings, error)public EmbeddedlinkSettings(string name, EmbeddedlinkSettingsArgs args, CustomResourceOptions? opts = null)
public EmbeddedlinkSettings(String name, EmbeddedlinkSettingsArgs args)
public EmbeddedlinkSettings(String name, EmbeddedlinkSettingsArgs args, CustomResourceOptions options)
type: descope:EmbeddedlinkSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_embeddedlink_settings" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args EmbeddedlinkSettingsArgs
- 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 EmbeddedlinkSettingsArgs
- 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 EmbeddedlinkSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EmbeddedlinkSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EmbeddedlinkSettingsArgs
- 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 embeddedlinkSettingsResource = new Descope.EmbeddedlinkSettings("embeddedlinkSettingsResource", new()
{
ProjectId = "string",
Disabled = false,
ExpirationTime = "string",
});
example, err := descope.NewEmbeddedlinkSettings(ctx, "embeddedlinkSettingsResource", &descope.EmbeddedlinkSettingsArgs{
ProjectId: pulumi.String("string"),
Disabled: pulumi.Bool(false),
ExpirationTime: pulumi.String("string"),
})
resource "descope_embeddedlink_settings" "embeddedlinkSettingsResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
disabled = false
expiration_time = "string"
}
var embeddedlinkSettingsResource = new EmbeddedlinkSettings("embeddedlinkSettingsResource", EmbeddedlinkSettingsArgs.builder()
.projectId("string")
.disabled(false)
.expirationTime("string")
.build());
embeddedlink_settings_resource = descope.EmbeddedlinkSettings("embeddedlinkSettingsResource",
project_id="string",
disabled=False,
expiration_time="string")
const embeddedlinkSettingsResource = new descope.EmbeddedlinkSettings("embeddedlinkSettingsResource", {
projectId: "string",
disabled: false,
expirationTime: "string",
});
type: descope:EmbeddedlinkSettings
properties:
disabled: false
expirationTime: string
projectId: string
EmbeddedlinkSettings 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 EmbeddedlinkSettings resource accepts the following input properties:
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - Expiration
Time string - How long the embedded link remains valid before it expires.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - Expiration
Time string - How long the embedded link remains valid before it expires.
- project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration_
time string - How long the embedded link remains valid before it expires.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled Boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time String - How long the embedded link remains valid before it expires.
- project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time string - How long the embedded link remains valid before it expires.
- project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration_
time str - How long the embedded link remains valid before it expires.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled Boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time String - How long the embedded link remains valid before it expires.
Outputs
All input properties are implicitly available as output properties. Additionally, the EmbeddedlinkSettings 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 EmbeddedlinkSettings Resource
Get an existing EmbeddedlinkSettings 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?: EmbeddedlinkSettingsState, opts?: CustomResourceOptions): EmbeddedlinkSettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
disabled: Optional[bool] = None,
expiration_time: Optional[str] = None,
project_id: Optional[str] = None) -> EmbeddedlinkSettingsfunc GetEmbeddedlinkSettings(ctx *Context, name string, id IDInput, state *EmbeddedlinkSettingsState, opts ...ResourceOption) (*EmbeddedlinkSettings, error)public static EmbeddedlinkSettings Get(string name, Input<string> id, EmbeddedlinkSettingsState? state, CustomResourceOptions? opts = null)public static EmbeddedlinkSettings get(String name, Output<String> id, EmbeddedlinkSettingsState state, CustomResourceOptions options)resources: existingEmbeddedlinkSettings: type: descope:EmbeddedlinkSettings get: id: ${id}import {
to = descope_embeddedlink_settings.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 EmbeddedlinkSettingsState
- 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 EmbeddedlinkSettingsState
- 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 EmbeddedlinkSettingsState
- 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 EmbeddedlinkSettingsState
- 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.
- Disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - Expiration
Time string - How long the embedded link remains valid before it expires.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - Expiration
Time string - How long the embedded link remains valid before it expires.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration_
time string - How long the embedded link remains valid before it expires.
- project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled Boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time String - How long the embedded link remains valid before it expires.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time string - How long the embedded link remains valid before it expires.
- project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled bool
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration_
time str - How long the embedded link remains valid before it expires.
- project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- disabled Boolean
- Setting this to
truewill disallow using embedded link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use embedded links. - expiration
Time String - How long the embedded link remains valid before it expires.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
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