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

    Create PasswordSettings Resource

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

    Constructor syntax

    new PasswordSettings(name: string, args: PasswordSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def PasswordSettings(resource_name: str,
                         args: PasswordSettingsArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def PasswordSettings(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         project_id: Optional[str] = None,
                         lock_attempts: Optional[int] = None,
                         mask_errors: Optional[bool] = None,
                         disallowed_characters: Optional[str] = None,
                         email_connector_id: Optional[str] = None,
                         email_template_id: Optional[str] = None,
                         enforce_strength: Optional[str] = None,
                         expiration: Optional[bool] = None,
                         expiration_weeks: Optional[int] = None,
                         lock: Optional[bool] = None,
                         min_length: Optional[int] = None,
                         disallow_email_match: Optional[bool] = None,
                         lowercase: Optional[bool] = None,
                         any_letter: Optional[bool] = None,
                         non_alphanumeric: Optional[bool] = None,
                         number: Optional[bool] = None,
                         disabled: Optional[bool] = None,
                         reuse: Optional[bool] = None,
                         reuse_amount: Optional[int] = None,
                         temporary_lock: Optional[bool] = None,
                         temporary_lock_attempts: Optional[int] = None,
                         temporary_lock_duration: Optional[str] = None,
                         uppercase: Optional[bool] = None)
    func NewPasswordSettings(ctx *Context, name string, args PasswordSettingsArgs, opts ...ResourceOption) (*PasswordSettings, error)
    public PasswordSettings(string name, PasswordSettingsArgs args, CustomResourceOptions? opts = null)
    public PasswordSettings(String name, PasswordSettingsArgs args)
    public PasswordSettings(String name, PasswordSettingsArgs args, CustomResourceOptions options)
    
    type: descope:PasswordSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_password_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PasswordSettingsArgs
    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 PasswordSettingsArgs
    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 PasswordSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PasswordSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PasswordSettingsArgs
    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 passwordSettingsResource = new Descope.PasswordSettings("passwordSettingsResource", new()
    {
        ProjectId = "string",
        LockAttempts = 0,
        MaskErrors = false,
        DisallowedCharacters = "string",
        EmailConnectorId = "string",
        EmailTemplateId = "string",
        EnforceStrength = "string",
        Expiration = false,
        ExpirationWeeks = 0,
        Lock = false,
        MinLength = 0,
        DisallowEmailMatch = false,
        Lowercase = false,
        AnyLetter = false,
        NonAlphanumeric = false,
        Number = false,
        Disabled = false,
        Reuse = false,
        ReuseAmount = 0,
        TemporaryLock = false,
        TemporaryLockAttempts = 0,
        TemporaryLockDuration = "string",
        Uppercase = false,
    });
    
    example, err := descope.NewPasswordSettings(ctx, "passwordSettingsResource", &descope.PasswordSettingsArgs{
    	ProjectId:             pulumi.String("string"),
    	LockAttempts:          pulumi.Int(0),
    	MaskErrors:            pulumi.Bool(false),
    	DisallowedCharacters:  pulumi.String("string"),
    	EmailConnectorId:      pulumi.String("string"),
    	EmailTemplateId:       pulumi.String("string"),
    	EnforceStrength:       pulumi.String("string"),
    	Expiration:            pulumi.Bool(false),
    	ExpirationWeeks:       pulumi.Int(0),
    	Lock:                  pulumi.Bool(false),
    	MinLength:             pulumi.Int(0),
    	DisallowEmailMatch:    pulumi.Bool(false),
    	Lowercase:             pulumi.Bool(false),
    	AnyLetter:             pulumi.Bool(false),
    	NonAlphanumeric:       pulumi.Bool(false),
    	Number:                pulumi.Bool(false),
    	Disabled:              pulumi.Bool(false),
    	Reuse:                 pulumi.Bool(false),
    	ReuseAmount:           pulumi.Int(0),
    	TemporaryLock:         pulumi.Bool(false),
    	TemporaryLockAttempts: pulumi.Int(0),
    	TemporaryLockDuration: pulumi.String("string"),
    	Uppercase:             pulumi.Bool(false),
    })
    
    resource "descope_password_settings" "passwordSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id              = "string"
      lock_attempts           = 0
      mask_errors             = false
      disallowed_characters   = "string"
      email_connector_id      = "string"
      email_template_id       = "string"
      enforce_strength        = "string"
      expiration              = false
      expiration_weeks        = 0
      lock                    = false
      min_length              = 0
      disallow_email_match    = false
      lowercase               = false
      any_letter              = false
      non_alphanumeric        = false
      number                  = false
      disabled                = false
      reuse                   = false
      reuse_amount            = 0
      temporary_lock          = false
      temporary_lock_attempts = 0
      temporary_lock_duration = "string"
      uppercase               = false
    }
    
    var passwordSettingsResource = new PasswordSettings("passwordSettingsResource", PasswordSettingsArgs.builder()
        .projectId("string")
        .lockAttempts(0)
        .maskErrors(false)
        .disallowedCharacters("string")
        .emailConnectorId("string")
        .emailTemplateId("string")
        .enforceStrength("string")
        .expiration(false)
        .expirationWeeks(0)
        .lock(false)
        .minLength(0)
        .disallowEmailMatch(false)
        .lowercase(false)
        .anyLetter(false)
        .nonAlphanumeric(false)
        .number(false)
        .disabled(false)
        .reuse(false)
        .reuseAmount(0)
        .temporaryLock(false)
        .temporaryLockAttempts(0)
        .temporaryLockDuration("string")
        .uppercase(false)
        .build());
    
    password_settings_resource = descope.PasswordSettings("passwordSettingsResource",
        project_id="string",
        lock_attempts=0,
        mask_errors=False,
        disallowed_characters="string",
        email_connector_id="string",
        email_template_id="string",
        enforce_strength="string",
        expiration=False,
        expiration_weeks=0,
        lock=False,
        min_length=0,
        disallow_email_match=False,
        lowercase=False,
        any_letter=False,
        non_alphanumeric=False,
        number=False,
        disabled=False,
        reuse=False,
        reuse_amount=0,
        temporary_lock=False,
        temporary_lock_attempts=0,
        temporary_lock_duration="string",
        uppercase=False)
    
    const passwordSettingsResource = new descope.PasswordSettings("passwordSettingsResource", {
        projectId: "string",
        lockAttempts: 0,
        maskErrors: false,
        disallowedCharacters: "string",
        emailConnectorId: "string",
        emailTemplateId: "string",
        enforceStrength: "string",
        expiration: false,
        expirationWeeks: 0,
        lock: false,
        minLength: 0,
        disallowEmailMatch: false,
        lowercase: false,
        anyLetter: false,
        nonAlphanumeric: false,
        number: false,
        disabled: false,
        reuse: false,
        reuseAmount: 0,
        temporaryLock: false,
        temporaryLockAttempts: 0,
        temporaryLockDuration: "string",
        uppercase: false,
    });
    
    type: descope:PasswordSettings
    properties:
        anyLetter: false
        disabled: false
        disallowEmailMatch: false
        disallowedCharacters: string
        emailConnectorId: string
        emailTemplateId: string
        enforceStrength: string
        expiration: false
        expirationWeeks: 0
        lock: false
        lockAttempts: 0
        lowercase: false
        maskErrors: false
        minLength: 0
        nonAlphanumeric: false
        number: false
        projectId: string
        reuse: false
        reuseAmount: 0
        temporaryLock: false
        temporaryLockAttempts: 0
        temporaryLockDuration: string
        uppercase: false
    

    PasswordSettings 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 PasswordSettings 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.
    AnyLetter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    Disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    DisallowEmailMatch bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    DisallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    EnforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    Expiration bool
    Whether users are required to change their password periodically.
    ExpirationWeeks int
    The number of weeks after which a user's password expires and they need to replace it.
    Lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    LockAttempts int
    The number of failed login attempts allowed before an account is locked.
    Lowercase bool
    Whether passwords must contain at least one lowercase letter.
    MaskErrors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    MinLength int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    NonAlphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    Number bool
    Whether passwords must contain at least one number.
    Reuse bool
    Whether to forbid password reuse when users change their password.
    ReuseAmount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    TemporaryLock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    TemporaryLockAttempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    TemporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    Uppercase bool
    Whether passwords must contain at least one uppercase letter.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    AnyLetter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    Disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    DisallowEmailMatch bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    DisallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    EnforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    Expiration bool
    Whether users are required to change their password periodically.
    ExpirationWeeks int
    The number of weeks after which a user's password expires and they need to replace it.
    Lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    LockAttempts int
    The number of failed login attempts allowed before an account is locked.
    Lowercase bool
    Whether passwords must contain at least one lowercase letter.
    MaskErrors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    MinLength int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    NonAlphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    Number bool
    Whether passwords must contain at least one number.
    Reuse bool
    Whether to forbid password reuse when users change their password.
    ReuseAmount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    TemporaryLock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    TemporaryLockAttempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    TemporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    Uppercase bool
    Whether passwords must contain at least one uppercase letter.
    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.
    any_letter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallow_email_match bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowed_characters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforce_strength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration bool
    Whether users are required to change their password periodically.
    expiration_weeks number
    The number of weeks after which a user's password expires and they need to replace it.
    lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    lock_attempts number
    The number of failed login attempts allowed before an account is locked.
    lowercase bool
    Whether passwords must contain at least one lowercase letter.
    mask_errors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    min_length number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    non_alphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number bool
    Whether passwords must contain at least one number.
    reuse bool
    Whether to forbid password reuse when users change their password.
    reuse_amount number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporary_lock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporary_lock_attempts number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporary_lock_duration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase bool
    Whether passwords must contain at least one uppercase letter.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    anyLetter Boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled Boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch Boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters String
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength String
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration Boolean
    Whether users are required to change their password periodically.
    expirationWeeks Integer
    The number of weeks after which a user's password expires and they need to replace it.
    lock Boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts Integer
    The number of failed login attempts allowed before an account is locked.
    lowercase Boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors Boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength Integer
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric Boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number Boolean
    Whether passwords must contain at least one number.
    reuse Boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount Integer
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock Boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts Integer
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration String
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase Boolean
    Whether passwords must contain at least one uppercase letter.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    anyLetter boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration boolean
    Whether users are required to change their password periodically.
    expirationWeeks number
    The number of weeks after which a user's password expires and they need to replace it.
    lock boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts number
    The number of failed login attempts allowed before an account is locked.
    lowercase boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number boolean
    Whether passwords must contain at least one number.
    reuse boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase boolean
    Whether passwords must contain at least one uppercase letter.
    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.
    any_letter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallow_email_match bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowed_characters str
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforce_strength str
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration bool
    Whether users are required to change their password periodically.
    expiration_weeks int
    The number of weeks after which a user's password expires and they need to replace it.
    lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    lock_attempts int
    The number of failed login attempts allowed before an account is locked.
    lowercase bool
    Whether passwords must contain at least one lowercase letter.
    mask_errors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    min_length int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    non_alphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number bool
    Whether passwords must contain at least one number.
    reuse bool
    Whether to forbid password reuse when users change their password.
    reuse_amount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporary_lock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporary_lock_attempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    temporary_lock_duration str
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase bool
    Whether passwords must contain at least one uppercase letter.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    anyLetter Boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled Boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch Boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters String
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength String
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration Boolean
    Whether users are required to change their password periodically.
    expirationWeeks Number
    The number of weeks after which a user's password expires and they need to replace it.
    lock Boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts Number
    The number of failed login attempts allowed before an account is locked.
    lowercase Boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors Boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength Number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric Boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number Boolean
    Whether passwords must contain at least one number.
    reuse Boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount Number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock Boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts Number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration String
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase Boolean
    Whether passwords must contain at least one uppercase letter.

    Outputs

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

    Get an existing PasswordSettings 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?: PasswordSettingsState, opts?: CustomResourceOptions): PasswordSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            any_letter: Optional[bool] = None,
            disabled: Optional[bool] = None,
            disallow_email_match: Optional[bool] = None,
            disallowed_characters: Optional[str] = None,
            email_connector_id: Optional[str] = None,
            email_template_id: Optional[str] = None,
            enforce_strength: Optional[str] = None,
            expiration: Optional[bool] = None,
            expiration_weeks: Optional[int] = None,
            lock: Optional[bool] = None,
            lock_attempts: Optional[int] = None,
            lowercase: Optional[bool] = None,
            mask_errors: Optional[bool] = None,
            min_length: Optional[int] = None,
            non_alphanumeric: Optional[bool] = None,
            number: Optional[bool] = None,
            project_id: Optional[str] = None,
            reuse: Optional[bool] = None,
            reuse_amount: Optional[int] = None,
            temporary_lock: Optional[bool] = None,
            temporary_lock_attempts: Optional[int] = None,
            temporary_lock_duration: Optional[str] = None,
            uppercase: Optional[bool] = None) -> PasswordSettings
    func GetPasswordSettings(ctx *Context, name string, id IDInput, state *PasswordSettingsState, opts ...ResourceOption) (*PasswordSettings, error)
    public static PasswordSettings Get(string name, Input<string> id, PasswordSettingsState? state, CustomResourceOptions? opts = null)
    public static PasswordSettings get(String name, Output<String> id, PasswordSettingsState state, CustomResourceOptions options)
    resources:  existingPasswordSettings:    type: descope:PasswordSettings    get:      id: ${id}
    import {
      to = descope_password_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 PasswordSettingsState
    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 PasswordSettingsState
    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 PasswordSettingsState
    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 PasswordSettingsState
    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:
    AnyLetter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    Disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    DisallowEmailMatch bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    DisallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    EnforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    Expiration bool
    Whether users are required to change their password periodically.
    ExpirationWeeks int
    The number of weeks after which a user's password expires and they need to replace it.
    Lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    LockAttempts int
    The number of failed login attempts allowed before an account is locked.
    Lowercase bool
    Whether passwords must contain at least one lowercase letter.
    MaskErrors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    MinLength int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    NonAlphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    Number bool
    Whether passwords must contain at least one number.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    Reuse bool
    Whether to forbid password reuse when users change their password.
    ReuseAmount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    TemporaryLock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    TemporaryLockAttempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    TemporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    Uppercase bool
    Whether passwords must contain at least one uppercase letter.
    AnyLetter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    Disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    DisallowEmailMatch bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    DisallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    EnforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    Expiration bool
    Whether users are required to change their password periodically.
    ExpirationWeeks int
    The number of weeks after which a user's password expires and they need to replace it.
    Lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    LockAttempts int
    The number of failed login attempts allowed before an account is locked.
    Lowercase bool
    Whether passwords must contain at least one lowercase letter.
    MaskErrors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    MinLength int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    NonAlphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    Number bool
    Whether passwords must contain at least one number.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    Reuse bool
    Whether to forbid password reuse when users change their password.
    ReuseAmount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    TemporaryLock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    TemporaryLockAttempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    TemporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    Uppercase bool
    Whether passwords must contain at least one uppercase letter.
    any_letter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallow_email_match bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowed_characters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforce_strength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration bool
    Whether users are required to change their password periodically.
    expiration_weeks number
    The number of weeks after which a user's password expires and they need to replace it.
    lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    lock_attempts number
    The number of failed login attempts allowed before an account is locked.
    lowercase bool
    Whether passwords must contain at least one lowercase letter.
    mask_errors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    min_length number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    non_alphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number bool
    Whether passwords must contain at least one number.
    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.
    reuse bool
    Whether to forbid password reuse when users change their password.
    reuse_amount number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporary_lock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporary_lock_attempts number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporary_lock_duration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase bool
    Whether passwords must contain at least one uppercase letter.
    anyLetter Boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled Boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch Boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters String
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength String
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration Boolean
    Whether users are required to change their password periodically.
    expirationWeeks Integer
    The number of weeks after which a user's password expires and they need to replace it.
    lock Boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts Integer
    The number of failed login attempts allowed before an account is locked.
    lowercase Boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors Boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength Integer
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric Boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number Boolean
    Whether passwords must contain at least one number.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    reuse Boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount Integer
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock Boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts Integer
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration String
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase Boolean
    Whether passwords must contain at least one uppercase letter.
    anyLetter boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters string
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength string
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration boolean
    Whether users are required to change their password periodically.
    expirationWeeks number
    The number of weeks after which a user's password expires and they need to replace it.
    lock boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts number
    The number of failed login attempts allowed before an account is locked.
    lowercase boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number boolean
    Whether passwords must contain at least one number.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    reuse boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration string
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase boolean
    Whether passwords must contain at least one uppercase letter.
    any_letter bool
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled bool
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallow_email_match bool
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowed_characters str
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforce_strength str
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration bool
    Whether users are required to change their password periodically.
    expiration_weeks int
    The number of weeks after which a user's password expires and they need to replace it.
    lock bool
    Whether the user account should be locked after a specified number of failed login attempts.
    lock_attempts int
    The number of failed login attempts allowed before an account is locked.
    lowercase bool
    Whether passwords must contain at least one lowercase letter.
    mask_errors bool
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    min_length int
    The minimum length of the password that users are required to use. The maximum length is always 64.
    non_alphanumeric bool
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number bool
    Whether passwords must contain at least one number.
    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.
    reuse bool
    Whether to forbid password reuse when users change their password.
    reuse_amount int
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporary_lock bool
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporary_lock_attempts int
    The number of failed login attempts allowed before an account is temporarily locked.
    temporary_lock_duration str
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase bool
    Whether passwords must contain at least one uppercase letter.
    anyLetter Boolean
    Whether passwords must contain at least one letter, either uppercase or lowercase.
    disabled Boolean
    Setting this to true will disallow using password authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use passwords.
    disallowEmailMatch Boolean
    Whether to reject passwords that match the user's email address or its local-part (the segment before @), case-insensitively. The check is skipped if the user's email is not known at validation time.
    disallowedCharacters String
    Reject passwords containing any of these characters. Each character in the string is treated as a forbidden literal (e.g., "'" to reject single and double quotes).
    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 for password reset emails, taken from a descope.EmailTemplate resource with its method set to password. The same template serves both the magic link and enchanted link reset flows. An empty value (the default) selects the built-in System template.
    enforceStrength String
    Use zxcvbn to calculate the strength of a given password and enforce a minimum level of strength.
    expiration Boolean
    Whether users are required to change their password periodically.
    expirationWeeks Number
    The number of weeks after which a user's password expires and they need to replace it.
    lock Boolean
    Whether the user account should be locked after a specified number of failed login attempts.
    lockAttempts Number
    The number of failed login attempts allowed before an account is locked.
    lowercase Boolean
    Whether passwords must contain at least one lowercase letter.
    maskErrors Boolean
    Prevents information about user accounts from being revealed in error messages, e.g., whether a user already exists.
    minLength Number
    The minimum length of the password that users are required to use. The maximum length is always 64.
    nonAlphanumeric Boolean
    Whether passwords must contain at least one non-alphanumeric character (e.g. !, @, #).
    number Boolean
    Whether passwords must contain at least one number.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    reuse Boolean
    Whether to forbid password reuse when users change their password.
    reuseAmount Number
    The number of previous passwords whose hashes are kept to prevent users from reusing old passwords.
    temporaryLock Boolean
    Whether the user account should be temporarily locked after a specified number of failed login attempts.
    temporaryLockAttempts Number
    The number of failed login attempts allowed before an account is temporarily locked.
    temporaryLockDuration String
    The amount of time before the user can sign in again after the account is temporarily locked.
    uppercase Boolean
    Whether passwords must contain at least one uppercase letter.

    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