On This Page

Overview

The User Mappings report for a given job presents the results of how source users and groups were mapped to destination users and groups during the migration. Each row shows a source identity, the corresponding destination identity it was matched to (if any), and the resolution method used to make that match. For data to appear on this tab, the job must have run at least once, and Permission Preservation (or owner preservation) must be enabled. If these conditions are not met, the tab will display a message explaining why user mappings are unavailable and how to resolve the issue.

Resolution Statuses

The Resolution column identifies how the source user/group was matched to the destination user/group (or if it was not matched). Values include:

Exception: Resolved via a manually defined mapped exception (explicit mapping rule)
Email: Resolved by matching email addresses
ID: Resolved by matching platform IDs
Username: Resolved by matching usernames
Name: Resolved by matching names
Provision: The user/group was provisioned (created) on the destination
Passthrough: The source identity was passed through as-is to the destination
External: Resolved as an external user
Default: Fell back to a default mapping
Unresolved: No match was found for this user/group

Filtering the Grid

You can filter the grid to narrow the results. The Resolution filter allows you to view groups or users based on the method used to resolve the mapping. Use the User or Group filter to view only users or groups, respectively.

Viewing Affected Items

To view the items affected by the permissions resolution, click the ellipses at the end of the row and click Show affected items. This will navigate to the Items page with the grid filtered to show only the items associated with that mapping.

Exporting the Report

To export the user mappings data, click the Export this report button located in the grid header, next to the count of users and groups identified. This will download a CSV file to your browser. The export respects any filters or search criteria currently applied to the grid.

The first row of the export contains column headers, followed by one row per user or group mapping entry. The exported CSV contains the following 12 columns in this order:

Report Column	Description

Report Column	Description
`type`	Indicates whether the mapping entry is for an individual user account or a group. The value will be either "account" (for users) or "group" (for groups).
`job_name`	The name of the migration job that produced this mapping entry. This is especially useful when exporting mappings across multiple jobs, as it tells you which specific job each row belongs to.
`source_id`	The unique identifier (ID) of the user or group on the source platform. This is the platform-specific ID assigned by the source system (for example, a Box user ID, SharePoint SID, etc.).
`source_username`	The login username of the user or group on the source platform. For user accounts, this is typically the login name (for example, jdoe or john.doe@company.com). For groups, this field is generally empty.
`source_name`	The name property of the user or group on the source platform. For user accounts, this maps to the email address. For groups, this is the group name.
`source_caption`	The display name (human-readable name) of the user or group on the source platform. For user accounts, this is typically the full name (for example, "John Doe"). For groups, this is the group's display name.
`destination_id`	The unique identifier (ID) of the matched user or group on the destination platform. If the mapping was unresolved, this field may be empty.
`destination_username`	The login username of the matched user or group on the destination platform. Similar to `source_username`, but for the destination side.
`destination_name`	The name property of the matched user or group on the destination platform. For accounts, this is typically the email address; for groups, it is the group name.
`destination_caption`	The display name (human-readable name) of the matched user or group on the destination platform.
`resolution`	Describes how the source user/group was matched to the destination user/group (or if it was not matched).
`message`	An optional text message providing additional context about the mapping result. This typically contains the reason a mapping was skipped or any error/warning information encountered during the resolution process. It corresponds to the SkipReason from the mapping context. If the mapping resolved successfully with no issues, this field may be empty.

Microsoft Excel has a maximum limit of 1,048,576 rows. When opening the export file, Excel displays a message to warn you if your file exceeds the maximum supported rows; any excess content is not displayed. See Microsoft’s Excel specifications and limits for more information. Refer to Exporting Large Data Sets in Chunks if you need to export more than the maximum limit.

User Mapping Reports Using the REST API

The "resolution" indicates how the permission was mapped, such as by exception mapping, account map, email, or external account. The “permissions" value indicates how many items are shared with the user.

GET {{url}}v1/transfers/{job_id}/security_map?include=all

.......
...........
    },
    "item": [
          {
            "id": "54604b5d86a344ca8040f73f867cc980",
            "source": {
                "name": "John Smith 2",
                "email": "jsmith2@email.com",
                "id": "1497385045",
                "type": "account"
            },
            "resolution": "exception",
            "permissions": 6
        },
        {
            "id": "44b1bf8179f9467b8f91126cba578bee",
            "source": {
                "name": "John Smith 3",
                "email": "jsmith3@email.com",
                "id": "389034265",
                "type": "account"
            },
            "resolution": "exception",
            "permissions": 7
        },
..........
......