DeleteUserAttributesRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DeleteUserAttributes operation. Deletes attributes from the currently signed-in user. For example, your application can submit a request to this operation when a user wants to remove their birthdate attribute value.

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

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.DeleteUserAttributesRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class DeleteUserAttributesRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The DeleteUserAttributesRequest type exposes the following members

Constructors

	Name	Description
	DeleteUserAttributesRequest()

Properties

Name Type Description

	Name	Type	Description
	AccessToken	System.String	Gets and sets the property AccessToken. A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for `aws.cognito.signin.user.admin`.
	UserAttributeNames	System.Collections.Generic.List<System.String>	Gets and sets the property UserAttributeNames. 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, for example `custom:department`. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

AccessToken

System.String

Gets and sets the property AccessToken.

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

UserAttributeNames

System.Collections.Generic.List<System.String>

Gets and sets the property UserAttributeNames.

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, for example custom:department.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer