Schema
Config
Credentials
The credentials used to access SharePoint Online via both the Graph API and the Rest API. Once supplied, these values will be encrypted and moved into the EncryptedCredentials property.
- Type: Object (See: SharePointCredentials)
EncryptedCredentials
The encrypted credentials that were supplied via the Credentials property
- Type: Object (See: SharePointCredentials)
DocumentLevelSecurityEnabled
Set to true to apply permissions to the synchronised content
- Type: Boolean
- Default: True
MaxDriveItemAgeInDays
If specified, then drive items older than this are not synchronised
- Type: Integer
SiteOptions
Options to define which sites will (or will not) be synchronised
- Type: Object (See: SharePointSiteOptions)
UsersOptions
Options to define which users will (or will not) be synchronised
- Type: Object (See: SharePointUsersOptions)
FacetTypeNameMappings
A collection of SharePoint entity facet type name mappings. If none are supplied then the defaults will be used.
- Type: Object (See: FacetTypeNameMapping)
TaxonomyTypeNameMappings
A collection of standard taxonomy field mappings for default meta data associated with synchronised entities. If none are supplied then the defaults will be used.
- Type: Object (See: TaxonomyTypeNameMapping)
IconSources
Options to configure icons that are used for folders, specific file extensions and a default icon
- Type: Object (See: IconSources)
UserLookupDomainReplacement
Can be used to replace the domain in the user email address with another domain, which is then used to perform a lookup of the user within the intranet
- Type: Object (See: UserLookupDomainReplacement)
IsEnabled
Set to true for this connector synchronisation to be performed
- Type: Boolean
- Default: True
LogEventLevel
The logging level for log messages to be recorded
- Type: Enum
- Values: Verbose, Debug, Information, Warning, Error, Fatal
- Default: Information
PerformUserAccessControlDigestion
Set to true for this connector to perform user external identities synchronisation for this connector
- Type: Boolean
- Default: True
PerformDocsDigestion
Set to true for this connector to perform docs synchronisation for this connector
- Type: Boolean
- Default: True
SharePointCredentials
ApplicationClientId
- Type: String
DirectoryTenantId
- Type: String
SecretId
- Type: String
SecretValue
- Type: String
TenantName
E.g. {TenantName}.onmicrosoft.com
- Type: String
SharePointSiteOptions
SitesListingMode
You can choose to synchronise all sites (and specifying a disallowed list) or specific allowed sites
- Type: Enum
- Values: AllSites, SpecificSites
- Default: SpecificSites
AllSitesListingOptions
If the SitesListingMode is AllSites then these settings are used
- Type: Object (See: AllSitesListingOptions)
SpecificSitesListingOptions
If the SitesListingMode is SpecificSites then these settings are used
- Type: Object (See: SpecificSitesListingOptions)
SpecificSiteOptions
A collection of site options corresponding to specific sites
- Type: Object (See: SpecificSiteOptions)
ListFilters
Default list filter settings that are applied to all sites by default. These settings can be overriden per site within the SpecificSiteOptions
- Type: Object (See: ItemFilters)
DriveFilters
Default drive filter settings that are applied to all sites by default. These settings can be overriden per site within the SpecificSiteOptions
- Type: Object (See: ItemFilters)
SharePointUsersOptions
UsersListingMode
You can choose to synchronise all users (and specifying a disallowed list) or specific users
- Type: Enum
- Values: AllUsers, SpecificUsers
- Default: SpecificUsers
AllUsersListingOptions
If the UsersListingMode is AllUsers then these settings are used
- Type: Object (See: AllUsersListingOptions)
SpecificUsersListingOptions
If the UsersListingMode is SpecificUsers then these settings are used
- Type: Object (See: SpecificUsersListingOptions)
FacetTypeNameMapping
Type
The SharePoint entity type that these settings apply to
- Type: Enum
- Values: SiteCollection, Site, SiteDrive, SiteDriveFile, SiteDriveFolder, SiteList, SiteListItem, SiteListItemAttachment, SitePage
- Default: SiteCollection
Name
The custom name that you want to use for this SharePoint entity type
- Type: String
TaxonomyTypeNameMapping
Type
The taxonomy type that these settings apply to
- Type: Enum
- Values: SiteCollection, Site, SiteDrive, SiteList, FileExtension, Directory
- Default: SiteCollection
Name
The custom name for this taxonomy type. I.e. how you want this to appear in your intranet.
- Type: String
IconSources
SiteCollection
If provided will override the default icon used for Site Collections during indexing
- Type: Object (See: IconSource)
Site
If provided will override the default icon used for Sites during indexing
- Type: Object (See: IconSource)
SiteDrive
If provided will override the default icon used for Site Drives during indexing
- Type: Object (See: IconSource)
SiteDriveFile
If provided will override the default icon used for Site Drive Files during indexing. This is the fallback icon for the site drive file, in case an icon is not configured for the file extension.
- Type: Object (See: IconSource)
SiteDriveFolder
If provided will override the default icon used for Site Drive Folders during indexing
- Type: Object (See: IconSource)
SiteList
If provided will override the default icon used for Site List during indexing
- Type: Object (See: IconSource)
SiteListItem
If provided will override the default icon used for Site List Items during indexing
- Type: Object (See: IconSource)
SiteListItemAttachment
If provided will override the default icon used for Site List Item Attachment during indexing. This is the fallback icon for the site list item attachment, in case an icon is not configured for the file extension.
- Type: Object (See: IconSource)
FileExtensions
Use these settings to define how the icon for any specific file extension should be evaluated
- Type: Object (See: FileExtensionIconSource)
UserLookupDomainReplacement
OriginalDomain
The domain to match in the user email address
- Type: String
ReplacementDomain
What the original domain should be replaced with in the user email address
- Type: String
AllSitesListingOptions
IncludeSites
Set to true to synchronise none team/group sites
- Type: Boolean
- Default: True
IncludeTeamSites
Set to true to synchronise team/group sites
- Type: Boolean
- Default: True
FetchSubSites
Set to true to synchronise any child sites of any root level sites or team/group sites that are detected and synchronised. The DisallowedSites property also applies to child sites.
- Type: Boolean
DisallowedSites
A list of sites (relative paths) that you do not want to synchronise
- Type: Array (String)
SpecificSitesListingOptions
AllowedSites
A list of sites (relative paths) that you want to synchronise
- Type: Array (String)
FetchSubSites
Set to true to synchronise any child sites of any root level sites or team/group sites that have been specified in AllowedSites
- Type: Boolean
SpecificSiteOptions
Site
The name of the site that these settings apply to
- Type: String
ListFilters
If supplied then these list filter settings are used instead of the default list filter settings
- Type: Object (See: ItemFilters)
DriveFilters
If supplied then these drive filter settings are used instead of the default drive filter settings
- Type: Object (See: ItemFilters)
SpecificListOptions
A collection of specific list options for this site
- Type: Object (See: SpecificListOptions)
SpecificDriveOptions
A collection of specific drive options for this site
- Type: Object (See: SpecificDriveOptions)
ForceResync
Force this site to be synchronised again including all of its drives and lists
- Type: Boolean
ItemFilters
Mode
- Type: Enum
- Values: All, Specific
- Default: Specific
AllModeOptions
- Type: Object (See: AllItemsFilterOptions)
SpecificModeOptions
- Type: Object (See: SpecificItemsFilterOptions)
AllUsersListingOptions
DisallowedUsers
A list of Emails, UserPrincipalNames or Ids to not synchronise
- Type: Array (String)
SpecificUsersListingOptions
AllowedUsers
A collection of user Emails, UserPrincipalNames or Ids to synchronise
- Type: Array (String)
IconSource
Url
If provided, then this url will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.
- Type: String
AssetId
If provided, then this asset id will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.
- Type: String
FileExtensionIconSource
FileExtensions
A comma delimetered list of file extensions that these settings apply to. E.g. '.png,.jpg'
- Type: String
Url
If provided, then this url will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.
- Type: String
AssetId
If provided, then this asset id will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.
- Type: String
SpecificListOptions
List
The name of the list that these settings apply to
- Type: String
Columns
A collection of list columns and settings that you want to synchronise
- Type: Object (See: ListColumnIndexSettings)
AvatarPathBuilder
You can use this to specify which column or a combination of columns can be used to provide the AvatarPath used to display the icon of the list item
- Type: Object (See: ValueBuilderDefinition)
ForceResync
Force this list to be synchronised again
- Type: Boolean
SpecificDriveOptions
Drive
The name of the drive that these settings apply to
- Type: String
ForceResync
Force this drive to be synchronised again
- Type: Boolean
AllItemsFilterOptions
Disallowed
- Type: Array (String)
SpecificItemsFilterOptions
Allowed
- Type: Array (String)
ListColumnIndexSettings
SharePointDisplayName
The display name of the list column that you want to synchronise
- Type: String
IndexedAs
If a value is supplied it will be used as the name instead of the one used in SharePoint
- Type: String
ValueBuilderDefinition
Parameters
- Type: Object (See: ValueBuilderParameterDefinition)
Format
- Type: String
ValueBuilderParameterDefinition
Name
- Type: String
Path
- Type: Array (String)
Updated 4 months ago