Skip to content

Commit 89afcc7

Browse files
authored
Update Set-SPOTenantPreAuthSettings.md
1 parent 53d981a commit 89afcc7

File tree

1 file changed

+55
-47
lines changed

1 file changed

+55
-47
lines changed

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

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

148
# Set-SPOTenantPreAuthSettings
@@ -62,53 +56,58 @@ You must be a SharePoint Administrator to run the cmdlet.
6256

6357
### Example 1
6458
```powershell
65-
Set-SPOTenantPreAuthSettings -IsDisabled $true
59+
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
6660
67-
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
61+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
6862
```
63+
6964
This example disables pre-authentication overall and adds a setting that allows two apps to use pre-authentication for all features.
7065

7166
### Example 2
7267
```powershell
73-
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
68+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
7469
```
70+
7571
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.
7672

7773
These switches are assumed to take the default value of `""` if not used with the cmdlet and example 2 is used to demonstrate the complete set of switches only.
7874

7975
### Example 3
8076
```powershell
81-
Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"
77+
PS C:\> Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"
8278
```
79+
8380
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.
8481

8582
### Example 4
8683
```powershell
87-
Set-SPOTenantPreAuthSettings -IsDisabled $true
84+
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
8885
89-
Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"
86+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"
9087
```
88+
9189
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"`.
9290

9391
In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` will always be denied from using pre-authentication since it is excluded from the allow list setting. Any other app will be allowed to use pre-authentication for any feature apart from `"Download"` and `"WebRenderingEmbed"`.
9492

9593
### Example 5
9694
```powershell
97-
Set-SPOTenantPreAuthSettings -IsDisabled $true
95+
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $true
9896
99-
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
97+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
10098
101-
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
99+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
102100
```
101+
103102
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.
104103

105104
In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` would not be allowed to use pre-authentication for any of the allow-listed features despite having the setting. This is because the Deny list takes precedence over the Allow list.
106105

107106
### Example 6
108107
```powershell
109-
Set-SPOTenantPreAuthSettings -IsDisabled $false
108+
PS C:\> Set-SPOTenantPreAuthSettings -IsDisabled $false
110109
111-
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
110+
PS C:\> Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
112111
```
113112
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.
114113

@@ -130,8 +129,9 @@ This parameter specifies that the operation of the cmdlet is to Add a setting to
130129
```yaml
131130
Type: SwitchParameter
132131
Parameter Sets: AddListItem
133-
Applicable: SharePoint Online
134-
Required: False
132+
Aliases:
133+
134+
Required: True
135135
Position: Named
136136
Default value: None
137137
Accept pipeline input: False
@@ -140,14 +140,13 @@ Accept wildcard characters: False
140140
141141
### -ExcludedApps
142142
143-
This parameter value contains the apps ids to configure within the `-ExcludedApps` scope.
144-
145-
PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
143+
This parameter value contains the apps ids to configure within the `-ExcludedApps` scope. Possible values include: `""`, `"Empty"`, or a comma-separated list of app IDs.
146144

147145
```yaml
148146
Type: String
149147
Parameter Sets: AddListItem
150-
Applicable: SharePoint Online
148+
Aliases:
149+
151150
Required: False
152151
Position: Named
153152
Default value: ""
@@ -157,14 +156,13 @@ Accept wildcard characters: False
157156

158157
### -ExcludedFeatures
159158

160-
This parameter value contains the feature names to configure within the `-ExcludedFeatures` scope.
161-
162-
PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
159+
This parameter value contains the feature names to configure within the `-ExcludedFeatures` scope. Possible values include: `""` or a comma-separated list of feature names (see NOTES section below).
163160

164161
```yaml
165162
Type: String
166163
Parameter Sets: AddListItem
167-
Applicable: SharePoint Online
164+
Aliases:
165+
168166
Required: False
169167
Position: Named
170168
Default value: ""
@@ -179,7 +177,8 @@ This parameter identifies the list item setting to remove from the current confi
179177
```yaml
180178
Type: String
181179
Parameter Sets: RemoveListItem
182-
Applicable: SharePoint Online
180+
Aliases:
181+
183182
Required: True
184183
Position: Named
185184
Default value: None
@@ -189,14 +188,13 @@ Accept wildcard characters: False
189188

190189
### -IncludedApps
191190

192-
This parameter value contains the app ids to configure within the `-IncludedApps` scope.
193-
194-
PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
191+
This parameter value contains the app ids to configure within the `-IncludedApps` scope. Possible values include: `""`, `"Empty"`, or a comma-separated list of app IDs.
195192

196193
```yaml
197194
Type: String
198195
Parameter Sets: AddListItem
199-
Applicable: SharePoint Online
196+
Aliases:
197+
200198
Required: False
201199
Position: Named
202200
Default value: ""
@@ -206,14 +204,13 @@ Accept wildcard characters: False
206204

207205
### -IncludedFeatures
208206

209-
This parameter value contains the feature names to configure within the `-IncludedFeatures` scope.
210-
211-
PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
207+
This parameter value contains the feature names to configure within the `-IncludedFeatures` scope. Possible values include: `""` or a comma-separated list of feature names (see NOTES section below).
212208

213209
```yaml
214210
Type: String
215211
Parameter Sets: AddListItem
216-
Applicable: SharePoint Online
212+
Aliases:
213+
217214
Required: False
218215
Position: Named
219216
Default value: ""
@@ -225,12 +222,11 @@ Accept wildcard characters: False
225222

226223
This parameter allows the administrator to toggle pre-authentication for all apps and features to be either enabled or disabled.
227224

228-
PARAMVALUE: True | False
229-
230225
```yaml
231226
Type: Boolean
232227
Parameter Sets: IsDisabled
233-
Applicable: SharePoint Online
228+
Aliases:
229+
234230
Required: True
235231
Position: Named
236232
Default value: False
@@ -245,8 +241,9 @@ This parameter specifies that the operation of the cmdlet is to Remove a setting
245241
```yaml
246242
Type: SwitchParameter
247243
Parameter Sets: RemoveListItem
248-
Applicable: SharePoint Online
249-
Required: False
244+
Aliases:
245+
246+
Required: True
250247
Position: Named
251248
Default value: None
252249
Accept pipeline input: False
@@ -257,20 +254,31 @@ Accept wildcard characters: False
257254

258255
This parameter indicates whether the cmdlet is interacting with the allow list or the deny list.
259256

260-
PARAMVALUE: Allow | Deny
261-
262257
```yaml
263258
Type: TenantPreAuthSettingsListType
264259
Parameter Sets: AddListItem
265-
Applicable: SharePoint Online
260+
Aliases:
261+
Accepted values: Allow, Deny
262+
266263
Required: True
267264
Position: Named
268265
Default value: None
269266
Accept pipeline input: False
270267
Accept wildcard characters: False
271268
```
272269

273-
### Feature Names
270+
### 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
280+
281+
## NOTES
274282

275283
The `-IncludedFeatures` and `-ExcludedFeatures` use feature names from the following table. It explicitly mentions if the feature will be broken if it is disabled via the PowerShell cmdlet.
276284

0 commit comments

Comments
 (0)