Skip to content

Commit 92c4e12

Browse files
CSOAR-3898: Updated the WIF configuration steps (#5835)
* CSOAR-3898: Updated the WIF configuration steps * CSOAR-3898: Fixed review comments * Updates from review --------- Co-authored-by: John Pipkin <[email protected]>
1 parent c60ebc9 commit 92c4e12

File tree

10 files changed

+42
-3
lines changed

10 files changed

+42
-3
lines changed

docs/platform-services/automation-service/app-central/integrations/google-chat.md

Lines changed: 42 additions & 3 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/google.png')} alt="google" width="80"/>
99

10-
***Version: 2.1
11-
Updated: Dec 06, 2024***
10+
***Version: 2.2
11+
Updated: Sept 25, 2025***
1212

1313
Google Chat is an intelligent and secure communication and collaboration tool, built for teams.
1414

@@ -29,6 +29,44 @@ To send rich text messages, use the Create Message action with `Disable HTML` in
2929

3030
## Google Chat configuration
3131

32+
Our Google Chat integration support two types of authentication, Service Account and WIF (Workload Identity Federation). We recommend using WIF since it is more secure and easier to manage. For more information, see [Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation).
33+
34+
## Required AWS details from Sumo Logic
35+
36+
To configure the Google Chat integration using WIF authentication, you need the following AWS details from Sumo Logic. These details are essential for setting up the Workload Identity Federation (WIF) credentials in Google Workspace:
37+
* Sumo Logic AWS account ID: `246946804217`
38+
* Sumo Logic AWS role: `stag-csoar-automation-gcpiam`
39+
* Sumo Logic AWS Lambda function: `stag-csoar-automation-gcpiam`
40+
* Full ARN: `arn:aws:sts::246946804217:assumed-role/stag-csoar-automation-gcpiam/stag-csoar-automation-gcpiam`
41+
42+
43+
### Workload Identity Federation (WIF) authentication
44+
45+
To [create WIF credentials](https://cloud.google.com/iam/docs/workload-identity-federation) in Google Workspace needed to configure the Google Chat app integration, follow these steps:
46+
1. Log in to the [Google Cloud](https://console.cloud.google.com) portal.
47+
2. Select a Google Cloud project (or create a new one).
48+
3. Go to the **API&Services**
49+
4. In the same page click on **ENABLED API AND SERVICES** and search for Google Chat and enable it.
50+
5. Go to the **IAM & Admin** > **Service Accounts** page.
51+
6. Click **CREATE SERVICE ACCOUNT** [Service Account](https://cloud.google.com/iam/docs/service-accounts-create) is required to access the Google Chat API.
52+
7. While creating the service account, in **Permissions** add the role **Service Account Token Creator** and click on **DONE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-11.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
53+
8. Go to the **IAM & Admin** > **Workload Identity Federation** page. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-4.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
54+
9. Click **CREATE POOL**, provide the details, and click on **CONTINUE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-5.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
55+
10. Add **Provider details**. Select **AWS** as the provider type and provide the details of the AWS Account ID which is provided by Sumo Logic. Click on **CONTINUE** and **SAVE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-6.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
56+
11. Now you will see the created pool and provider. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-8.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
57+
12. Now we have to build a principal name to configure in Sumo Logic. The format of the principal name is: `principalSet://iam.googleapis.com/projects/{YourProjectID}/locations/global/workloadIdentityPools/{YourPoolName}/attribute.aws_role/arn:aws:sts::{SumoAWSAccountID}:assumed-role/{SumoAWSRole}/{SumoAWSLambdaFunction}`.
58+
13. Go to the **IAM & Admin** > **IAM** page and click on **Grant Access** to add a new principal.
59+
14. In the **New principals** field, provide the above principal name and select the role **Workload Identity User**. Click on **SAVE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-12.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
60+
15. Go to the **IAM & Admin** > **Workload Identity Federation** page and select the pool which was created above.
61+
16. Click on **Grant Access** > **Grant access using service account impersonation**.
62+
17. Select the service account which created above, select the principle as aws_role and provide the arn `arn:aws:sts::{SumoAWSAccountID}:assumed-role/{SumoAWSRole}` and click on **SAVE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-chat/google-chat-10.png')} style={{border:'1px solid gray'}} alt="google-chat" width="800"/>
63+
18. Again go to **Grant Access** > **Grant access using service account impersonation**. Select the service account which was created above. Select the principle as `aws_role` and provide the arn `arn:aws:sts::{SumoAWSAccountID}:assumed-role/{SumoAWSRole}/{SumoAWSLambdaFunction}`. Click on **SAVE**.
64+
19. Download the WIF `conf.json` file. Make sure you save it in a safe place. Use the JSON content to configure the Google Chat integration to use WIF authentication in Automation Service and Cloud SOAR.
65+
20. To configure the app in Google Chat API, go to **APIs & Services**, select **Google Chat API**, and in **CONFIGURATION** provide the details and click on **SAVE**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-10.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/>
66+
21. Go to the **Google Chat App** and add the above app in that. Also, to add above app in space, go to **space** and in **Apps & integration** add the app.
67+
68+
69+
### Service Account authentication
3270
To [create service account credentials](https://developers.google.com/workspace/guides/create-credentials) in Google Workspace needed to configure the Google Chat app integration, follow these steps:
3371

3472
1. Log in to the [Google Cloud](https://console.cloud.google.com) portal.
@@ -83,4 +121,5 @@ Use Google Chat to receive notifications, ensuring you promptly get important up
83121

84122
* August 27, 2024 (v2.0) - First upload
85123
* October 29, 2024 (v2.0) - Updated the docs
86-
* December 06, 2024 (v2.1) - Added the Rich Text Message support in the Create Message action
124+
* December 06, 2024 (v2.1) - Added the Rich Text Message support in the Create Message action
125+
* September 25, 2025 (v2.2) - Updated the WIF configuration steps
788 KB
Loading
424 KB
Loading
539 KB
Loading
470 KB
Loading
432 KB
Loading
441 KB
Loading
438 KB
Loading
526 KB
Loading
769 KB
Loading

0 commit comments

Comments
 (0)