# Snyk Jumpstart Customer Prerequisites

## Overview of Snyk Jumpstart Customer Prerequisites

A Snyk Implementation Consultant will provide services to help the Customer accelerate integration of Snyk through assisted account configuration. The engagement will consist of knowledge transfer and paired configuration.

Before engagement starts, prerequisites must be met for each product module.

## What is excluded from Jumpstart?

* Snyk Code Local Engine
* Snyk Code Custom Rules
* Drift detection configuration
* API scripting
* Monorepos larger than 20 GB
* Non-generally available features (features in Closed Beta or Early Access)

## Snyk platform prerequisites

<table><thead><tr><th width="268">Snyk platform - initial setup</th><th width="227">Prerequisites</th><th>Customer participants</th></tr></thead><tbody><tr><td><ul><li>Base SSO connection configuration</li><li>SSO Custom Mapping</li></ul></td><td></td><td><ul><li>Requires an admin for your IDP to create an application within the IDP and create the mappings.</li><li>Snyk Group Admin access</li></ul></td></tr><tr><td><ul><li>(Template Org) Custom Roles and Service account configuration</li><li>(Template Org) Notification configuration</li><li>Template Org) Language settings configuration</li><li>(Template Org) Account Organization and Group configuration</li></ul></td><td></td><td>Snyk Group Admin access</td></tr><tr><td>(Template Org) Jira or Slack App configuration</td><td>Jira Cloud, Slack, or Jira v5 and later</td><td>Jira or Slack Admin</td></tr><tr><td>Admin training</td><td></td><td>Snyk Admins</td></tr><tr><td>Developer training</td><td></td><td>Developers</td></tr></tbody></table>

## Snyk Open Source prerequisites

<table><thead><tr><th>Snyk Open Source configuration</th><th width="275">Prerequisites</th><th>Customer participants</th></tr></thead><tbody><tr><td>Repository import (one SCM integration)</td><td><p></p><p>Projects must be in <a href="https://docs.snyk.io/scan-using-snyk/supported-languages-and-frameworks/supported-languages-frameworks-and-feature-availability-overview#open-source-and-licensing-snyk-open-source">a supported language/package manager</a></p><ul><li>.NET (NuGet or Paket)</li><li>Bazel</li><li>C/C++</li><li>Go (Go Modules)</li><li>Java and Kotlin (Maven or Gradle)</li><li>JavaScript (NPM or Yarn)</li><li>PHP (Composer)</li><li>Python (pip, Poetry, Pipenv, or setup.py)</li><li>Ruby (Bundler)</li><li>Scala (sbt)</li><li>Swift and Objective-C (Cocoapods)<br><br>No monorepos greater than 20GB</li></ul></td><td><ul><li>SCM Admin access</li><li>Snyk Admin access</li></ul></td></tr><tr><td>SCM integration setting</td><td>Must be using a <a href="../../scm-ide-and-ci-cd-integrations/snyk-scm-integrations">supported SCM integration</a></td><td><p></p><ul><li>SCM Admin access</li><li>Snyk Admin access</li></ul></td></tr><tr><td>SCM Broker installation</td><td>Snyk Broker environment must be on Linux, <a href="../../../enterprise-setup/snyk-broker/prepare-snyk-broker-for-deployment#prerequisites-for-snyk-broker">meet the prerequisites for Snyk Broker</a>, and be procured ahead of the engagement start</td><td>Admin/Root access to the infrastructure where Broker will be configured</td></tr><tr><td>Snyk Tools - API Import and SCM Sync</td><td>Access to repositories</td><td><p></p><ul><li>Snyk Admin access</li><li>Snyk Service account with Admin access</li></ul></td></tr><tr><td>Single pipeline configuration (direct integration OR CLI)</td><td>Service Account created by Org or Group Admin with Group or Org Admin permissions</td><td>User with pipeline edit access for CI/CD tool</td></tr><tr><td>SBOM Walkthrough (CLI and API)</td><td>Minimum of Snyk CLI version 1.1071.0</td><td></td></tr><tr><td>Interpreting and actioning Open Source results</td><td></td><td></td></tr></tbody></table>

