diff --git a/docs/platform-services/automation-service/app-central/integrations/google-firestore.md b/docs/platform-services/automation-service/app-central/integrations/google-firestore.md index ed0fd525fb..f962bbc5ee 100644 --- a/docs/platform-services/automation-service/app-central/integrations/google-firestore.md +++ b/docs/platform-services/automation-service/app-central/integrations/google-firestore.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; google ***Version: 1.0 -Updated: Sep 29, 2025*** +Updated: Oct 17, 2025*** Google Firestore is a flexible, scalable NoSQL cloud database, built on Google Cloud infrastructure, to store and sync data for client and server-side development. @@ -19,6 +19,43 @@ Google Firestore is a flexible, scalable NoSQL cloud database, built on Google C ## Google Firestore configuration +Our Google Firestore 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). + +## Required AWS details from Sumo Logic + +To configure the Google Firestore 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: +* Deployment name is the unique name of your Sumo Logic [deployment](/docs/api/about-apis/getting-started/#documentation), for example, `dub`, `fra`, etc. +* Sumo Logic AWS account ID: `926226587429` +* Sumo Logic AWS role: `-csoar-automation-gcpiam` +* Sumo Logic AWS Lambda function: `-csoar-automation-gcpiam` +* Full ARN: `arn:aws:sts::926226587429:assumed-role/-csoar-automation-gcpiam/-csoar-automation-gcpiam` + + +### Workload Identity Federation (WIF) authentication + +To [create WIF credentials](https://cloud.google.com/iam/docs/workload-identity-federation) in Google Workspace needed to configure the Google Firestore integration, follow these steps: +1. Log in to the [Google Cloud](https://console.cloud.google.com) portal. +2. Select a Google Cloud project (or create a new one). +3. Go to the **API&Services** +4. In the same page click on **ENABLED API AND SERVICES** and search for Cloud Resource Manager API, IAM Service Account Credentials API, Identity and Access Management (IAM) API, Security Token Service API, Google Firestore API and enable it all. +5. Go to the **IAM & Admin** > **Service Accounts** page. +6. Click **CREATE SERVICE ACCOUNT** [Service Account](https://cloud.google.com/iam/docs/service-accounts-create) is required to access the Google Firestore. +7. While creating the service account, in **Permissions** add the role **Service Account Token Creator** and click on **DONE**.
google-chat +8. Go to the **IAM & Admin** > **Workload Identity Federation** page.
google-chat +9. Click **CREATE POOL**, provide the details, and click on **CONTINUE**.
google-chat +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**.
google-chat +11. Now you will see the created pool and provider.
google-chat +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}`. +13. Go to the **IAM & Admin** > **IAM** page and click on **Grant Access** to add a new principal. +14. In the **New principals** field, provide the above principal name and select the role **Workload Identity User**. Click on **SAVE**.
google-chat +15. Go to the **IAM & Admin** > **Workload Identity Federation** page and select the pool which was created above. +16. Click on **Grant Access** > **Grant access using service account impersonation**. +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**.
google-chat +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**. +19. Download the WIF `conf.json` file. Make sure you save it in a safe place. Use the JSON content to configure the Google Firestore integration to use WIF authentication in Automation Service and Cloud SOAR. + +### Service Account authentication + To [create service account credentials](https://developers.google.com/workspace/guides/create-credentials) in Google Workspace needed to configure the Google Firestore app integration, follow these steps: 1. Log in to the [Google Cloud](https://console.cloud.google.com) portal. @@ -57,4 +94,4 @@ For information about Google Firestore, see [Google Firestore documentation](htt ## Change Log -* September 29, 2025 (v1.0) - First upload +* October 17, 2025 (v1.0) - First upload