Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ Clears the pre-authentication settings for either the allow or deny list.

## EXAMPLES

### EXAMPLE 1

### Example 1
```powershell
Clear-SPOTenantPreAuthSettings –Type Allow
```

This example clears all list items from the allow list.

### EXAMPLE 2
### Example 2

```powershell
Clear-SPOTenantPreAuthSettings –Type Deny
Expand All @@ -56,25 +55,67 @@ This example clears all list items from the deny list.

## PARAMETERS

### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Type

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

PARAMVALUE: Allow | Deny

```yaml
Type: TenantPreAuthSettingsListType
Applicable: SharePoint Online
Parameter Sets: (All)
Aliases:
Accepted values: Allow, Deny

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

- [Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ Gets the configuration of pre-authentication.

## EXAMPLES

### EXAMPLE 1
### Example 1

```powershell
Get-SPOTenantPreAuthSettings
```

This example returns all the pre-authentication settings for the tenant as an object.

### EXAMPLE 2
### Example 2

```powershell
Get-SPOTenantPreAuthSettings | ConvertTo-Json
Expand All @@ -59,6 +59,16 @@ Gets all the pre-authentication settings for the tenant. Note that this example
### CommonParameters
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).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,9 @@ This parameter specifies that the operation of the cmdlet is to Add a setting to
```yaml
Type: SwitchParameter
Parameter Sets: AddListItem
Applicable: SharePoint Online
Required: False
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Expand All @@ -140,14 +141,13 @@ Accept wildcard characters: False

### -ExcludedApps

This parameter value contains the apps ids to configure within the `-ExcludedApps` scope.

PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
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.

```yaml
Type: String
Parameter Sets: AddListItem
Applicable: SharePoint Online
Aliases:

Required: False
Position: Named
Default value: ""
Expand All @@ -157,14 +157,13 @@ Accept wildcard characters: False

### -ExcludedFeatures

This parameter value contains the feature names to configure within the `-ExcludedFeatures` scope.

PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
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).

```yaml
Type: String
Parameter Sets: AddListItem
Applicable: SharePoint Online
Aliases:

Required: False
Position: Named
Default value: ""
Expand All @@ -179,7 +178,8 @@ This parameter identifies the list item setting to remove from the current confi
```yaml
Type: String
Parameter Sets: RemoveListItem
Applicable: SharePoint Online
Aliases:

Required: True
Position: Named
Default value: None
Expand All @@ -189,14 +189,13 @@ Accept wildcard characters: False

### -IncludedApps

This parameter value contains the app ids to configure within the `-IncludedApps` scope.

PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
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.

```yaml
Type: String
Parameter Sets: AddListItem
Applicable: SharePoint Online
Aliases:

Required: False
Position: Named
Default value: ""
Expand All @@ -206,14 +205,13 @@ Accept wildcard characters: False

### -IncludedFeatures

This parameter value contains the feature names to configure within the `-IncludedFeatures` scope.

PARAMVALUE: `"Empty"`, `""`, or a comma-separated list of app IDs
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).

```yaml
Type: String
Parameter Sets: AddListItem
Applicable: SharePoint Online
Aliases:

Required: False
Position: Named
Default value: ""
Expand All @@ -225,12 +223,11 @@ Accept wildcard characters: False

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

PARAMVALUE: True | False

```yaml
Type: Boolean
Parameter Sets: IsDisabled
Applicable: SharePoint Online
Aliases:

Required: True
Position: Named
Default value: False
Expand All @@ -245,8 +242,9 @@ This parameter specifies that the operation of the cmdlet is to Remove a setting
```yaml
Type: SwitchParameter
Parameter Sets: RemoveListItem
Applicable: SharePoint Online
Required: False
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Expand All @@ -257,20 +255,31 @@ Accept wildcard characters: False

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

PARAMVALUE: Allow | Deny

```yaml
Type: TenantPreAuthSettingsListType
Parameter Sets: AddListItem
Applicable: SharePoint Online
Aliases:
Accepted values: Allow, Deny

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### Feature Names
### CommonParameters
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).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

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.

Expand All @@ -288,9 +297,6 @@ The `-IncludedFeatures` and `-ExcludedFeatures` use feature names from the follo
| 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) |
| 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) |

### CommonParameters
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).

## RELATED LINKS

- [Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md)
Expand Down