Skip to content

Commit 4dec5a0

Browse files
Updated the DOC of Microsoft EWS (#4751)
* updated the DOC of microsoft-ews * Updates from review --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 16b67ac commit 4dec5a0

File tree

1 file changed

+22
-7
lines changed
  • docs/platform-services/automation-service/app-central/integrations

1 file changed

+22
-7
lines changed

docs/platform-services/automation-service/app-central/integrations/microsoft-ews.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
77

88
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/microsoft-ews.png')} alt="microsoft-ews" width="100"/>
99

10-
***Version: 2.3
11-
Updated: Mar 4, 2024***
10+
***Version: 2.4
11+
Updated: Nov 12, 2024***
1212

1313
Perform actions on Microsoft EWS mailboxes, accounts, and security settings.
1414

@@ -31,7 +31,7 @@ Perform actions on Microsoft EWS mailboxes, accounts, and security settings.
3131

3232
Each application you want the Microsoft identity platform to perform identity and access management (IAM) needs to be registered. Registering it establishes a trust relationship between your application and the identity provider, the Microsoft identity platform.
3333

34-
**Register an application**
34+
### Register an application
3535

3636
Registering your application establishes a trust relationship between your app and the Microsoft identity platform. The trust is unidirectional: your app trusts the Microsoft identity platform, and not the other way around.
3737

@@ -49,14 +49,15 @@ When registration completes, the Azure portal displays the app registration's Ov
4949

5050
The client ID as one aspect in validating the security tokens it receives from the identity platform.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/microsoft-ews/microsoft-ews-3.png')} style={{border:'1px solid gray'}} alt="/microsoft-ews" width="800"/>
5151

52-
**Add credentials**
52+
### Add credentials
5353

5454
Credentials are used by confidential client applications that access an API. Examples of confidential clients are web apps, or service- and daemon-type applications. Credentials allow your application to authenticate as itself, requiring no interaction from a user at runtime.
5555
You can add client secrets (a string) as credentials to your confidential client app registration.
5656

5757
<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/microsoft-ews/microsoft-ews-4.png')} style={{border:'1px solid gray'}} alt="/microsoft-ews" width="800"/>
5858

59-
**Add a client secret**
59+
### Add a client secret
60+
6061
The client secret, known also as an application password, is a string value of your app.
6162

6263
1. Select your application in App registrations in the Azure portal.
@@ -66,15 +67,15 @@ The client secret, known also as an application password, is a string value of y
6667
5. Select **Add**.
6768
6. Record the secret's value for use in your client application code - it's never displayed again after you leave this page.
6869

69-
**Add permissions to API**
70+
### Add permissions to API
7071

7172
1. Select your application in App registrations in the Azure portal.
7273
2. Select **API permissions > Add a permission**.
7374
3. Delegated permissions are selected by default. Delegated permissions are appropriate for client apps that access an API as the signed-in user, and whose access should be restricted to the permissions you select in the next step.
7475
4. Application permissions are for service- or daemon-type applications that need to access API as themselves, without user interaction for sign-in or consent. Unless you've defined application roles for your API.
7576
5. Select Add a permission, and add the following permissions (as we can see from picutre). <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/microsoft-ews/microsoft-ews-5.png')} style={{border:'1px solid gray'}} alt="/microsoft-ews" width="800"/>
7677

77-
**EWS API need to be configure these permissions**
78+
#### EWS API to be configured for these permissions
7879

7980
Applications are authorized to call APIs when they are granted permissions by users/admins as part of the consent process. The list of configured permissions should include all the permissions the application needs.
8081

@@ -130,6 +131,17 @@ full\_access\_as\_app Use Exchange Web Services with full access to all mailboxe
130131

131132
Once API permission are added then Admin must consent to a grant these permissions, [Learn more about permissions and consent](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent?WT.mc_id=Portal-Microsoft_AAD_RegisteredApps).
132133

134+
### Assign the required roles in the Exchange Admin Center
135+
136+
1. Sign in to the [Exchange Admin Center (EAC)](https://admin.exchange.microsoft.com/#/).
137+
2. In the EAC, navigate to **Roles**.
138+
3. Click **Admin Roles**.
139+
4. Search for the role **Discovery Management** and click on it.
140+
5. Click on the **Assign** tab.
141+
6. Click **+** and search for the user you want to assign the role to.
142+
7. Click **Save**.
143+
144+
133145
## Category
134146

135147
Email Gateway
@@ -146,3 +158,6 @@ Email Gateway
146158
* November 29, 2022 - Added new actions (Send Email and Reply To Email)
147159
* October 6, 2023 (v2.2) - Integration Updated
148160
* March 4, 2024 (v2.3) - Updated code for compatibility with Python 3.12
161+
* November 12, 2024 (v2.4)
162+
* Updated the exchange_lib library to 5.4.2
163+
* Updated the action Get Contacts to return the message "No contacts found" if the contacts are not found rather than returning an exception.

0 commit comments

Comments
 (0)