Creating an extended integration for Sophos Endpoint Security users

Let Oomnitza be your single source of truth!

You'll get visibility of your devices as data from Sophos Endpoint Security is automatically transformed into consumable information and actionable insights.

Manage endpoints in Sophos
Oomnitza supports bi-directional APIs to manage configuration and other changes to devices in Sophos.

Connect Oomnitza and Sophos in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about your users with your colleagues and management
• Configurable workflows that you can create such as:
  • Retrieving a users role
  • Deactivating and deleting users 

Before you start

Before you can create the integration with Oomnitza, you need to have added your Sophos Endpoint Security credentials and global variables to Oomnitza.

Integrate Sophos Endpoint Security with Oomnitza

1. In Oomnitza, click Configuration>Integrations>Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. Search for the integration in the sidebar.
6. Click ADD.

Integration Overview

Before you start

More information is provided about the following fields to help you complete the integration:

Integration preferences: By default, the option Create & Update is selected, which allows for editing existing user records and adding new ones. If your goal is only to edit existing user records, choose Update Only. On the other hand, if you only want to add new records, select Create Only.

User selection: Select User only to create user records and add them to the People object.  Select User plus SaaS User to create and add user records to the Software > SaaS object. Once your users are created in the SaaS menu, you can create SaaS user workflows to validate the existence of a given user in a SaaS system and to pull role information from your SaaS System. For steps see Creating SaaS user workflows.

When you select User plus SaaS User and you have multiple instances of the same SaaS, you can choose your SaaS instance from the dropdown. If you have a single instance of the SaaS, your instance is already detected by the system.

Integration details

Procedure
To review or update the integrations details, click Edit :

1. Update the integration name if necessary. 
2. From the User Selection list, select an option. 
3. For installation type decide whether you want to store the credentials locally or in Oomnitza:
   1. Select Local if you want to store credentials locally.This mode does not support OAuth or AWS.
   2. Select Cloud if you want to store credentials in your Oomnitza instance.
4. For integration preferences, select an option.
5. Enter the name of the integration user.

Credential details

Choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit :.

Creating custom mappings

Map the Sophos fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Create a custom mapping for the Sophos ID. To do this, complete the following steps:
   1. Select the down arrow on the ID field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to Sophos User Id.
   4. Select the Unique checkbox.
   5. Click CREATE. 
3. Ensure that the Email is mapped to the
   1. Username field on the Oomnitza side (required for integration).
   2. Email field on the Oomnitza side (required for integration).
4. Select the Role field on the Oomnitza mapping side.
5. Choose a suitable role from the list (a defined role is necessary for the integration)
6. Assign a sync key to a unique field, such as the Email.
7. Click UPDATE.

Tracking information for user loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

• Connect: Credentials
• Connect: Data Region
• Connect: Tenant ID

Standard Sophos to Oomnitza mappings

The following Sophos fields can be mapped to Oomnitza:

Connector Sync Time
Created at
Email
Full name
ID
Source of User (custom, activeDirectory, azureActiveDirectory)
Updated at

Did you know? 
You can define rules for your integration by selecting Edit integration on the mapping page. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  

You can add new fields to your integration by selecting Add new field   on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, select Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, refer to Running an extended integration

If you selected Local as the installation type when creating the integration, refer to Running an extended integration locally.

Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click the Software tab.  
To view the information that is collected about your users, click People. If you selected User plus SaaS User when running the user integration, you can also find a list of users in the Software > SaaS menu

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Create workflows using the SaaS User Role retrieval block

You can create a Saas User workflow in Oomnitza using the Sophos User Role preset. This preset sets the Role to User for all users retrieved.

Prerequisites

Before you create a SaaS user workflow, you should have already run your extended user integration and selected User plus SaaS User to populate the software entry in the Software > SaaS menu.

To create a Saas User workflow using the Sophos User Role preset, complete the following steps:

1. Click Configuration > Workflows > Saas Users from the menu.
2. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
3. Enter the name and a description of the workflow. 
4. Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
5. Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
6. Click the Edit icon.
7. Enter Sophos in the search field and choose the Sophos SaaS User Role preset.
8. Click the right arrow >.
9. Enter your Credentials.
10. Your Sophos information is derived from the global variables you created in Adding Sophos Endpoint Security global variables or can be entered manually. 
11. Select the Deactivate User checkbox to deactivate the SaaS user in SaaS > Sophos > Users if they are not found in your Sophos instance.
12. Click SAVE.
13. Connect the blocks.
14. Save, validate, and activate your workflow.

To view active Sophos users in the SaaS Users UI, complete the following steps:

1. Click Software from the menu.
2. Select the Saas tab, and select your software entry for Sophos.
3. Click Users in the side pane.
4. The Role column is populated with the user details to confirm that this user has been found in your Sophos SaaS.

Next steps

Create an offboarding workflow using an API block. Select the following presets:

• Sophos Delete User preset deletes a Sophos User. 

Important
When creating the offboarding workflow, ensure that the Begin block criteria accurately identifies inactive users. For example, for SaaS user workflows you can set the To be Deleted in SaaS flag to Yes, or for People workflows, you can set the Offboarding Date to Current date.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your assets and software
• Configure custom reports about your assets and software

See Getting started.