|
| 1 | +--- |
| 2 | +title: Google Workspace IDP |
| 3 | +description: '' |
| 4 | +--- |
| 5 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 6 | + |
| 7 | +<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/google.png')} alt="google" width="80"/> |
| 8 | + |
| 9 | +***Version: 1.1 |
| 10 | +Updated: May 21, 2025*** |
| 11 | + |
| 12 | +Google Workspace Identity Platform (IDP) is a cloud-based identity management system that enables secure authentication, single sign-on (SSO), and user access control across Google services and third-party applications. |
| 13 | + |
| 14 | +## Actions |
| 15 | + |
| 16 | +* **Create User** *(Containment)* - Adds a new user account to the domain. |
| 17 | +* **Enable User** *(Containment)* - Reactivates a previously suspended user account. |
| 18 | +* **Suspend User** *(Containment)* - Temporarily disables a user account. |
| 19 | +* **List All Users** *(Enrichment)* - Retrieves a list of users in the specified domain. |
| 20 | +* **List All Groups** *(Enrichment)* - Lists all Google Groups in the domain. |
| 21 | +* **List Group Members** *(Enrichment)* - Lists all members of a specific group. |
| 22 | +* **Get Group** *(Enrichment)* - Retrieves details of a specific group by group email. |
| 23 | +* **Get User** *(Enrichment)* - Fetches detailed information about a specific user by email or user ID. |
| 24 | + |
| 25 | +## Google Workspace IDP configuration |
| 26 | + |
| 27 | +To [create service account credentials](https://developers.google.com/workspace/guides/create-credentials) in Google Workspace and generate the JSON file needed to configure the Google Workspace IDP integration, follow these steps: |
| 28 | + |
| 29 | +1. Log in to the [Google Cloud](https://console.cloud.google.com) portal. |
| 30 | +1. Select a Google Cloud project (or create a new one). |
| 31 | +1. Go to the **APIs & Services > Credentials** page. |
| 32 | +1. Click **CREATE CREDENTIALS** and select **Service account**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-1.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 33 | +1. Enter a service account name to display in the Google Cloud console. The Google Cloud console generates a service account ID based on this name. |
| 34 | +1. Optional: Enter a description of the service account. |
| 35 | +1. Skip two optional grant permissions steps and click **Done** to complete the service account creation.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-2.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 36 | +1. Click on the generated service account to open the details.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-3.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 37 | +1. Under the **KEYS** tab, click **ADD KEY** and choose **Create new key**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-4.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 38 | +1. Click on **CREATE** (make sure **JSON** is selected).<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-5.png')} style={{border:'1px solid gray'}} alt="google-drive" width="400"/> |
| 39 | +1. The JSON file is downloaded. Make sure you save it in a safe place. |
| 40 | +1. Enable the Admin SDK API for the project at [https://console.cloud.google.com/flows/enableapi?apiid=admin.googleapis.com](https://console.cloud.google.com/flows/enableapi?apiid=admin.googleapis.com). |
| 41 | +1. Go to [https://admin.google.com/ac/owl/domainwidedelegation](https://admin.google.com/ac/owl/domainwidedelegation) to open the Domain-Wide delegation settings in the Google Admin portal |
| 42 | +1. Click on **Add new**. <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-6.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 43 | +1. In the **Client ID** field, provide the client ID from the JSON file.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-7.png')} style={{border:'1px solid gray'}} alt="google-drive" width="300"/><br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-8.png')} style={{border:'1px solid gray'}} alt="google-drive" width="600"/> |
| 44 | +1. In the **OAuth scopes (comma-delimited)** field, provide the following scopes: <br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-workspace-idp/google-workspace-idp1.png')} style={{border:'1px solid gray'}} alt="google-workspace-idp1" width="400"/> |
| 45 | +1. Click **Authorize**.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/google-drive/google-drive-9.png')} style={{border:'1px solid gray'}} alt="google-drive" width="800"/> |
| 46 | + |
| 47 | +## Configure Google Workspace IDP in Automation Service and Cloud SOAR |
| 48 | + |
| 49 | +import IntegrationsAuth from '../../../../reuse/integrations-authentication.md'; |
| 50 | + |
| 51 | +<IntegrationsAuth/> |
| 52 | + |
| 53 | +* **Label**. The desired name for the resource. |
| 54 | +* **Private Key JSON**. Provide the content of the JSON file generated in the previous steps. Open the file and copy-paste the whole content in the field. |
| 55 | +* **Admin User Email**. The e-mail address of a Google Workspace admin user. |
| 56 | +* **Domain Name**. Enter your Google Workspace [domain](https://support.google.com/a/answer/182080?sjid=839597157220156918-NC). |
| 57 | +* **Automation Engine**. Select whether to use [Cloud or Bridge execution](/docs/platform-services/automation-service/automation-service-integrations/#cloud-or-bridge-execution). |
| 58 | +* **Proxy Options**. Select whether to use a proxy. |
| 59 | + |
| 60 | +<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/google-workspace-idp-configuration.png')} style={{border:'1px solid gray'}} alt="Google Workspace IDP Configuration" width="400"/> |
| 61 | + |
| 62 | +For information about Google Workspace IDP, see [Google Workspace IDP API documentation](https://developers.google.com/workspace/admin/directory/reference/rest). |
| 63 | + |
| 64 | +## Change Log |
| 65 | + |
| 66 | +* May 21, 2025 (v1.0) - First upload |
| 67 | +* May 21, 2025 (v1.1) - Updated google logo in integration |
0 commit comments