Tfs User Mapping Tool

This is the JSON schema that defines the structure and validation rules for this configuration.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://devopsmigration.io/schema/schema.tools.tfsusermappingtool.json",
  "title": "TfsUserMappingTool",
  "description": "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.",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "identityFieldsToCheck": {
      "description": "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.",
      "type": "array"
    },
    "matchUsersByEmail": {
      "description": "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.",
      "type": "boolean"
    },
    "projectCollectionValidUsersGroupName": {
      "description": "This is the regionalized \"Project Collection Valid Users\" group name. Default is \"Project Collection Valid Users\".",
      "type": "string"
    },
    "skipValidateAllUsersExistOrAreMapped": {
      "description": "When set to true, this setting will skip a validation that all users exists or mapped",
      "type": "boolean"
    },
    "userMappingFile": {
      "description": "This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file.",
      "type": "string"
    }
  }
}