1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. MagiclinkSettings
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 the project-level magic link authentication settings. This is a singleton resource, and its id is always the project ID.

    Create MagiclinkSettings Resource

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

    Constructor syntax

    new MagiclinkSettings(name: string, args: MagiclinkSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def MagiclinkSettings(resource_name: str,
                          args: MagiclinkSettingsArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def MagiclinkSettings(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          project_id: Optional[str] = None,
                          disabled: Optional[bool] = None,
                          email_connector_id: Optional[str] = None,
                          email_template_id: Optional[str] = None,
                          expiration_time: Optional[str] = None,
                          redirect_url: Optional[str] = None,
                          text_connector_id: Optional[str] = None,
                          text_template_id: Optional[str] = None)
    func NewMagiclinkSettings(ctx *Context, name string, args MagiclinkSettingsArgs, opts ...ResourceOption) (*MagiclinkSettings, error)
    public MagiclinkSettings(string name, MagiclinkSettingsArgs args, CustomResourceOptions? opts = null)
    public MagiclinkSettings(String name, MagiclinkSettingsArgs args)
    public MagiclinkSettings(String name, MagiclinkSettingsArgs args, CustomResourceOptions options)
    
    type: descope:MagiclinkSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_magiclink_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MagiclinkSettingsArgs
    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 MagiclinkSettingsArgs
    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 MagiclinkSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MagiclinkSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MagiclinkSettingsArgs
    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 magiclinkSettingsResource = new Descope.MagiclinkSettings("magiclinkSettingsResource", new()
    {
        ProjectId = "string",
        Disabled = false,
        EmailConnectorId = "string",
        EmailTemplateId = "string",
        ExpirationTime = "string",
        RedirectUrl = "string",
        TextConnectorId = "string",
        TextTemplateId = "string",
    });
    
    example, err := descope.NewMagiclinkSettings(ctx, "magiclinkSettingsResource", &descope.MagiclinkSettingsArgs{
    	ProjectId:        pulumi.String("string"),
    	Disabled:         pulumi.Bool(false),
    	EmailConnectorId: pulumi.String("string"),
    	EmailTemplateId:  pulumi.String("string"),
    	ExpirationTime:   pulumi.String("string"),
    	RedirectUrl:      pulumi.String("string"),
    	TextConnectorId:  pulumi.String("string"),
    	TextTemplateId:   pulumi.String("string"),
    })
    
    resource "descope_magiclink_settings" "magiclinkSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id         = "string"
      disabled           = false
      email_connector_id = "string"
      email_template_id  = "string"
      expiration_time    = "string"
      redirect_url       = "string"
      text_connector_id  = "string"
      text_template_id   = "string"
    }
    
    var magiclinkSettingsResource = new MagiclinkSettings("magiclinkSettingsResource", MagiclinkSettingsArgs.builder()
        .projectId("string")
        .disabled(false)
        .emailConnectorId("string")
        .emailTemplateId("string")
        .expirationTime("string")
        .redirectUrl("string")
        .textConnectorId("string")
        .textTemplateId("string")
        .build());
    
    magiclink_settings_resource = descope.MagiclinkSettings("magiclinkSettingsResource",
        project_id="string",
        disabled=False,
        email_connector_id="string",
        email_template_id="string",
        expiration_time="string",
        redirect_url="string",
        text_connector_id="string",
        text_template_id="string")
    
    const magiclinkSettingsResource = new descope.MagiclinkSettings("magiclinkSettingsResource", {
        projectId: "string",
        disabled: false,
        emailConnectorId: "string",
        emailTemplateId: "string",
        expirationTime: "string",
        redirectUrl: "string",
        textConnectorId: "string",
        textTemplateId: "string",
    });
    
    type: descope:MagiclinkSettings
    properties:
        disabled: false
        emailConnectorId: string
        emailTemplateId: string
        expirationTime: string
        projectId: string
        redirectUrl: string
        textConnectorId: string
        textTemplateId: string
    

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

    ProjectId 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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    ExpirationTime string
    How long the magic link remains valid before it expires.
    RedirectUrl string
    The URL to redirect users to after they log in using the magic link.
    TextConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    TextTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    ProjectId 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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    ExpirationTime string
    How long the magic link remains valid before it expires.
    RedirectUrl string
    The URL to redirect users to after they log in using the magic link.
    TextConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    TextTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    email_connector_id string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expiration_time string
    How long the magic link remains valid before it expires.
    redirect_url string
    The URL to redirect users to after they log in using the magic link.
    text_connector_id string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    text_template_id string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    projectId 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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime String
    How long the magic link remains valid before it expires.
    redirectUrl String
    The URL to redirect users to after they log in using the magic link.
    textConnectorId String
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId String
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    projectId 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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime string
    How long the magic link remains valid before it expires.
    redirectUrl string
    The URL to redirect users to after they log in using the magic link.
    textConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    email_connector_id str
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id str
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expiration_time str
    How long the magic link remains valid before it expires.
    redirect_url str
    The URL to redirect users to after they log in using the magic link.
    text_connector_id str
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    text_template_id str
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    projectId 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 true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime String
    How long the magic link remains valid before it expires.
    redirectUrl String
    The URL to redirect users to after they log in using the magic link.
    textConnectorId String
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId String
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.

    Outputs

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

    Get an existing MagiclinkSettings 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?: MagiclinkSettingsState, opts?: CustomResourceOptions): MagiclinkSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disabled: Optional[bool] = None,
            email_connector_id: Optional[str] = None,
            email_template_id: Optional[str] = None,
            expiration_time: Optional[str] = None,
            project_id: Optional[str] = None,
            redirect_url: Optional[str] = None,
            text_connector_id: Optional[str] = None,
            text_template_id: Optional[str] = None) -> MagiclinkSettings
    func GetMagiclinkSettings(ctx *Context, name string, id IDInput, state *MagiclinkSettingsState, opts ...ResourceOption) (*MagiclinkSettings, error)
    public static MagiclinkSettings Get(string name, Input<string> id, MagiclinkSettingsState? state, CustomResourceOptions? opts = null)
    public static MagiclinkSettings get(String name, Output<String> id, MagiclinkSettingsState state, CustomResourceOptions options)
    resources:  existingMagiclinkSettings:    type: descope:MagiclinkSettings    get:      id: ${id}
    import {
      to = descope_magiclink_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 MagiclinkSettingsState
    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 MagiclinkSettingsState
    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 MagiclinkSettingsState
    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 MagiclinkSettingsState
    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:
    Disabled bool
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    ExpirationTime string
    How long the magic link remains valid before it expires.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RedirectUrl string
    The URL to redirect users to after they log in using the magic link.
    TextConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    TextTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    Disabled bool
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    ExpirationTime string
    How long the magic link remains valid before it expires.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RedirectUrl string
    The URL to redirect users to after they log in using the magic link.
    TextConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    TextTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    disabled bool
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    email_connector_id string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expiration_time string
    How long the magic 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.
    redirect_url string
    The URL to redirect users to after they log in using the magic link.
    text_connector_id string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    text_template_id string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    disabled Boolean
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime String
    How long the magic link remains valid before it expires.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl String
    The URL to redirect users to after they log in using the magic link.
    textConnectorId String
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId String
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    disabled boolean
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime string
    How long the magic link remains valid before it expires.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl string
    The URL to redirect users to after they log in using the magic link.
    textConnectorId string
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId string
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    disabled bool
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    email_connector_id str
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id str
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expiration_time str
    How long the magic 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.
    redirect_url str
    The URL to redirect users to after they log in using the magic link.
    text_connector_id str
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    text_template_id str
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    disabled Boolean
    Setting this to true will disallow using magic link authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use magic links.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to users, taken from a descope.EmailTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.
    expirationTime String
    How long the magic link remains valid before it expires.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl String
    The URL to redirect users to after they log in using the magic link.
    textConnectorId String
    The ID of an SMS connector to use for sending text messages. An empty value (the default) selects the built-in Descope delivery service.
    textTemplateId String
    The ID of the text template to send to users, taken from a descope.TextTemplate resource with its method set to magiclink. An empty value (the default) selects the built-in System template.

    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