Step 1: Download service account IaC template (API)

Before you can create a Snyk Cloud Environment, you must download an infrastructure as code (IaC) template declaring a tightly-scoped Google service account that gives Snyk permission to scan the configuration of resources in your Google project.

The template also enables a set of Google service APIs for your Google Cloud project. This ensures that Snyk Cloud can utilize the necessary APIs to scan your project's resources.

You will use this IaC template to provision the role in Step 2: Create the Google service account (API).

Retrieve the IaC template

To retrieve the IaC template from the Snyk API, you need the API token for a Snyk Organization-level service account with an Org Admin role.

1. In the Snyk Web UI, navigate to Settings (cog icon) > General > Organization ID and copy your Organization ID.

2. Send a request to the Snyk API in the below format:

curl -X POST \
'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/permissions?version=2022-12-21~beta' \
-H 'Authorization: token YOUR-API-TOKEN' \
-H 'Content-Type:application/vnd.api+json' -d '{
    "data": {
        "attributes": {
            "type": "tf",
            "platform": "google"
        },
        "type": "permissions"
    }
}'

The example above uses curl, but you can use any API client, such as Postman or HTTPie.

The response is a JSON document like the one below (trimmed for length):

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "permissions",
    "attributes": {
      "data": "variable \"project_id\"<...>",
      "type": "tf"
    }
  }
}

Unescape the JSON

The data.attributes.data field in the output above is an escaped JSON string containing the Terraform template with the Google service account.

Before you can use the template to provision the resources, you need to unescape the JSON. This can be accomplished in either of the following ways:

• Use jq

• Transform the content manually

Use jq

1. Download and install jq.

2. When submitting the API request during template retrieval, append the following to the end of the command:

| jq -r .data.attributes.data > snyk_google_iac_template.tf

This will place the properly-formatted template into the file snyk_google_iac_template.tf in your current working directory.

Transform the content manually

1. Copy the contents of data.attributes.data from the API response, excluding the double quote at the very beginning and the very end of the value. You should end up with a long string starting with variable \"project_id\".

2. Paste the string into a tool such as FreeFormatter.com to unescape the JSON.

3. Save the unescaped Terraform output as a new .tf file.

What's next?

The next step is to create the Google service account for Snyk.