yandex_organizationmanager_idp_userpool (Resource)

A userpool is a container for users in the Identity Provider system.

Example usageExample usage

//
// Create a new OrganizationManager Idp Userpool.
//
resource "yandex_organizationmanager_idp_userpool" "example_userpool" {
  name              = "example-userpool"
  organization_id   = "your_organization_id"
  default_subdomain = "example-subdomain"
  description       = "Description example"

  labels = {
    example-label = "example-label-value"
  }

  user_settings = {
    allow_edit_self_login = true
  }

  password_quality_policy = {
    allow_similar   = true
    max_length      = 128
    match_length    = 4
    fixed = {
      lowers_required = true
      uppers_required = true
      digits_required = true
      min_length      = 8
    }
  }
}

Arguments & Attributes ReferenceArguments & Attributes Reference

• bruteforce_protection_policy [Block]. Bruteforce protection policy for this userpool.
  • attempts (Number). Number of failed attempts allowed within the window before blocking.
  • block (String). Duration of the block after too many failed attempts.
  • window (String). Time window for counting failed authentication attempts.
• created_at (Read-Only) (String). Timestamp when the userpool was created.
• default_subdomain (Required)(String). Default subdomain for the userpool.
• description (String). Description of the userpool.
• domains (Read-Only) (List Of String). List of domains associated with this userpool.
• id (String). ID of the userpool to return.
  To get the userpool ID, make a [UserpoolService.List] request.
• labels (Map Of String). Resource labels as key:value pairs.
• name (Required)(String). Name of the userpool.
• organization_id (Required)(String). ID of the organization this userpool belongs to.
• password_blacklist_policy [Block]. Password blacklist policy for this userpool.
  • check_common (Bool). Whether check in common password database is enabled. Default value is true.
• password_lifetime_policy [Block]. Password lifetime policy for this userpool.
  • max_days_count (Number). Maximum number of days a password remains valid.
    Zero means passwords never expire.
  • min_days_count (Number). Minimum number of days before a password can be changed.
• password_quality_policy [Block]. Password quality policy for this userpool.
  • allow_similar (Bool). Whether passwords similar to previous ones are allowed.
  • fixed [Block]. Fixed complexity requirements. Exactly one of complexity requirements must be specified.
    • digits_required (Bool). Whether digits are required in the password.
    • lowers_required (Bool). Whether lowercase letters are required in the password.
    • min_length (Number). Minimum length required for all passwords.
    • specials_required (Bool). Whether special characters are required in the password.
    • uppers_required (Bool). Whether uppercase letters are required in the password.
  • match_length (Number). Minimum length of substrings to check for similarity to vulnerable sequences.
  • max_length (Number). Maximum password length. Zero means no maximum length is enforced.
  • smart [Block]. Smart complexity requirements. Exactly one of complexity requirements must be specified.
    • four_classes (Number). For passwords with all four classes of characters
    • one_class (Number). For passwords with one class of characters
    • three_classes (Number). For passwords with three classes of characters
    • two_classes (Number). For passwords with two classes of characters
• status (Read-Only) (String). Current status of the userpool.
• timeouts [Block].
  • create (String). A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
  • delete (String). A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
  • read (String). A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
  • update (String). A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
• updated_at (Read-Only) (String). Timestamp when the userpool was last updated.
• user_settings [Block]. User settings for this userpool.
  • allow_edit_self_contacts (Bool). Whether users can edit their own contact information.
  • allow_edit_self_info (Bool). Whether users can edit their own profile information.
  • allow_edit_self_login (Bool). Whether users can edit their own login information.
  • allow_edit_self_password (Bool). Whether users can change their own passwords.
• userpool_id (String). ID of the userpool to return.
  To get the userpool ID, make a [UserpoolService.List] request.