Auto-provisioning guide

Provisioning is the first interaction you have with Snyk before getting access. You provide answers to the following questions about how you will be using the platform:

  • What is the name of your business?

  • Where do you want your data to be hosted?

  • What is the authentication method your users will access Snyk with?

  • Do you already have a Snyk account you want to use (a previously completed Pilot) or do you want to start from scratch?

This guide covers the following aspects of automated provisioning:

Prerequisite: the "Welcome to Snyk" email

You should receive an email in your inbox containing links to start provisioning. Search for "Welcome to Snyk" as a subject, sent from no-reply@snyk.io.

If you have not received this email, look into your spam folder or reach out to your account executive.

This email contains two links:

  1. "Log in and activate your existing account" - To be used if you already have an account and wish to apply your plan to it.

  2. "Create and activate a new account" - To be used if you're entirely new to Snyk or want to start from scratch with a different user.

Once provisioning is complete, these links will become invalid and you will see an "Access denied" error page.

If you have not completed provisioning but still see this error, make sure someone else in your organization has not already completed the flow themselves, in case the welcome email has more recipients.

Sign up - start from scratch

Clicking the sign-up link in your welcome email will take you to the sign-up page in the provisioning app.

The provisioning app is only accessible through a unique link, all other access is disabled and will show an error page.

Step 1: Enter the company name

The company name you enter here will be used to create the Tenant, the top-level instance you'll see in the Snyk Platform. It is a required field and has 60-character limit.

Provisioning will also create a Group and a default Organization using the same name.

Step 2: Choose where to host the account

Snyk offers regional hosting to comply with regional data protection laws and improve service performance. This ensures data residency requirements are met and reduces data latency.

Provisioning is currently enabled for these three regions. Each of these regions is running at least one instance of the Snyk Platform:

  • 🇺🇸 United States: SNYK-US-01, SNYK-US-02

  • 🇪🇺 Europe: SNYK-EU-01

  • 🇦🇺 Australia: SNYK-AU-01

In the case of multiple instances being available in a chosen region (United States), Snyk reserves the right to chose the specific instance where your account will be created. For more information see Regional Hosting and data residency.

Automated provisioning is only possible for multi-tenant environments. For single-tenant availability (Snyk Private Cloud), reach out to your account team in advance of provisioning.

Step 3: Select an authentication method

The available authentication methods are either Single sign-on (SSO) or Third-party authentication.

  1. Single Sign-On - use your company's existing identity management system, see Single Sign-On (SSO) for authentication to Snyk for more details.

  2. Third-party authentication - we support a list of third-party identity providers, see Authentication for third-party tools for more details. This method is only available for the United States region.

Which authentication methods are available for each region?

Region
Single Sign-On
Third-party providers

🇺🇸 United States

✔️

✔️

🇪🇺 Europe

✔️

✖️

🇦🇺 Australia

✔️

✖️

Snyk recommends selecting SSO since it is best supported across all environments. Selecting this option will then prompt you to enter a valid, work-issued email address, used to create an initial Snyk Admin user. No extra configuration for SSO is required at this point.

Step 4: Confirm details and start provisioning

As a final step, you must confirm the details entered are correct.

  • If you have selected SSO as the authentication method, clicking "Sign up" will then show a loading page while Snyk does the background work.

  • If you have selected Third-party authentication, clicking "Continue to sign up options" will redirect you to the Snyk Login page where you can choose your identity provider (Github, Google, and so on.). Once you have completed signing up you will be redirected back to the provisioning application where the loading page will indicate in-progress background work.

Snyk advises you to not close the page, otherwise you risk not seeing the process complete successfully.

Step 5: Access the Snyk platform

  • If you have selected SSO as the authentication method, once plan activation is done, you will see a success message and a verification button. Snyk also sends an email to indicate a successful provisioning containing the same login verification link. This link does not expire and it can be used for multiple authentications if needed. Once clicked, a login code will be sent to the email address previously entered. This is known as a Passwordless Login. Enter the code where prompted and you are ready to start using Snyk!

  • If you have selected Third-party authentication, once plan activation is done you are all set! You can click "Continue to your account" and start using the platform.

Logging in - provision using an existing user account

Clicking the sign-up link in your welcome email will take you to the log in page in the provisioning app.

Step 1: Logging in

If you have a user account connected through a third-party provider, you will need to use SNYK-US-01

You can find the links for all the regions in the Login and Web UI URLs section.

Step 2: Select an existing Tenant or start fresh

If you already have a Snyk User, you can choose how you activate your Enterprise plan or Pilot after logging in:

  • Linking the plan to an existing Tenant. If your user is a member of multiple Tenants, you have the option to choose between them. Click the card of the Tenant you wish to select and then click "Confirm and activate".

  • Starting fresh with a new Tenant linked to your user. Click "Create new Tenant account" and enter the company name. It's the same field as Step 1: Enter the company name of signing up. You will be asked to confirm the name you entered before starting the provisioning process.

Step 3: Access the Snyk Platform

This step is the same as Step 5: Access the Snyk platform when signing up. Once the process is done you can "Continue to your account" and begin using Snyk.

Error types and solutions

Validation errors

When creating a new Tenant or User Snyk checks for duplicates and surfaces any issues.

  • "The business name provided is already in use." - Use a different name or reach out to your account executive if you want to link your plan to that existing Tenant but you are not a member of it.

Plan Activation errors

Snyk is doing it's best for you to never see this screen, but in case you do, save the reference ID and send it to your account executive or reach out to support with the reference ID and the steps taken.

Last updated

Was this helpful?