resetUserPassword method

Future<void> resetUserPassword({
  1. required String directoryId,
  2. required String newPassword,
  3. required String userName,
})

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
  • For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.

May throw DirectoryUnavailableException. May throw UserDoesNotExistException. May throw InvalidPasswordException. May throw UnsupportedOperationException. May throw EntityDoesNotExistException. May throw ClientException. May throw ServiceException.

Parameter directoryId : Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.

Parameter newPassword : The new password that will be reset.

Parameter userName : The user name of the user whose password will be reset.

Implementation

Future<void> resetUserPassword({
  required String directoryId,
  required String newPassword,
  required String userName,
}) async {
  ArgumentError.checkNotNull(directoryId, 'directoryId');
  ArgumentError.checkNotNull(newPassword, 'newPassword');
  _s.validateStringLength(
    'newPassword',
    newPassword,
    1,
    127,
    isRequired: true,
  );
  ArgumentError.checkNotNull(userName, 'userName');
  _s.validateStringLength(
    'userName',
    userName,
    1,
    64,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'DirectoryService_20150416.ResetUserPassword'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DirectoryId': directoryId,
      'NewPassword': newPassword,
      'UserName': userName,
    },
  );
}