CognitoIdentityProvider / Client / delete_user_attributes

delete_user_attributes#

CognitoIdentityProvider.Client.delete_user_attributes(**kwargs)#

Deletes the attributes for a user.

Authorize this action with a signed-in user’s access token. It must include the scope aws.cognito.signin.user.admin.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

See also: AWS API Documentation

Request Syntax

response = client.delete_user_attributes(
    UserAttributeNames=[
        'string',
    ],
    AccessToken='string'
)
Parameters:

  • UserAttributeNames (list) –

    [REQUIRED]

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

    For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

    • (string) –

  • AccessToken (string) –

    [REQUIRED]

    A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Represents the response from the server to delete user attributes.

Exceptions