Veeva Vault API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "veeva_vault",
  "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
  },
  "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": "SOURCE_NAMING",
  "config": {
    "authentication_method": "Basic | OAuth2",
    "base_url": "my-org.veevavault.com",
    "client_id": "my_client_id",
    "client_secret": "my_client_secret",
    "o_auth_service_token_url": "https://login.veevavault.com/auth/oauth/token/v1",
    "oidc_profile_id": "my_oidc_profile_id",
    "password": "password",
    "scope": "openid",
    "username": "username",
    "vault_dns": "my-vault.veevavault.com",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`authentication_method`	(Optional) Authentication type (default value is `Basic`)
`base_url`	Base URL of your Veeva Vault instance
`client_id`	OAuth2 client ID (only when authentication_method is `OAuth2`)
`client_secret`	OAuth2 client secret (only when authentication_method is `OAuth2`)
`o_auth_service_token_url`	OAuth2 authorization server token endpoint URL (only when authentication_method is `OAuth2`)
`oidc_profile_id`	OIDC profile ID configured in Veeva Vault (only when authentication_method is `OAuth2`)
`password`	Password (only when authentication_method is `Basic`)
`scope`	OAuth2 scope (only when authentication_method is `OAuth2`)
`username`	Username (only when authentication_method is `Basic`)
`vault_dns`	(Optional) Target Vault DNS if different from default (only when authentication_method is `OAuth2`)
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

Basic authentication: By specifying the authentication_method as "Basic" and the values for the username, password and base_url parameters in the request.

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

{
  "service": "veeva_vault",
  "group_id": "group_id",
  "config": {
    "username": "username",
    "password": "password",
    "base_url": "my-org.veevavault.com",
    "authentication_method": "Basic"
  }
}

OAuth2.0 authentication: By specifying the authentication_method as "OAuth2" and the values for the client_id, client_secret, scope, oidc_profile_id, o_auth_service_token_url, vault_dns and base_url parameters in the request.

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

{
  "service": "veeva_vault",
  "group_id": "group_id",
  "config": {
    "client_id": "my_client_id",
    "client_secret": "my_client_secret",
    "scope": "openid",
    "oidc_profile_id": "my_oidc_profile_id",
    "o_auth_service_token_url": "https://login.veevavault.com/auth/oauth/token/v1",
    "vault_dns": "my-vault.veevavault.com",
    "base_url": "my-org.veevavault.com",
    "authentication_method": "OAuth2"
  }
}

By using the Connect Card or the Fivetran dashboard.