SharePoint

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Enabled by default.
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: Sites.Read.All, Sites.ReadWrite.All, Files.Read.All, Files.ReadWrite.All, offline_access.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
MICROSOFT_CLIENT_IDYesMicrosoft Azure App Client ID (shared with Outlook/Teams) Docs.
MICROSOFT_CLIENT_SECRETYesMicrosoft Azure App Client Secret Docs.

Cloud access modes

Hosted Cloud tools support both user-delegated OAuth 2.0 authorization code access and application/service access using the OAuth 2.0 client credentials grant. These are separate credential configurations. The local Code runtime has its own supported authentication methods.

Set every application variable below in the target project environment. Delegated OAuth app variables above do not activate application access.

Application variableRequired
SHAREPOINT_SERVICE_ACCOUNT_CLIENT_IDYes
SHAREPOINT_SERVICE_ACCOUNT_CLIENT_SECRETYes
SHAREPOINT_SERVICE_ACCOUNT_TENANT_IDYes
SHAREPOINT_SERVICE_ACCOUNT_SITE_IDYes

Configure application access describes provider setup, identity selection, project tool policy and supported-operation restrictions.

Setup

  1. Choose who owns the Microsoft OAuth app: On hosted Veryfront, SharePoint uses the Veryfront-managed Microsoft OAuth app: connect SharePoint from the project's integrations and approve the Microsoft consent screen, no environment variables needed. Set MICROSOFT_CLIENT_ID and MICROSOFT_CLIENT_SECRET only to use your own Microsoft OAuth app, which is required for local and self-hosted runs.
  2. Register an app in Microsoft Entra: In the Microsoft Entra admin center, open App registrations and register a new application. For Supported account types, choose accounts in any organizational directory. SharePoint needs a work or school account.
  3. Add the redirect URIs: Under Authentication, add a Web platform. Add the redirect URI of the environment that completes the flow: https://api.veryfront.com/oauth/callback/sharepoint for hosted Veryfront, or your app origin followed by /api/auth/sharepoint/callback for a local or self-hosted app.
  4. Add Microsoft Graph permissions: Under API permissions, add these delegated Microsoft Graph permissions: Sites.Read.All, Sites.ReadWrite.All, Files.Read.All, Files.ReadWrite.All, offline_access. If your tenant does not let users consent to apps, an administrator must grant consent for the organization.
  5. Create a client secret: Under Certificates & secrets, create a client secret. Set MICROSOFT_CLIENT_ID and MICROSOFT_CLIENT_SECRET from the app's credentials. Client secrets expire, so rotate MICROSOFT_CLIENT_SECRET before the expiry date you choose.
  6. Verify access: Run List SharePoint Sites (read-only). It returns sites the connected user can open without changing them.

Provider notes

  • The connection requests Sites.Read.All, Sites.ReadWrite.All, Files.Read.All, Files.ReadWrite.All and offline_access. offline_access lets the connection refresh its access token.
  • Tools that create, update, send or delete data are marked as writes and need write authority; the other tools are read-only.

Provider API reference.

Tools

ToolAccessDescription
List SharePoint Sites<br /><code className="reference-identifier">sharepoint__list_sites</code>ReadList SharePoint sites
Get Site Details<br /><code className="reference-identifier">sharepoint__get_site</code>ReadGet site details
List Files<br /><code className="reference-identifier">sharepoint__list_files</code>ReadList files
Get File<br /><code className="reference-identifier">sharepoint__get_file</code>ReadGet file
Upload File<br /><code className="reference-identifier">sharepoint__upload_file</code>WriteUpload file
Search Files<br /><code className="reference-identifier">sharepoint__search_files</code>ReadSearch files
Download File<br /><code className="reference-identifier">sharepoint__download_file</code>ReadDownload file

Verify the connection

Call a read tool such as sharepoint__list_sites with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.