Amazon Cognito · Schema

AdminDeleteUserAttributesRequest

Represents the request to delete user attributes as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

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

JSON Schema

cognito-idp-admin-delete-user-attributes-request-schema.json Raw ↑
{
  "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"
  ],
  "description": "Represents the request to delete user attributes as an administrator.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-admin-delete-user-attributes-request-schema.json",
  "title": "AdminDeleteUserAttributesRequest"
}