Edit

Share via


Clear-SPOTenantPreAuthSettings

Clears the pre-authentication settings for either the allow or deny list.

Syntax

Default (Default)

Clear-SPOTenantPreAuthSettings
    -Type <TenantPreAuthSettingsListType>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Clears the pre-authentication settings for either the allow or deny list.

Note

What is pre-authentication?

SharePoint includes self-issued tokens in URLs called pre-authentication URLs (also known as tempauth URLs) to provide temporary access to a SharePoint resource, which helps support more rich user experiences. For example, a common scenario is downloading a file using a URL that includes a token in the tempauth query parameter like the following:

https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...

This feature is currently being deprecated and you can use the related Set-SPOTenantPreAuthSettings to control the use of pre-authentication in various use cases.

Examples

Example 1

Clear-SPOTenantPreAuthSettings –Type Allow

This example clears all list items from the allow list.

Example 2

Clear-SPOTenantPreAuthSettings –Type Deny

This example clears all list items from the deny list.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

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

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.TenantPreAuthSettingsListType
Default value:None
Accepted values:Allow, Deny
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object