Amazon Cognito · JSON Structure

User Pools Admin Delete User Attributes Request Structure

Represents the request to delete user attributes as an administrator.

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

AdminDeleteUserAttributesRequest 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

UserPoolId Username UserAttributeNames

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-delete-user-attributes-request-structure.json",
  "name": "AdminDeleteUserAttributesRequest",
  "description": "Represents the request to delete user attributes 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 user attributes."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name of the user from which you would like to delete attributes."
        }
      ]
    },
    "UserAttributeNames": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeNameListType"
        },
        {
          "description": "<p>An array of strings representing the user attribute names you want to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "UserAttributeNames"
  ]
}