Skip to content

Commit 97d1564

Browse files
Merge branch 'main' into PLG-97-rename
2 parents e1d7b96 + e3f3929 commit 97d1564

File tree

4 files changed

+48
-26
lines changed

4 files changed

+48
-26
lines changed

docs/platform-services/automation-service/app-central/integrations/azure-ad.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,51 +6,55 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
66

77
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/azure-ad.png')} alt="axonius" width="80"/>
88

9-
***Version: 1.8
10-
Updated: Jan 16, 2024***
9+
***Version: 1.9
10+
Updated: Nov 12, 2024***
1111

1212
Azure Active Directory (Azure AD) is Microsoft's cloud-based identity and access management service, which helps your employees sign in and access resources.
1313

1414
## Actions
1515

16-
* **Create User** *(Enrichment)* - Create a new user.
17-
* **Delete User** *(Containment)* - Delete a specific user.
18-
* **List Users** *(Enrichment)* - List all users.
19-
* **Get User** (Enrichment) - Get details for a specific user.
16+
* **Add Member To Group** *(Enrichment)* - Add a user to a specific group.
2017
* **Create Group** *(Enrichment)* - Create a group.
18+
* **Create User** *(Enrichment)* - Create a new user.
2119
* **Delete Group** *(Containment)* -Delete a specific group.
22-
* **Add Member To Group** *(Enrichment)* - Add a user to a specific group.
20+
* **Delete User** *(Containment)* - Delete a specific user.
21+
* **Disable User** *(Containment)* - Block user account.
2322
* **Get Manager** (*Enrichment*) - Get user manager.
23+
* **Get Member Groups** *(Enrichment)* - Retrieve a Group memberships for the user.
24+
* **Get User** (Enrichment) - Get details for a specific user.
25+
* **List Devices** *(Enrichment)* - Retrieve a list of device objects registered in the organization.
2426
* **List Groups** (*Enrichment*) - List all the groups available in an organization.
27+
* **List Users** *(Enrichment)* - List all users.
28+
* **Reset User Password** *(Containment)* - Reset user password.
2529
* **Revoke Sign In Sessions** (*Containment*) - Invalidates all the refresh tokens issued to applications for a user (as well as session cookies in a user's browser).
26-
* **List Devices** *(Enrichment)* - Retrieve a list of device objects registered in the organization.
27-
* **Disable User** *(Containment)* - Block user account.
28-
* **Get Member Groups** *(Enrichment)* - Retrieve a Group memberships for the user.
2930

3031
## Azure Active Directory configuration
3132

3233
The following steps show how to create an Azure AD Application in order to work with Cloud SOAR.
3334

3435
1. Log in to Azure portal with the user that has administrator privileges.
3536
1. Navigate to **Azure Active Directory** > **App registrations** > **New registration**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-1.png')} style={{border:'1px solid gray'}} alt="azure-ad-1" width="600"/>
36-
1. In the registration form, choose a name for your application and then click Register.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-2.png')} style={{border:'1px solid gray'}} alt="azure-ad-2" width="600"/>
37-
1. Write down the Application ID and Directory ID, you will need them later for the integration configuration.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-3.png')} style={{border:'1px solid gray'}} alt="azure-ad-3" width="600"/>
38-
1. Configure Azure AD Application permissions: on the left choose API permissions.
39-
1. Then click the **Add a permission** button.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-4.png')} style={{border:'1px solid gray'}} alt="azure-ad-4" width="600"/>
40-
1. Select your application in App registrations in the Azure portal.
37+
1. In the registration form, choose a name for your application and then click **Register**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-2.png')} style={{border:'1px solid gray'}} alt="azure-ad-2" width="600"/>
38+
1. Write down the Application ID and Directory ID. You will need them later for the integration configuration.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-3.png')} style={{border:'1px solid gray'}} alt="azure-ad-3" width="600"/>
39+
1. To configure Azure AD Application permissions, on the left choose **API permissions**.
40+
6. Click the **Add a permission** button.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-4.png')} style={{border:'1px solid gray'}} alt="azure-ad-4" width="600"/>
41+
7. Select your application in App registrations in the Azure portal.
4142
* Delegated permissions are selected by default.
4243
* 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.
4344
* Application permissions are for service or daemon-type applications that need to access API as themselves, without user interaction for sign-in or consent.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-5.png')} style={{border:'1px solid gray'}} alt="azure-ad-5" width="700"/>
4445
1. Select the following permissions to add:
4546
* **Delegated (work or school account)**. User.Read, User.ReadWrite, User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All.
4647
* **Delegated (personal Microsoft account)**. User.Read, User.ReadWrite.
4748
* **Application**. User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-6.png')} style={{border:'1px solid gray'}} alt="azure-ad-6" width="600"/>
48-
1. 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)). <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-7.png')} style={{border:'1px solid gray'}} alt="azure-ad-7" width="600"/>
49-
1. Once Admin Consent is granted, API permissions configuration have been completed. Then we have to add a Client secret that will be used for the authentication, along with Client ID and Directory ID. To add Client secret, go to Certificates and secrets, and click **New client secret**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-8.png')} style={{border:'1px solid gray'}} alt="azure-ad-8" width="600"/>
50-
1. Select description and expiry period for the created secret and create it.
49+
1. 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).) <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-7.png')} style={{border:'1px solid gray'}} alt="azure-ad-7" width="600"/>
50+
1. Once Admin Consent is granted, API permissions configuration have been completed. Then we have to add a Client secret that will be used for the authentication, along with Client ID and Directory ID. To add Client secret, go to Certificates and secrets, and click **New client secret**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-8.png')} style={{border:'1px solid gray'}} alt="azure-ad-8" width="600"/>
51+
1. Select description and expiry period for the created secret and create it.
5152
1. Once it's created, make sure you save its value, since its only displayed once.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-9.png')} style={{border:'1px solid gray'}} alt="azure-ad-9" width="600"/>
5253
1. Once you do these steps you will need to find the Tenant ID in order to use it on your resources file.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/azure-ad/azure-ad-10.png')} style={{border:'1px solid gray'}} alt="azure-ad-10" width="600"/>
5354
1. Configuration of Azure AD application is completed, you will need application’s Client ID, secret, Tenant ID.
55+
1. Assign the app the role of User Administrator. This is required to perform action "Reset User Password".
56+
* **Azure Active Directory** > **Roles and administrators** > **User Administrator** > **Add assignments** > **Your app** > **Add**.
57+
5458

