Tfs User Mapping Tool

The TfsUserMappingTool is used to map users from the source to the target system. Run it with the ExportUsersForMappingContext to create a mapping file then with WorkItemMigrationContext to use the mapping file to update the users in the target system as you migrate the work items.

Last updated: June 25, 2025 | Edit this page | Discuss this page

The TfsUserMappingTool is used to map users from the source to the target system. Run it with the ExportUsersForMappingContext to create a mapping file then with WorkItemMigrationContext to use the mapping file to update the users in the target system as you migrate the work items.

top

Options

Parameter Type Description Default Value
Enabled Boolean If set to true then the tool will run. Set to false and the processor will not run. missing XML code comments
IdentityFieldsToCheck List This is a list of the Identiy fields in the Source to check for user mapping purposes. You should list all identiy fields that you want to map. missing XML code comments
MatchUsersByEmail Boolean By default, users in source are mapped to target users by their display name. If this is set to true, then the users will be mapped by their email address first. If no match is found, then the display name will be used. missing XML code comments
UserMappingFile String This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file. missing XML code comments
top

Samples

top

Sample

Sample 

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsUserMappingTool": {
        "Enabled": "True",
        "IdentityFieldsToCheck": [
          "System.AssignedTo",
          "System.ChangedBy",
          "System.CreatedBy",
          "Microsoft.VSTS.Common.ActivatedBy",
          "Microsoft.VSTS.Common.ResolvedBy",
          "Microsoft.VSTS.Common.ClosedBy"
        ],
        "UserMappingFile": "C:\\temp\\userExport.json"
      }
    }
  }
}
top

Defaults

Defaults 

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsUserMappingTool": {
        "Enabled": "False",
        "IdentityFieldsToCheck": [
          "System.AssignedTo",
          "System.ChangedBy",
          "System.CreatedBy",
          "Microsoft.VSTS.Common.ActivatedBy",
          "Microsoft.VSTS.Common.ResolvedBy",
          "Microsoft.VSTS.Common.ClosedBy"
        ],
        "UserMappingFile": "C:\\temp\\userExport.json"
      }
    }
  }
}
top

Classic

Classic 

{
  "$type": "TfsUserMappingToolOptions",
  "Enabled": true,
  "IdentityFieldsToCheck": [
    "System.AssignedTo",
    "System.ChangedBy",
    "System.CreatedBy",
    "Microsoft.VSTS.Common.ActivatedBy",
    "Microsoft.VSTS.Common.ResolvedBy",
    "Microsoft.VSTS.Common.ClosedBy",
    "System.AssignedTo",
    "System.ChangedBy",
    "System.CreatedBy",
    "Microsoft.VSTS.Common.ActivatedBy",
    "Microsoft.VSTS.Common.ResolvedBy",
    "Microsoft.VSTS.Common.ClosedBy"
  ],
  "UserMappingFile": "C:\\temp\\userExport.json",
  "MatchUsersByEmail": false
}
top

Metadata

Metadata

Class Name
TfsUserMappingTool
Status
Missing XML Code Comments
Processing Target
missing XML code comments
Type
Tools
Previous Tfs Team Settings Tool
Next Tfs Validate Required Field Tool
Project Information
Azure DevOps Marketplace
Visual Studio Marketplace Stars View Extension
YouTube Channel
Youtube Subscribers Youtube Views
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Documentation Versions
Production Azure DevOps Migration Tools Release Version
Preview Azure DevOps Migration Tools Preview Version
Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation