This integration will let you collect all user details from your Google Workspace Admin Console along with their metadata. This provides your Coralogix features with additional user details to get better context. The integration will normalize user identifiers from relevant product logs into a cx_security.user
key.
1. Configure a Service Account and API Key to facilitate automated intermediation.
2. Set up Domain Wide Delegation, to authorize your Service Account to read user data and send it to Coralogix. The OAuth Scope permission required is https://www.googleapis.com/auth/admin.directory.user.readonly
.
3. Navigate to API & Services > Library screen. Select Admin SDK API and ensure it’s enabled.
4. From your Coralogix toolbar, navigate to Data Flow > Integrations. Select Google Workspace Users.
5. Click + ADD NEW.
6. If you haven’t already done so in step 1, click GO TO GCP ACCOUNT and create a key file. Then, click NEXT.
7. Click SELECT FILE and upload the key file you previously created.
8. A confirmation will appear when the file is uploaded successfully. Click NEXT.
9. Fill in the settings:
10. Click COMPLETE and finish the setup. Please wait a few minutes before the integration takes effect and user data is available.
11. Verify that the integration pipeline occurred. Go to Data Flow > Data Enrichment > Custom Enrichment. The following two files should have been created: users_normalization
and users_metadata
12. Check that user data was properly ingested. Go to the Explore screen, and run these DataPrime queries to verify that the enrichment files were uploaded with the user details:
source users_normalization source users_metadata
If you are not getting a response, please wait a few minutes and try again.
Once you have activated this integration, the service will automatically connect to your Google Workspace environment and read all relevant user details. User data will be stored under two files in Custom Enrichment: users_normalization
and users_metadata
. This sync will run once a day, to keep an updated status of user details stored in Coralogix.
All logs containing a user email in the cx_security.email
key are automatically enriched into the cx_security.email_enriched
key, which will show the user’s display name and the email in brackets. This is done by the users_normalization
CSV file created automatically in Custom Enrichments.
To enrich other keys containing the email address during log ingestion, select the key in Data Flow > Data Enrichment> Custom Enrichments > users_normalization
. To view the contents of this file, run the DataPrime query:
source users_normalization
The users_metadata
CSV file in Custom Enrichment augments the user with additional metadata, such as department, title and manager’s email. To view all user metadata and further filter results by the user, run the DataPrime query:
source users_metadata
You can also use DataPrime enrich commands to augment your logs with additional user context. Do this automatically during log ingestion by defining the cx_security.email_enriched
key in Data Flow > Data Enrichment > Custom Enrichments. This will allow you to define alert rules based on user context (e.g. department, role) and visualize these statistics in custom dashboards.
Google Workspace Users integration adds user context to normalized log keys as part of Coralogix’s log normalization.
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to contact us via our in-app chat or by emailing [email protected].