Amazon Cognito · JSON Structure

Cognito Idp Password Policy Type Structure

The password policy type.

Type: object Properties: 6
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

PasswordPolicyType is a JSON Structure definition published by Amazon Cognito, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

MinimumLength RequireUppercase RequireLowercase RequireNumbers RequireSymbols TemporaryPasswordValidityDays

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "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>"
        }
      ]
    }
  },
  "description": "The password policy type.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-password-policy-type-structure.json",
  "name": "PasswordPolicyType"
}