Amazon Cognito · Schema

AdminSetUserPasswordRequest

AdminSetUserPasswordRequest schema from Amazon Cognito API

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
Username object
Password object
Permanent object
View JSON Schema on GitHub

JSON Schema

user-pools-admin-set-user-password-request-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-admin-set-user-password-request-schema.json",
  "title": "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"
  ]
}