Skip to content

Commit 85f0266

Browse files
Merge pull request #812 from lw-msft/patch-2
Add Documentation for SPOTenantPreAuthSettings
2 parents d6ca381 + 3debb3e commit 85f0266

File tree

4 files changed

+455
-0
lines changed

4 files changed

+455
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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
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 -Type <TenantPreAuthSettingsListType> [-WhatIf] [-Confirm] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
Clears the pre-authentication settings for either the allow or deny list.
29+
30+
> [!NOTE]
31+
> **What is pre-authentication?**
32+
>
33+
> 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:
34+
>
35+
> `https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...`
36+
>
37+
> 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.
38+
39+
## EXAMPLES
40+
41+
### EXAMPLE 1
42+
43+
```powershell
44+
Clear-SPOTenantPreAuthSettings –Type Allow
45+
```
46+
47+
This example clears all list items from the allow list.
48+
49+
### EXAMPLE 2
50+
51+
```powershell
52+
Clear-SPOTenantPreAuthSettings –Type Deny
53+
```
54+
55+
This example clears all list items from the deny list.
56+
57+
## PARAMETERS
58+
59+
### -Type
60+
61+
This parameter indicates whether the cmdlet is interacting with the allow list or the deny list.
62+
63+
PARAMVALUE: Allow | Deny
64+
65+
```yaml
66+
Type: TenantPreAuthSettingsListType
67+
Applicable: SharePoint Online
68+
Required: True
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### CommonParameters
76+
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).
77+
78+
## RELATED LINKS
79+
80+
- [Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md)
81+
- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md)
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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/get-spotenantpreauthsettings
5+
applicable: SharePoint Online
6+
title: Get-SPOTenantPreAuthSettings
7+
schema: 2.0.0
8+
author: lw-msft
9+
ms.author: laurenwong
10+
ms.reviewer:
11+
manager: bhaveshd
12+
---
13+
14+
# Get-SPOTenantPreAuthSettings
15+
16+
## SYNOPSIS
17+
18+
Gets the configuration of pre-authentication.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-SPOTenantPreAuthSettings [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
Gets the configuration of pre-authentication.
29+
30+
> [!NOTE]
31+
> **What is pre-authentication?**
32+
>
33+
> 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:
34+
>
35+
> `https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...`
36+
>
37+
> But this feature is currently being deprecated. You can use the related [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md) to control the use of pre-authentication in various use cases.
38+
39+
## EXAMPLES
40+
41+
### EXAMPLE 1
42+
43+
```powershell
44+
Get-SPOTenantPreAuthSettings
45+
```
46+
47+
This example returns all the pre-authentication settings for the tenant as an object.
48+
49+
### EXAMPLE 2
50+
51+
```powershell
52+
Get-SPOTenantPreAuthSettings | ConvertTo-Json
53+
```
54+
55+
Gets all the pre-authentication settings for the tenant. Note that this example uses `ConvertTo-Json` to display the settings in JSON format since more complex Allow or Deny lists may be hard to read as an object.
56+
57+
## PARAMETERS
58+
59+
### CommonParameters
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).
61+
62+
## RELATED LINKS
63+
64+
- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md)
65+
- [Clear-SPOTenantPreAuthSettings](Clear-SPOTenantPreAuthSettings.md)

0 commit comments

Comments
 (0)