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

    Create InviteSettings Resource

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

    Constructor syntax

    new InviteSettings(name: string, args: InviteSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def InviteSettings(resource_name: str,
                       args: InviteSettingsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def InviteSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       project_id: Optional[str] = None,
                       add_magiclink_token: Optional[bool] = None,
                       email_connector_id: Optional[str] = None,
                       email_template_id: Optional[str] = None,
                       expire_invited_users: Optional[bool] = None,
                       invite_expiration: Optional[str] = None,
                       invite_url: Optional[str] = None,
                       require_invitation: Optional[bool] = None,
                       send_email: Optional[bool] = None,
                       send_text: Optional[bool] = None)
    func NewInviteSettings(ctx *Context, name string, args InviteSettingsArgs, opts ...ResourceOption) (*InviteSettings, error)
    public InviteSettings(string name, InviteSettingsArgs args, CustomResourceOptions? opts = null)
    public InviteSettings(String name, InviteSettingsArgs args)
    public InviteSettings(String name, InviteSettingsArgs args, CustomResourceOptions options)
    
    type: descope:InviteSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_invite_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args InviteSettingsArgs
    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 InviteSettingsArgs
    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 InviteSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InviteSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InviteSettingsArgs
    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 inviteSettingsResource = new Descope.InviteSettings("inviteSettingsResource", new()
    {
        ProjectId = "string",
        AddMagiclinkToken = false,
        EmailConnectorId = "string",
        EmailTemplateId = "string",
        ExpireInvitedUsers = false,
        InviteExpiration = "string",
        InviteUrl = "string",
        RequireInvitation = false,
        SendEmail = false,
        SendText = false,
    });
    
    example, err := descope.NewInviteSettings(ctx, "inviteSettingsResource", &descope.InviteSettingsArgs{
    	ProjectId:          pulumi.String("string"),
    	AddMagiclinkToken:  pulumi.Bool(false),
    	EmailConnectorId:   pulumi.String("string"),
    	EmailTemplateId:    pulumi.String("string"),
    	ExpireInvitedUsers: pulumi.Bool(false),
    	InviteExpiration:   pulumi.String("string"),
    	InviteUrl:          pulumi.String("string"),
    	RequireInvitation:  pulumi.Bool(false),
    	SendEmail:          pulumi.Bool(false),
    	SendText:           pulumi.Bool(false),
    })
    
    resource "descope_invite_settings" "inviteSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id           = "string"
      add_magiclink_token  = false
      email_connector_id   = "string"
      email_template_id    = "string"
      expire_invited_users = false
      invite_expiration    = "string"
      invite_url           = "string"
      require_invitation   = false
      send_email           = false
      send_text            = false
    }
    
    var inviteSettingsResource = new InviteSettings("inviteSettingsResource", InviteSettingsArgs.builder()
        .projectId("string")
        .addMagiclinkToken(false)
        .emailConnectorId("string")
        .emailTemplateId("string")
        .expireInvitedUsers(false)
        .inviteExpiration("string")
        .inviteUrl("string")
        .requireInvitation(false)
        .sendEmail(false)
        .sendText(false)
        .build());
    
    invite_settings_resource = descope.InviteSettings("inviteSettingsResource",
        project_id="string",
        add_magiclink_token=False,
        email_connector_id="string",
        email_template_id="string",
        expire_invited_users=False,
        invite_expiration="string",
        invite_url="string",
        require_invitation=False,
        send_email=False,
        send_text=False)
    
    const inviteSettingsResource = new descope.InviteSettings("inviteSettingsResource", {
        projectId: "string",
        addMagiclinkToken: false,
        emailConnectorId: "string",
        emailTemplateId: "string",
        expireInvitedUsers: false,
        inviteExpiration: "string",
        inviteUrl: "string",
        requireInvitation: false,
        sendEmail: false,
        sendText: false,
    });
    
    type: descope:InviteSettings
    properties:
        addMagiclinkToken: false
        emailConnectorId: string
        emailTemplateId: string
        expireInvitedUsers: false
        inviteExpiration: string
        inviteUrl: string
        projectId: string
        requireInvitation: false
        sendEmail: false
        sendText: false
    

    InviteSettings 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 InviteSettings 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.
    AddMagiclinkToken bool
    Whether to include a magic link token in invitation messages.
    EmailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    ExpireInvitedUsers bool
    Expire the user account if the invitation is not accepted within the expiration time.
    InviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    InviteUrl string
    Custom URL to include in the message sent to invited users.
    RequireInvitation bool
    Whether users must be invited before they can sign up to the project.
    SendEmail bool
    Whether to send invitation emails to users.
    SendText bool
    Whether to send invitation SMS messages to users.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    AddMagiclinkToken bool
    Whether to include a magic link token in invitation messages.
    EmailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    ExpireInvitedUsers bool
    Expire the user account if the invitation is not accepted within the expiration time.
    InviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    InviteUrl string
    Custom URL to include in the message sent to invited users.
    RequireInvitation bool
    Whether users must be invited before they can sign up to the project.
    SendEmail bool
    Whether to send invitation emails to users.
    SendText bool
    Whether to send invitation SMS messages to users.
    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.
    add_magiclink_token bool
    Whether to include a magic link token in invitation messages.
    email_connector_id string
    The ID of an email connector to use for sending invitation 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 invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expire_invited_users bool
    Expire the user account if the invitation is not accepted within the expiration time.
    invite_expiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    invite_url string
    Custom URL to include in the message sent to invited users.
    require_invitation bool
    Whether users must be invited before they can sign up to the project.
    send_email bool
    Whether to send invitation emails to users.
    send_text bool
    Whether to send invitation SMS messages to users.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    addMagiclinkToken Boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId String
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers Boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration String
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl String
    Custom URL to include in the message sent to invited users.
    requireInvitation Boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail Boolean
    Whether to send invitation emails to users.
    sendText Boolean
    Whether to send invitation SMS messages to users.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    addMagiclinkToken boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl string
    Custom URL to include in the message sent to invited users.
    requireInvitation boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail boolean
    Whether to send invitation emails to users.
    sendText boolean
    Whether to send invitation SMS messages to users.
    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.
    add_magiclink_token bool
    Whether to include a magic link token in invitation messages.
    email_connector_id str
    The ID of an email connector to use for sending invitation 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 invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expire_invited_users bool
    Expire the user account if the invitation is not accepted within the expiration time.
    invite_expiration str
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    invite_url str
    Custom URL to include in the message sent to invited users.
    require_invitation bool
    Whether users must be invited before they can sign up to the project.
    send_email bool
    Whether to send invitation emails to users.
    send_text bool
    Whether to send invitation SMS messages to users.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    addMagiclinkToken Boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId String
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers Boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration String
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl String
    Custom URL to include in the message sent to invited users.
    requireInvitation Boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail Boolean
    Whether to send invitation emails to users.
    sendText Boolean
    Whether to send invitation SMS messages to users.

    Outputs

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

    Get an existing InviteSettings 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?: InviteSettingsState, opts?: CustomResourceOptions): InviteSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            add_magiclink_token: Optional[bool] = None,
            email_connector_id: Optional[str] = None,
            email_template_id: Optional[str] = None,
            expire_invited_users: Optional[bool] = None,
            invite_expiration: Optional[str] = None,
            invite_url: Optional[str] = None,
            project_id: Optional[str] = None,
            require_invitation: Optional[bool] = None,
            send_email: Optional[bool] = None,
            send_text: Optional[bool] = None) -> InviteSettings
    func GetInviteSettings(ctx *Context, name string, id IDInput, state *InviteSettingsState, opts ...ResourceOption) (*InviteSettings, error)
    public static InviteSettings Get(string name, Input<string> id, InviteSettingsState? state, CustomResourceOptions? opts = null)
    public static InviteSettings get(String name, Output<String> id, InviteSettingsState state, CustomResourceOptions options)
    resources:  existingInviteSettings:    type: descope:InviteSettings    get:      id: ${id}
    import {
      to = descope_invite_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 InviteSettingsState
    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 InviteSettingsState
    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 InviteSettingsState
    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 InviteSettingsState
    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:
    AddMagiclinkToken bool
    Whether to include a magic link token in invitation messages.
    EmailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    ExpireInvitedUsers bool
    Expire the user account if the invitation is not accepted within the expiration time.
    InviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    InviteUrl string
    Custom URL to include in the message sent to invited users.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RequireInvitation bool
    Whether users must be invited before they can sign up to the project.
    SendEmail bool
    Whether to send invitation emails to users.
    SendText bool
    Whether to send invitation SMS messages to users.
    AddMagiclinkToken bool
    Whether to include a magic link token in invitation messages.
    EmailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    ExpireInvitedUsers bool
    Expire the user account if the invitation is not accepted within the expiration time.
    InviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    InviteUrl string
    Custom URL to include in the message sent to invited users.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RequireInvitation bool
    Whether users must be invited before they can sign up to the project.
    SendEmail bool
    Whether to send invitation emails to users.
    SendText bool
    Whether to send invitation SMS messages to users.
    add_magiclink_token bool
    Whether to include a magic link token in invitation messages.
    email_connector_id string
    The ID of an email connector to use for sending invitation 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 invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expire_invited_users bool
    Expire the user account if the invitation is not accepted within the expiration time.
    invite_expiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    invite_url string
    Custom URL to include in the message sent to invited users.
    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.
    require_invitation bool
    Whether users must be invited before they can sign up to the project.
    send_email bool
    Whether to send invitation emails to users.
    send_text bool
    Whether to send invitation SMS messages to users.
    addMagiclinkToken Boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId String
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers Boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration String
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl String
    Custom URL to include in the message sent to invited users.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    requireInvitation Boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail Boolean
    Whether to send invitation emails to users.
    sendText Boolean
    Whether to send invitation SMS messages to users.
    addMagiclinkToken boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId string
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration string
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl string
    Custom URL to include in the message sent to invited users.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    requireInvitation boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail boolean
    Whether to send invitation emails to users.
    sendText boolean
    Whether to send invitation SMS messages to users.
    add_magiclink_token bool
    Whether to include a magic link token in invitation messages.
    email_connector_id str
    The ID of an email connector to use for sending invitation 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 invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expire_invited_users bool
    Expire the user account if the invitation is not accepted within the expiration time.
    invite_expiration str
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    invite_url str
    Custom URL to include in the message sent to invited users.
    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.
    require_invitation bool
    Whether users must be invited before they can sign up to the project.
    send_email bool
    Whether to send invitation emails to users.
    send_text bool
    Whether to send invitation SMS messages to users.
    addMagiclinkToken Boolean
    Whether to include a magic link token in invitation messages.
    emailConnectorId String
    The ID of an email connector to use for sending invitation emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template to send to invited users, taken from a descope.EmailTemplate resource with its method set to invite. An empty value (the default) selects the built-in System template.
    expireInvitedUsers Boolean
    Expire the user account if the invitation is not accepted within the expiration time.
    inviteExpiration String
    The expiry time for the invitation, meant to be used together with expireInvitedUsers and/or addMagiclinkToken. Use values such as "2 weeks", "4 days", etc. The minimum value is "1 hour".
    inviteUrl String
    Custom URL to include in the message sent to invited users.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    requireInvitation Boolean
    Whether users must be invited before they can sign up to the project.
    sendEmail Boolean
    Whether to send invitation emails to users.
    sendText Boolean
    Whether to send invitation SMS messages to users.

    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