Amazon Cognito · Schema

PasswordPolicyType

The password policy type.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
MinimumLength object
RequireUppercase object
RequireLowercase object
RequireNumbers object
RequireSymbols object
TemporaryPasswordValidityDays object
View JSON Schema on GitHub

JSON Schema

user-pools-password-policy-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-password-policy-type-schema.json",
  "title": "PasswordPolicyType",
  "description": "The password policy type.",
  "type": "object",
  "properties": {
    "MinimumLength": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PasswordPolicyMinLengthType"
        },
        {
          "description": "The minimum length of the password in the policy that you have set. This value can't be less than 6."
        }
      ]
    },
    "RequireUppercase": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password."
        }
      ]
    },
    "RequireLowercase": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password."
        }
      ]
    },
    "RequireNumbers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "In the password policy that you have set, refers to whether you have required users to use at least one number in their password."
        }
      ]
    },
    "RequireSymbols": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password."
        }
      ]
    },
    "TemporaryPasswordValidityDays": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemporaryPasswordValidityDaysType"
        },
        {
          "description": "<p>The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.</p> <note> <p>When you set <code>TemporaryPasswordValidityDays</code> for a user pool, you can no longer set a value for the legacy <code>UnusedAccountValidityDays</code> parameter in that user pool.</p> </note>"
        }
      ]
    }
  }
}