## Snyk Code prerequisites

| Snyk Code configuration                      | Prerequisites                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Customer participants                                                                     |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| Repository import (one SCM integration)      | <p>Projects must be in <a href="https://docs.snyk.io/scan-using-snyk/supported-languages-and-frameworks/supported-languages-frameworks-and-feature-availability-overview#open-source-and-licensing-snyk-open-source">a supported language/package manager</a></p><p></p><ul><li>Apex</li><li>C# (.NET, ASP.NET, .NET Core)</li><li>C/C++ (C++ Standard Library, POSIX, Win32)</li><li>Go</li><li>Java (Apache Camel, Apache Struts, Spring MVC, Spring JDBC, Jakarta XML Services, Dropwizard)</li><li>Javascript (React, Vue.js, Express, JQuery)</li><li>Kotlin</li><li>PHP (Symphony, Laravel)</li><li>Python (Django, Flask)</li><li>Ruby on Rails</li><li>Scala (Play, Akka, HTTP4S)</li><li>Swift (AlamoFire, Pathos, SQLite, CryptoKit)</li><li>Typescript </li><li>VB.NET<br><br>No monorepos greater than 20GB</li></ul> | <p></p><ul><li>SCM Admin access</li><li>Snyk Admin access</li></ul>                       |
| SCM integration settings                     | Must be using a [supported SCM integration](../../scm-ide-and-ci-cd-integrations/snyk-scm-integrations)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | <p></p><ul><li>SCM Admin access</li><li>Snyk Admin access</li></ul>                       |
| SCM Broker installation                      | Snyk Broker environment must be on Linux, [meet the prerequisites for Snyk Broker](../../../enterprise-setup/snyk-broker/prepare-snyk-broker-for-deployment#prerequisites-for-snyk-broker), and be procured ahead of the engagement start                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Admin/Root access to the infrastructure where Broker will be configured                   |
| Snyk Tools - API Import and SCM Sync         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | <p></p><ul><li>Snyk Admin access</li><li>Snyk Service Account with Admin access</li></ul> |
| Interpreting and actioning Snyk Code Results |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                           |

## Snyk Container prerequisites

<table><thead><tr><th width="272">Snyk Container configuration</th><th>Prerequesites</th><th>Customer participants</th></tr></thead><tbody><tr><td>Single Broker Container Registry installation and configuration</td><td><p>Snyk Broker environment must be on Linux, <a href="../../../enterprise-setup/snyk-broker/prepare-snyk-broker-for-deployment#prerequisites-for-snyk-broker">meet the prerequisites for Snyk Broker</a>, and be procured ahead of the engagement start</p><p><br>Broker Server: running on the Snyk SaaS backend.</p><p><br>Broker Client and Container Registry Agent: two Docker images deployed in your infrastructure, creating two separate services, responsible for sampling your container registries in a secured manner and sending the allowed information to Snyk</p></td><td>Admin/Root access to the infrastructure where Broker will be configured</td></tr><tr><td>Container Registry Import (Up to 50 Targets)</td><td></td><td>User with Container Registry Admin access</td></tr><tr><td>Interpreting and actioning Container results</td><td></td><td></td></tr><tr><td>Single CI/CD CLI integration</td><td></td><td>CI/CD user with pipeline edit access for CI/CD tool and Snyk Admin permissions</td></tr><tr><td>Custom Base Images walkthrough (UI and CLI)</td><td>Snyk CLI installed locally</td><td></td></tr></tbody></table>

## Snyk IaC prerequisites

| Snyk IaC configuration                  | Prerequisites                                                                                                                                                                                                                                                                                                                                                                                            | Customer participants                                                          |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| Repository import (one SCM integration) | <p>Must be using <a href="https://docs.snyk.io/scan-using-snyk/scan-infrastructure/supported-iac-languages-cloud-providers-and-cloud-resources#supported-iac-languages">a supported IAC language</a>:</p><ul><li>AWS CloudFormation</li><li>Kubernetes Manifests</li><li>Terraform (Single File)</li><li>Terraform (modules)</li><li>Terraform (variables file)</li><li>Azure Resource Manager</li></ul> | <ul><li>SCM Admin access</li><li>Snyk Admin access</li></ul>                   |
| Interpreting and actioning IaC results  |                                                                                                                                                                                                                                                                                                                                                                                                          |                                                                                |
| SCM integration settings                | Must be using a supported SCM integration                                                                                                                                                                                                                                                                                                                                                                | User with SCM Admin access                                                     |
| SCM Broker installation                 | Snyk Broker environment must be on Linux, [meet the prerequisites for Snyk Broker](../../../enterprise-setup/snyk-broker/prepare-snyk-broker-for-deployment#prerequisites-for-snyk-broker), and be procured ahead of the engagement start                                                                                                                                                                | Admin/Root access to the infrastructure where Broker will be configured        |
| Single pipeline CI/CD CLI configuration | Must be using Terraform                                                                                                                                                                                                                                                                                                                                                                                  | CI/CD user with pipeline edit access for CI/CD tool and Snyk Admin permissions |



## Snyk Essentials prerequisites

| Essentials configuration                                             | Prerequisites | Customer particiapnts                                                                                                                                                                                                                                                                          |
| -------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Coverage and visibility configuration                                | <p><br></p>   | <p>Snyk Group Admin or User with <strong>Edit AppRisk</strong> permission </p><p></p><p>SCM Read Access token<br></p><p><a href="https://docs.snyk.io/integrate-with-snyk/third-party-integrations-for-snyk-apprisk">Application context provider integration settings and credentials</a></p> |
| Walkthrough of coverage and visibility use cases in Snyk Essentials  | <p><br></p>   | <p><br></p>                                                                                                                                                                                                                                                                                    |
| Walkthrough of prioritized issues in Snyk Essentials                 | <p><br></p>   | <p><br></p>                                                                                                                                                                                                                                                                                    |

## Snyk AppRisk prerequisites

| Snyk AppRisk configuration                                                | Prerequisites                                                                                                                                             | Customer participants                                                                                                                                                                            |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Third-party coverage and visibility configuration                         | <p><br></p>                                                                                                                                               | <p>Snyk Group Admin or User with the <strong>Edit AppRisk</strong> permission<br><br></p><p>User with credentials for the chosen third-party system to configure the third-party integration</p> |
| <p>Snyk Runtime Sensor installation</p><p><br></p>                        | Prerequisites detailed in [Prerequisites for Snyk Rintime Sensor](../../../integrate-with-snyk/snyk-runtime-sensor#prerequisites-for-snyk-runtime-sensor) | **Admin/Root** access to the infrastructure on which the Snyk Runtime Sensor will be configured                                                                                                  |
| Tagging of Projects for the prioritized issues feature (up to 50 Targets) | <p><br></p>                                                                                                                                               | <p><br></p>                                                                                                                                                                                      |
| Walkthrough of prioritized issues in AppRisk                              | <p><br></p>                                                                                                                                               | <p><br></p>                                                                                                                                                                                      |

## **Probely prerequisites**

| Probely configuration                                                                  | Prerequisites                                                                                                                                                      | Customer participants                                                                                                             |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| Web Target configuration, including authenticated scans (up to three web applications) | Credentials for Web Targets to configure authorization (form, sequence, or 2FA)                                                                                    | <p><br></p>                                                                                                                       |
| API Target configuration (up to one API collection)                                    | Postman Collection or OpenAPI definition for API                                                                                                                   | <p><br></p>                                                                                                                       |
| Domain Ownership Verification                                                          | <p><br></p>                                                                                                                                                        | Web infrastructure access to verify ownership of domain using a txt file, DNS, meta tag, Cloudflare connection, or AWS connection |
| Scanning Agent configuration (one agent)                                               | Prerequisites detailed in the Probely help article [How to install a Scanning Agent](https://help.probely.com/en/articles/6503388-how-to-install-a-scanning-agent) | Admin/Root access to the infrastructure on which the Scanning Agent will be configured                                            |
| Review of Target Scan results                                                          | <p><br></p>                                                                                                                                                        | <p><br></p>                                                                                                                       |
