This component uses the REST API to fetch users and groups from SharePoint Online. One single call is done to get all the users and groups from each site collection url specified on the connector configuration. All users and groups information is cached.

Note: The SharePoint Online group expansion will only return users and groups inside SharePoint. To get the Azure AD group information, you need to install the Azure AD Group Expander.

 

SharePoint Online Group Expansion
Factory Namecom.searchtechnologies.aspire:aspire-sharepointonline-scanner
subTypescanner
InputsA Job containing a group expansion request
OutputsA Job containing a group expansion result

Configuration

 <component name="GroupExpansionScheduler" subType="default" factoryName="aspire-scheduler">
  <debug>${debug}</debug>
  <schedules>
    <schedule name="GECache" enabled="true">
      <cron>${geSchedule}</cron>
      <event>onGECache</event>
      <job>
        <![CDATA[
        <doc actionProperties="cacheGroups">
          <routingTable>
            <SharePointOnlineConnector>
              <properties>
                <connectorSource>
		  <domain>QA</domain>
		  <username>spadmin</username>									
		  <groupPrefixSeparator>@</groupPrefixSeparator>
		  <siteCollectionsToScan>
		    <siteCollectionUrl>http://10.10.21.127/sites/aspire</siteCollectionUrl>
		  </siteCollectionsToScan>
		  <password>encrypted:562E81591F85B858E5A5D3876F9C9FDB</password>
		</connectorSource>
	      </properties>
            </SharePointOnlineConnector>
          </routingTable>
	  <displayName>SharePointOnlineConnector</displayName>
	</doc>
	]]>
      </job>
    </schedule>
  </schedules>
  <branches>
    <branch event="onGECache" pipelineManager="Main" />
  </branches>
</component>

This section lists all configuration parameters available to configure the SharePoint Online Group Expansion component.

ElementTypeDefaultDescription
usernamestring Username used to authenticate against SharePoint.
passwordstringN/APassword used to authenticate against SharePoint.
cacheTimeoutlong1800000
(=30 mins)		The cache timeout in ms.
siteCollectionsToScan/siteCollectionUrlstring URLs of site collections from which groups will be gathered (more that one allowed).
groupPrefixSeparatorstring@The separator inserted between the site URL and the SharePoint group name when extracting groups from sites.

Example Configuration