Data sharing

Secure data sharing is a fundamental capability enabling controlled access to data assets while maintaining strict compliance with security standards. By enabling secure and structured sharing, Veracity not only protects sensitive information but also facilitates the generation of insights across organizational boundaries—turning data into actionable value. Veracity supports granular sharing options, allowing data to be shared either with individual users or with entire workspaces, and with configurable read or write permissions. This flexibility empowers teams to collaborate effectively while maintaining full control over data access.

Veracity supports granular sharing options, allowing data to be shared either with individual users or with entire workspaces, and with configurable read or write permissions. This flexibility empowers teams to collaborate effectively while maintaining full control over data access.

API

To browse the Data workbench API, see subsection Shares.

Base URL: https://api.veracity.com/veracity/dw/gateway/api/v2

Authentication: Authentication and subscription key is required for each API request, see details.

Share-request API lifecycle

Use the share-request endpoints to create, retrieve, query, resolve, or delete requests for sharing structured data. All paths use the lowercase sharerequests segment.

Method	Endpoint	Purpose
POST	/workspaces/{workspaceId}/sharerequests	Create a share request.
POST	/workspaces/{workspaceId}/sharerequests/query	Query requests in which the workspace is the requestor or receiver.
GET	/workspaces/{workspaceId}/sharerequests/{shareRequestId}	Retrieve one request.
POST	/workspaces/{workspaceId}/sharerequests/{shareRequestId}/accept	Accept one request.
POST	/workspaces/{workspaceId}/sharerequests/{shareRequestId}/decline	Decline one request.
POST	/workspaces/{workspaceId}/sharerequests/resolve	Accept, decline, revert, or abandon multiple requests.
DELETE	/workspaces/{workspaceId}/sharerequests	Delete one or more requests.

For query and get operations, use isRequestor to indicate whether {workspaceId} is the requesting workspace. For the bulk resolve endpoint:

• For Accept and Decline, use the receiver workspace ID and add an optional receiverNote.
• For RevertToProposed and Abandon, use the requestor workspace ID. Abandon accepts an optional requestorNote; RevertToProposed does not accept notes.

The bulk resolve response contains one result per share-request ID. Check each result because some items can succeed while others fail.

When creating a request:

• Identify the receiver with either receiverWorkspaceId or receiverEmail, but not both.
• If you provide groupId, you must also provide receiverWorkspaceId.
• A request without a receiver must use the Proposed initial status.
• Provide schemaVersionId, or use schemaId only when the EnableCreateShareRequestWithSchemaId feature is enabled. Do not provide both.
• Use requestorNote for a note from the requestor. The older notes property is deprecated.

To delete requests, use the requestor workspace ID and provide the IDs in shareRequestIds. Deletion supports multiple requests, applies regardless of request status, and is idempotent.

For the corresponding UI workflow, see To request sharing a data set.

Invite users into workspace

• Add a user to a workspace and provide a role. The user has read or write access to data depending on role.
• Create a service principal within the workspace for application integration. Service principals have read access to all data in the workspace by default.

Share data to user

• Share selected dataset to a user using email.
• Share selected file or folder to a user using email.

Share data to a workspace

• Share selected dataset to a workspace.
• Share selected file or folder to a workspace.

Share access using SAS keys

• Share access to selected dataset, or all datasets, by generating SAS key for dataset.
• Share access to files by generating SAS key for workspace, folder or file.

Regions

When sharing files, folder or dataset to a user; that user will see these shared datasets/files under Data Catalog/Shared with me in all workspaces he is member of as long as the workspace is in the same region as the region data was shared from. I.e, data from US can only be viewed in another workspace located in US.

Share single dataset to individual user (B2C sharing)

From Data Catalog, select dataset and share to user using email. User can be external to the tenant. The receiver will receive an email and when opening the workspace they can only see the dataset shared to them. Dataset can be viewed and downloaded.

If receiver is already member of one or several workspaces; shared data is visible in each of his workspaces from Data Catalogue/Shared-to-me. This dataset is not visible in Analytics environment. The shared dataset using this sharing is not visible for other users in the receivers workspaces.

Receivers can chosoe to add the shared dataset into current workspace and make the shared dataset available for all users in this workspace. Select dataset from shared to me and then button "Add to Workspace". The dataset is now shared with a B2B sharing and this sharing is available the next time someone shares from the orginal workspace. The dataset is now available in the Analytics Environment.

Share single dataset to another workspace (B2B sharing)

If a dataset is shared from workspace A to a user and receiver adds this dataset to his workspace B, a workspace sharing is enabled between workspace A and B. Next time someone shares from workspace A, the "sharer" can select workspace B automatically from the dropdown list. All users in workspace B, can see the shared dataset in Data Catalog. The dataset is now available in the Analytic Environment (if environment is enabled).

Share datasets using SAS key

Select dataset and generate SAS access keys. This key is read-only and lasts until the given end date. From API, you can generate a SAS token for the whole workspace or for an individual dataset.

Share single file or folder to individual user (B2C sharing)

Select single file or whole folder and select share icon. User can be external to the tenant. The receiver will receive an email and when opening the workspace they can only see the files/folders shared to them.

If receiver is already member of one or several workspaces; shared data is visible in each of his workspaces from Data Catalogue/Shared-to-me. These files are not visible in Analytics environment. The shared files using this sharing is not visible for other users in the receiver's workspace(s).

These files are not available in the Analytics environment.

*Adding shared files to a workspace will soon be available.

Share single file or folder to another workspace (B2B sharing)

If a file or folder is shared from workspace A to a user and receiver adds this file to his workspace B, a workspace sharing is enabled between workspace A and B. Next time someone shares from workspace A, the "sharer" can select workspace B automatically from the dropdown list.

Share files using SAS key

From File storage, SAS keys can be generated for a single file, a folder, or at workspace level. To generate a SAS token, call the endpoint: POST: https://api.veracity.com/veracity/dw/gateway/api/v2/workspaces/{workspaceId}/storages/sas

If using ?format=object in query string, the SAS URI is received as an object parsed into sasToken and resourceUri.

Code Example See how to receive SAS keys using APIs.

Revoke sharing

A sharing to user or to workspace can be revoked and receiver will no longer see the shared data.

Get share owner info

Use this endpoint to query share-owner information for one or more dataset IDs.

POST {baseUrl}/workspaces/{workspaceId}/shares/sharedby/query

BODY

{
  "datasetIds": [
    "string"
  ]
}