Availability

ConductorOne currently only integrates with Snyk Enterprise. ConductorOne can only integrate with Snyk editions that include API access. You cannot use this connector successfully with the Free or Team editions of Snyk.

Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Snyk credentials

Each setup method requires you to pass in credentials generated in Snyk. Gather these credentials before you move on.

A user with access to a service or user account in Snyk with admin permissions on the Group you’re integrating must perform this task.

Look up your account’s Snyk API token

1. In Snyk, navigate to the Account Settings page.

2. Click General.

3. In the KEY field, click to display the account API token.

4. Carefully copy and save the API token.

Look up your Snyk Group ID

1. In Snyk, navigate to the group Settings page and click General.

2. In the Group ID section of the page, carefully copy and save the group ID.

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a Snyk cloud-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of Snyk credentials generated by following the instructions above

1. In ConductorOne, navigate to Admin > Connectors and click Add connector.

2. Search for Snyk and click Add.

3. Choose how to set up the new Snyk 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

4. 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.

5. Click Next.

6. Find the Settings area of the page and click Edit.

7. Paste the API key into the API key field.

8. Paste the Group ID into the Group ID field.

9. Optional. If you want ConductorOne to only sync access data from specific Snyk organizations, enter the organization names in the Org IDs field.

   If you leave this field blank, ConductorOne will sync data from all organizations.

10. Click Save.

11. 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 Snyk connector is now pulling access data into ConductorOne.

Set up a Snyk 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 Snyk and ConductorOne.

See the ConductorOne Snyk integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.

Set up a Snyk self-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of Snyk 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 Snyk connector

1. In ConductorOne, navigate to Connectors > Add connector.

2. Search for Baton and click Add.

3. Choose how to set up the new Snyk 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

4. 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.

5. Click Next.

6. In the Settings area of the page, click Edit.

7. 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 Snyk connector deployment:

Secrets configuration

# baton-snyk-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-snyk-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Snyk credentials
  BATON_API_TOKEN: <Snyk API token>
  BATON_GROUP_ID: <Snyk group ID>
  BATON_ORG_IDS: <Limit syncing to only the specified Snyk organizations (optional)>

  # Optional: include if you want ConductorOne to provision access using this connector
  BATON_PROVISIONING: true

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-snyk.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-snyk
  labels:
    app: baton-snyk
spec:
  selector:
    matchLabels:
      app: baton-snyk
  template:
    metadata:
      labels:
        app: baton-snyk
        baton: true
        baton-app: snyk
    spec:
      containers:
      - name: baton-snyk
        image: ghcr.io/conductorone/baton-snyk:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-snyk-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run ConductorOne connectors (if desired):

   kubectl create namespace conductorone
   

2. Apply the secret configuration:

   kubectl -n conductorone apply -f baton-snyk-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-snyk.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n conductorone get pods
   

2. View the connector logs:

   kubectl -n conductorone logs -l app=baton-${baton-snyk}
   

3. 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 Snyk connector to. Snyk data should be found on the Entitlements and Accounts tabs.

That’s it! Your Snyk connector is now pulling access data into ConductorOne.