diff --git a/docs/platform-services/automation-service/app-central/integrations/index.md b/docs/platform-services/automation-service/app-central/integrations/index.md index c865f075a3..b6f16f6700 100644 --- a/docs/platform-services/automation-service/app-central/integrations/index.md +++ b/docs/platform-services/automation-service/app-central/integrations/index.md @@ -13,7 +13,7 @@ Please refer to the individual integration documentation for detailed informatio Some integrations are tailor-made for Cloud SOAR and are indicated as such within their respective documentation entries. These integrations only appear in the [Cloud SOAR App Central](/docs/cloud-soar/automation/#app-central). ::: -## Integrations (331) +## Integrations (332) import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; diff --git a/docs/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail.md b/docs/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail.md new file mode 100644 index 0000000000..51d075eee6 --- /dev/null +++ b/docs/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail.md @@ -0,0 +1,91 @@ +--- +title: Sumo Logic Notifications By Gmail +description: '' +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +sumo-logic-notifications + +***Version: 1.0 +Updated: July 26, 2024*** + +Integration with Sumo Logic platform for monitors and Slack notification. + +## Actions + +* **Assess Alert Status** (*Scheduled*) - Periodically monitor status of a Sumo Logic alert and notify a Slack user about an unresolved alert. +* **Authorize DO NOT USE IN PLAYBOOK** (*Enrichment*) - Authorize access to Gmail. This should only be run once and not from a playbook. +* **Confirm DO NOT USE IN PLAYBOOK** (*Enrichment*) - Confirm access to Gmail. This should only be run once and not from a playbook. + +## Sumo Logic Notifications By Gmail configuration + +1. In the main Sumo Logic menu, select your username and then **Preferences**. +2. From the preferences screen, in the section **My Access Keys**, click **Add Access Key**.
sumo-logic-notifications +3. Populate the name and click **Create Key**.
sumo-logic-notifications +4. Copy the **Access ID** and **Access Key** and store them (temporally) into a text editor. + :::note + They won't be available again once you close this screen. + ::: +5. Click **Done** after you copied the Access ID and Access Key.
sumo-logic-notifications +6. Create a new Project in the [Developer Console](https://console.developers.google.com/). +7. In the **APIs & Services** section, navigate to **Credentials** and select **Create Credentials**: [https://console.cloud.google.com/apis/api](https://console.cloud.google.com/apis/api). +8. Select **OAuth Client ID** as the credential type and set the following inputs: + * **Application Type**. Web Application. + * **Authorized redirect URIs > Add URI**. Enter `http://localhost/`. + :::note + Will only be used to generate a refresh token. + ::: +9. Copy the resulting Client ID and Client Secret Key values, as these will be used later.
gmail +10. Navigate to the **OAuth Consent Screen** section and set the following inputs: + * **App Name** + * **User Support Email**. Set to an email that you have access to. + * **Developer Contact Information**. Set to an email that you have access to. +11. The following Scopes are needed: + * `https://mail.google.com` + * `https://www.googleapis.com/auth/gmail.modify` + * `https://www.googleapis.com/auth/gmail.readonly` + * `https://www.googleapis.com/auth/admin.directory.user` + * `https://www.googleapis.com/auth/gmail.compose` + * `https://www.googleapis.com/auth/gmail.send` + * `https://www.googleapis.com/auth/gmail.settings.basic` + * `https://www.googleapis.com/auth/gmail.settings.sharing` + +12. In Cloud SOAR, navigate to **Automation > Integrations > Gmail**, add a new Resource and provide the following inputs: + * Client ID (generated in step 4) + * Client Secret Key (generated in step 4) +13. Save and close the Resource. +14. Click and execute the **Authorize DO NOT USE IN PLAYBOOK** action. If successful, a URL will be returned.
gmail +15. Open a new browser tab, and navigate to the URL generated in the previous step. +16. Provide consent for this developer project to access the Gmail API. +17. The response to this consent flow is the localhost redirect specified earlier. Copy this URL. +18. Within this URL, copy the code nested in this URL: + ``` + http://localhost/?code=4/0AbUR2VXXXXFe8kuMTUE4Dkxts4J8mo3\_BkZKxXAcdzXXXXtd9lrjai00pEuG0YXWtWjimg&scope=https://mail.google.com/%20https://www.googleapis.com/auth/gmail.settings.basic + ``` +
gmail +19. In Cloud SOAR, click and run the **Confirm DO NOT USE IN PLAYBOOK** action, providing the code generated above in the Code input.
gmail +20. This will return a JSON result with a "**credentials**" key. Copy the value of this key, which is a base64-encoded string JSON credential we will use in the next and final step.
gmail +21. Paste the base64 string in the "**credentials**" field of the Integration Resource created in **step 12**. Save and close the resource window. + +## External Libraries + +* [Gmail (python)](https://github.com/googleapis/google-auth-library-python/blob/master/LICENSE) +* [Gmail (Google API)](https://github.com/googleapis/google-api-python-client/blob/master/LICENSE) + +## Sumo Logic Notifications By Gmail in Automation Service and Cloud SOAR + +1. Access integrations in the [Automation Service](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) or [Cloud SOAR](/docs/cloud-soar/automation). +2. After the list of the integrations appears, search for the integration and click on the row. +3. The integration details will appear. Click the **+** button to add a new Resource.
sumo-logic-notifications +4. Populate all the required fields (\*) and then click **Save**.
sumo-logic-notifications + * **Label**. The name of the resource. + * **Sumo Logic API URL**. URL to the API of the instance ([learn more](/docs/api)). + * **Access ID (Sumologic)**. The access ID that you copied earlier. + * **Access Key (Sumologic)**. The access key that you copied earlier. + * **Client ID (Gmail)**. To set up the Client ID, please refer to step 6 . + * **Client Secret Key (Gmail)**. To set up the Client Secret Key, please refer to step 6. + * **Credentials(Gmail)**. Retrieve Credentials from the "Confirm DO NOT USE IN PLAYBOOK" Action +## Change Log + +* July 26, 2024 - First upload \ No newline at end of file diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-1.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-1.png new file mode 100644 index 0000000000..15cd85a8de Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-1.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-10.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-10.png new file mode 100644 index 0000000000..4b4e2545b1 Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-10.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-2.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-2.png new file mode 100644 index 0000000000..9e1d283adc Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-2.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-3.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-3.png new file mode 100644 index 0000000000..6654eb1e9c Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-3.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-4.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-4.png new file mode 100644 index 0000000000..8e9391ac9a Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-4.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-6.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-6.png new file mode 100644 index 0000000000..26e5009969 Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-6.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-7.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-7.png new file mode 100644 index 0000000000..1e85f18078 Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-7.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-8.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-8.png new file mode 100644 index 0000000000..6890bbede7 Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-8.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-9.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-9.png new file mode 100644 index 0000000000..120e531aef Binary files /dev/null and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications-by-gmail/sumo-logic-notifications-by-gmail-9.png differ diff --git a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications/sumo-logic-notifications-4.png b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications/sumo-logic-notifications-4.png index 8e9391ac9a..defb2b5f06 100644 Binary files a/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications/sumo-logic-notifications-4.png and b/static/img/platform-services/automation-service/app-central/integrations/sumo-logic-notifications/sumo-logic-notifications-4.png differ