Skip to content

Commit 8f53468

Browse files
Updated the DOC of azure-ad (#4754)
* updated the DOC of azure-ad * Updates from review --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 4dec5a0 commit 8f53468

File tree

1 file changed

+24
-18
lines changed
  • docs/platform-services/automation-service/app-central/integrations

1 file changed

+24
-18
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

0 commit comments

Comments
 (0)