Skip to content

Commit 6500f50

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-9152: API: Update navigation to reflect use of authetication and changelog for REST and V! , REST API page
1 parent 9e2c9c9 commit 6500f50

40 files changed

+270
-270
lines changed

docs/SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -970,11 +970,11 @@
970970
* [REST API](snyk-api/rest-api/README.md)
971971
* [About the REST API](snyk-api/rest-api/about-the-rest-api.md)
972972
* [Getting started with the REST API](snyk-api/rest-api/getting-started-with-the-rest-api.md)
973-
* [Authentication for API](snyk-api/rest-api/authentication-for-api/README.md)
974-
* [Snyk API token permissions users can control](snyk-api/rest-api/authentication-for-api/snyk-api-token-permissions-users-can-control.md)
975-
* [Revoke and regenerate a Snyk API token](snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token.md)
976-
* [Changelog](snyk-api/rest-api/changelog.md)
977973
* [V1 API](snyk-api/v1-api.md)
974+
* [Authentication for API](snyk-api/authentication-for-api/README.md)
975+
* [Snyk API token permissions users can control](snyk-api/authentication-for-api/snyk-api-token-permissions-users-can-control.md)
976+
* [Revoke and regenerate a Snyk API token](snyk-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token.md)
977+
* [Changelog](snyk-api/changelog.md)
978978
* [OAuth2 API](snyk-api/oauth2-api.md)
979979
* [Reference](snyk-api/reference/README.md)
980980
* [Apps](snyk-api/reference/apps.md)

docs/enterprise-setup/service-accounts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ From the **Role** dropdown list, select an appropriate role.
8484

8585
For Group service accounts, choose from the following list of roles to configure the scope of the token; Snyk recommends selecting Viewer or Admin.
8686

87-
* **Group Viewer** enables read-only access. Note that to set an API token to be read-only and unable to write to the platform, you must use a service account and set it to Group Viewer. See [Snyk API token permissions users can control](../../snyk-api/rest-api/authentication-for-api/snyk-api-token-permissions-users-can-control.md).
87+
* **Group Viewer** enables read-only access. Note that to set an API token to be read-only and unable to write to the platform, you must use a service account and set it to Group Viewer. See [Snyk API token permissions users can control](../../snyk-api/authentication-for-api/snyk-api-token-permissions-users-can-control.md).
8888
* **Group Admin** enables full administrator access.
8989
* **Group Member** associates a service account with a group but does not grant any specific access.
9090

docs/getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ To obtain your personal Snyk API token:
7777

7878
If you want a new API token, select **Revoke & Regenerate**, but be aware that this will make the previous API token invalid.
7979

80-
For information on when to use an API token and when to use a service account token, available to Enterprise plan users only, see [Authentication for API](../snyk-api/rest-api/authentication-for-api/).
80+
For information on when to use an API token and when to use a service account token, available to Enterprise plan users only, see [Authentication for API](../snyk-api/authentication-for-api/).
8181

8282
## Import a Project to scan and identify issues
8383

docs/scan-with-snyk/snyk-open-source/snyk-for-bazel/dep-graph-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To test and monitor dependencies managed by [Bazel](./), it is recommended that
1212
Follow these basic steps:
1313

