Case management federation (SOAR only)

The case management federation feature allows secondary customers to have their own standalone SOAR platform, instead of having their SOAR instance as an environment in the platform. This feature is primarily for use with MSSPs but can apply also to enterprises who prefer to have standalone platforms for different geographical locations. All the metadata of all the cases on the standalone platform is synchronized with the primary provider's local platform. This way the primary provider can both view and access their secondary customer's cases and perform actions on them. However, the secondary customers can decide for themselves which environments they want to share with their primary platform provider and therefore which cases they can access.

After the primary platform analyst clicks on a remote case link, if they have been granted permissions to that case environment, they are redirected to the standalone, also known as remote, platform where they can log in with their email and password. They will remain logged in to the remote platform for the duration of that session only.

Set up metadata sync on the primary platform

The following sections should be carried out on the local primary platform.

Set up the remote platform display name

1. Using the POST method, run the /api/external/v1/federation/platforms endpoint with the unique display name for the remote platform. There is a maximum of 255 characters for the display name. The following example is for reference only.

   curl -X POST https://federation.siemplify-soar.com/api/external/v1/federation/platforms \
   -H "Content-Type: application/json" \
   -d '{
       "displayName": "Sample Platform",
       "host": "https://federation.siemplify-soar.com" 
   }'
   

2. Store the returned API key on your desktop for retrieval later on. You will need to give this API key to the secondary customer when they create the new Case Federation sync job.

Download Case Federation integration

1. In the primary platform, go to the Marketplace.
2. Click the Case Federation integration configuration icon and select the Is Primary checkbox and then click Save. Selecting this checkbox ensures the data is synced to your platform.
3. Go to Response > IDE page.
4. Click add Add.
5. Select Job.
6. Select Case Federation Sync Job in the Job Name field and Case Federation in the Integration field.
7. Click Create.
8. Do not configure any of the parameters in the Job except for the schedule. Google recommends setting one minute as the default sync time.

Create or edit a user on the primary platform

This procedure lets you create or edit a user with permissions to one or more remote platforms.

1. In the primary platform, go to Settings > Organization > User Management.
2. Click add Add.
3. Fill out the user details as required. In the Platform field, select as many remote platforms as needed.
4. Click Save.

Set up metadata sync on the remote platform

The following sections should be carried out by the secondary customer on their platform.

Download the Case Federation integration

1. In the platform, go to the Marketplace.
2. Click the Case Federation integration configuration icon and then click Save. Do not click Is Primary.
3. Go to Response > IDE page.
4. Click add Add.
5. Select Job.
6. Select Case Federation Sync Job in the Job Name field and Case Federation in the Integration field.
7. Click Create.
8. In the Target Platform field, enter the hostname of the primary provider. The hostname is taken from the beginning of the primary provider's platform URL.
9. In the API key field, enter the API key that your primary provider gave you.
10. Configure the schedule with one minute as the default sync time.

Create or edit a user on the secondary platform

This procedure lets you grant permissions to specific environments for the relevant primary platform personas. This allows the primary analyst to pivot to the relevant cases in the secondary platform.

1. In the platform, go to Settings > Organization > User Management
2. Click add Add.
3. Fill out the primary platform user details as required. In the Environment field, select the required environments that you want to give primary platform analysts access to.
4. Click Save.

Pivot from the primary platform to the secondary platform

The primary platform analyst can pivot from their local platform to the selected case in the remote (secondary) platform in both the Case list view and the Case side-by-side view in the Cases screen.

1. Go the Cases page and select either the list view or the side-by-side view.
2. If you are in the side by side view, look through the Cases queue to see which cases have the R (R for remote) icon and click the case to be redirected to the remote platform.
3. If you are in the list view, scan through the Platform column to see which platform the case is coming from and click the case ID to be redirected to the remote platform.
4. Log in to the remote platform with your email and password. If you are blocked from logging in, the secondary customer has not granted you access to the environment where the cases are coming from.