SharePoint connector schema

Reference for every field in the SharePoint native connector configuration JSON.

Overview

This page documents each property in the SharePoint connector config. For guidance on how to use these settings, see SharePoint connector config. Full endpoint details live in the API Reference.

Config

Property	Description	Type	Default
`Credentials`	The credentials used to access SharePoint via both the Graph API and the REST API. Once supplied, these values are encrypted and moved into the `EncryptedCredentials` property.	Object (SharePointCredentials)
`EncryptedCredentials`	The encrypted credentials supplied via the `Credentials` property.	Object (SharePointCredentials)
`DocumentLevelSecurityEnabled`	Set to `true` to apply permissions to the synchronised content.	Boolean	`True`
`MaxDriveItemAgeInDays`	If specified, drive items older than this are not synchronised.	Integer
`SiteOptions`	Options to define which sites are or are not synchronised.	Object (SharePointSiteOptions)
`UsersOptions`	Options to define which users are or are not synchronised.	Object (SharePointUsersOptions)
`FacetTypeNameMappings`	A collection of SharePoint entity facet type name mappings. If none are supplied, the defaults are used.	Object (FacetTypeNameMapping)
`TaxonomyTypeNameMappings`	A collection of standard taxonomy field mappings for default metadata associated with synchronised entities. If none are supplied, the defaults are used.	Object (TaxonomyTypeNameMapping)
`IconSources`	Options to configure icons used for folders, specific file extensions, and a default icon.	Object (IconSources)
`UserLookupDomainReplacement`	Replaces the domain in the user email address with another domain, which is then used to look up the user within the intranet.	Object (UserLookupDomainReplacement)
`IsEnabled`	Set to `true` for this connector synchronisation to be performed.	Boolean	`True`
`LogEventLevel`	The logging level for log messages. Values: `Verbose`, `Debug`, `Information`, `Warning`, `Error`.	Enum	`Information`
`PerformUserAccessControlDigestion`	Set to `true` for this connector to perform user external identities synchronisation.	Boolean	`True`
`PerformDocsDigestion`	Set to `true` for this connector to perform docs synchronisation.	Boolean	`True`

SharePointCredentials

Property	Description	Type
`ApplicationClientId`		String
`DirectoryTenantId`		String
`SecretId`		String
`SecretValue`		String
`TenantName`	For example, `{{tenant_name}}.onmicrosoft.com`.	String

SharePointSiteOptions

Property	Description	Type	Default
`SitesListingMode`	Synchronise all sites (with a disallowed list) or specific allowed sites. Values: `AllSites`, `SpecificSites`.	Enum	`SpecificSites`
`AllSitesListingOptions`	Used if `SitesListingMode` is `AllSites`.	Object (AllSitesListingOptions)
`SpecificSitesListingOptions`	Used if `SitesListingMode` is `SpecificSites`.	Object (SpecificSitesListingOptions)
`SpecificSiteOptions`	A collection of site options corresponding to specific sites.	Object (SpecificSiteOptions)
`ListFilters`	Default list filter settings applied to all sites by default. Can be overridden per site within `SpecificSiteOptions`.	Object (ItemFilters)
`DriveFilters`	Default drive filter settings applied to all sites by default. Can be overridden per site within `SpecificSiteOptions`.	Object (ItemFilters)

SharePointUsersOptions

Property	Description	Type	Default
`UsersListingMode`	Synchronise all users (with a disallowed list) or specific users. Values: `AllUsers`, `SpecificUsers`.	Enum	`SpecificUsers`
`AllUsersListingOptions`	Used if `UsersListingMode` is `AllUsers`.	Object (AllUsersListingOptions)
`SpecificUsersListingOptions`	Used if `UsersListingMode` is `SpecificUsers`.	Object (SpecificUsersListingOptions)

FacetTypeNameMapping

Property	Description	Type	Default
`Type`	The SharePoint entity type these settings apply to. Values: `SiteCollection`, `Site`, `SiteDrive`, `SiteDriveFile`, `SiteDriveFolder`, `SiteList`, `SiteListItem`, `SiteListItemAttachment`, `SitePage`.	Enum	`SiteCollection`
`Name`	The custom name to use for this SharePoint entity type.	String

TaxonomyTypeNameMapping

Property	Description	Type	Default
`Type`	The taxonomy type these settings apply to. Values: `SiteCollection`, `Site`, `SiteDrive`, `SiteList`, `FileExtension`, `Directory`.	Enum	`SiteCollection`
`Name`	The custom name for this taxonomy type, that is, how it appears in your intranet.	String

IconSources

