Skip to content

Commit 621621a

Browse files
authored
Create Clear-SPOTenantPreAuthSettings.md
1 parent 63c7e70 commit 621621a

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/clear-spotenantpreauthsettings
5+
applicable: SharePoint Online
6+
title: Clear-SPOTenantPreAuthSettings
7+
schema: 2.0.0
8+
author: lw-msft
9+
ms.author: laurenwong, neilh
10+
ms.reviewer:
11+
manager: bhaveshd
12+
---
13+
14+
# Clear-SPOTenantPreAuthSettings
15+
16+
## SYNOPSIS
17+
18+
Clears the pre-authentication settings for either the allow or deny list.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Clear-SPOTenantPreAuthSettings
24+
-Type {Allow | Deny}
25+
[<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
30+
Clears the pre-authentication settings for either the allow or deny list.
31+
32+
**What is pre-authentication?**
33+
34+
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:
35+
36+
`https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...`
37+
38+
This feature is currently being deprecated and you can use the related [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md) to control the use of pre-authentication in various use cases.
39+
40+
## EXAMPLES
41+
42+
### EXAMPLE 1
43+
44+
```powershell
45+
Clear-SPOTenantPreAuthSettings –Type Allow
46+
```
47+
48+
This example clears all list items from the allow list.
49+
50+
**Example Output**:
51+
52+
```powershell
53+
Confirm
54+
55+
This action will permanently delete all the Allow list item settings. Are you sure you want to proceed?
56+
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
57+
```
58+
59+
### EXAMPLE 2
60+
61+
```powershell
62+
Clear-SPOTenantPreAuthSettings –Type Deny
63+
```
64+
65+
This example clears all list items from the deny list.
66+
67+
## PARAMETERS
68+
69+
### -Type
70+
71+
This parameter indicates whether the cmdlet is interacting with the Allow list or the Deny list within the SPOTenantPreAuthSettings.
72+
73+
PARAMVALUE: Allow | Deny
74+
75+
```yaml
76+
Type: ListType
77+
Applicable: SharePoint Online
78+
Required: True
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### CommonParameters
86+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
87+
88+
## RELATED LINKS
89+
90+
- [Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md)
91+
- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md)

0 commit comments

Comments
 (0)