adminUpdateUserAttributes method

Future<void> adminUpdateUserAttributes({ required List<AttributeType> userAttributes, required String userPoolId, required String username, Map<String, String>? clientMetadata, })

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

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

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Calling this action requires developer credentials.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw UnexpectedLambdaException. May throw UserLambdaValidationException. May throw InvalidLambdaResponseException. May throw AliasExistsException. May throw TooManyRequestsException. May throw NotAuthorizedException. May throw UserNotFoundException. May throw InternalErrorException. May throw InvalidSmsRoleAccessPolicyException. May throw InvalidEmailRoleAccessPolicyException. May throw InvalidSmsRoleTrustRelationshipException.

Parameter userAttributes : An array of name-value pairs representing user attributes.

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

Parameter userPoolId : The user pool ID for the user pool where you want to update user attributes.

Parameter username : The user name of the user for whom you want to update user attributes.

Parameter clientMetadata : A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Implementation

Future<void> adminUpdateUserAttributes({
  required List<AttributeType> userAttributes,
  required String userPoolId,
  required String username,
  Map<String, String>? clientMetadata,
}) async {
  ArgumentError.checkNotNull(userAttributes, 'userAttributes');
  ArgumentError.checkNotNull(userPoolId, 'userPoolId');
  _s.validateStringLength(
    'userPoolId',
    userPoolId,
    1,
    55,
    isRequired: true,
  );
  ArgumentError.checkNotNull(username, 'username');
  _s.validateStringLength(
    'username',
    username,
    1,
    128,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.AdminUpdateUserAttributes'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserAttributes': userAttributes,
      'UserPoolId': userPoolId,
      'Username': username,
      if (clientMetadata != null) 'ClientMetadata': clientMetadata,
    },
  );
}