Admin Delete User Attributes

cognitoidentityprovider_admin_delete_user_attributes

R Documentation

Deletes attribute values from a user

Description

Deletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer have this attribute.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_delete_user_attributes(UserPoolId,
  Username, UserAttributeNames)

Arguments

UserPoolId

[required] The ID of the user pool where you want to delete user attributes.

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

UserAttributeNames

[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.

Value

An empty list.

Request syntax

svc$admin_delete_user_attributes(
  UserPoolId = "string",
  Username = "string",
  UserAttributeNames = list(
    "string"
  )
)