5559
## Change Log
5660

@@ -69,3 +73,5 @@ The following steps show how to create an Azure AD Application in order to work
6973
* September 19, 2023 (v1.7) - Versioning
7074
* January 16, 2024 (v1.8)
7175
+ Added New Action: Get Member Groups
76+
* November 12, 2024 (v1.9)
77+
+ Added New Action: Reset User Password

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.

docs/platform-services/automation-service/app-central/integrations/netskope-v2.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ When finished, click **OK**. After being created, tokens can be managed by click
4343
1. The integration details will appear. Click on the **"+"** button to add new Resource.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/netskope-v2/netskope-v2-7.png')} style={{border:'1px solid gray'}} alt="netskope-v2" width="150"/>
4444
1. Populate all the required fields (\*) and then click **SAVE**.
4545
* **Server URL**. URL for API V2 REST API (https://&lt;tenant-name&gt;.goskope.com).
46-
* **Token**. The Token you copied earlier.
46+
* **Token**. The Token you copied earlier.
47+
* <img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/netskope-v2/netskope-v2-11.png')} style={{border:'1px solid gray'}} alt="netskope-v2" width="400"/>
4748
1. Additionally, if need you can populate the query daemons.
4849
1. To make sure the resource is working, hover over the resource and then click the **TEST** that appears on the right.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/netskope-v2/netskope-v2-8.png')} style={{border:'1px solid gray'}} alt="netskope-v2" width="200"/>
4950
1. You should receive a successful notification in the bottom right corner.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/netskope-v2/netskope-v2-10.png')} style={{border:'1px solid gray'}} alt="netskope-v2" width="400"/>
102 KB
Loading

0 commit comments

Comments
 (0)