Skip to content

ConductorOne/baton-xsoar

Repository files navigation

Baton Logo

baton-xsoar Go Reference main ci

baton-xsoar is a connector for xsoar (Cortex XSOAR) built using the Baton SDK. It communicates with created instance of Cortex XSOAR API to sync data about users and their roles.

Check out Baton to learn more about the project in general.

Prerequisites

To use this connector, you need to install Cortex XSOAR (xsoar) instance and create API key to access the API.

More information about installation of Cortex XSOAR can be found in Cortex XSOAR administration guide for example this guide for installing server for single server deployment.

To obtain API key, login to webview of Cortex XSOAR instance and go to Settings -> Integrations -> API Keys and click on Get Your Key button. You can find more information about API keys here.

Getting Started

The instance comes by default with invalid SSL certificate, so to bypass validation you have to set BATON_UNSAFE environment variable to true or use --unsafe flag.

brew

brew install conductorone/baton/baton conductorone/baton/baton-xsoar

BATON_TOKEN=token baton-xsoar
baton resources

docker

docker run --rm -v $(pwd):/out -e BATON_TOKEN=token BATON_UNSAFE=true ghcr.io/conductorone/baton-xsoar:latest -f "/out/sync.c1z"
docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c1z" resources

source

go install github.com/conductorone/baton/cmd/baton@main
go install github.com/conductorone/baton-xsoar/cmd/baton-xsoar@main

BATON_TOKEN=token baton-xsoar
baton resources

Data Model

baton-xsoar will fetch information about the following resources:

  • Users
  • Roles

Contributing, Support and Issues

We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a Github Issue!

See CONTRIBUTING.md for more details.

baton-xsoar Command Line Usage

baton-xsoar

Usage:
  baton-xsoar [flags]
  baton-xsoar [command]

Available Commands:
  capabilities       Get connector capabilities
  completion         Generate the autocompletion script for the specified shell
  help               Help about any command

Flags:
      --api-url string         The API URL of the Cortex XSOAR instance. ($BATON_API_URL)
      --client-id string       The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
      --client-secret string   The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
  -f, --file string            The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
  -h, --help                   help for baton-xsoar
      --log-format string      The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
      --log-level string       The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
  -p, --provisioning           This must be set in order for provisioning actions to be enabled. ($BATON_PROVISIONING)
      --token string           Access token used to connect to the Cortex XSOAR API. ($BATON_TOKEN)
      --unsafe                 Allow insecure TLS connections to Cortex XSOAR instance. ($BATON_UNSAFE)
  -v, --version                version for baton-xsoar

Use "baton-xsoar [command] --help" for more information about a command.