​
How it works

The SharePoint connector will go through all configured sites belonging to an organization and index all the documents attached to that site. Note, it currently does not parse the site page contents, only the attached files. This includes:
  • Word Doc, Excel, PDF, PowerPoints, and all plaintext files like .txt, .mdx, etc.

​
Setting up

​
Authorization

We support two authorization methods—pick one that fits your environment: Note: Permission sync is only available with certificate-based authentication.

​
Indexing

Once you’ve set up your authorization method, follow these steps to index your SharePoint sites:
  1. Navigate to the Onyx Admin Dashboard and select the SharePoint Connector.
  2. In Step 1, configure your authorization: SharepointConnector
    • If you have existing credentials, select them from the list
    • If you don’t have existing credentials, click Create New to add new authorization:
      • Client Secret: Enter your Application ID, Directory ID, and Client Secret
      • Certificate: Upload your certificate file and enter Application/Directory IDs
  3. Click Create to save your configuration.
  4. Ensure your chosen credential is selected, then click Continue
  5. In Step 2, specify your SharePoint configuration:
    • Connector Name: Enter a name for the connector (e.g., “MySharePointConnector”)
    • Sites: Select a list of sites to pull from or leave blank to pull everything
    • Permission Sync (Certificate auth only): Enable to sync SharePoint permissions with Onyx
  6. Click Create Connector to begin indexing.
The connector will start indexing your SharePoint sites and you can add more sites or modify settings as needed.

​
Understanding SharePoint Structure

SharePoint organizes content into sites, which can contain document libraries, lists, and pages. Each site can contain an unlimited number of documents. The connector focuses on indexing documents stored in document libraries across your selected sites. For more information on SharePoint structure, visit the Microsoft SharePoint documentation.