From e2124692e5120a3b65e9501d8926adb99ae67892 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Tue, 22 Oct 2024 19:44:25 +0100 Subject: [PATCH 01/11] [Email Security (formerly Area 1)] Restructure Gmail BCC setup and retraction --- .../api/setup/gsuite-bcc-setup/add-domain.mdx | 21 ++++++++++++ .../setup/gsuite-bcc-setup/add-retraction.mdx | 17 ++++++++++ .../gsuite-bcc-setup/bcc-rules-to-area1.mdx | 28 ++++++++++++++++ .../gsuite-bcc-setup/create-project-gcp.mdx | 16 ++++++++++ .../create-service-account.mdx | 32 +++++++++++++++++++ .../gsuite-bcc-setup/geographic locations.mdx | 10 ++++++ .../index.mdx} | 15 ++------- 7 files changed, 126 insertions(+), 13 deletions(-) create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx create mode 100644 src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/geographic locations.mdx rename src/content/docs/email-security/deployment/api/setup/{gsuite-bcc-setup.mdx => gsuite-bcc-setup/index.mdx} (67%) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx new file mode 100644 index 00000000000000..cc4a7a992fd0ca --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx @@ -0,0 +1,21 @@ +--- +title: Find BCC address and add domain +pcx_content_type: how-to +sidebar: + order: 2 +--- + +import { Render } from "~/components" + +:::caution[Area 1 has been renamed] + +::: + +To set up Email Security (formerly Area 1) phishing risk assessment for Gmail: + +1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/). +2. Select the question mark, where you will be able to find your BCC address. +3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**. +4. Fill in the information needed to add your domain, then select **Publish Domain**. + + diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx new file mode 100644 index 00000000000000..a556a12e9e7cca --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx @@ -0,0 +1,17 @@ +--- +title: Add retraction +pcx_content_type: how-to +sidebar: + order: 5 +--- + +import { Render } from "~/components" + +1. On the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/), select **Domains** under **DOMAINS & ROUTING**, then select **NEW DOMAIN**. Fill in the information to add a new domain: + - On **FORWARDING TO**: Enter **Google.com**. + - Adjust **Hops** to 2. + - On **Outbound TLS**: Ensure you select **Forward all messages over TLS**. +2. Select **Publish Domain**. +3. Select **RETRACT SETTINGS** > **Authorize Gmail**. +4. Upload the JSON file [previously generated](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/). +5. Under **DOMAINS**, select the domain you added previously, then select **SAVE**. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx new file mode 100644 index 00000000000000..e77f4865a03f21 --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx @@ -0,0 +1,28 @@ +--- +title: Add BCC rules to Area 1 +pcx_content_type: how-to +sidebar: + order: 3 +--- + +import { Render } from "~/components" + +1. In the [Google Admin console](https://admin.google.com/), go to **Menu** > **Apps** > **Google Workspace** > **Gmail** > **Compliance**. +2. Go to **Content Compliance** > Select **Edit**. +3. Add a **Content Compliance** filter, and name it `Email Security (Area 1) - BCC`. +4. In **Email messages to affect**, select **Inbound**. +5. Select the recipients you want to send emails to Area 1 via BCC: + 1. Select **Add** to configure the expression. + 2. Select **Advanced content match**. + 3. In **Location**, select **Headers + Body**. + 4. In **Match type**, select **Matches regex**. + 5. In **Regexp** input `.*`. You can customize the regex as needed and test within the admin page or on sites like [Regexr](https://regexr.com/). + 6. Select **SAVE**. +6. In **If the above expressions match, do the following**, select **Modify message**, select **Add more recipients** > Select **ADD** > Choose **Advanced**: + 1. Under **Envelope recipient**, select **Change envelope recipient** > **Replace recipient** > Enter the email of the recipient. + 2. Under **Spam and delivery options**, select **Suppress bounces from this recipient**. + 3. Under **Headers**, select **Add X-Gm-Spam and X-Gm-Phishy headers**. + 4. Select **SAVE**. +7. In **Account types to affect**, select **Users** and **Groups**. +8. Select **SAVE**. + diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx new file mode 100644 index 00000000000000..c78c22603b46a7 --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx @@ -0,0 +1,16 @@ +--- +title: Create a project on Google Cloud Console +pcx_content_type: how-to +updated: 2022-10-11 +sidebar: + order: 4 +--- + +import { Render } from "~/components" + +1. Log in to the [Google Cloud Console](https://console.cloud.google.com/welcome/new). From the dashboard, select **CREATE OR SELECT PROJECT**. +2. Provide the details for the new project, and select **CREATE** to start your new project. +3. Once the new project has been created, the Google Cloud Platform console will automatically redirect you to the Project console. If not, you can use the Project selector to change to the project you created. +4. In **Getting Started**, select **Explore and enable APIs** > Select **ENABLE APIs & SERVICES**. +5. On search bar, search for "Admin SDK API". Select **Admin SDK API**, then select **ENABLE**. +6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx new file mode 100644 index 00000000000000..a8e5a7425f4c09 --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx @@ -0,0 +1,32 @@ +--- +title: Create service account +pcx_content_type: how-to +updated: 2022-10-11 +sidebar: + order: 4 +--- + +import { Render } from "~/components" + +1. On the [Google Cloud Console](https://console.cloud.google.com/welcome/new), select **Credentials**. +2. Select **CREATE CREDENTIALS** > **Service account**. +3. Fill in the details to create a service account: + - **Service account name**: Enter **Message Retraction Service Account**. + - **Service account ID**: Enter **message-retraction-service-acc**. + - **Service account description**: Enter **Email Security Message Retraction**. + - Select **CREATE AND CONTINUE**. +4. In **Grant this service account access to project**, select **Select a role** > Choose **Owner**. Select **CONTINUE**, then **DONE**. +5. Go back to **Credentials**, and select your service account under **Service Accounts**. In **Details**, take note of the **Unique ID**. +6. Select **Advanced settings** > **VIEW GOOGLE WORKSPACE ADMIN CONSOLE**, then enter your password. +7. On the sidebar, select **Security** > **Access and data control** > **API controls** > Select **MANAGE DOMAIN WIDE DELEGATION**. +8. Select **Add new** > Add a new client ID: + - **Client ID**: Enter the **Unique ID** you took note of. + - **OAuth scopes**: Enter the following URL: + + ```txt + https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.alias.readonly, https://www.googleapis.com/auth/gmail.labels, https://mail.google.com/ + ``` + - Select **AUTHORIZE**. + +9. Go back to the sidebar > **Service Accounts**. +10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/geographic locations.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/geographic locations.mdx new file mode 100644 index 00000000000000..fd9f9fc26f8071 --- /dev/null +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/geographic locations.mdx @@ -0,0 +1,10 @@ +--- +title: Geographic locations +pcx_content_type: reference +sidebar: + order: 6 +--- + +import { Render } from "~/components" + + \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx similarity index 67% rename from src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup.mdx rename to src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx index 535a6de48a2f72..39d6cb7c45149c 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx @@ -1,7 +1,6 @@ --- title: Gmail BCC setup pcx_content_type: integration-guide -updated: 2022-10-11 sidebar: order: 1 head: @@ -11,24 +10,14 @@ head: --- -import { Render } from "~/components" +import { Render, Details } from "~/components" :::caution[Area 1 has been renamed] - - ::: For customers using Gmail, setting up Email Security via BCC is quick and easy. All you need to do is create a content compliance filter to send emails to Email Security through BCC. The following email flow shows how this works: -![Email flow when setting up a phishing assessment risk for Gmail with Email Security.](~/assets/images/email-security/deployment/api-setup/gmail/gmail-bcc-flow.png) - -To setup Email Security (formerly Area 1) phishing risk assessment for Gmail: - - - -## Geographic locations - - +![Email flow when setting up a phishing assessment risk for Gmail with Email Security.](~/assets/images/email-security/deployment/api-setup/gmail/gmail-bcc-flow.png) \ No newline at end of file From 06e6021006b062605dc847153d666d0eb46e2344 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 11:40:12 +0100 Subject: [PATCH 02/11] Deleting page --- .../api/setup/gsuite-bcc-setup/add-domain.mdx | 2 +- .../retract-settings/gmail-retraction.mdx | 207 ------------------ 2 files changed, 1 insertion(+), 208 deletions(-) delete mode 100644 src/content/docs/email-security/email-configuration/retract-settings/gmail-retraction.mdx diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx index cc4a7a992fd0ca..bdf4bba056cd53 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx @@ -11,7 +11,7 @@ import { Render } from "~/components" ::: -To set up Email Security (formerly Area 1) phishing risk assessment for Gmail: +To set up Email Security (formerly Area 1) for Gmail: 1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/). 2. Select the question mark, where you will be able to find your BCC address. diff --git a/src/content/docs/email-security/email-configuration/retract-settings/gmail-retraction.mdx b/src/content/docs/email-security/email-configuration/retract-settings/gmail-retraction.mdx deleted file mode 100644 index 22f208203c7987..00000000000000 --- a/src/content/docs/email-security/email-configuration/retract-settings/gmail-retraction.mdx +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Gmail retraction -pcx_content_type: how-to -sidebar: - order: 1 -head: - - tag: title - content: Retraction guide for Gmail - ---- - -import { Render } from "~/components" - -![Email workflow for retracting emails with Google Gmail](~/assets/images/email-security/email-retraction/gmail/opening_img-gmail-retraction.png) - -In this tutorial you will learn how to set up email retraction for Gmail. - -## 1. Configure project and service account in Google Cloud Platform - -For Email Security to be able to retract messages from Gmail inboxes, you first need to create a service account in a Google Cloud Platform (GCP) project. - -1. Access the [Google Cloud Console](https://console.cloud.google.com). From the Dashboard, select **CREATE PROJECT**. - - ![Select Create project to start your new project](~/assets/images/email-security/email-retraction/gmail/step1-createproject.png) - -2. Provide the details for the new project, and select **CREATE** to start your new project. - - ![Fill in the details from your organizations](~/assets/images/email-security/email-retraction/gmail/step2-create.png) - -3. Once the new project has been created, the GCP console will automatically redirect you to the Project console. If not, you can use the **Project selector** to change to the project you created. - - ![If you need, use Project selector to choose the project you created in the previous step](~/assets/images/email-security/email-retraction/gmail/step3-project.png) - -4. In the **Getting Started** card, select **Explore and enable APIs** to access the APIs and services configuration console. - - ![Find the Getting started card, and select Explore and enable APIs](~/assets/images/email-security/email-retraction/gmail/step4-explore-apis.png) - -5. Select **ENABLE APIS AND SERVICES** to open the API Library. - - ![Enable APIs and services](~/assets/images/email-security/email-retraction/gmail/step5-enable-apis.png) - -6. You will need to enable the Admin SDK API and the Gmail API. On the API Library, locate the **Google Workspace** section. Then, select **View All** to access all the available APIs for Google Workspace. - - ![Find the View all link to access the Admin SDK API and Gmail API](~/assets/images/email-security/email-retraction/gmail/step6-api-library.png) - -7. Select **Admin SDK API**. - - ![Select the SDK API](~/assets/images/email-security/email-retraction/gmail/step7-sdk-api.png) - -8. Select **Enable** to activate the Admin SDK API. - - ![Select Enable to enable the SDK API](~/assets/images/email-security/email-retraction/gmail/step8-enable-sdk.png) - -9. Return to the Google Workspace API library, and select the **Gmail API**. - - ![Select the Gmail API](~/assets/images/email-security/email-retraction/gmail/step9-gmail-api.png) - -10. Select **ENABLE** to activate the Gmail API. - - ![Select Enable to enable the Gmail API](~/assets/images/email-security/email-retraction/gmail/step10-enable-gmail.png) - -11. You will now create a service account to use the API. From the **Gmail API console**, select **Credentials**. - - ![Select Credentials to create a service account](~/assets/images/email-security/email-retraction/gmail/step11-gmail-credentials.png) - -12. Select **CREATE CREDENTIALS** > **Service account**. - - ![Select Create credentials followed by Service account](~/assets/images/email-security/email-retraction/gmail/step12-credentials.png) - -13. In **Service account details** provide the following information: - - * **Service account name**: `Message Retraction Service Account` - * **Service account ID**: This value is automatically generated. - * **Service account description**: A description for this service. For example, `Email Security Message Retraction` - - Select **CREATE AND CONTINUE** when you are done. - - ![Provide the details to create the service account](~/assets/images/email-security/email-retraction/gmail/step13-service-account-details.png) - -14. In **Grant this service account access to project**, select the **Select a role** drop-down menu. Then, select **Project** on the left column, and **Owner** on the right column. - - ![Find the project owner options, in the Grant this service account access to project section](~/assets/images/email-security/email-retraction/gmail/step14-project-owner.png) - -15. Once the role is assigned, select **DONE** to complete the setup. - - ![Select the Done button to complete the setup](~/assets/images/email-security/email-retraction/gmail/step15-complete-setup.png) - -16. Once the role assignment has been saved, you will return to the API credential configuration console. In **Service Accounts**, select the newly-created service account to configure the domain-wide delegation. - - ![Select your newly-created service account to continue](~/assets/images/email-security/email-retraction/gmail/step16-service-accounts.png) - -17. In **Details**, take note of the **Unique ID**. Then, select **SHOW ADVANCED SETTINGS**. - - ![Take note of the Unique ID code, and then select Show advanced settings](~/assets/images/email-security/email-retraction/gmail/step17-detail.png) - -:::note[Note] -Write down the **Unique ID** value. This information will be required in the next step, for the configuration of domain-wide delegation in the Google Workspace configuration. -::: - -18. Select **VIEW GOOGLE WORKSPACE ADMIN CONSOLE** to configure the domain-wide delegation. This will open a new window to the Google admin console. - - ![Select View Google Workspace Admin Console to configure the domain-wide delegation](~/assets/images/email-security/email-retraction/gmail/step18-google-console.png) - -19. Go to **Security** > **Access and data control** > **API controls**. - - ![Go to Security, Access and data controls, and select API controls](~/assets/images/email-security/email-retraction/gmail/step19-api-controls.png) - -20. Find the **Domain wide delegation** section, and select **MANAGE DOMAIN WIDE DELEGATION**. - - ![Select Manage domain wide delegation](~/assets/images/email-security/email-retraction/gmail/step20-domain-wide-delegation.png) - -21. Select **Add new** to add a new client ID. - - ![Select Add new](~/assets/images/email-security/email-retraction/gmail/step21-add-new.png) - -22. In **Add a new client ID**, enter the following information: - - * **Client ID**: Enter your client ID. This is the Unique ID value you saved in step 17. - * **OAuth scopes**: Enter the following information (the input field accepts comma separated values): - - ```txt - https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.alias.readonly, https://www.googleapis.com/auth/gmail.labels, https://mail.google.com/ - ``` - - Select **AUTHORIZE** when you are finished. - - ![Enter the required information](~/assets/images/email-security/email-retraction/gmail/step22-clientid-oauth.png) - -23. Return to the Google Cloud Platform (GCP) console, and select **IAM & Admin** > **Service Accounts** to return to the service account screen. - - ![Select Service accounts](~/assets/images/email-security/email-retraction/gmail/step23-service-accounts.png) - -24. You need to create an API key in the Service account configuration panel. Select the three dots button to open the menu. Then, select **Manage keys**: - - ![Select the three dots menu, and then select Manage Keys](~/assets/images/email-security/email-retraction/gmail/step24-manage-keys.png) - -25. In the Keys configuration panel, select **ADD KEY** > **Create new key**. - - ![Select Add Key and then Create new key](~/assets/images/email-security/email-retraction/gmail/step25-create-key.png) - -26. In **Key type** select **JSON** as the format to create the private key. Then, select **CREATE**. - - ![Select JSON as the key type](~/assets/images/email-security/email-retraction/gmail/step26-json-key.png) - -:::caution[Important] -Save this key in a secure location as it allows access to your cloud resources. You will need to share it with Email Security as part of the configuration process in the next step. -::: - -## 2. Share the service account JSON key with Email Security - -You have to upload the private key generated in the previous step to Email Security. This is needed to execute retractions on your Gmail inboxes. - -1. Log in to the [Email Security dashboard](https://horizon.area1security.com/), and select **Settings** (the gear icon). - -2. Go to **Email Configuration** > **RETRACT SETTINGS** > **Authorize Gmail**. - - ![Go to Authorize Gmail in your Email Security dashboard](~/assets/images/email-security/email-retraction/gmail/step2-authorize-gmail.png) - -3. Select **New Authorization** and configure the following settings: - - * Select **AUTHORIZATION DATA (JWT)**, and find and upload your JSON private key. - * Under **Domains**, specify which domain this private key belongs to. - * Select **Save** to save the configuration. - - ![Select New authorization and configure its settings](~/assets/images/email-security/email-retraction/gmail/step3-private-key.png) - -## 3. Configure auto-retraction actions in Email Security - -:::caution[Important] -If you choose the hard delete retraction for Gmail, email messages will be permanently deleted. These messages cannot be recovered, even by admins. -::: - - - -## 4. Adjust the hop count in Email Security - -Since Email Security is not configured as the MX record for your domains, you will need to adjust Area 1’s position (hop count) relative to Area 1’s position in the email processing order. - -1. Log in to the [Email Security dashboard](https://horizon.area1security.com/), and select **Settings** (the gear icon). - -2. Go to **Email Configuration** > **DOMAINS & ROUTING**. - -3. Select the three-dots menu on the domain you want to verify the position, and then select **Edit**. - - ![Go to Domain to verify Email Security's hop position](~/assets/images/email-security/email-retraction/gmail/step3-hop-position.png) - -4. For standalone Gmail only deployments, the value should be set to `2`. If it is not, adjust the **Hops** count to `2`, and select **Update Domain**. - - ![Go to Domain to verify Email Security's hop position](~/assets/images/email-security/email-retraction/gmail/step4-hops-count.png) - -:::note -If you have an existing secure email gateway (SEG) deployed as the MX record, you will need to adjust the hop count accordingly. -::: - -## 5. Configure BCC rule in Google Workspaces - -You must send copies of inbound email messages to Email Security for inspection, so that Email Security can automatically retract messages. Messages can be sent to Email Security using a BCC compliance rule. Refer to the steps below to learn how to set this up. Automatic retraction is not available when Email Security is deployed as MX. - - - -### Geographic locations - - - -## 6. Manual message retraction - - From 714047e9c8bc45138fcb06be4512aa8bd5eb25ab Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 11:41:09 +0100 Subject: [PATCH 03/11] Removing spaces --- .../deployment/api/setup/gsuite-bcc-setup/add-domain.mdx | 4 +--- .../api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx | 3 +-- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx index bdf4bba056cd53..0ffc4ad3042138 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx @@ -16,6 +16,4 @@ To set up Email Security (formerly Area 1) for Gmail: 1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/). 2. Select the question mark, where you will be able to find your BCC address. 3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**. -4. Fill in the information needed to add your domain, then select **Publish Domain**. - - +4. Fill in the information needed to add your domain, then select **Publish Domain**. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx index e77f4865a03f21..12b58f490731b9 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx @@ -24,5 +24,4 @@ import { Render } from "~/components" 3. Under **Headers**, select **Add X-Gm-Spam and X-Gm-Phishy headers**. 4. Select **SAVE**. 7. In **Account types to affect**, select **Users** and **Groups**. -8. Select **SAVE**. - +8. Select **SAVE**. \ No newline at end of file From 57affcefe5a937988cace16ab234ff15edd99811 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:11:02 +0100 Subject: [PATCH 04/11] Fixing redirects and broken links --- public/_redirects | 2 ++ .../api/setup/gsuite-bcc-setup/add-retraction.mdx | 11 ++++++++++- .../email-configuration/retract-settings/index.mdx | 2 +- .../docs/email-security/reporting/audit-logs.mdx | 2 +- 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/public/_redirects b/public/_redirects index 2d883423dfcba5..afe3281e58dc06 100644 --- a/public/_redirects +++ b/public/_redirects @@ -374,6 +374,8 @@ # email-security /email-security/setup/api-deployment/ /email-security/setup/post-delivery-deployment/api/ 301 /email-security/setup/api-deployment/office365-api/ /email-security/setup/post-delivery-deployment/api/office365-api/ 301 +/email-security/email-configuration/retract-settings/gmail-retraction/ /email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/ 301 + # firewall /firewall/api/cf-lists/ /waf/tools/lists/lists-api/ 301 diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx index a556a12e9e7cca..db44c1dfce83e4 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx @@ -14,4 +14,13 @@ import { Render } from "~/components" 2. Select **Publish Domain**. 3. Select **RETRACT SETTINGS** > **Authorize Gmail**. 4. Upload the JSON file [previously generated](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/). -5. Under **DOMAINS**, select the domain you added previously, then select **SAVE**. \ No newline at end of file +5. Under **DOMAINS**, select the domain you added previously, then select **SAVE**. + +## Post delivery retractions for new threats + +Email Security (formerly Area 1) is continuously gathering new information about phishing campaigns. Users might have email messages in their inboxes that were scanned by Email Security (formerly Area 1) but not retracted initially because, at the time of scan, these email messages had not been identified as a threat. To mitigate risk, Email Security (formerly Area 1) offers you tools to re-evaluate email messages at a fixed time interval based on knowledge Cloudflare may have acquired since initial delivery. Any email messages that fit this new threat knowledge will be retracted. + +You can enable two options: + +- **Post Delivery Response**: Email Security (formerly Area 1) will continue to re-evaluate emails already delivered to your users’ inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security (formerly Area 1) retracts them. +- **Phish Submission Response**: Email Security (formerly Area 1) will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security (formerly Area 1). Retraction will occur according to your configuration. \ No newline at end of file diff --git a/src/content/docs/email-security/email-configuration/retract-settings/index.mdx b/src/content/docs/email-security/email-configuration/retract-settings/index.mdx index ac03a1e514d9b6..1d089cdbaa8db7 100644 --- a/src/content/docs/email-security/email-configuration/retract-settings/index.mdx +++ b/src/content/docs/email-security/email-configuration/retract-settings/index.mdx @@ -16,7 +16,7 @@ However — so long as you also have [journaling](/email-security/deployment/api Once you set up retraction, you can retract messages manually or set up automatic retractions to move messages matching certain dispositions to specific folders within a user’s mailbox. You can also enable Post Delivery Response and Phish Submission Response to re-evaluate messages previously delivered against new information gathered by Email Security. Scanned emails that were previously delivered and now match this new phishing information will be retracted. -Refer to [Gmail](/email-security/email-configuration/retract-settings/gmail-retraction/) and [Office 365](/email-security/email-configuration/retract-settings/office365-retraction/) guides for detailed information regarding these options. +Refer to [Gmail](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) and [Office 365](/email-security/email-configuration/retract-settings/office365-retraction/) guides for detailed information regarding these options. ## Retraction metrics diff --git a/src/content/docs/email-security/reporting/audit-logs.mdx b/src/content/docs/email-security/reporting/audit-logs.mdx index 3caa0c70646e26..64d1d1c205e747 100644 --- a/src/content/docs/email-security/reporting/audit-logs.mdx +++ b/src/content/docs/email-security/reporting/audit-logs.mdx @@ -22,7 +22,7 @@ You can use Email Security logs to review actions performed on your account: You can use one of the Preview logs to preview how Email Security handles post delivery retractions. With Audit logs Preview, Email Security shows you the emails that would have been retracted with Post Delivery Response (PDR) or Phish Submissions Response (PSR) enabled. -Refer to **Post delivery retractions for new threats** for [Gmail](/email-security/email-configuration/retract-settings/gmail-retraction/#post-delivery-retractions-for-new-threats) or [Office 365](/email-security/email-configuration/retract-settings/office365-retraction/#post-delivery-retractions-for-new-threats) to learn more about this feature. +Refer to **Post delivery retractions for new threats** for [Gmail](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/#post-delivery-retractions-for-new-threats) or [Office 365](/email-security/email-configuration/retract-settings/office365-retraction/#post-delivery-retractions-for-new-threats) to learn more about this feature. To review preview logs: From 107cd7de15ac8f9986d2c38b969be20591ab2066 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:14:15 +0100 Subject: [PATCH 05/11] Update src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> --- .../deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx index db44c1dfce83e4..58a6b3d23c0e49 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx @@ -22,5 +22,5 @@ Email Security (formerly Area 1) is continuously gathering new information about You can enable two options: -- **Post Delivery Response**: Email Security (formerly Area 1) will continue to re-evaluate emails already delivered to your users’ inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security (formerly Area 1) retracts them. +- **Post Delivery Response**: Email Security (formerly Area 1) will continue to re-evaluate emails already delivered to your users' inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security (formerly Area 1) retracts them. - **Phish Submission Response**: Email Security (formerly Area 1) will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security (formerly Area 1). Retraction will occur according to your configuration. \ No newline at end of file From 799fa1cd1f4839a68b356a0d3cdc5d9bbbf9b2db Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:10:04 +0100 Subject: [PATCH 06/11] Apply suggestions from code review Committing Pedro suggestions Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com> --- .../api/setup/gsuite-bcc-setup/add-retraction.mdx | 2 +- .../api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx | 4 ++-- .../api/setup/gsuite-bcc-setup/create-project-gcp.mdx | 2 +- .../api/setup/gsuite-bcc-setup/create-service-account.mdx | 8 ++++---- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx index 58a6b3d23c0e49..4e94f551b4af41 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx @@ -8,7 +8,7 @@ sidebar: import { Render } from "~/components" 1. On the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/), select **Domains** under **DOMAINS & ROUTING**, then select **NEW DOMAIN**. Fill in the information to add a new domain: - - On **FORWARDING TO**: Enter **Google.com**. + - On **FORWARDING TO**: Enter `Google.com`. - Adjust **Hops** to 2. - On **Outbound TLS**: Ensure you select **Forward all messages over TLS**. 2. Select **Publish Domain**. diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx index 12b58f490731b9..1a7acbff318ff3 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx @@ -1,5 +1,5 @@ --- -title: Add BCC rules to Area 1 +title: Add BCC rules pcx_content_type: how-to sidebar: order: 3 @@ -11,7 +11,7 @@ import { Render } from "~/components" 2. Go to **Content Compliance** > Select **Edit**. 3. Add a **Content Compliance** filter, and name it `Email Security (Area 1) - BCC`. 4. In **Email messages to affect**, select **Inbound**. -5. Select the recipients you want to send emails to Area 1 via BCC: +5. Select the recipients you want to send emails to Email Security (formerly Area 1) via BCC: 1. Select **Add** to configure the expression. 2. Select **Advanced content match**. 3. In **Location**, select **Headers + Body**. diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx index c78c22603b46a7..5b6819d553e8c8 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx @@ -12,5 +12,5 @@ import { Render } from "~/components" 2. Provide the details for the new project, and select **CREATE** to start your new project. 3. Once the new project has been created, the Google Cloud Platform console will automatically redirect you to the Project console. If not, you can use the Project selector to change to the project you created. 4. In **Getting Started**, select **Explore and enable APIs** > Select **ENABLE APIs & SERVICES**. -5. On search bar, search for "Admin SDK API". Select **Admin SDK API**, then select **ENABLE**. +5. On search bar, search for `Admin SDK API`. Select **Admin SDK API**, then select **ENABLE**. 6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx index a8e5a7425f4c09..756a5889188cfb 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx @@ -11,9 +11,9 @@ import { Render } from "~/components" 1. On the [Google Cloud Console](https://console.cloud.google.com/welcome/new), select **Credentials**. 2. Select **CREATE CREDENTIALS** > **Service account**. 3. Fill in the details to create a service account: - - **Service account name**: Enter **Message Retraction Service Account**. - - **Service account ID**: Enter **message-retraction-service-acc**. - - **Service account description**: Enter **Email Security Message Retraction**. + - **Service account name**: Enter `Message Retraction Service Account`. + - **Service account ID**: Enter `message-retraction-service-acc`. + - **Service account description**: Enter `Email Security Message Retraction`. - Select **CREATE AND CONTINUE**. 4. In **Grant this service account access to project**, select **Select a role** > Choose **Owner**. Select **CONTINUE**, then **DONE**. 5. Go back to **Credentials**, and select your service account under **Service Accounts**. In **Details**, take note of the **Unique ID**. @@ -21,7 +21,7 @@ import { Render } from "~/components" 7. On the sidebar, select **Security** > **Access and data control** > **API controls** > Select **MANAGE DOMAIN WIDE DELEGATION**. 8. Select **Add new** > Add a new client ID: - **Client ID**: Enter the **Unique ID** you took note of. - - **OAuth scopes**: Enter the following URL: + - **OAuth scopes**: Enter the following URLs: ```txt https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.alias.readonly, https://www.googleapis.com/auth/gmail.labels, https://mail.google.com/ From 89ff610b20f9d9b0feaea4028c91d55a7bff3926 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:08:29 +0100 Subject: [PATCH 07/11] Addressing Pedro suggestion --- .../api/setup/gsuite-bcc-setup/add-retraction.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx index 4e94f551b4af41..916938572b7d7d 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx @@ -18,9 +18,9 @@ import { Render } from "~/components" ## Post delivery retractions for new threats -Email Security (formerly Area 1) is continuously gathering new information about phishing campaigns. Users might have email messages in their inboxes that were scanned by Email Security (formerly Area 1) but not retracted initially because, at the time of scan, these email messages had not been identified as a threat. To mitigate risk, Email Security (formerly Area 1) offers you tools to re-evaluate email messages at a fixed time interval based on knowledge Cloudflare may have acquired since initial delivery. Any email messages that fit this new threat knowledge will be retracted. +Email Security (formerly Area 1) is continuously gathering new information about phishing campaigns. Users might have email messages in their inboxes that were scanned by Email Security but not retracted initially because, at the time of scan, these email messages had not been identified as a threat. To mitigate risk, Email Security offers you tools to re-evaluate email messages at a fixed time interval based on knowledge Cloudflare may have acquired since initial delivery. Any email messages that fit this new threat knowledge will be retracted. You can enable two options: -- **Post Delivery Response**: Email Security (formerly Area 1) will continue to re-evaluate emails already delivered to your users' inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security (formerly Area 1) retracts them. -- **Phish Submission Response**: Email Security (formerly Area 1) will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security (formerly Area 1). Retraction will occur according to your configuration. \ No newline at end of file +- **Post Delivery Response**: Email Security will continue to re-evaluate emails already delivered to your users' inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security retracts them. +- **Phish Submission Response**: Email Security will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security. Retraction will occur according to your configuration. \ No newline at end of file From a841cbf5fc3216532024a34ee201bd5bcca36274 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:32:52 +0100 Subject: [PATCH 08/11] Clarify order of completion --- .../api/setup/gsuite-bcc-setup/add-domain.mdx | 4 +++- .../setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx | 4 +++- .../setup/gsuite-bcc-setup/create-project-gcp.mdx | 5 +++-- .../gsuite-bcc-setup/create-service-account.mdx | 5 +++-- .../deployment/api/setup/gsuite-bcc-setup/index.mdx | 12 ++++++++++-- 5 files changed, 22 insertions(+), 8 deletions(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx index 0ffc4ad3042138..5b6254b4a4c3bc 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx @@ -16,4 +16,6 @@ To set up Email Security (formerly Area 1) for Gmail: 1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/). 2. Select the question mark, where you will be able to find your BCC address. 3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**. -4. Fill in the information needed to add your domain, then select **Publish Domain**. \ No newline at end of file +4. Fill in the information needed to add your domain, then select **Publish Domain**. + +Continue with [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/) for the next steps. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx index 1a7acbff318ff3..3b0a39442c51b8 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx @@ -24,4 +24,6 @@ import { Render } from "~/components" 3. Under **Headers**, select **Add X-Gm-Spam and X-Gm-Phishy headers**. 4. Select **SAVE**. 7. In **Account types to affect**, select **Users** and **Groups**. -8. Select **SAVE**. \ No newline at end of file +8. Select **SAVE**. + +Continue with [Create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/) for the next steps. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx index 5b6819d553e8c8..87ba3923b2249c 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx @@ -1,7 +1,6 @@ --- title: Create a project on Google Cloud Console pcx_content_type: how-to -updated: 2022-10-11 sidebar: order: 4 --- @@ -13,4 +12,6 @@ import { Render } from "~/components" 3. Once the new project has been created, the Google Cloud Platform console will automatically redirect you to the Project console. If not, you can use the Project selector to change to the project you created. 4. In **Getting Started**, select **Explore and enable APIs** > Select **ENABLE APIs & SERVICES**. 5. On search bar, search for `Admin SDK API`. Select **Admin SDK API**, then select **ENABLE**. -6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. \ No newline at end of file +6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. + +Continue with [Create service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/) for the next steps. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx index 756a5889188cfb..5af03f9598b940 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx @@ -1,7 +1,6 @@ --- title: Create service account pcx_content_type: how-to -updated: 2022-10-11 sidebar: order: 4 --- @@ -29,4 +28,6 @@ import { Render } from "~/components" - Select **AUTHORIZE**. 9. Go back to the sidebar > **Service Accounts**. -10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage. \ No newline at end of file +10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage. + +Continue with [Add retraction](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) for the next steps. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx index 39d6cb7c45149c..30eb6c4c1ec447 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx @@ -5,7 +5,7 @@ sidebar: order: 1 head: - tag: title - content: Setup phishing risk assessment for Gmail with Email Security (formerly + content: Setup Gmail with Email Security (formerly Area 1) --- @@ -20,4 +20,12 @@ import { Render, Details } from "~/components" For customers using Gmail, setting up Email Security via BCC is quick and easy. All you need to do is create a content compliance filter to send emails to Email Security through BCC. The following email flow shows how this works: -![Email flow when setting up a phishing assessment risk for Gmail with Email Security.](~/assets/images/email-security/deployment/api-setup/gmail/gmail-bcc-flow.png) \ No newline at end of file +![Email flow when setting up a phishing assessment risk for Gmail with Email Security.](~/assets/images/email-security/deployment/api-setup/gmail/gmail-bcc-flow.png) + +To set up Gmail with Email Security: + +1. [Find your BCC address and add a domain](/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain/). +2. [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/). +3. [Create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/). +4. [Create a service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/). +5. [Add retraction](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/). \ No newline at end of file From 5175da87097113d31e0b91e4373d3e94cbec02d8 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:23:11 +0100 Subject: [PATCH 09/11] adding next steps --- .../deployment/api/setup/gsuite-bcc-setup/add-domain.mdx | 4 +++- .../api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx | 4 +++- .../api/setup/gsuite-bcc-setup/create-project-gcp.mdx | 4 +++- .../api/setup/gsuite-bcc-setup/create-service-account.mdx | 4 +++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx index 5b6254b4a4c3bc..98cafdb46489ea 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx @@ -18,4 +18,6 @@ To set up Email Security (formerly Area 1) for Gmail: 3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**. 4. Fill in the information needed to add your domain, then select **Publish Domain**. -Continue with [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/) for the next steps. \ No newline at end of file +## Next steps + +Now that you have found your BCC address and added your domain, continue with [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/) to add BCC rules to Email Security. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx index 3b0a39442c51b8..a5f8637f7e3ac0 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx @@ -26,4 +26,6 @@ import { Render } from "~/components" 7. In **Account types to affect**, select **Users** and **Groups**. 8. Select **SAVE**. -Continue with [Create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/) for the next steps. \ No newline at end of file +## Next steps + +Now that you have added BCC rules on the Area 1 portal, you need to [create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/). \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx index 87ba3923b2249c..c048342c14ef3c 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx @@ -14,4 +14,6 @@ import { Render } from "~/components" 5. On search bar, search for `Admin SDK API`. Select **Admin SDK API**, then select **ENABLE**. 6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. -Continue with [Create service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/) for the next steps. \ No newline at end of file +## Next steps + +Now that you have created a project on Google Cloud Console, you need to [create a service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/) on Google Cloud Console. \ No newline at end of file diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx index 5af03f9598b940..3989dccc0a2685 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx @@ -30,4 +30,6 @@ import { Render } from "~/components" 9. Go back to the sidebar > **Service Accounts**. 10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage. -Continue with [Add retraction](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) for the next steps. \ No newline at end of file +## Next steps + +Now that you have created a service account, you need to [add retractions](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) to your email. \ No newline at end of file From 65829eb6077973d045e03f900a7f74f4843c2684 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:33:57 +0100 Subject: [PATCH 10/11] minor language change --- .../api/setup/gsuite-bcc-setup/create-service-account.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx index 3989dccc0a2685..9cad42abef70c4 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx @@ -32,4 +32,4 @@ import { Render } from "~/components" ## Next steps -Now that you have created a service account, you need to [add retractions](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) to your email. \ No newline at end of file +Now that you have created a service account, proceed to [adding retractions](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) to your email. \ No newline at end of file From 719a254a4387a3d8ce3627181984220adaa607b6 Mon Sep 17 00:00:00 2001 From: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:37:54 +0100 Subject: [PATCH 11/11] Update src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com> --- .../deployment/api/setup/gsuite-bcc-setup/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx index 30eb6c4c1ec447..316bfe554af4b1 100644 --- a/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx +++ b/src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx @@ -5,7 +5,7 @@ sidebar: order: 1 head: - tag: title - content: Setup Gmail with Email Security (formerly + content: Setup Gmail with Email Security (formerly Area 1) ---