Amazon Cognito · JSON Structure

User Pools Delete User Attributes Request Structure

Represents the request to delete user attributes.

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

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

Properties

UserAttributeNames AccessToken

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-delete-user-attributes-request-structure.json",
  "name": "DeleteUserAttributesRequest",
  "description": "Represents the request to delete user attributes.",
  "type": "object",
  "properties": {
    "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 prependattach the <code>custom:</code> prefix to the front of the attribute name.</p>"
        }
      ]
    },
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose attributes you want to delete."
        }
      ]
    }
  },
  "required": [
    "UserAttributeNames",
    "AccessToken"
  ]
}