Skip to content

Commit 7edd222

Browse files
authored
Create Get-SPOTenantPreAuthSettings.md
1 parent 796bc7c commit 7edd222

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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, neilh
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+
## EXAMPLES
31+
32+
### EXAMPLE 1
33+
34+
```powershell
35+
Get-SPOTenantPreAuthSettings
36+
```
37+
38+
This example returns all the PreAuthentication settings for the tenant as an object.
39+
40+
**Example Output**:
41+
42+
```powershell
43+
IsDisabled AllowList
44+
---------- ----------
45+
True {{Id: 1cddb994-de09-4ebd-b401-5d68ea148252, IncludedApps: [00000000-0000-0000-0000-000000000000], Exclude...
46+
```
47+
48+
### EXAMPLE 2
49+
50+
```powershell
51+
Get-SPOTenantPreAuthSettings | ConvertTo-Json
52+
```
53+
54+
Gets all the pre auth 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.
55+
56+
**Example Output**:
57+
58+
```powershell
59+
{
60+
"IsDisabled": true,
61+
"AllowList": [
62+
{
63+
"Id": "1cddb994-de09-4ebd-b401-5d68ea148252",
64+
"IncludedApps": "00000000-0000-0000-0000-000000000000",
65+
"ExcludedApps": "",
66+
"IncludedFeatures": "",
67+
"ExcludedFeatures": "Download, WebRenderingEmbed"
68+
}
69+
],
70+
"DenyList": [
71+
72+
]
73+
}
74+
```
75+
76+
## PARAMETERS
77+
78+
### CommonParameters
79+
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).
80+
81+
## RELATED LINKS
82+
83+
- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md)
84+
- [Clear-SPOTenantPreAuthSettings](Clear-SPOTenantPreAuthSettings.md)

0 commit comments

Comments
 (0)