Skip to content

Commit 540d9a5

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-8885: Broker: Code Agent, update Obtain the required tokens for setup of the Code Agent
1 parent bca5d41 commit 540d9a5

File tree

2 files changed

+6
-36
lines changed

2 files changed

+6
-36
lines changed

docs/enterprise-setup/snyk-broker/snyk-broker-code-agent/install-snyk-broker-code-agent-using-docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
The Code Agent is deprecated and is no longer maintained.
77

8-
The preferred method of running Snyk Code analysis using Snyk Broker is through [Brokered Code](../../git-clone-through-broker.md). The Code Agent is an alternative method without advantages. For details, contact your Snyk Integration Consultant or Technical Success Manager or contact [Snyk Support](https://support.snyk.io).
8+
The preferred method of running Snyk Code analysis using Snyk Broker is through [Brokered Code](../../git-clone-through-broker.md). The Code Agent is an alternative method without advantages. For details, contact your Snyk Integration Consultant or Technical Success Manager or contact [Snyk support](https://support.snyk.io).
99

1010
The automatic [PR Checks](../../../../scan-with-snyk/pull-requests/pull-request-checks/) feature is not supported for Snyk Broker - Code Agent.
1111
{% endhint %}

docs/enterprise-setup/snyk-broker/snyk-broker-code-agent/install-snyk-broker-code-agent-using-docker/obtain-the-required-tokens-for-setup.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
To set up the Code Agent wtih the Broker client, you need the following tokens:
44

55
* **Snyk API token** - this token is **required for the Code Agent setup**. It is used in the `-e SNYK_TOKEN` parameter to authenticate the Code Agent component with your Snyk Account. See [Obtain and use your Snyk API token](../../../../getting-started/#obtain-and-use-your-snyk-api-token) and [Set up the Code Agent](set-up-the-code-agent.md).
6-
* **Broker token** - this token is **required for the Broker client setup**. It is used in the `-e BROKER_TOKEN` parameter. The Broker token is associated with a specific Organization by default and with a specific integrated SCM, and enables Snyk Broker deployment for this Organization and SCM. For each SCM, a different Broker token is required. For details, see [Obtain your Broker token for Snyk Broker - Code Agent](obtain-the-required-tokens-for-setup.md#obtain-your-broker-token-for-snyk-broker-code-agent).
7-
* **Integrated SCM token** - this token is required for the Broker Client setup. It is used in the `-e <SCM>_TOKEN` parameter, or example, `-e GITHUB_TOKEN=xxx…`, to enable access to the SCM with certain permissions needed for the operation of the Broker and Snyk Code. See [Obtain your SCM token](obtain-the-required-tokens-for-setup.md#obtain-your-scm-token).
6+
* **Broker token** - this token is **required for the Broker client setup**. It is used in the `-e BROKER_TOKEN` parameter. The Broker token is associated with a specific Organization by default and with a specific integrated SCM, and enables Snyk Broker deployment for this Organization and SCM. For each SCM, a different Broker token is required. Details are on this page.
7+
* **Integrated SCM token** - this token is required for the Broker Client setup. It is used in the `-e <SCM>_TOKEN` parameter, for example, `-e GITHUB_TOKEN=xxx…`, to enable access to the SCM with certain permissions needed for the operation of the Broker and Snyk Code. For details, see [Integrated SCM tokens for Snyk Broker](../../../../scm-ide-and-ci-cd-integrations/snyk-scm-integrations/#integrated-scm-tokens-for-snyk-broker).
88

9-
After you have obtained the required tokens, save them in a safe and accessible place. When you start setting up the Code Agent and the Client Broker components, you will need to use these tokens.
9+
After you have obtained the required tokens, save them in a safe and accessible place for use in setting up the Code Agent and the Broker Client.
1010

1111
## Obtain your Broker token for Snyk Broker - Code Agent
1212

@@ -23,7 +23,7 @@ You have the following options for obtaining the Broker token:
2323

2424
After a Broker token is generated by either method, you can [obtain your Broker token from the Web UI](obtain-the-required-tokens-for-setup.md#obtain-your-broker-token-from-the-web-ui).
2525

26-
### **Generate your Broker token using the Snyk API**
26+
## **Generate your Broker token using the Snyk API**
2727

2828
You can generate the Broker token by using the API as follows:
2929

@@ -32,7 +32,7 @@ You can generate the Broker token by using the API as follows:
3232
You can see the generated Broker token in the API response body and on the Web UI.
3333
3. Copy and save the Broker token and store it in a secure location for future use, or obtain it later using the Web UI.
3434

35-
### **Obtain your Broker token from the Web UI**
35+
## **Obtain your Broker token from the Web UI**
3636

3737
Your Broker token is displayed on the Web UI after it is generated. Follow these steps to obtain the token.
3838

@@ -41,33 +41,3 @@ Your Broker token is displayed on the Web UI after it is generated. Follow these
4141
3. On the **Settings** page of the selected Integration, in the **Broker Credentials** section, copy the Broker token from the **Token** box and save it for future use:
4242

4343
<figure><img src="../../../../.gitbook/assets/Snyk Broker - Broker Token - box.png" alt="Copy the Broker token"><figcaption><p>Copy the Broker token</p></figcaption></figure>
44-
45-
## Obtain your SCM token
46-
47-
**To obtain your SCM token,** follow the instructions provided by the SCM you want to integrate with the Snyk Broker, and create a token with the required permissions.
48-
49-
The following SCM tokens are required for the different SCMs:
50-
51-
**GitHub and GitHub Enterprise**:
52-
53-
`GITHUB_TOKEN=` - a GitHub personal access token. Scopes: **`repo, read:org`** and **`admin:repo_hook`**.
54-
55-
See GitHub documentation - [_Creating a personal access token_](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\_\_
56-
57-
**Gitlab**:
58-
59-
**`GITLAB_TOKEN=`** - a GitLab personal access token. Gitlab account with **`Maintainer`** permissions. Scope: **`api`**.
60-
61-
See Gitlab documentation - [_Personal access tokens_](https://docs.gitlab.com/ee/user/profile/personal\_access\_tokens.html)\_\_
62-
63-
**Azure Repos**:
64-
65-
**`AZURE_REPOS_TOKEN=`** - an Azure Repos personal access token. Scopes: **`Custom defined`, \*\* `Code:` \*\* `Read & write`**_._
66-
67-
See Azure Repos documentation - [_Use personal access tokens_](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops\&tabs=Windows)\_\_
68-
69-
**Bitbucket Server/Data Center**:
70-
71-
**`BITBUCKET_USERNAME=`**, **`BITBUCKET_PASSWORD=`** – the Bitbucket Server username and password or a Bitbucket Server personal access token. Scope: **`Repository admin`**.
72-
73-
See Bitbucket Server documentation - [_Personal access tokens_](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html)\\

0 commit comments

Comments
 (0)