Skip to content

Commit 3899641

Browse files
authored
Update Set-SPOTenantPreAuthSettings.md
1 parent 187d106 commit 3899641

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
2+
external help file: sharepointonline.xml
33
Module Name: Microsoft.Online.SharePoint.PowerShell
4-
online version:
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/set-spotenantpreauthsettings
5+
applicable: SharePoint Online
6+
title: Set-SPOTenantPreAuthSettings
57
schema: 2.0.0
8+
author: lw-msft
9+
ms.author: laurenwong
10+
ms.reviewer:
11+
manager: bhaveshd
612
---
713

814
# Set-SPOTenantPreAuthSettings
@@ -56,16 +62,16 @@ You must be a SharePoint Administrator to run the cmdlet.
5662

5763
### Example 1
5864
```powershell
59-
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
65+
Set-SPOTenantPreAuthSettings -IsDisabled $true
6066
61-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
67+
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
6268
```
6369

6470
This example disables pre-authentication overall and adds a setting that allows two apps to use pre-authentication for all features.
6571

6672
### Example 2
6773
```powershell
68-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
74+
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
6975
```
7076

7177
This example performs the same function as example 1 except in this case the switches for `-ExcludedApps`, `-IncludedFeatures`, and `-ExcludedFeatures` are added to the cmdlet.
@@ -74,16 +80,16 @@ These switches are assumed to take the default value of `""` if not used with th
7480

7581
### Example 3
7682
```powershell
77-
PS C:\> Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"
83+
Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"
7884
```
7985

8086
This example will remove an existing item from the current list of items. The remove switch can remove allow or deny entries from the list.
8187

8288
### Example 4
8389
```powershell
84-
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
90+
Set-SPOTenantPreAuthSettings -IsDisabled $true
8591
86-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"
92+
Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"
8793
```
8894

8995
This example disables pre-authentication overall and allows all apps apart from one to use pre-authentication for all features except for `"Download"` and `"WebRenderingEmbed"`.
@@ -92,11 +98,11 @@ In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` will always be de
9298

9399
### Example 5
94100
```powershell
95-
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
101+
Set-SPOTenantPreAuthSettings -IsDisabled $true
96102
97-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
103+
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
98104
99-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
105+
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
100106
```
101107

102108
This example disables pre-authentication overall but contains an overlap between the settings in the Allow list and Deny list. It first allows an app to use pre-authentication for the `"OfficeOnline"`, `"WebRenderingEmbed"`, and `"Download"` features. But in the final execution of the cmdlet, it denies the same app from using pre-authentication for all features.
@@ -105,9 +111,9 @@ In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` would not be allo
105111

106112
### Example 6
107113
```powershell
108-
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $false
114+
Set-SPOTenantPreAuthSettings -IsDisabled $false
109115
110-
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
116+
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
111117
```
112118
This example enables pre-authentication overall and denies requests that are not coming from an app (e.g. requests coming via a browser) from using pre-authentication for all features.
113119

@@ -268,15 +274,7 @@ Accept wildcard characters: False
268274
```
269275

270276
### CommonParameters
271-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
272-
273-
## INPUTS
274-
275-
### None
276-
277-
## OUTPUTS
278-
279-
### System.Object
277+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1).
280278

281279
## NOTES
282280

0 commit comments

Comments
 (0)