Skip to content

Commit b4acced

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-8887: Broker: Code Agent, Obtain the required tokens foe setup, small corrections
1 parent 540d9a5 commit b4acced

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

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: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Obtain the required tokens for setup
22

3-
To set up the Code Agent wtih the Broker client, you need the following tokens:
3+
To set up the Code Agent wtih the Broker client, you must have 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).
66
* **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.
@@ -12,31 +12,31 @@ After you have obtained the required tokens, save them in a safe and accessible
1212

1313
You have the following options for obtaining the Broker token:
1414

15-
* **Using an existing Broker token for the Code Agent setup** - if you already have a Broker token, which you used for running the Broker client for another Snyk product in the same Organization and the same SCM, you can also use it to set up Snyk Broker - Code Agent.
15+
* **Using an existing Broker token for the Code Agent setup** -If you already have a Broker token, which you used for running the Broker client for another Snyk product in the same Organization and the same SCM, you can also use it to set up Snyk Broker - Code Agent.
1616
* **Using the same Broker token for multiple Snyk Organizations** -\
1717
Although by default a Broker token is associated with only one Snyk Organization, if you have Organization Admin permissions, you can use the same Broker token for multiple Organizations as follows:
18-
* **A new Organization** - if you create a new Organization based on an existing Organization that has a Broker token, the existing Broker token is cloned during the creation of the new Organization, and you can use it for the new Organization as well.
19-
* **An existing Organization** – if you want to use an existing Broker token for other existing Organizations, you can use the endpoint Clone an integratio[Clone an integration (with settings and credentials)](../../../../snyk-api/reference/integrations-v1.md#org-orgid-integrations-integrationid-clone). This API clones existing integration settings, including the Broker token for the Integration.
20-
* **Using a Broker token for redundancy** - if you set up two Broker Clients for the same Organization and the same SCM for redundancy purposes, you must use the same Broker token for both Broker clients. You can obtain the Snyk Broker token in the following ways:
21-
* Recommended: ask your Snyk account team to generate a Broker token for you, and then obtain it from the Web UI.
22-
* Generate the Broker token using Snyk APIs (see the instructions that follow).
18+
* **A new Organization** - If you create a new Organization based on an existing Organization that has a Broker token, the existing Broker token is cloned during the creation of the new Organization, and you can use it for the new Organization as well.
19+
* **An existing Organization** - If you want to use an existing Broker token for other existing Organizations, you can use the endpoint [Clone an integration (with settings and credentials)](../../../../snyk-api/reference/integrations-v1.md#org-orgid-integrations-integrationid-clone). This API clones existing integration settings, including the Broker token for the Integration.
20+
* **Using a Broker token for redundancy** -If you set up two Broker Clients for the same Organization and the same SCM for redundancy purposes, you must use the same Broker token for both Broker clients. You can obtain the Snyk Broker token in the following ways:
21+
* Recommended: ask your Snyk account team to generate a Broker token for you and then obtain it from the Web UI.
22+
* Generate the Broker token using Snyk APIs. See the instructions in the next section.
2323

24-
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).
24+
After a Broker token is generated by your Snyk account team or through the API, 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

2626
## **Generate your Broker token using the Snyk API**
2727

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

3030
1. Use the endpoint [Update Existing Integration](../../../../snyk-api/reference/integrations-v1.md#org-orgid-integrations-type) to enable Snyk Broker for a specific Organization and a specific SCM. This generates a Broker token in the UI.
31-
2. To generate a Broker token programmatically, after enabling Snyk Broker, use the endpoint [Provision new Broker token](../../../../snyk-api/reference/integrations-v1.md#org-orgid-integrations-integrationid-authentication-provision-token) to generate a Broker token.\
31+
2. To generate a Broker token programmatically after enabling Snyk Broker, use the endpoint [Provision new Broker token](../../../../snyk-api/reference/integrations-v1.md#org-orgid-integrations-integrationid-authentication-provision-token) to generate a Broker token.\
3232
You can see the generated Broker token in the API response body and on the Web UI.
33-
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.
33+
3. After generating the Broker token, copy and save it and store it in a secure location for future use, or obtain it later using the Web UI.
3434

3535
## **Obtain your Broker token from the Web UI**
3636

37-
Your Broker token is displayed on the Web UI after it is generated. Follow these steps to obtain the token.
37+
After your Broker token is generated, it is displayed on the Web UI. Follow these steps to obtain the token:
3838

39-
1. In the Snyk Web UI, select the Organization for which you want to set up the Snyk Broker.
39+
1. In the Snyk Web UI, select the **Organization** for which you want to set up the Snyk Broker.
4040
2. In the selected Organization, select **Integration**. Find the Integration to which you want to connect Snyk Broker, and click the **Settings** icon.
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

0 commit comments

Comments
 (0)