Microsoft Dynamics 365 CRM API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

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

{
  "group_id": "group_id",
  "service": "dynamics_365",
  "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",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "auth_type": "SERVICE_PRINCIPAL | OAUTH2",
    "domain_name": "domain_name",
    "resource_url": "resource_url",
    "schema": "schema_name"
  },
  "auth": {
    "client_access": {
      "client_id": "service_principal_client_id",
      "client_secret": "service_principal_client_secret"
    },
    "refresh_token": "my_refresh_token"
  }
}

Config parameters

Name	Description
`auth_type`	Authentication mechanism. Either one of `OAUTH2`, or `SERVICE_PRINCIPAL`. Default value `OAUTH2`
`domain_name`	The custom domain name associated with Dynamics 365.
`resource_url`	URL at which Dynamics 365 is accessed
`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:

OAuth2: By specifying the values for the client_access and refresh_token parameters in the auth section and the auth_type as "OAUTH2" in the request.

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

{
  "service": "dynamics_365",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "client_id": "service_principal_client_id",
      "client_secret": "service_principal_client_secret"
    },
    "refresh_token": "my_refresh_token"
  },
  "config": {
    "auth_type": "OAUTH2"
  }
}

Auth Parameters

Name	Description
`client_access`
`client_access.client_id`	Client ID of your Dynamics 365 client application, or service principal.
`client_access.client_secret`	Client Secret of your Dynamics 365 client application, or service principal.
`refresh_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.

betaService Principal: By specifying the values for the client_access and refresh_token parameters in the auth section and the auth_type as "SERVICE_PRINCIPAL" in the request.

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

{
  "service": "dynamics_365",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "client_id": "service_principal_client_id",
      "client_secret": "service_principal_client_secret"
    },
    "refresh_token": "my_refresh_token"
  },
  "config": {
    "auth_type": "SERVICE_PRINCIPAL"
  }
}

Auth Parameters

Name	Description
`client_access`
`client_access.client_id`	Client ID of your Dynamics 365 client application, or service principal.
`client_access.client_secret`	Client Secret of your Dynamics 365 client application, or service principal.
`refresh_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.

By using the Connect Card or the Fivetran dashboard.