The Permission Level Transfer Report can be exported through the DataHub Platform user interface or through the REST API. It provides the permissions assigned to each item at all levels of the hierarchy that were applied during transfer. The report includes only applied or equal permissions. The export does not include failed, skipped, or removed permissions.
In addition to providing information for the permissions applied for a job, the export can be used as a tool to expedite the creation of new permission mappings. The Permissions Import feature will accept the format of the Permission Level Transfer export, so you can use the export to create new permission maps as needed. Simply export the report, edit permissions as needed, and import the the CSV file as the permission mapping for the job you are creating.
The following features use permissions and will all generate the information for the report:
-
Basic transfer, Folder mapping, User account mapping, Network home drive mapping
-
Simulation Mode/Analyzer
-
Transfer in one direction with copy & both directions with sync
-
Jobs using Impersonation / Run as user
Understanding the Report
Below is an example of report. The two columns of note are the rights column and the access_control column.
The rights column identifies the access rights for a given item. Valid values are read, write, append, delete, read_permissions, write_permissions, read_write, and full.
The access_control column contains a flag that indicates if access should be granted (allow) or denied (deny).
Example CSV Report
Exporting the Report in the User Interface
The Permission report available for export in the DataHub user interface is a full permission export. The report is saved as a CSV file in your default downloads location. (Some browsers will also display the file at the bottom of the browser window for quick access.) You can export the report from the Jobs and Reports areas.
Exporting the Report through Jobs
-
Select Jobs.
-
Select the job for which you want to view the report.
-
Select Sharing Insights.
-
Select Export full permissions report.
Exporting the Report through Reports
If a report includes multiple jobs, the export will include the permissions for all jobs in the report group.
-
Select Reports.
-
Select View full report on the report widget for which you want to view the report.
-
Select Sharing Insights.
-
Select Export full permissions report.
Exporting the Report Through the REST API
When exporting the report using a REST API call, you have the option of receiving a link through the call or viewing the CSV data within the response.
Get a Download Link
The following request produces a response that contains an href link. Copy and paste the link into your browser to download the CSV file.
GET {{url}}v1/transfers/permissions
View the CSV in the response
The following request produces a response that contains the report information in CSV format within the body of the message.
GET {{url}}v1/transfers/permissions.csv
Requesting Specific Permissions Through the REST API
Through the REST API, you have the option to request permissions by job, user/account map, item, audit trail, or a combination of each. Each can be passed in as a query string parameter. See the examples below for usage.
|
OPTION |
Description |
QUERY STRING PARAMETER |
Example |
|---|---|---|---|
|
Transfer Item ID’s |
The transfer item identifier for the item located on the source platform |
"item" "item_id" "transfer_item_id" "items" "item_ids" "transfer_item_ids" |
GET {{url}}/v1/transfers/permissions?items
|
|
Include |
The indicator to include all |
“all” |
GET {{url}}/v1/transfers/permissions?include=all
|
|
Security Map ID’s |
The identifier assigned to the user mapped in the job leveraging the user / account map |
"security_map" "security_maps" "security_map_id" "security_map_ids" |
GET {{url}}/v1/transfers/permissions?security_map_ids
|
|
Job ID’s |
The identifier assigned to the job transferring the permissions and content |
"job" "jobs" "job_id" "job_ids" |
GET {{url}}/v1/transfers/permissions?jobs
|
|
audit_trail |
The audit category for content |
“null” (the permissions are new and haven’t been applied to the destination) “created-by” “modified-by”
|
GET {{url}}/v1/transfers/permissions?audit_trail
|
Example Requests
The following examples show how to use the query parameters in combination with each other.
In this example, the permission report request is for 2 jobs, for 3 users and 1 specific item (such as a folder)
GET {{url}}v1/transfers/permissions?include=all&job_ids={{job_id_1}},{{job_id_2}}&security_map_ids={{user_id_1}},{{user_id_2}},{{user_id_3}}&transfer_item_ids={{transfer_item_id_1}}
In this example, the permission report request will return all transfer permission levels by security map id’s for all items for a given job
GET {{url}}/v1/transfers/permissions?security_map_ids-all&job_ids={{job_id}}