> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation.

# Splunk SOAR

Splunk SOAR (On-premises) is a Security Orchestration, Automation, and Response (SOAR) system (see <https://www.splunk.com/en_us/form/soar-tour.html?utm_campaign=google_amer_en_search_brand&utm_source=google&utm_medium=cpc&utm_content=SOAR_Tour&utm_term=splunk%20soar&_bk=splunk%20soar&_bt=660036319642&_bm=p&_bn=g&_bg=122074808302&device=c&gclid=EAIaIQobChMI88i8iMeEgQMVyUFyCh3_rQx4EAAYAiAAEgIKRPD_BwE>). You can protect access to Splunk SOAR by integrating Splunk SOAR with Identity as a Service. Once integrated, users can use single sign-on to log in to their Splunk SOAR account through Identity as a Service.

note

This integration was tested using Identity as a Service version 5.31 and Splunk SOAR August 2023 version. Other versions of Splunk SOAR may require integration and configuration steps that differ from those documented in this procedure. In the event of other issues, contact <support@entrust.com> for assistance.

To integrate Splunk SOAR with Identity as a Service, you must do the following

Before you begin, open two browser windows. In one window, log in to your Splunk SOAR administrator account. In the other window, log in to your IDaaS administrator account.

## Step 1: Copy the SAML configurations from Identity as a Service

1. Log into your Identity as a Service administrator account.

2. Click Menu icon **>** **Security > Applications**. The **Applications** **Lists** page appears.

3. Under **SAML Cloud Integrations**, click **SAML Configuration**. The **SAML Configuration** dialog box appears. This dialog box contains information you need to configure your SAML application for Identity as a Service authentication.

4. Do one of the following:

   - Leave this dialog box open to reference later in this procedure.
   - Copy the Entity ID, Single Sign-on URL, and Single Logout URL to a text file and save it to reference later in this procedure.

note
Depending on the integration you are performing, you may not need all three of these SAML configuration values.

## Step 2: Download the metadata file from Identity as a Service

1. In Identity as a Service, click Menu icon **>** **Security > Applications**. The **Applications List** page appears.

2. Do one of the following:

   - Click Cloud Download icon next to the application you are integrating with Identity as a Service.
   - Click Ellipsis Vertical icon next to the application you are integrating with Identity as a Service and select **SAML IDP Metadata**.

3. The **SAML Application Metadata** dialog box appears.

4. **Select the certificate to include in the SAML IDP Metadata file** from the drop-down list.

5. If applicable, **Select the domain to include in the SAML IDP Metadata** file from the drop-down list.

6. Enter the **Lifetime, in days, for the SAML IDP Metadata file**. The value must be between 2 and 730.

7. Do one of the following, as required:

   - Copy the **Public Endpoint** to paste into your SAML application being used Identity Provider authentication.
   - Click **Download**.

note
If you are using multiple domains, you must download each domain's metadata file separately because the values in the metadata file vary for each domain.

## Step 3: Encode the IDaaS metadata file to Base64

1. Go to <https://www.base64encode.org> (or a similar base64 encoding tool).
2. Set the **Destination Character Set** to **UTF-8**.
3. Copy and paste the SAML metadata your downloaded in _Step 1: Download the metadata file from identity as a Service_.
4. Click **Encode**.
5. Click **Copy to Clipboard** or copy and save the contents to a text file.

## Step 4: Configure Splunk SOAR for Identity as a Service authentication

1. Log into your Splunk SOAR administrator account. The **Administrator** page appears.
2. Expand **User Management** and then select **Authentication**. The **Authentication Settings** page appears.
3. Click **SAML2**.
4. Toggle **SAML2** to **On**.
5. Enter the **Provider Name**, for example, Entrust.
6. In the **Single sign-on URL** field, enter the **Single Sign-on URL** that you copied in _Step 1: Copy the SAML configurations from Identity as a Service_.
7. In the **Issuer ID** field, enter the **Entity ID** that you copied in _Step 1: Copy the SAML configurations from Identity as a Service_.
8. In the **Metadata XML** field, copy and paste the Metadata you downloaded in _Step 2: Download the metadata from Identity as a Service_ and then converted in _Step 3: Encode the IDaaS metadata file to Base64_.
9. Scroll to **Configuration Info**.
10. Open a text editor such as Notepad and copy and paste the URL that appears after the text, Once these settings have been saved, metadata for Splunk SOAR can be found at. You need the metadata file for _Step 4: Add Splunk SOAR to Identity as a Service_.
11. Click **Save Changes**.

## Step 5: Add Splunk SOAR to Identity as a Service

1. Log into your Identity as a Service administrator account.

2. Click Menu icon **>** **Security > Applications**. The **Applications** **Lists** page appears.

3. Click **Add**. The **Select an Application Template** page appears.

4. Do one of the following:

   - Select **SAML Cloud Integrations** from the search drop-down list and scroll to find the application you want to add to IDaaS.
   - In the **Search bar**, enter a search option to filter for the application you want to add to IDaaS.

5. Click **Splunk SOAR**. The **Add Splunk SOAR** page appears.

6. Enter an **Application Name**.

7. Enter an **Application Description**.

8. Optional. Add a custom application logo.

   1. Click Plus icon next to **Application Logo**. The **Upload Logo** dialog box appears.
   2. Click Upload icon to select an image file to upload.
   3. Browse to select your file and click **Open**. The **Upload Logo** dialog box reappears showing your selected image.
   4. If required, resize your image.
   5. Click **OK**.

9. Select the **Authentication Flow** that appears to users during login.

10. Click **Next**. The **General** page appears.

11. Click Upload icon to the **Upload Metadata XML** and browse to the location of the metadata file you downloaded. The **Metadata Configuration** dialog box appears.

12. If required, click **Merge with existing values** to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.

13. Click **Save**.

14. Optional. Enter the **SAML Username Parameter Name** used to identity the user ID being requested for authentication. The user ID can then be passed as a parameter, for example, Username=jdoe. Alternately, if the SAML username is NameID, the SAML Request XML NameID element value is used to the identify the IDaaS userID.

15. Enter the **SAML Session Timeout** to the time when the SAML Assertion times out. The maximum is 720 minutes.

16. Enter the **Max Authentication Age (seconds)** to set the maximum amount of time that can elapse before a user is required to reauthenticate during a new login attempt. This applies for both SP-initiated and IDP-initiated login. Set this field to -1 to disable this feature.

17. From the **SAML NameID Attribute** drop-down list, select **Email**.

18. From the **SAML NameID Encoding Format** drop-down list, select **Email**.

19. From the **SAML Signing Certificate** the drop-down list, select the signing certificate.

20. From the **SAML NameID Encoding Format** drop-down list, select **SHA512**.

21. Deselect **Sign Complete SAML Response**.

22. Deselect **Enable Go Back Button** if you do not want users to be able to go back to the Splunk SOAR login page to log in.

23. Select **Show Default Assertion Consumer URL Service in the My Profile**. When selected, the Default Assertion Consumer URL appears in a user's My Profile page in addition to relay states and Alternative Assertion Consumer URLs.

24. Optional. Add **Alternative Assertion Consumer Service URLs**, as follows:

    1. Click **Add**.
    2. Enter a **Name**.
    3. Enter a URL **Value**.
    4. Select **Show in My Profile** to display the Alternative Consumer Service URL in a user's My profile page.
    5. Optional. **Add an Application Logo**.
    6. Click **Add**.
    7. Repeat these steps to add more Alternative Assertion Consumer Service URLs.

25. For the IDP initiated login to be successful, you need to set Splunk soar SP-Init-SSO. Splunk soar can also set up IdP-Init-SSO. IdP-Init-SSO requires IdP to send the Relay State parameter along with the SAML request. You can do this by editing the metadata xml file or setting a Relay state value. Relay states appear on the user's **My Profile** page. Do the following:

    1. Under **Relay State**, click **Add**. The **Add Relay State** dialog box appears.

    2. Enter **Splunk** in the relay **Name** field.

    3. Enter the **Value** for the relay state. This setting specifies the application or URL that a user is redirected to after successful authentication.

    4. Under **Show in My Profile,** select **Display relay state in user's My Assigned Applications** to display the relay state on the user's My Profile page.

    note
    After you add relay states, you can also enable or disable them on the Add/Edit application page. Relay states apply to the Default Assertion Consumer Service URLs and not the Alternative Consumer Service URLs.

    5. Optional. Add a Relay State custom logo.

       1. Click Plus icon next to **Relay State Logo**. The **Upload Logo** dialog box appears.
       2. Click Upload icon to select an image file to upload.
       3. Browse to select your file and click **Open**. The **Upload Logo** dialog box reappears showing your selected image.
       4. If required, resize your image.
       5. Click **OK**.

    6. Click **Add**.

    7. Repeat these steps to add more Relay States.

26. Click **Submit**.

## Step 6: Add a resource rule

See [Create resource rules](/docs/authentication-and-security/create-and-manage-resource-rules.md).

## Step 7: Test the integration

Testing Service Provider Login:

1. Open a Web browser and enter the URL for your Splunk SOAR account.
2. Click the name of your single sign-on IDP (for example, Entrust). You are redirected to **Identity as a Service**.
3. Log in to IDaaS.
4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to Splunk SOAR.

Testing Identity as a Service redirect log in:

1. Log in to your Identity as a Service account.
2. Go to your **My Profile** page if you are not already there.
3. Under **Applications**, click **Splunk SOAR**.
4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to Splunk SOAR.

Testing Identity as a Service redirect log in

Log in to your Identity as a Service account.

Go to your **My Profile** page if you are not already there.

Under **Applications**, click **Splunk SOAR**.

Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to Splunk SOAR.