Skip to content

Commit 401c5be

Browse files
Update Sharepoint Online connector documentation
1 parent 79713f5 commit 401c5be

File tree

1 file changed

+43
-14
lines changed

1 file changed

+43
-14
lines changed

docs/reference/connector/docs/connectors-sharepoint-online.asciidoc

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,10 @@ Follow these steps:
7575
* Leave the *Redirect URIs* blank for now.
7676
* *Register* the application.
7777
* Find and keep the **Application (client) ID** and **Directory (tenant) ID** handy.
78-
* Locate the **Secret** by navigating to **Client credentials: Certificates & Secrets**.
79-
* Select **New client secret**
80-
* Pick a name for your client secret.
81-
Select an expiration date. (At this expiration date, you will need to generate a new secret and update your connector configuration.)
82-
** Save the client secret **Secret ID** before leaving this screen.
83-
** Save the client secret **Value** before leaving this screen.
78+
* Create a certificate and private key. This can, for example, be done by running `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout azure_app.key -out azure_app.crt` command. Store both in a safe and secure place
79+
* Locate the **Certificates** by navigating to **Client credentials: Certificates & Secrets**.
80+
* Select **Upload certificate**
81+
* Upload the certificate created in one of previous steps: `azure_app.crt`
8482
* Set up the permissions the OAuth App will request from the Azure Portal service account.
8583
** Navigate to **API Permissions** and click **Add Permission**.
8684
** Add **application permissions** until the list looks like the following:
@@ -114,6 +112,18 @@ When entities are not available via the Graph API the connector falls back to us
114112
[discrete#es-connectors-sharepoint-online-oauth-app-permissions]
115113
====== SharePoint permissions
116114
115+
Microsoft is retiring Azure ACS: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/retirement-announcement-for-azure-acs. Because of that, setting up permissions for new tenants and for old tenants can be different. We recommend switching to usage of certificates for older tenants too, but if it's not yet possible, a legacy permission setup can still be used.
116+
117+
[discrete#es-connectors-sharepoint-online-oauth-app-certificate-auth]
118+
===== Certificate Authentication
119+
120+
This authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
121+
122+
[discrete#es-connectors-sharepoint-online-oauth-app-secret-auth]
123+
===== Secret Authentication
124+
125+
This method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
126+
117127
Refer to the following documentation for setting https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs[SharePoint permissions^].
118128
119129
* To set `DisableCustomAppAuthentication` to false, connect to SharePoint using PowerShell and run `set-spotenant -DisableCustomAppAuthentication $false`
@@ -219,8 +229,17 @@ The tenant name for the Azure account hosting the Sharepoint Online instance.
219229
Client ID::
220230
The client id to authenticate with SharePoint Online.
221231
232+
Authentication Method::
233+
Authentication method to use to connector to Sharepoint Online and Rest APIs. `secret` is deprecated and `certificate` is recommended.
234+
222235
Secret value::
223-
The secret value to authenticate with SharePoint Online.
236+
The secret value to authenticate with SharePoint Online, if Authentication Method: `secret` is chosen.
237+
238+
Content of certificate file::
239+
Content of certificate file if Authentication Method: `certificate` is chosen.
240+
241+
Content of private key file::
242+
Content of private key file if Authentication Method: `certificate` is chosen.
224243
225244
Comma-separated list of sites::
226245
List of site collection names or paths to fetch from SharePoint.
@@ -588,12 +607,10 @@ Follow these steps:
588607
* Leave the *Redirect URIs* blank for now.
589608
* *Register* the application.
590609
* Find and keep the **Application (client) ID** and **Directory (tenant) ID** handy.
591-
* Locate the **Secret** by navigating to **Client credentials: Certificates & Secrets**.
592-
* Select **New client secret**
593-
* Pick a name for your client secret.
594-
Select an expiration date. (At this expiration date, you will need to generate a new secret and update your connector configuration.)
595-
** Save the client secret **Secret ID** before leaving this screen.
596-
** Save the client secret **Value** before leaving this screen.
610+
* Create a certificate and private key. This can, for example, be done by running `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout azure_app.key -out azure_app.crt` command. Store both in a safe and secure place
611+
* Locate the **Certificates** by navigating to **Client credentials: Certificates & Secrets**.
612+
* Select **Upload certificate**
613+
* Upload the certificate created in one of previous steps: `azure_app.crt`
597614
* Set up the permissions the OAuth App will request from the Azure Portal service account.
598615
** Navigate to **API Permissions** and click **Add Permission**.
599616
** Add **application permissions** until the list looks like the following:
@@ -624,9 +641,21 @@ The connector uses the https://learn.microsoft.com/en-us/sharepoint/dev/apis/sha
624641
When entities are not available via the Graph API the connector falls back to using the Sharepoint https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service[REST API^].
625642
====
626643
627-
[discrete#es-connectors-sharepoint-online-client-oauth-app-permissions]
644+
[discrete#es-connectors-sharepoint-online-oauth-app-permissions]
628645
====== SharePoint permissions
629646
647+
Microsoft is retiring Azure ACS: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/retirement-announcement-for-azure-acs. Because of that, setting up permissions for new tenants and for old tenants can be different. We recommend switching to usage of certificates for older tenants too, but if it's not yet possible, a legacy permission setup can still be used.
648+
649+
[discrete#es-connectors-sharepoint-online-oauth-app-certificate-auth]
650+
===== Certificate Authentication
651+
652+
This authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
653+
654+
[discrete#es-connectors-sharepoint-online-oauth-app-secret-auth]
655+
===== Secret Authentication
656+
657+
This method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
658+
630659
Refer to the following documentation for setting https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs[SharePoint permissions^].
631660
632661
* To set `DisableCustomAppAuthentication` to false, connect to SharePoint using PowerShell and run `set-spotenant -DisableCustomAppAuthentication $false`

0 commit comments

Comments
 (0)