Skip to content

Commit cf04750

Browse files
Update Sharepoint Online connector documentation (#119933)
Co-authored-by: Liam Thompson <[email protected]> (cherry picked from commit f2d069e)
1 parent eb6c6fd commit cf04750

File tree

1 file changed

+63
-14
lines changed

1 file changed

+63
-14
lines changed

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

Lines changed: 63 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,24 @@ 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 https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/retirement-announcement-for-azure-acs[retiring Azure Access Control Service (ACS)]. This affects permission configuration:
116+
117+
* *Tenants created after November 1st, 2024*: Certificate authentication is required
118+
* *Tenants created before November 1st, 2024*: Secret-based authentication must be migrated to certificate authentication by April 2nd, 2026
119+
120+
[discrete#es-connectors-sharepoint-online-oauth-app-certificate-auth]
121+
===== Certificate Authentication
122+
123+
This authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
124+
125+
[discrete#es-connectors-sharepoint-online-oauth-app-secret-auth]
126+
===== Secret Authentication
127+
128+
[IMPORTANT]
129+
====
130+
This method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
131+
====
132+
117133
Refer to the following documentation for setting https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs[SharePoint permissions^].
118134
119135
* To set `DisableCustomAppAuthentication` to false, connect to SharePoint using PowerShell and run `set-spotenant -DisableCustomAppAuthentication $false`
@@ -167,8 +183,17 @@ The tenant name for the Azure account hosting the Sharepoint Online instance.
167183
Client ID::
168184
The client id to authenticate with SharePoint Online.
169185
186+
Authentication Method::
187+
Authentication method to use to connector to Sharepoint Online and Rest APIs. `secret` is deprecated and `certificate` is recommended.
188+
170189
Secret value::
171-
The secret value to authenticate with SharePoint Online.
190+
The secret value to authenticate with SharePoint Online, if Authentication Method: `secret` is chosen.
191+
192+
Content of certificate file::
193+
Content of certificate file if Authentication Method: `certificate` is chosen.
194+
195+
Content of private key file::
196+
Content of private key file if Authentication Method: `certificate` is chosen.
172197
173198
Comma-separated list of sites::
174199
List of site collection names or paths to fetch from SharePoint.
@@ -536,12 +561,10 @@ Follow these steps:
536561
* Leave the *Redirect URIs* blank for now.
537562
* *Register* the application.
538563
* Find and keep the **Application (client) ID** and **Directory (tenant) ID** handy.
539-
* Locate the **Secret** by navigating to **Client credentials: Certificates & Secrets**.
540-
* Select **New client secret**
541-
* Pick a name for your client secret.
542-
Select an expiration date. (At this expiration date, you will need to generate a new secret and update your connector configuration.)
543-
** Save the client secret **Secret ID** before leaving this screen.
544-
** Save the client secret **Value** before leaving this screen.
564+
* 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
565+
* Locate the **Certificates** by navigating to **Client credentials: Certificates & Secrets**.
566+
* Select **Upload certificate**
567+
* Upload the certificate created in one of previous steps: `azure_app.crt`
545568
* Set up the permissions the OAuth App will request from the Azure Portal service account.
546569
** Navigate to **API Permissions** and click **Add Permission**.
547570
** Add **application permissions** until the list looks like the following:
@@ -575,6 +598,23 @@ When entities are not available via the Graph API the connector falls back to us
575598
[discrete#es-connectors-sharepoint-online-client-oauth-app-permissions]
576599
====== SharePoint permissions
577600
601+
Microsoft is https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/retirement-announcement-for-azure-acs[retiring Azure Access Control Service (ACS)]. This affects permission configuration:
602+
* *Tenants created after November 1st, 2024*: Certificate authentication is required
603+
* *Tenants created before November 1st, 2024*: Secret-based authentication must be migrated to certificate authentication by April 2nd, 2026
604+
605+
[discrete#es-connectors-sharepoint-online-client-oauth-app-certificate-auth]
606+
===== Certificate Authentication
607+
608+
This authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
609+
610+
[discrete#es-connectors-sharepoint-online-client-oauth-app-secret-auth]
611+
===== Secret Authentication
612+
613+
[IMPORTANT]
614+
====
615+
This method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
616+
====
617+
578618
Refer to the following documentation for setting https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs[SharePoint permissions^].
579619
580620
* To set `DisableCustomAppAuthentication` to false, connect to SharePoint using PowerShell and run `set-spotenant -DisableCustomAppAuthentication $false`
@@ -637,8 +677,17 @@ The tenant name for the Azure account hosting the Sharepoint Online instance.
637677
`client_id`::
638678
The client id to authenticate with SharePoint Online.
639679
680+
`auth_method`::
681+
Authentication method to use to connector to Sharepoint Online and Rest APIs. `secret` is deprecated and `certificate` is recommended.
682+
640683
`secret_value`::
641-
The secret value to authenticate with SharePoint Online.
684+
The secret value to authenticate with SharePoint Online, if auth_method: `secret` is chosen.
685+
686+
`certificate`::
687+
Content of certificate file if auth_method: `certificate` is chosen.
688+
689+
`private_key`::
690+
Content of private key file if auth_method: `certificate` is chosen.
642691
643692
`site_collections`::
644693
List of site collection names or paths to fetch from SharePoint.

0 commit comments

Comments
 (0)