GITBOOK-8673: IDE plugins and extensions: JB+VS Code config: add mult…

…i-tenant non-default region notice
snyk · Jan 9, 2025 · 7152923 · 7152923
1 parent c73568b
commit 7152923
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/...de-plugins-and-extensions/eclipse-plugin/configuration-of-the-eclipse-plugin.md b/...de-plugins-and-extensions/eclipse-plugin/configuration-of-the-eclipse-plugin.md
@@ -11,7 +11,8 @@ You can set the following global configuration settings in the Snyk preferences.
 * `Token`: Set the authentication token for Snyk.
 * `Use token authentication`: Select to override the default OAuth2 authentication in order to use a Snyk API token. Snyk recommends keeping this setting off because the default OAuth2 authentication is more secure.
 * `Path`: Specify your additions to the path to find needed third-party tools such as Gradle or Maven.
-* `Custom Endpoint`: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls). Multi-tenant users who do not belong to the default region will be automatically redirected to the correct domain for the email with which the user authenticated. The redirect will not occur for cases where the users are expected to use a custom URL, such as companies with single-tenant setups.
+* `Custom Endpoint`: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).\
+  Multi-tenant users who do not belong to the default region will be automatically redirected to the correct domain for the email with which the user authenticated. The redirect will not occur for cases where the users are expected to use a custom URL, such as companies with single-tenant setups.
 * `Allow unknown certificate authorities`: Disable certificate checks for SSL connections.
 * `Snyk Open Source enabled`: Enable or disable Snyk Open Source Dependency Scans through the Language Server. Default: `Enabled` during beta.
 * `Snyk Code Security enabled`: Enable or disable Snyk Code Security Issues through the Language Server. Default: `Disabled` by default.

diff --git a/.../jetbrains-plugins/configuration-for-the-snyk-jetbrains-plugin-and-ide-proxy.md b/.../jetbrains-plugins/configuration-for-the-snyk-jetbrains-plugin-and-ide-proxy.md
@@ -6,7 +6,8 @@ Navigate to **Preferences**, **Tools**, and then **Snyk** to set the following c
 
 * **Authentication method:** Specify whether to authenticate with OAuth2 or with an API token. `OAuth2` is the default
 * **Token**: Set the token to use for authentication with Snyk. For details, see [Authentication for the JetBrains plugins](authentication-for-the-jetbrains-plugins.md).
-* **Custom endpoint**: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+* **Custom endpoint**: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).\
+  Multi-tenant users who do not belong to the default region will be automatically redirected to the correct domain for the email with which the user authenticated. The redirect will not occur for cases where the users are expected to use a custom URL, such as companies with single-tenant setups.
 * **Ignore unknown CA**: Ignore the SSL cert, if needed
 *   **Organization**: Set the Organization to run `snyk test` against (similar to the `--org=` option in the CLI). Snyk recommends using the `ORG_ID`. If you specify an Organization slug name, the value must match the URL slug as displayed in the URL of your Organization in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`.
 

diff --git a/...ions/visual-studio-code-extension/visual-studio-code-extension-configuration.md b/...ions/visual-studio-code-extension/visual-studio-code-extension-configuration.md
@@ -7,7 +7,8 @@ After the plugin is installed, you can set the following configurations for the
 ### Snyk account
 
 * **Authentication method:** Specify whether to authenticate with OAuth2 or with an API token. `OAuth2`is the default
-* **Custom Endpoint**: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).
+* **Custom Endpoint**: Specify the Snyk API endpoint for a custom multi-tenant or single-tenant setup. If you are using `https://api.snyk.io`, no configuration is required. For details, see the list of [IDE URLs](../../../working-with-snyk/regional-hosting-and-data-residency.md#ides-urls).\
+  Multi-tenant users who do not belong to the default region will be automatically redirected to the correct domain for the email with which the user authenticated. The redirect will not occur for cases where the users are expected to use a custom URL, such as companies with single-tenant setups.
 *   **Organization**: Sets the Organization to run `snyk test` against, similar to the `--org=` option in the CLI. Snyk recommends using the `ORG_ID`. If you specify an Organization slug name, the value must match the URL slug as displayed in the URL of your Organization in the Snyk UI: `https://app.snyk.io/org/[orgslugname]`.
 
     If this is not specified, the preferred Organization, as defined in your [web account settings](https://app.snyk.io/account), is used to run tests.