Amazon Cognito · JSON Structure

User Pools Admin Set User Password Request Structure

AdminSetUserPasswordRequest schema from Amazon Cognito API

Type: object Properties: 4 Required: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

UserPoolId Username Password Permanent

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-admin-set-user-password-request-structure.json",
  "name": "AdminSetUserPasswordRequest",
  "description": "AdminSetUserPasswordRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool where you want to set the user's password."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name of the user whose password you want to set."
        }
      ]
    },
    "Password": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PasswordType"
        },
        {
          "description": "The password for the user."
        }
      ]
    },
    "Permanent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": " <code>True</code> if the password is permanent, <code>False</code> if it is temporary."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "Password"
  ]
}