You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sharepoint/sharepoint-ps/sharepoint-online/Clear-SPOTenantPreAuthSettings.md
+47-6Lines changed: 47 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,15 +38,14 @@ Clears the pre-authentication settings for either the allow or deny list.
38
38
39
39
## EXAMPLES
40
40
41
-
### EXAMPLE 1
42
-
41
+
### Example 1
43
42
```powershell
44
43
Clear-SPOTenantPreAuthSettings –Type Allow
45
44
```
46
45
47
46
This example clears all list items from the allow list.
48
47
49
-
### EXAMPLE 2
48
+
### Example 2
50
49
51
50
```powershell
52
51
Clear-SPOTenantPreAuthSettings –Type Deny
@@ -56,25 +55,67 @@ This example clears all list items from the deny list.
56
55
57
56
## PARAMETERS
58
57
58
+
### -Confirm
59
+
Prompts you for confirmation before running the cmdlet.
60
+
61
+
```yaml
62
+
Type: SwitchParameter
63
+
Parameter Sets: (All)
64
+
Aliases: cf
65
+
66
+
Required: False
67
+
Position: Named
68
+
Default value: None
69
+
Accept pipeline input: False
70
+
Accept wildcard characters: False
71
+
```
72
+
59
73
### -Type
60
74
61
75
This parameter indicates whether the cmdlet is interacting with the allow list or the deny list.
62
76
63
-
PARAMVALUE: Allow | Deny
64
-
65
77
```yaml
66
78
Type: TenantPreAuthSettingsListType
67
-
Applicable: SharePoint Online
79
+
Parameter Sets: (All)
80
+
Aliases:
81
+
Accepted values: Allow, Deny
82
+
68
83
Required: True
69
84
Position: Named
70
85
Default value: None
71
86
Accept pipeline input: False
72
87
Accept wildcard characters: False
73
88
```
74
89
90
+
### -WhatIf
91
+
Shows what would happen if the cmdlet runs.
92
+
The cmdlet is not run.
93
+
94
+
```yaml
95
+
Type: SwitchParameter
96
+
Parameter Sets: (All)
97
+
Aliases: wi
98
+
99
+
Required: False
100
+
Position: Named
101
+
Default value: None
102
+
Accept pipeline input: False
103
+
Accept wildcard characters: False
104
+
```
105
+
75
106
### CommonParameters
76
107
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).
Copy file name to clipboardExpand all lines: sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,15 +38,15 @@ Gets the configuration of pre-authentication.
38
38
39
39
## EXAMPLES
40
40
41
-
### EXAMPLE 1
41
+
### Example 1
42
42
43
43
```powershell
44
44
Get-SPOTenantPreAuthSettings
45
45
```
46
46
47
47
This example returns all the pre-authentication settings for the tenant as an object.
48
48
49
-
### EXAMPLE 2
49
+
### Example 2
50
50
51
51
```powershell
52
52
Get-SPOTenantPreAuthSettings | ConvertTo-Json
@@ -59,6 +59,16 @@ Gets all the pre-authentication settings for the tenant. Note that this example
59
59
### CommonParameters
60
60
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).
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
144
+
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.
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
160
+
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).
163
161
164
162
```yaml
165
163
Type: String
166
164
Parameter Sets: AddListItem
167
-
Applicable: SharePoint Online
165
+
Aliases:
166
+
168
167
Required: False
169
168
Position: Named
170
169
Default value: ""
@@ -179,7 +178,8 @@ This parameter identifies the list item setting to remove from the current confi
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
192
+
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.
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
208
+
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).
This parameter indicates whether the cmdlet is interacting with the allow list or the deny list.
259
257
260
-
PARAMVALUE: Allow | Deny
261
-
262
258
```yaml
263
259
Type: TenantPreAuthSettingsListType
264
260
Parameter Sets: AddListItem
265
-
Applicable: SharePoint Online
261
+
Aliases:
262
+
Accepted values: Allow, Deny
263
+
266
264
Required: True
267
265
Position: Named
268
266
Default value: None
269
267
Accept pipeline input: False
270
268
Accept wildcard characters: False
271
269
```
272
270
273
-
### Feature Names
271
+
### CommonParameters
272
+
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).
273
+
274
+
## INPUTS
275
+
276
+
### None
277
+
278
+
## OUTPUTS
279
+
280
+
### System.Object
281
+
282
+
## NOTES
274
283
275
284
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.
276
285
@@ -288,9 +297,6 @@ The `-IncludedFeatures` and `-ExcludedFeatures` use feature names from the follo
288
297
| WebRenderingEmbed | Embed SharePoint files in another application. 3rd party application and some 1st party applications may be broken | [Embed Web Part](https://support.microsoft.com/office/add-content-to-your-page-using-the-embed-web-part-721f3b2f-437f-45ef-ac4e-df29dba74de8) |
289
298
| Whiteboard | Teams integration with Whiteboard app will be broken for anonymous and guest users. | [Use Whiteboard in a Teams meeting - Microsoft Support](https://support.microsoft.com/office/use-whiteboard-in-a-teams-meeting-26f87802-b37f-4af0-806d-af79fbfb8ae6) |
290
299
291
-
### CommonParameters
292
-
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).
0 commit comments