Add Custom Integrations with WatchGuard CloudDR

Applies To: WatchGuard CloudDR

If you use a cloud application that is not currently supported with a CloudDR integration, you can add a custom integration. This guide describes how to add a custom integration to CloudDR.

To add a custom CloudDR integration, from WatchGuard Cloud:

In WatchGuard Cloud, select Configure > CloudDR.
Select the Integrations tab.
(Service Providers) From the Select Integrations View drop-down list, select Add Integrations.

From the left navigation pane, select Custom Integrations.
In the Custom Integration widget, click Add.
Click Start Integration.
On the Display Details page, enter these details:
1. Select a logo and enter your integration details:
  - Select Logo — You have two options to select a logo:
    - Choose Avatar Color — Select a color for your integration avatar.
    - Upload Avatar Image — Upload a custom image (maximum size: 5KB).
2. Integration Name — The name of the cloud service that the data belongs to.
3. Display Name (Alias) — An alias to describe the integration.
4. Select Data Source Type — Upload file, Google Drive File, or Microsoft OneDrive File. The requirements for the data file are:
  - File Size — Maximum file size: 50MB
  - Supported Formats — .CSV and .JSON files are supported
  - Template Files — Download template files to confirm the expected data format
Click Next.
On the Data Source Details page, upload your file.
(Optional) Download Template Files in .CSV or .JSON format.
(Optional) Click View Data Guide to view detailed information about the required data format for your integration. For more information, go to Data Format Guide.
Click Next.
On the Data Validation page, a sync begins. You can:
- Monitor Data Validation — You can monitor the data validation results to make sure your data is synced correctly and identify any issues.
- Fix Validation Issues — If validation fails, you must correct the data format and try again.
- Complete Integration — After validation is successful, you can complete the integration process.
Click Finish.

Data Format Guide

This Data Format guide provides detailed information about the required data format for your integration. Make sure your data follows these specifications exactly.

Required Fields

This field is mandatory and must be included in your data:

emailId — The email address of the user (must be a valid email format)

Optional Fields

These fields are optional and can be included if available:

firstName — The first name of the user (string)
lastName — The last name of the user (string)
role — The role of the user (must be one of):
- SUPER ADMIN, ADMIN, USER
createdOn — Date of creation (format: DDMMYYYY, e.g., 01012024)
userStatus — Status of the user (must be one of):
- ACTIVE, DISABLED, DELETED
accountType — Account type (must be one of):
- USER, SERVICE
department — Department of the user (string)
mfaEnrolmentStatus — MFA enrollment status (true/false)
accountPaymentStatus — Payment status (must be one of):
- PAID, UNPAID, NA

Data Format Examples

Examples of valid data entries:

JSON Format

Copy

{

{
  "firstName": "John",
  "lastName": "Doe",
  "emailId": "[email protected]",
  "department": "Engineering",
  "role": "ADMIN",
  "createdOn": "01012024",
  "mfaEnrolmentStatus": true,
  "userStatus": "ACTIVE",
  "accountPaymentStatus": "PAID",
  "accountType": "USER"
  }

CSV Format