Skip to content

Commit 1beee1a

Browse files
authored
Merge pull request #12360 from samantharamon/samramon-legacy-exchange-parameters
Update parameters for legacy Exchange tokens
2 parents 3f99fe8 + 09a95ae commit 1beee1a

File tree

3 files changed

+84
-4
lines changed

3 files changed

+84
-4
lines changed

exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121

2222
```
2323
Get-AuthenticationPolicy [[-Identity] <AuthPolicyIdParameter>]
24+
[-AllowLegacyExchangeTokens]
2425
[-TenantId <String>]
2526
[<CommonParameters>]
2627
```
@@ -44,6 +45,13 @@ Get-AuthenticationPolicy -Identity "Engineering Group"
4445

4546
This example returns detailed information for the authentication policy named Engineering Group.
4647

48+
### Example 3
49+
```powershell
50+
Get-AuthenticationPolicy -AllowLegacyExchangeTokens
51+
```
52+
53+
In Exchange Online, this example specifies whether legacy Exchange tokens for Outlook add-ins are allowed in the organization.
54+
4755
## PARAMETERS
4856

4957
### -Identity
@@ -66,6 +74,31 @@ Accept pipeline input: False
6674
Accept wildcard characters: False
6775
```
6876
77+
### -AllowLegacyExchangeTokens
78+
This parameter is available only in the cloud-based service.
79+
80+
The AllowLegacyExchangeTokens switch specifies whether legacy Exchange tokens are allowed for Outlook add-ins in your organization. You don't need to specify a value with this switch.
81+
82+
Legacy Exchange tokens include Exchange user identity and callback tokens.
83+
84+
**Important**:
85+
86+
- Currently, the AllowLegacyExchangeTokens switch only specifies whether legacy Exchange tokens are allowed in your organization. For now, disregard the empty Allowed and Blocked arrays returned by the switch.
87+
- Legacy Exchange tokens will eventually be blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens).
88+
89+
```yaml
90+
Type: SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases:
93+
Applicable: Exchange Online, Exchange Online Protection
94+
95+
Required: False
96+
Position: Named
97+
Default value: True
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
69102
### -TenantId
70103
This parameter is available only in the cloud-based service.
71104

exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ Remove-AuthenticationPolicy -Identity "Engineering Group"
4141

4242
This example removes the authentication policy named "Engineering Group".
4343

44+
### Example 2
45+
```powershell
46+
Remove-AuthenticationPolicy -Identity "LegacyExchangeTokens" -AllowLegacyExchangeTokens
47+
```
48+
49+
In Exchange Online, this example enables legacy Exchange tokens to be issued to Outlook add-ins. This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication polices can't be applied.
50+
4451
## PARAMETERS
4552

4653
### -Identity
@@ -66,7 +73,18 @@ Accept wildcard characters: False
6673
### -AllowLegacyExchangeTokens
6774
This parameter is available only in the cloud-based service.
6875
69-
This parameter is reserved for internal Microsoft use.
76+
The AllowLegacyExchangeTokens switch enables legacy Exchange tokens to be issued to Outlook add-ins for your organization. You don't need to specify a value with this switch.
77+
78+
Legacy Exchange tokens include Exchange user identity and callback tokens.
79+
80+
This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication polices can't be applied.
81+
82+
**Important**:
83+
84+
- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes.
85+
- It might take up to 24 hours for the change to take effect across your entire organization.
86+
- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire.
87+
- Legacy Exchange tokens will eventually be blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens).
7088
7189
```yaml
7290
Type: SwitchParameter

exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ Set-AuthenticationPolicy -Identity "Research and Development Group" -BlockLegacy
7777

7878
In Exchange 2019, this example re-enables Basic authentication for Exchange Reporting Web Services in the authentication policy named Research and Development Group.
7979

80+
### Example 3
81+
```powershell
82+
Set-AuthenticationPolicy -Identity "LegacyExchangeTokens" -BlockLegacyExchangeTokens
83+
```
84+
85+
In Exchange Online, this example blocks legacy Exchange tokens from being issued to Outlook add-ins. The switch applies to the entire organization, and the Identity parameter must be set to the value "LegacyExchangeTokens". Specific authentication polices can't be applied.
86+
8087
## PARAMETERS
8188

8289
### -Identity
@@ -354,7 +361,17 @@ Accept wildcard characters: False
354361
### -AllowLegacyExchangeTokens
355362
This parameter is available only in the cloud-based service.
356363

357-
This parameter is reserved for internal Microsoft use.
364+
The AllowLegacyExchangeTokens switch specifies to allow legacy Exchange tokens to be issued to Outlook add-ins. You don't need to specify a value with this switch.
365+
366+
Legacy Exchange tokens include Exchange user identity and callback tokens.
367+
368+
The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication polices can't be applied.
369+
370+
**Important**:
371+
372+
- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes.
373+
- It might take up to 24 hours for the change to take effect across your entire organization.
374+
- Legacy Exchange tokens will eventually be blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens).
358375

359376
```yaml
360377
Type: SwitchParameter
@@ -540,7 +557,19 @@ Accept wildcard characters: False
540557
### -BlockLegacyExchangeTokens
541558
This parameter is available only in the cloud-based service.
542559

543-
This parameter is reserved for internal Microsoft use.
560+
The BlockLegacyExchangeTokens switch specifies to block legacy Exchange tokens being issued to Outlook add-ins. You don't need to specify a value with this switch.
561+
562+
Legacy Exchange tokens include Exchange user identity and callback tokens.
563+
564+
The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication polices can't be applied.
565+
566+
**Important**:
567+
568+
- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes.
569+
- It might take up to 24 hours for the change to take effect across your entire organization.
570+
- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire.
571+
- Blocking legacy Exchange tokens might cause some Microsoft add-ins to stop working. These add-ins are being updated to no longer use legacy tokens.
572+
- Legacy Exchange tokens will eventually be blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens).
544573

545574
```yaml
546575
Type: SwitchParameter
@@ -550,7 +579,7 @@ Applicable: Exchange Online, Exchange Online Protection
550579
551580
Required: False
552581
Position: Named
553-
Default value: True
582+
Default value: False
554583
Accept pipeline input: False
555584
Accept wildcard characters: False
556585
```

0 commit comments

Comments
 (0)