Skip to content

Commit dee1661

Browse files
authored
Update Set-SPOTenantPreAuthSettings.md
1 parent 3b08c7c commit dee1661

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Sets the pre auth settings for the tenant.
1919

2020
**What is pre auth?**
2121

22-
SharePoint includes self-issued tokens into some URLs called pre auth URLs or temp auth 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 pre auth URL that includes the token in the `tempauth` query parameter like so:
22+
SharePoint includes self-issued tokens into URLs called pre auth URLs or temp auth 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 pre auth URL that includes the token in the `tempauth` query parameter like so:
2323

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

@@ -64,7 +64,7 @@ Sets the pre auth settings for the tenant.
6464
> 3. IsDisabled
6565
6666
> [!NOTE]
67-
> If there are any overlapping settings (meaning that they apply to the same app id and feature) within the Allow or Deny list, the last setting that comes in the list wins and essentially overwrites the previous settings.
67+
> The -IncludedApps and -IncludedFeatures parameters alone should be enough for simpler configurations. However, there are some cases (like example 3) where the -ExcludedApps and -ExcludedFeatures parameters are useful to define exactly which apps are allowed/denied from using pre auth.
6868
6969
## EXAMPLES
7070

@@ -74,11 +74,13 @@ Set-SPOTenantPreAuthSettings -IsDisabled $true
7474
7575
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"
7676
```
77-
This example disables pre auth for the tenant overall and adds a setting that allows 2 apps continue using pre auth for all features, while the rest of the apps and features are denied from using pre auth.
77+
This example disables pre auth for the tenant overall and adds a setting that allows two apps continue using pre auth for all features, while the rest of the apps and features are denied from using pre auth.
7878

7979
> [!NOTE]
80-
> This example relies on the default values for the `-ExcludedApps`, `-IncludedFeatures`, or `-ExcludedFeatures` parameters. So the following would be an equivalent command, where the empty quotes say that all other apps and features are included for the setting.
81-
> `Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""`
80+
> This example relies on the default values for the `-ExcludedApps`, `-IncludedFeatures`, or `-ExcludedFeatures` parameters. The following would be an equivalent command, where empty quotes for -ExcludedApps mean that the rest of the apps are excluded from the setting and empty quotes for both -IncludedFeatures and -ExcludedFeatures mean that all features are included for the setting.
81+
> ```
82+
> Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
83+
> ```
8284
8385
### Example 2
8486
```powershell
@@ -104,9 +106,9 @@ Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-
104106
105107
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"
106108
```
107-
This example enables pre auth for the tenant overall, but it has overlapping settings between the allow and deny lists. The allow list setting allows the app with id 00000000-0000-0000-0000-000000000000 to use pre auth for WAC, Embed, and Download features. But the deny list setting denies the same app from using pre auth for all features.
109+
This example disables pre auth for the tenant overall, but it has overlapping settings between the allow and deny lists. The allow list setting tries to allow the app with id 00000000-0000-0000-0000-000000000000 to use pre auth for WAC, Embed, and Download features. But the deny list setting denies the same app from using pre auth for all features.
108110

109-
In this case, the app with id 00000000-0000-0000-0000-000000000000 will not be allowed to use pre auth for any feature (including all the allow-listed features) because the deny list takes precedence over the allow list. Any other app will be denied from using pre auth for any feature.
111+
In this case, the app with id 00000000-0000-0000-0000-000000000000 will be denied from using pre auth for any feature (including all the allow-listed features) because the deny list takes precedence over the allow list. Any other app will be denied from using pre auth for any feature.
110112

111113
## PARAMETERS
112114

@@ -180,7 +182,7 @@ String containing a comma-separated list of app ids that are included for the al
180182
181183
Possible Values:
182184
- `""`: Default. If both the -IncludedApps and -ExcludedApps parameters are empty strings, the allow or deny list setting will apply to all apps.
183-
- A comma-separated list of app ids (e.g. `"00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"`): The allow or deny list setting will apply to only the apps in the list and all other apps will not have the setting applied.
185+
- A comma-separated list of app ids (e.g. `"00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"`): The allow or deny list setting will apply to only the apps in the list and all other apps will be excluded from the setting.
184186
185187
```yaml
186188
Type: String
@@ -199,7 +201,7 @@ String containing a comma-separated list of app ids that are excluded for the al
199201
200202
Possible Values:
201203
- `""`: Default. If both the -IncludedApps and -ExcludedApps parameters are empty strings, the allow or deny list setting will apply to all apps.
202-
- A comma-separated list of app ids (e.g. `"00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"`): The allow or deny list setting will not apply to the apps in the list and all other apps will have the setting applied.
204+
- A comma-separated list of app ids (e.g. `"00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111"`): The allow or deny list setting will not apply to the apps in the list and all other apps will be included for this setting.
203205
204206
```yaml
205207
Type: String
@@ -218,7 +220,7 @@ String containing a comma-separated list of features included for the allow list
218220
219221
Possible Values:
220222
- `""`: Default. If both the -IncludedFeatures and -ExcludedFeatures parameters are empty string, the allow or deny list setting will apply to all features.
221-
- A comma-separated list of features (e.g. `"Whiteboard,Download,WAC"`): The allow or deny list setting will apply to only the features in the list (see the list below for all available features) and all other features will not have the setting applied.
223+
- A comma-separated list of features (e.g. `"Whiteboard,Download,WAC"`): The allow or deny list setting will apply to only the features in the list (see the list below for all available features) and all other features will be excluded from the setting.
222224
223225
Features:
224226
- "Whiteboard"
@@ -250,7 +252,7 @@ Features:
250252
- "Thumbnail"
251253
- "Embed"
252254
- "VroomContent"
253-
- "S2S-PAC"
255+
- "S2SPAC"
254256
- "PAC"
255257
- "VideoPlayback"
256258
- "AudioTrackUpload"
@@ -273,7 +275,7 @@ String containing a comma-separated list of features excluded for the allow list
273275
274276
Possible Values:
275277
- `""`: Default. If both the -IncludedFeatures and -ExcludedFeatures parameters are empty string, the allow or deny list setting will apply to all features.
276-
- A comma-separated list of features (e.g. `"Whiteboard,Download,WAC"`): The allow or deny list setting will not apply to the features in the list (see the list above for all available features) and all other features will have the setting applied.
278+
- A comma-separated list of features (e.g. `"Whiteboard,Download,WAC"`): The allow or deny list setting will not apply to the features in the list (see the list above for all available features) and all other features will be included for the setting.
277279
278280
```yaml
279281
Type: String

0 commit comments

Comments
 (0)