Guidewire Cloud Data Access API Configuration Private Preview

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "guidewire_cloud_data_access",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "config": {
    "access_key_id": "access_key_id_value",
    "access_key_secret": "access_key_secret_value",
    "auth_type": "IAM_ROLE | PUBLIC_BUCKET | ACCESS_KEY",
    "bucket": "bucket_name",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "is_private_link_required": true,
    "manifest_path": "CDA/manifest.json",
    "role_arn": "arn::your_role_arn",
    "schema": "schema_name",
    "table_group_name": "string"
  }
}

Config parameters

Name	Description
`access_key_id`	Access Key ID for access key authentication.
`access_key_secret`	Access Key Secret for access key authentication.
`auth_type`	Access approach. Supported values: IAM_ROLE, ACCESS_KEY, PUBLIC_BUCKET.
`bucket`	The S3 bucket name containing the Guidewire CDA export. Required for connector creation.
`connection_type`	Connection method. Default value: `Directly`.
`is_private_link_required`	Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
`manifest_path`	The path to the Guidewire CDA manifest.json file in the S3 bucket.
`role_arn`	The Role ARN required for IAM role authentication.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation
`table_group_name` (required)	Combined with the schema to form the Fivetran connection name `<schema>.<table_group_name>`. Lets you create multiple Merge Mode connections per schema.

Authorization

There are four ways to authorize this connector type:

IAM role: By specifying the auth_type as "IAM_ROLE" and the values for the role_arn, bucket and manifest_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "role_arn": "arn::your_role_arn",
    "bucket": "bucket_name",
    "manifest_path": "CDA/manifest.json",
    "auth_type": "IAM_ROLE"
  }
}

Access key: By specifying the auth_type as "ACCESS_KEY" and the values for the access_key_id, access_key_secret, bucket and manifest_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "access_key_id": "access_key_id_value",
    "access_key_secret": "access_key_secret_value",
    "bucket": "bucket_name",
    "manifest_path": "CDA/manifest.json",
    "auth_type": "ACCESS_KEY"
  }
}

Public bucket: By specifying the auth_type as "PUBLIC_BUCKET" and the values for the bucket and manifest_path parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "guidewire_cloud_data_access",
  "group_id": "group_id",
  "config": {
    "bucket": "bucket_name",
    "manifest_path": "CDA/manifest.json",
    "auth_type": "PUBLIC_BUCKET"
  }
}

By using the Connect Card or the Fivetran dashboard.