Skip to content

Commit d591411

Browse files
grtaylor806chrisda
andauthored
Document EwsAllowedAppIDs parameter in Set-OrganizationConfig (#13643)
* Document EwsAllowedAppIDs parameter in Set-OrganizationConfig Added EwsAllowedAppIDs parameter documentation for EWS access control. * Update Set-OrganizationConfig.md * Update Set-OrganizationConfig.md * Update Set-OrganizationConfig.md --------- Co-authored-by: Chris Davis <chris.davis@microsoft.com>
1 parent e090ba6 commit d591411

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

exchange/exchange-ps/ExchangePowerShell/Set-OrganizationConfig.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault <ShortenEventScopeMode>
9393
[-EwsAllowList <MultiValuedProperty>]
9494
[-EwsAllowMacOutlook <Boolean>]
9595
[-EwsAllowOutlook <Boolean>]
96+
[-EwsAllowedAppIDs <String>]
9697
[-EwsApplicationAccessPolicy <EwsApplicationAccessPolicy>]
9798
[-EwsBlockList <MultiValuedProperty>]
9899
[-EwsEnabled <Boolean>]
@@ -418,6 +419,7 @@ Set-OrganizationConfig [-DelayedDelicensingEnabled <Boolean>] [-EndUserMailNotif
418419
[-EwsAllowList <MultiValuedProperty>]
419420
[-EwsAllowMacOutlook <Boolean>]
420421
[-EwsAllowOutlook <Boolean>]
422+
[-EwsAllowedAppIDs <String>]
421423
[-EwsApplicationAccessPolicy <EwsApplicationAccessPolicy>]
422424
[-EwsBlockList <MultiValuedProperty>]
423425
[-EwsEnabled <Boolean>]
@@ -595,6 +597,15 @@ Set-OrganizationConfig -VisibleMeetingUpdateProperties "Location,Subject,Body,Al
595597

596598
In Exchange Online, this example results in meeting updates being auto-processed (meeting update messages aren't visible in attendee Inbox folders) except any changes to meeting location, subject and body as well as any property changes within 15 minutes of the meeting start time.
597599

600+
### Example 7
601+
```powershell
602+
Set-OrganizationConfig -EwsEnabled $true -EwsAllowedAppIDs"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee,11111111-2222-3333-4444-555555555555"
603+
```
604+
605+
This example restricts EWS access to only the two specified Entra applications. All other applications are blocked from accessing EWS.
606+
607+
**Note**: To remove the application ID restriction on EWS access, use the value `$null`.
608+
598609
## PARAMETERS
599610

600611
### -ShortenEventScopeDefault
@@ -2573,6 +2584,36 @@ Accept pipeline input: False
25732584
Accept wildcard characters: False
25742585
```
25752586

2587+
### -EwsAllowedAppIDs
2588+
2589+
> Applicable: Exchange Online
2590+
2591+
This parameter is available only in the cloud-based service.
2592+
2593+
The EwsAllowedAppIDs parameter specifies the Azure AD applications that are allowed to access Exchange Web Services (EWS) when the EwsEnabled parameter on this cmdlet is also set to the value $true. Unspecified applications are blocked from accessing EWS. You identify each application by its Azure AD application ID (GUID).
2594+
2595+
- When EwsEnabled is $true, only applications specified by this parameter can access EWS.
2596+
- When EwsEnabled is $false, all EWS access is blocked regardless of this parameter.
2597+
- When EwsEnabled is blank ($null; not configured), this parameter has no effect.
2598+
2599+
To specify multiple values, use a comma-separated list of GUIDs: `"AppId1,AppId2,...AppIdN"`.
2600+
2601+
To remove all allowed app IDs and stop restricting access by app ID, use the value `$null` for this parameter.
2602+
2603+
**Note**: This parameter applies only to direct EWS (SOAP) connections. It doesn't affect requests from the Microsoft Graph API or the REST endpoint.
2604+
2605+
```yaml
2606+
Type: String
2607+
Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet
2608+
Aliases:
2609+
2610+
Required: False
2611+
Position: Named
2612+
Default value: None
2613+
Accept pipeline input: False
2614+
Accept wildcard characters: False
2615+
```
2616+
25762617
### -EwsApplicationAccessPolicy
25772618

25782619
> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

0 commit comments

Comments
 (0)