Skip to main content
Skip table of contents

Digital Guardian

LAST UPDATED: 04/12/2024

Digital Guardian Analytics and Reporting Cloud (DG ARC) is an analytics, workflow and reporting cloud service that delivers holistic data protection. Leveraging streaming data from Digital Guardian endpoint agents and network sensors, ARC provides the overall visibility into system, user and data events.

D3 SOAR is providing REST operations to function with Digital Guardian.

Digital Guardian is available for use in:

D3 SOAR

V12.7.241+

Category

Endpoint Security

Deployment Options

Option II, Option IV

Connection

To connect to Digital Guardian from D3 SOAR, please follow this part to collect the required information below:

Parameter

Description

Example

Base URL

The Access Gateway Base URL that you got from Digital Guardian Portal.

https://accessgw-usw.msp.digitalguardian.com

Authorization URL

The Authorization Server URL that you got from Digital Guardian Portal.

https://authsrv.msp.digitalguardian.com

Client ID

The Client ID for the authentication that you got from the Digital Guardian portal.

2c2e****************827c

Client Secret

The Client Secret for the authentication that you got from the Client Secret on the Digital Guardian portal.

oec8****************22uE

Access Token

Creates Access Token for the integration commands.

****************

API Version

API Version.

1.0

Configuring Digital Guardian to Work with D3 SOAR

To get the values for you to connect to D3 SOAR, please refer to https://dg-partner-dgmc-arc.dgmcdemo.com/rest/1.0/help/externalSwaggerUI/index.html for more details.

Configuring D3 SOAR to Work with Digital Guardian

  1. Log in to D3 SOAR.

  2. Find the Digital Guardian integration.

a. Navigate to Configuration on the top header menu.

b. Click on the Integration icon on the left sidebar.

c. Type Digital Guardian in the search box to find the integration, then click it to select it.

d. Click + Connection, on the right side of the Connections section. A new connection window will appear.

  1. Configure the following fields to create a connection to Digital Guardian.

a. Connection Name: The desired name for the connection.

b. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

c. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

d. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

e. Description (Optional): Add your desired description for the connection.

f. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

g. Configure User Permissions: Defines which users have access to the connection.

h. Active: Check the tick box to ensure the connection is available for use.

i. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.

1. Input the domain level Server URL.

2. Input Client ID.

3. Input Client Secret.

4. Input Auth Server.

5. Input API Version. The default value is 1.0.

j. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

  1. Test the connection.

a. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

b. Click OK to close the alert window.

c. Click + Add to create and add the configured connection.

Commands

Digital Guardian includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Digital Guardian API, please refer to the Digital Guardian API reference.

Get Items Request

Request data from export profile.

Input

Input Parameter

Required/Optional

Description

Example

Export Profile

Optional

Export profile

No sample data

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
No Sample Data
Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE
No Sample Data

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Get Items Request failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Digital Guardian portal. Refer to the HTTP Status Code Registry for details.

Status Code: 403.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Invalid REST API URL!

Error Sample Data

Get Items Request failed.

Status Code: 403.

Message: Invalid REST API URL!

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.