Set up a Cortex XSOAR connector
Capabilities
Resource | Sync | Provision |
---|---|---|
Accounts | ✅ | |
Roles | ✅ |
Available hosting methods
Choose the hosting method that best suits your needs:
Method | Availability | Notes |
---|---|---|
Cloud hosted | ✅ | A built-in, no-code connector hosted by ConductorOne. |
Self-hosted | ✅ | The XSOAR connector, hosted and run in your own environment. |
Gather XSOAR credentials
Each setup method requires you to pass in credentials generated in XSOAR. Gather these credentials before you move on.
A user with the Admin role or a custom role with the ability to generate API tokens in XSOAR must perform this task.
Generate an API key
Log into Cortex XSOAR and navigate to Settings & Info > Settings > Integrations > API Keys.
Click New Key.
Choose the Standard API key.
If desired, set an expiration for the API key and add a comment describing the key’s purpose.
Give the API key the Admin role or a custom role with the permission to read user and role data.
Click Save to generate the new API key.
Carefully copy and save the API key.
Find your API URL
In the table of API keys, right-click your newly generated API key and select View Examples.
Copy the CURL Example URL. The example contains your FQDN, which forms part of your unique API URL. The API URL is in this form:
https://api-{fqdn}/xsoar/
.
That’s it! Next, move on to the instructions for your chosen setup method.
Set up a XSOAR cloud-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of XSOAR credentials generated by following the instructions above
In ConductorOne, click Connectors > Add connector.
Search for XSOAR and click Add.
Choose how to set up the new XSOAR connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
Find the Settings area of the page and click Edit.
Enter the API URL of the Cortex XSOAR instance in the API URL field.
Paste the API key into the Token field.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
That’s it! Your XSOAR connector is now pulling access data into ConductorOne.
Set up a XSOAR cloud-hosted connector using Terraform
As an alternative to the cloud-hosted setup process described above, you can use Terraform to configure the integration between XSOAR and ConductorOne.
See the ConductorOne XSOAR integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.
Set up a XSOAR self-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of XSOAR credentials generated by following the instructions above
When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.
Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.
Step 1: Configure the XSOAR connector
In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new XSOAR connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
In the Settings area of the page, click Edit.
Click Rotate to generate a new Client ID and Secret.
Carefully copy and save these credentials. We’ll use them in Step 2.
Step 2: Create Kubernetes configuration files
Create two Kubernetes manifest files for your XSOAR connector deployment:
Secrets configuration
# baton-xsoar-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: baton-xsoar-secrets
type: Opaque
stringData:
# ConductorOne credentials
BATON_CLIENT_ID: <ConductorOne client ID>
BATON_CLIENT_SECRET: <ConductorOne client secret>
# XSOAR credentials
BATON_API_URL: <API URL of the Cortex XSOAR instance>
BATON_TOKEN: <XSOAR API key>
See the connector’s README or run
--help
to see all available configuration flags and environment variables.
Deployment configuration
# baton-xsoar.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: baton-xsoar
labels:
app: baton-xsoar
spec:
selector:
matchLabels:
app: baton-xsoar
template:
metadata:
labels:
app: baton-xsoar
baton: true
baton-app: xsoar
spec:
containers:
- name: baton-xsoar
image: ghcr.io/conductorone/baton-xsoar:latest
args: ["service"]
imagePullPolicy: IfNotPresent
envFrom:
- secretRef:
name: baton-xsoar-secrets
Step 3: Deploy the connector
Create a namespace in which to run ConductorOne connectors (if desired):
kubectl create namespace baton-xsoar
Apply the secret configuration:
kubectl -n baton-xsoar apply -f baton-xsoar-secrets.yaml
Apply the deployment:
kubectl -n baton-xsoar apply -f baton-xsoar.yaml
Step 4: Verify the deployment
Check that the deployment is running:
kubectl -n c1 get pods
View the connector logs:
kubectl -n c1 logs -l app=baton-${baton-xsoar}
Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the XSOAR connector to. XSOAR data should be found on the Entitlements and Accounts tabs.
That’s it! Your XSOAR connector is now pulling access data into ConductorOne.