AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest

Objective-C

@interface AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest

Swift

class AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest

Represents the request to delete user attributes as an administrator.

Required parameters: [UserPoolId, Username, 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable userAttributeNames;

    Swift

    var userAttributeNames: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable username;

    Swift

    var username: String? { get set }