Property	Description	Type
`SiteCollection`	Overrides the default icon used for site collections during indexing.	Object (IconSource)
`Site`	Overrides the default icon used for sites during indexing.	Object (IconSource)
`SiteDrive`	Overrides the default icon used for site drives during indexing.	Object (IconSource)
`SiteDriveFile`	Overrides the default icon used for site drive files during indexing. This is the fallback icon when an icon is not configured for the file extension.	Object (IconSource)
`SiteDriveFolder`	Overrides the default icon used for site drive folders during indexing.	Object (IconSource)
`SiteList`	Overrides the default icon used for site lists during indexing.	Object (IconSource)
`SiteListItem`	Overrides the default icon used for site list items during indexing.	Object (IconSource)
`SiteListItemAttachment`	Overrides the default icon used for site list item attachments during indexing. This is the fallback icon when an icon is not configured for the file extension.	Object (IconSource)
`FileExtensions`	Defines how the icon for any specific file extension is evaluated.	Object (FileExtensionIconSource)

UserLookupDomainReplacement

Property	Description	Type
`OriginalDomain`	The domain to match in the user email address.	String
`ReplacementDomain`	What the original domain is replaced with in the user email address.	String

AllSitesListingOptions

Property	Description	Type	Default
`IncludeSites`	Set to `true` to synchronise non team/group sites.	Boolean	`True`
`IncludeTeamSites`	Set to `true` to synchronise team/group sites.	Boolean	`True`
`FetchSubSites`	Set to `true` to synchronise child sites of any root-level or team/group sites that are detected and synchronised. The `DisallowedSites` property also applies to child sites.	Boolean
`DisallowedSites`	A list of sites (relative paths) not to synchronise.	Array (String)

SpecificSitesListingOptions

Property	Description	Type
`AllowedSites`	A list of sites (relative paths) to synchronise.	Array (String)
`FetchSubSites`	Set to `true` to synchronise child sites of any root-level or team/group sites specified in `AllowedSites`.	Boolean

SpecificSiteOptions

Property	Description	Type
`Site`	The name of the site these settings apply to.	String
`ListFilters`	If supplied, these list filter settings are used instead of the default list filter settings.	Object (ItemFilters)
`DriveFilters`	If supplied, these drive filter settings are used instead of the default drive filter settings.	Object (ItemFilters)
`SpecificListOptions`	A collection of specific list options for this site.	Object (SpecificListOptions)
`SpecificDriveOptions`	A collection of specific drive options for this site.	Object (SpecificDriveOptions)
`ForceResync`	Force this site to be synchronised again, including all of its drives and lists.	Boolean

ItemFilters

Property	Description	Type	Default
`Mode`	Values: `All`, `Specific`.	Enum	`Specific`
`AllModeOptions`		Object (AllItemsFilterOptions)
`SpecificModeOptions`		Object (SpecificItemsFilterOptions)

AllUsersListingOptions

Property	Description	Type
`DisallowedUsers`	A list of emails, user principal names, or IDs not to synchronise.	Array (String)

SpecificUsersListingOptions

Property	Description	Type
`AllowedUsers`	A collection of user emails, user principal names, or IDs to synchronise.	Array (String)

IconSource

Property	Description	Type
`Url`	If provided, this URL is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String
`AssetId`	If provided, this asset ID is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String

FileExtensionIconSource

Property	Description	Type
`FileExtensions`	A comma-delimited list of file extensions these settings apply to, for example `.png,.jpg`.	String
`Url`	If provided, this URL is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String
`AssetId`	If provided, this asset ID is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String

SpecificListOptions

Property	Description	Type
`List`	The name of the list these settings apply to.	String
`Columns`	A collection of list columns and settings to synchronise.	Object (ListColumnIndexSettings)
`AvatarPathBuilder`	Specifies which column, or combination of columns, provides the `AvatarPath` used to display the icon of the list item.	Object (ValueBuilderDefinition)
`ForceResync`	Force this list to be synchronised again.	Boolean

SpecificDriveOptions

Property	Description	Type
`Drive`	The name of the drive these settings apply to.	String
`ForceResync`	Force this drive to be synchronised again.	Boolean

AllItemsFilterOptions

Property	Description	Type
`Disallowed`		Array (String)

SpecificItemsFilterOptions

Property	Description	Type
`Allowed`		Array (String)

ListColumnIndexSettings

Property	Description	Type
`SharePointDisplayName`	The display name of the list column to synchronise.	String
`IndexedAs`	If a value is supplied, it is used as the name instead of the one used in SharePoint.	String

ValueBuilderDefinition

Property	Description	Type
`Parameters`		Object (ValueBuilderParameterDefinition)
`Format`		String

ValueBuilderParameterDefinition

Property	Description	Type
`Name`		String
`Path`		Array (String)

Section: Workplace Search