1414
1. For each type of dependency, for example, Maven, Cocoapods, create a [Dep Graph JSON object](https://github.com/snyk/dep-graph) listing all the dependency packages and versions. See [Example of Snyk for Baszel](dep-graph-api.md#example-of-snyk-for-bazel).
15-
2. As part of a Bazel test rule, send the Dep Graph JSON object as a POST request to the endpoint [Test Dep Graph](../../../snyk-api/reference/test-v1.md#test-dep-graph), along with your [auth token](../../../snyk-api/rest-api/authentication-for-api/). An example curl request follows:
15+
2. As part of a Bazel test rule, send the Dep Graph JSON object as a POST request to the endpoint [Test Dep Graph](../../../snyk-api/reference/test-v1.md#test-dep-graph), along with your [auth token](../../../snyk-api/authentication-for-api/). An example curl request follows:
1616

1717
```
1818
curl -X POST 'https://api.snyk.io/v1/test/dep-graph' \

docs/scm-ide-and-ci-cd-integrations/snyk-ci-cd-integrations/snyk-ci-cd-integration-deployment-and-strategies/ci-cd-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To continuously avoid known vulnerabilities in your dependencies, integrate Snyk
4949

5050
### Set up automatic monitoring
5151

52-
If you monitor a Project with Snyk, you will be notified if the dependencies in your Project are affected by newly disclosed vulnerabilities. To ensure the list of dependencies Snyk has for your Open Source Project is up to date, refresh it continuously by running `snyk monitor` in your deployment process. Configure your environment to include the `SNYK_TOKEN` environment variable. You can [find your API token ](../../../snyk-api/rest-api/authentication-for-api/)in your Snyk account settings.
52+
If you monitor a Project with Snyk, you will be notified if the dependencies in your Project are affected by newly disclosed vulnerabilities. To ensure the list of dependencies Snyk has for your Open Source Project is up to date, refresh it continuously by running `snyk monitor` in your deployment process. Configure your environment to include the `SNYK_TOKEN` environment variable. You can [find your API token ](../../../snyk-api/authentication-for-api/)in your Snyk account settings.
5353

5454
### API token configuration
5555

docs/scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-server-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ To set up the integration you will need the following:
141141

142142
* The base API address for your Snyk region; refer to the list of [API URLs](../../working-with-snyk/regional-hosting-and-data-residency.md#api-urls) for Snyk regional hosting.
143143
* The Snyk Organization ID you want to set up the integration in.
144-
* A valid [Snyk API token](../../snyk-api/rest-api/authentication-for-api/#how-to-obtain-your-personal-token).
144+
* A valid [Snyk API token](../../snyk-api/authentication-for-api/#how-to-obtain-your-personal-token).
145145
* `snyk-broker-config` tool installed
146146
* Tenant Admin role
147147

docs/snyk-api/rest-api/authentication-for-api/README.md renamed to docs/snyk-api/authentication-for-api/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ To use the Snyk API, you must be an Enterprise plan customer and have a token fr
77
{% endhint %}
88

99
{% hint style="warning" %}
10-
Use the URL for your region when calling an API. See [API URLs](../about-the-rest-api.md#api-urls).
10+
Use the URL for your region when calling an API. See [API URLs](../rest-api/about-the-rest-api.md#api-urls).
1111
{% endhint %}
1212

13-
Enterprise users have [access to a personal token under their profile](./#how-to-obtain-your-personal-token) and to service account tokens. The personal API token is associated with your Snyk Account and not with a specific Organization. Service accounts are associated with an Organization or a Group. For more information, see [Service accounts](../../../enterprise-setup/service-accounts/).
13+
Enterprise users have [access to a personal token under their profile](./#how-to-obtain-your-personal-token) and to service account tokens. The personal API token is associated with your Snyk Account and not with a specific Organization. Service accounts are associated with an Organization or a Group. For more information, see [Service accounts](../../enterprise-setup/service-accounts/).
1414

1515
* **Enterprise users should use a service account** to authenticate for any kind of automation. This includes, but is not limited to, CI/CD scanning with the CLI or build system plugins and any automation, including automation with the API.
1616
* **Enterprise users should use the personal token** under their user profile for:
17-
* Running the CLI locally on their machine; for details, see [Authenticate to use the CLI](../../../snyk-cli/authenticate-to-use-the-cli.md).
17+
* Running the CLI locally on their machine; for details, see [Authenticate to use the CLI](../../snyk-cli/authenticate-to-use-the-cli.md).
1818
* Authenticating with the IDE manually
1919
* Running API calls one time, for example, to test something
2020

21-
Note that for free and team plan users, the personal token does not have access to the API and may be used for authenticating to IDE, CLI, and CI/CD integrations only. For details, see [Obtain and use your API token](../../../getting-started/#obtain-and-use-your-snyk-api-token).
21+
Note that for free and team plan users, the personal token does not have access to the API and may be used for authenticating to IDE, CLI, and CI/CD integrations only. For details, see [Obtain and use your API token](../../getting-started/#obtain-and-use-your-snyk-api-token).
2222

2323
For additional information, see [Snyk API token permissions users can control](snyk-api-token-permissions-users-can-control.md).
2424

@@ -41,7 +41,7 @@ curl --request GET \
4141

4242
## Authenticating for Snyk Apps
4343

44-
If you are using the [Snyk Apps APIs](../../using-specific-snyk-apis/snyk-apps-apis/), provide the `access_token` in an `Authorization: bearer` header as follows:
44+
If you are using the [Snyk Apps APIs](../using-specific-snyk-apis/snyk-apps-apis/), provide the `access_token` in an `Authorization: bearer` header as follows:
4545

4646
```bash
4747
curl --request GET \

docs/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token.md renamed to docs/snyk-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ If you suspect an API token has been leaked, it is good practice to revoke that
88

99
To revoke your Snyk user API token, navigate to your personal General Account Settings in the Snyk Web UI at [app.snyk.io/account](https://app.snyk.io/account).
1010

11-
![API token screen, Revoke & Regenerate button](../../../.gitbook/assets/account-settings-general-auth-token.png)
11+
![API token screen, Revoke & Regenerate button](../../.gitbook/assets/account-settings-general-auth-token.png)
1212

1313
Click the **Revoke & Regenerate** button to revoke your API token. A new one will be generated in its place. You can now copy the newly generated API token and update integrations that used the old token.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ To set an API token to have read-only permissions so the user is unable to write
44

55
Service accounts at the Organization level have only Organization Admin and Organization Collaborator permissions. Thus, to set a service account to view only, you must use a Group-level service account.
66

7-
For more information see [Service accounts](../../../enterprise-setup/service-accounts/).
7+
For more information see [Service accounts](../../enterprise-setup/service-accounts/).
File renamed without changes.

0 commit comments

Comments
 (0)