Skip to content

Update parameters for legacy Exchange tokens #12360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
a6306b4
Update switches for legacy Exchange tokens
samantharamon Nov 12, 2024
24d2ea4
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Nov 12, 2024
408fb73
Update Remove-AuthenticationPolicy.md
chrisda Nov 19, 2024
9dea352
Update Remove-AuthenticationPolicy.md
chrisda Nov 19, 2024
9b2bfeb
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Nov 19, 2024
1ab3aad
Minor consistency updates
chrisda Nov 19, 2024
c2774ef
Remove Get-AuthenticationPolicy changes
samantharamon Nov 20, 2024
57a8aa5
Add note about token issuance
samantharamon Nov 20, 2024
b71b4ca
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Nov 20, 2024
2e0cf6f
Add examples for Exchange token switches
samantharamon Nov 21, 2024
c4212ad
Add note
samantharamon Nov 21, 2024
34311c6
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Nov 22, 2024
44f2354
Apply suggestions from review
samantharamon Nov 22, 2024
720a163
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Dec 10, 2024
511a8d4
Add Get-AuthenticationPolicy switch
samantharamon Dec 11, 2024
c659d15
Add note to Get-AuthenticationPolicy switch
samantharamon Dec 12, 2024
acfc6d5
Update Get-AuthenticationPolicy.md
chrisda Dec 12, 2024
0e8e412
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Dec 12, 2024
f7032e3
Merge branch 'main' into samramon-legacy-exchange-parameters
chrisda Dec 12, 2024
da99bf6
Update exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md
chrisda Dec 12, 2024
215d969
Update exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md
chrisda Dec 12, 2024
612fc39
Update exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md
chrisda Dec 12, 2024
6ed65f9
Update exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md
chrisda Dec 12, 2024
7f7a470
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
184b729
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
ccffc5a
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
edf657f
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
3d2a9f1
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
09a95ae
Update exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
chrisda Dec 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha

```
Get-AuthenticationPolicy [[-Identity] <AuthPolicyIdParameter>]
[-AllowLegacyExchangeTokens]
[-TenantId <String>]
[<CommonParameters>]
```
Expand All @@ -44,6 +45,13 @@ Get-AuthenticationPolicy -Identity "Engineering Group"

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

### Example 3
```powershell
Get-AuthenticationPolicy -AllowLegacyExchangeTokens
```

In Exchange Online, this example specifies whether legacy Exchange tokens for Outlook add-ins are allowed in the organization.

## PARAMETERS

### -Identity
Expand All @@ -66,6 +74,31 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AllowLegacyExchangeTokens
This parameter is available only in the cloud-based service.

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.

Legacy Exchange tokens include Exchange user identity and callback tokens.

**Important**:

- 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.
- 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).

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Online, Exchange Online Protection

Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
```

### -TenantId
This parameter is available only in the cloud-based service.

Expand Down
20 changes: 19 additions & 1 deletion exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ Remove-AuthenticationPolicy -Identity "Engineering Group"

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

### Example 2
```powershell
Remove-AuthenticationPolicy -Identity "Legacy Exchange Tokens" -AllowLegacyExchangeTokens
```

In Exchange Online, this example returns your organization to its previous state before legacy Exchange token issuance was allowed or blocked for Outlook add-ins. Since this switch applies to the entire organization, the authentication policy specified with the Identity parameter is ignored.

## PARAMETERS

### -Identity
Expand All @@ -66,7 +73,18 @@ Accept wildcard characters: False
### -AllowLegacyExchangeTokens
This parameter is available only in the cloud-based service.

This parameter is reserved for internal Microsoft use.
The AllowLegacyExchangeTokens switch returns your organization to its previous state before changes were made to allow or block legacy Exchange tokens for Outlook add-ins. You don't need to specify a value with this switch.

Legacy Exchange tokens include Exchange user identity and callback tokens.

This switch applies to the entire organization. Although the Identity parameter is required, its value is ignored. You can pass any non-empty value as the Identity parameter.

**Important**:

- 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.
- It might take up to 24 hours for the change to take effect across your entire organization.
- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire.
- 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).

```yaml
Type: SwitchParameter
Expand Down
35 changes: 32 additions & 3 deletions exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ Set-AuthenticationPolicy -Identity "Research and Development Group" -BlockLegacy

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

### Example 3
```powershell
Set-AuthenticationPolicy -Identity "Legacy Exchange Tokens" -BlockLegacyExchangeTokens
```

In Exchange Online, this example blocks legacy Exchange tokens from being issued to Outlook add-ins. Since this switch applies to the entire organization, the authentication policy specified with the Identity parameter is ignored.

## PARAMETERS

### -Identity
Expand Down Expand Up @@ -354,7 +361,17 @@ Accept wildcard characters: False
### -AllowLegacyExchangeTokens
This parameter is available only in the cloud-based service.

This parameter is reserved for internal Microsoft use.
The AllowLegacyExchangeTokens switch specifies whether to allow legacy Exchange tokens for Outlook add-ins. You don't need to specify a value with this switch.

Legacy Exchange tokens include Exchange user identity and callback tokens.

This switch applies to the entire organization. Although the Identity parameter is required, its value is ignored. You can pass any non-empty value as the Identity parameter.

**Important**:

- 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.
- It might take up to 24 hours for the change to take effect across your entire organization.
- 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).

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -540,7 +557,19 @@ Accept wildcard characters: False
### -BlockLegacyExchangeTokens
This parameter is available only in the cloud-based service.

This parameter is reserved for internal Microsoft use.
The BlockLegacyExchangeTokens switch specifies whether to block legacy Exchange tokens for Outlook add-ins. You don't need to specify a value with this switch.

Legacy Exchange tokens include Exchange user identity and callback tokens.

This switch applies to the entire organization. Although the Identity parameter is required, its value is ignored. You can pass any non-empty value as the Identity parameter.

**Important**:

- 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.
- It might take up to 24 hours for the change to take effect across your entire organization.
- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire.
- 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.
- 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).

```yaml
Type: SwitchParameter
Expand All @@ -550,7 +579,7 @@ Applicable: Exchange Online, Exchange Online Protection

Required: False
Position: Named
Default value: True
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Loading