Amazon Cognito · Schema

AdminDeleteUserRequest

Represents the request to delete a user as an administrator.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

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

JSON Schema

user-pools-admin-delete-user-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-delete-user-request-schema.json",
  "title": "AdminDeleteUserRequest",
  "description": "Represents the request to delete a user as an administrator.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool where you want to delete the user."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name of the user you want to delete."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username"
  ]
}