Microsoft Lists API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "microsoft_lists",
  "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": {
    "site_name": "target_site_name",
    "auth_method": "AUTHORIZATION_CODE",
    "site_id": "target_site_id",
    "schema": "schema_name"
  },
  "auth": {
    "tenant_id": "41db1ebd-41a6-4dda-8029-5dd8f227d843",
    "refresh_token": "my_refresh_token",
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Config parameters

Name	Description
`site_name`	The Name of the SharePoint site. The Site Name is the `name` field in the Graph API response for sites.
`auth_method`	Authentication Method
`site_id`	The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the `id` field in the Graph API response for sites.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access and refresh_token parameters in the auth section.

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

{
  "service": "microsoft_lists",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    },
    "refresh_token": "my_refresh_token"
  }
}

Auth Parameters

Name	Description
`refresh_token`	The long-lived Refresh token carries the information necessary to get a new access token for API resources.
`client_access`
`client_access.client_secret`	`Client Secret` of your Microsoft client application.
`client_access.client_id`	`Client ID` of your Microsoft client application.

Permissions Required

If the customer wants to grant access to all SharePoint sites, the following Delegated scopes must be provided to their app:
- Sites.Read.All
- Files.Read
- offline_access
If the customer prefers not to grant broad-level access, they can instead use the more granular Application permission:
- sites.selected

By using the Connect Card or the Fivetran dashboard.