> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DataGrail

> How to set up the DataGrail connector, plus the actions that are available.

![DataGrail](https://stackone-logos.com/api/datagrail/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/datagrail/changelog.md)

[39 actions](#actions) · 1 auth method

Security

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/datagrail/guides/connector-profile/api-key.md)
>
> Requires API access to be enabled on your DataGrail environment by an Account Manager. The key is created in the DataGra...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/datagrail/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

39 actions

ActionDescription

List Assessments`datagrail_list_assessments`

Returns paginated list of assessments with optional filtering. Only returns current versions - superseded assessments ar...

Create Assessment`datagrail_create_assessment`

Create a new assessment from a template, optionally linked to systems. The assessment starts in not\_started status. The...

Get Assessment`datagrail_get_assessment`

Returns full assessment detail including the form with current answers, per-question visibility flags, progress, and app...

Submit Assessment Answers`datagrail_submit_assessment_answers`

Atomically submits one or more answers for an assessment. All answers are validated before any are persisted — if any an...

Assign Assessment Approver`datagrail_assign_assessment_approver`

Sets the assessment approver from an email, so a procurement system driving assessments over the API can route sign-off...

Approve Assessment`datagrail_approve_assessment`

Approves an assessment, so a procurement system driving assessments over the API can sign off without a user opening the...

Upload Assessment Document`datagrail_upload_assessment_document`

Uploads a document to an assessment. The document is attributed to one of your active users, identified by uploader\_emai...

Download Assessment PDF`datagrail_download_assessment_pdf`

Download a completed assessment as a PDF document. Only available for assessments in approved status.

List Assessment Templates`datagrail_list_assessment_templates`

Returns paginated list of assessment templates available to the customer, including platform defaults.

Get Assessment Template`datagrail_get_assessment_template`

Returns full assessment template detail including sections and question schema. Divider-type questions are excluded.

List Consent Audit Log Exports`datagrail_list_consent_audit_log_exports`

Returns a list of monthly consent audit log export files. Each export covers one calendar month and is updated nightly....

Download Consent Audit Log Export`datagrail_download_consent_audit_log_export`

Downloads the contents of a specific monthly audit log export file. The response is a JSON file containing an array of i...

List Data Discovery Integrations`datagrail_list_data_discovery_integrations`

GET a list of integrations for an authenticated agent.

Get Data Discovery Integration`datagrail_get_data_discovery_integration`

GET an RDD integration for an authenticated agent.

Create Data Discovery Integration`datagrail_create_data_discovery_integration`

POST RDD integration details for a system to be scanned using an authenticated agent. If successful, the newly created i...

Update Data Discovery Integration`datagrail_update_data_discovery_integration`

UPDATE RDD integration details for a system to be scanned using an authenticated agent. Note that names are required to...

Delete Data Discovery Integration`datagrail_delete_data_discovery_integration`

DELETE an RDD integration for an authenticated agent

List Opt Out Integrations`datagrail_list_opt_out_integrations`

Get a list of opt out integrations

Update Opt Out Integration`datagrail_update_opt_out_integration`

Update an opt out integration

List Opt Out Requests`datagrail_list_opt_out_requests`

Get a list of opt out requests

Get Opt Out Request`datagrail_get_opt_out_request`

Get an opt out request

Create Opt Out Request`datagrail_create_opt_out_request`

Create an opt out request

Update Opt Out Request`datagrail_update_opt_out_request`

Update an opt out request

Sync Remote Files To Integration`datagrail_sync_remote_files_to_integration`

Sync remote files to the integration

Upload Files To Integration`datagrail_upload_files_to_integration`

Upload files to the integration

List Privacy Request Integrations`datagrail_list_privacy_request_integrations`

Get a list of privacy request integrations

Update Privacy Request Integration`datagrail_update_privacy_request_integration`

Update a privacy request integration

List Privacy Request Policies`datagrail_list_privacy_request_policies`

Get a list of privacy request policies

List Privacy Requests`datagrail_list_privacy_requests`

Get a list of privacy requests

Get Privacy Request`datagrail_get_privacy_request`

Get a privacy request

Create Privacy Request`datagrail_create_privacy_request`

Create a privacy request

Update Privacy Request`datagrail_update_privacy_request`

Update a privacy request

Create Scan Schedule`datagrail_create_scan_schedule`

POST a cron expression to perform data discovery scans for a given integration. If successful, the newly created schedul...

List Scan Schedules`datagrail_list_scan_schedules`

GET a list of schedules for an integration.

Get Scan Schedule`datagrail_get_scan_schedule`

GET a schedule for an integration

Update Scan Schedule`datagrail_update_scan_schedule`

UPDATE the schedule of an integration.

Delete Scan Schedule`datagrail_delete_scan_schedule`

DELETE an integration schedule and use DataGrail defaults

List Security Audit Logs`datagrail_list_security_audit_logs`

Returns login and permission-decision audit log entries for the current customer. With no pagination parameter, up to 10...

Create Detected Objects`datagrail_create_detected_objects`

Create Detected Objects


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.