> For the complete documentation index, see [llms.txt](https://docs.expel.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.expel.io/connect-your-technology/q-z-integrations/sublime-security-setup-for-workbench.md).
# Sublime Security Setup for Workbench
This integration enables application of Expel's detection strategy to Message Groups and Messages from Sublime Security, as well as pulling of alerts into Workbench for investigation and remediation.
## Prerequisites
* You must have admin access in Workbench to set up this integration.
* You must have Admin privileges in Sublime to create a user account and API key.
## Step 1: Add a Sublime User with the Analyst Role for Console Access
The Analyst role is the minimum required role from the default roles available and necessary for Expel to fully triage and research alerts, as well as manage API keys. [Learn more about why Expel asks for console access](/connect-your-technology/about-integrations/why-expel-asks-for-console-access.md).
1. Log into the [Sublime dashboard](https://platform.sublime.security/).
2. Using the side menu, navigate to **Admin > Account**.
3. In the Users section, select **Invite Users**.
4. On the Invite users page, configure the settings as follows:
* **Email addresses** - enter "soc+\@expel.io".
* For example, if your organization were Acme Corp, the format would be "".
* **Role** - select **Analyst** from the dropdown menu.
5. Select **Create invitation**.
This triggers an email invitation allowing the Expel SOC to create an account and complete console access configuration in Workbench on your behalf.
## Step 2: Generate API Credentials
To integrate the technology with Workbench, you need to create secure credentials for the API.
1. In Sublime, use the side menu to navigate to **Automate > API**.
2. Your Base URL is displayed near the top of the page. **Copy and save** it to a safe place for use in a later step. *Base URLs depend on deployment type and region, so yours may be different from the example below.*
3. Next, select **New Key**.
4. Give your new key a name, for example "Expel-Key".
5. Select **Save**.
6. The next screen shows the newly generated API key. **Copy and save** this value in a safe place for use in a later step. *You may also reference this value on the API page later if needed.*
7. Close the Create API Key modal. Your new key appears in the API Keys list.
## Step 3: Add a Tag to a Rule in Sublime
This step is optional and allows you to apply a tag to any rules for which you don't want results pulled into Workbench. For example, you could apply a tag to a rule for a process that isn't related to malicious emails or phishing.
1. In Sublime, use the side menu to navigate to **Detection Posture > Detection Rules**.
2. Select **List view**.
3. Select the rule you wish to create a tag for.
4. On the Detection Rule Details screen, select **Edit Metadata**.
5. Leave the Actions dropdown with no action selected.
6. In the Tags dropdown, enter "ExpelIgnore" and select **Create "ExpelIgnore"**.
7. Select **Save Rule**.
## Step 4: Add Sublime Security as a Security Device in Workbench
Now that you have the necessary credentials, you can configure the integration in Workbench.
1. [Log in to Workbench](https://workbench.expel.io/auth/login?orig=%2F).
2. In the side menu, navigate to **Organization Settings > Security Devices**.
3. Select **Add Security Device**.
4. In the search box, type “Sublime” and then select the **Sublime Security** integration.
5. A configuration pane displays. Complete the fields as follows:
* **Name** - enter a name that might help you more easily identify this integration, such as “CompanyName Sublime Security”; this name will display in Workbench under the Name column, and is a text string that you can filter on.
* **Location** - enter the location of your integration, for example “cloud.” This is also a text string that you can filter on, so we recommend being consistent with location naming across your Expel integrations.
* **Sublime security API base URL** - enter the Base URL you acquired in [Step 2](#step-2-generate-api-credentials).
* **Sublime security API key** - enter the API Key generated in [Step 2](#step-2-generate-api-credentials).
6. Select **Save**.
7. On the console access screen, select **Set up later** from the dropdown, as Expel will complete console access configuration.
8. Select **Save**.
9. Your device should be created successfully within a few seconds. A few reminders:
* After your connection is healthy, it will take some time for your device to begin polling and receiving data.
* To check on the status, select the downward arrow for your device in the first column and choose **View details**.
* Polling will happen first; data will be received after that. **You must refresh the page to see updates**.
* If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, [contact our support team](/support/how-to-reach-us.md) for help.
* To check if alerts are coming through, navigate to **Dashboards > Alert Analysis**. Scroll to the device you want to check, and select the **Expel Alerts** tab to reveal more alert information. It can take 36 to 72 hours for alerts to appear after setup, as we [tune your device](/workbench-reference/alerts/how-expel-alerts-work.md#device-tuning).
## Step 5: (Optional) Set Up Auto Email Deletion
The preceding steps of this guide enable Expel to ingest Sublime Security alerts and investigate any malicious activity. This optional configuration lets us use detection strategy to immediately delete any email that Sublime Security identifies as malicious *as soon as we ingest its associated alert*.
This means those emails will be assumed as correctly flagged by Sublime Security as malicious, and then deleted for every email user without a SOC investigation. We will instead focus all of our SOC efforts on other types of Sublime Security alerts. However, the Sublime Security alert that references the deleted email will still be available to our SOC analysts and can be correlated to other suspicious activity where needed.
[Learn more about how remediation works](/connect-your-technology/about-integrations/about-mdr-for-email.md#h_01jrjp0rrke00fk9dm80bevyg8) in this process.
{% hint style="warning" %}
You must have Microsoft 365 or Google Workspace as your email provider to use this feature.
{% endhint %}
### Step 1: Enable Permissions in Your Email Provider
1. Set up appropriate permissions within your email provider by selecting one of the links below for instructions.\
***If you have already enabled the Remove Malicious Email auto remediation in support of a different integration, you can skip this step (because you will have already set this part up).***
* [Microsoft 365](/workbench-setup/auto-remediations/remove-malicious-email/microsoft-365-remove-malicious-email.md#step-2-add-an-additional-api-permission): Follow *only* the Step 2 section of this guide, then return to this page and continue to step 2.
* [Google Workspace](/workbench-setup/auto-remediations/remove-malicious-email/google-workspace-formerly-g-suite-remove-malicious-email.md#h_01jh5zgcgw8ekzjnfd2tzwjvat): Follow *only* the Step 1 and Step 2 sections of this guide, then return to this page and continue to step 2.
### Step 2: Enable the Auto Remediation in Workbench
1. Contact your Customer Success Manager (CSM) and ask that they enable the **Auto-Remediate Suspicious Delivered Email Alerts** (`org.preference.email.auto_remediate_delivered`) value in Workbench.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.expel.io/connect-your-technology/q-z-integrations/sublime-security-setup-for-workbench.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
