Amazon Cognito · JSON Structure

Cognito Idp Change Password Request Structure

Represents the request to change a user password.

Type: object Properties: 3 Required: 3
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

ChangePasswordRequest is a JSON Structure definition published by Amazon Cognito, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PreviousPassword ProposedPassword AccessToken

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "PreviousPassword": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PasswordType"
        },
        {
          "description": "The old password."
        }
      ]
    },
    "ProposedPassword": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PasswordType"
        },
        {
          "description": "The new password."
        }
      ]
    },
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose password you want to change."
        }
      ]
    }
  },
  "required": [
    "PreviousPassword",
    "ProposedPassword",
    "AccessToken"
  ],
  "description": "Represents the request to change a user password.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-change-password-request-structure.json",
  "name": "ChangePasswordRequest"
}