/

POST

Deletes the user attributes in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "Username": "string",
    "UserAttributeNames": []
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to delete user attributes as an administrator.

UserPoolId

string

required

The user pool ID for the user pool where you want to delete user attributes.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Username

string <password>

required

The user name of the user from which you would like to delete attributes.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

UserAttributeNames

array[string]

required

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserNotFoundException

🟠485InternalErrorException

Modified at 2023-08-15 07:11:06