Sophos Central
Introduction
This guide explains how to authenticate the Sophos Central connector in Swimlane using OAuth 2.0 Client Credentials. You will register an API client in Sophos Central, collect the required credentials, and configure the connector asset in Swimlane Turbine.
Prerequisites
Sophos Central Access Requirements
You must have Sophos Central administrator permissions to:
- Access Sophos Central Admin console
- Create and manage API credentials
- Retrieve tenant and region information
- Authorize API access for integrations
Required Credentials
During setup you will collect:
- Sophos Central API Base URL (Data Region URL)
- Client ID
- Client Secret
- XβTenantβID (optional but recommended)
- Token URL
Register a Sophos Central API Client
- Log in to the Sophos Central Admin console at https://central.sophos.com.
- Navigate to Global Settings.
- Open the API Credentials Management section.
- Click Add Credential.
- Provide a Name and Description for the API credential.
- Assign the required access permissions for the integration.
- Click Save to generate credentials.
- Copy the Client ID and Client Secret.
- Store the credentials securely.
Retrieve Tenant Information
- After creating API credentials, navigate to the Sophos Central dashboard.
- Locate your Tenant ID from the Sophos Central environment.
- Alternatively call the WhoAmI API endpoint to retrieve tenant details.
- Copy the Tenant ID value for use in the Swimlane asset configuration.
Determine the Sophos Data Region URL
Sophos Central uses regional API endpoints. The base API URL depends on the region where your Sophos Central tenant is hosted.
Region | API URL Example |
|---|---|
United States | https://api.central.sophos.com |
Europe | https://api-eu.central.sophos.com |
Australia | https://api-au.central.sophos.com |
India | https://api-in.central.sophos.com |
Connector Configuration in Swimlane
- Log in to Turbine.
- From the left navigation pane click ORCHESTRATION and select Assets.
- Click the Plus (+) icon to create a new asset.
- Select Sophos Central from the Asset Type list.
- Fill in the Asset Settings and Asset Input fields as shown below.
- Click Create.
Field | Description | Required |
|---|---|---|
url | Base API URL for the Sophos Central data region | Required |
client_id | Sophos Central API Client ID | Required |
client_secret | Sophos Central API Client Secret | Required |
X-Tenant-ID | Sophos tenant identifier | Optional |
token_url | OAuth token endpoint for Sophos Central | Optional |
scope | Optional OAuth permission scopes | Optional |
verify_ssl | Enable or disable SSL verification | Optional |
http_proxy | Proxy configuration if API traffic requires proxy | Optional |
Troubleshooting
- Ensure the Client ID and Client Secret are copied correctly from the Sophos Central console.
- Verify the API URL corresponds to the correct Sophos region.
- If authentication fails, regenerate the API credentials and update the Swimlane asset.
- Confirm the integration permissions assigned to the API credential allow the required API actions.
- Ensure outbound network access to Sophos Central API endpoints is allowed.
- If your environment uses a proxy, configure the http_proxy parameter.
Result
You have successfully authenticated the Sophos Central connector in Swimlane.
Sources