diff --git a/notebooks/quickstart/quickstart_documentation.ipynb b/notebooks/quickstart/quickstart_documentation.ipynb index 8b93353c9..31be6c6da 100644 --- a/notebooks/quickstart/quickstart_documentation.ipynb +++ b/notebooks/quickstart/quickstart_documentation.ipynb @@ -277,7 +277,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ] }, { diff --git a/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb b/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb index f2de9aada..6c3f2b21e 100644 --- a/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb +++ b/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb @@ -208,7 +208,7 @@ "\n", "### Initialize the ValidMind Library\n", "\n", - "Use [`vm.init()`](https://docs.validmind.ai/validmind/validmind.html) with **`issuer`** and **`client_id`** (your IdP’s OAuth public client for device flow), plus **`model`** and **`api_host`** (or environment variables `VM_API_MODEL` / `VM_API_HOST`). Do not pass `api_key` / `api_secret` here; those are for the API-key quickstart. Optional **`audience`** (or `VM_OIDC_AUDIENCE`) and **`scope`** are often needed so tokens are accepted by the ValidMind API; your ValidMind or identity administrator can supply values that match your deployment. For general library usage, see the [ValidMind Library documentation](https://docs.validmind.ai/developer/validmind-library.html).\n", + "Use [`vm.init()`](https://docs.validmind.ai/validmind/validmind.html) with **`issuer`** and **`client_id`** (your IdP’s OAuth public client for device flow), plus **`model`** and **`api_host`** (or environment variables `VM_API_MODEL` / `VM_API_HOST`). Do not pass `api_key` / `api_secret` here; those are for the API-key quickstart. Optional **`audience`** (or `VM_OIDC_AUDIENCE`) and **`scope`** are often needed so tokens are accepted by the ValidMind API; your ValidMind or identity administrator can supply values that match your deployment. For setup details, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html). For general library usage, see the [ValidMind Library documentation](https://docs.validmind.ai/developer/validmind-library.html).\n", "\n", "When you run the cell below, the library may print a **verification URL** and **user code**: open the URL, enter the code, and complete sign-in; the notebook waits until the flow finishes. Valid tokens are cached under `~/.validmind/credentials.json`." ] diff --git a/notebooks/quickstart/quickstart_validation.ipynb b/notebooks/quickstart/quickstart_validation.ipynb index e9c1ec814..3ad7a3a31 100644 --- a/notebooks/quickstart/quickstart_validation.ipynb +++ b/notebooks/quickstart/quickstart_validation.ipynb @@ -316,7 +316,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ], "id": "ae918c6c" }, diff --git a/notebooks/templates/install-validmind/_install-initialize-with-development.ipynb b/notebooks/templates/install-validmind/_install-initialize-with-development.ipynb index f0f7f8f3b..b3a4b923c 100644 --- a/notebooks/templates/install-validmind/_install-initialize-with-development.ipynb +++ b/notebooks/templates/install-validmind/_install-initialize-with-development.ipynb @@ -95,7 +95,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ] }, { diff --git a/notebooks/templates/install-validmind/_install-initialize-with-monitoring.ipynb b/notebooks/templates/install-validmind/_install-initialize-with-monitoring.ipynb index f0ea62aa9..8e0c9b353 100644 --- a/notebooks/templates/install-validmind/_install-initialize-with-monitoring.ipynb +++ b/notebooks/templates/install-validmind/_install-initialize-with-monitoring.ipynb @@ -95,7 +95,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ] }, { diff --git a/notebooks/templates/install-validmind/_install-initialize-with-validation.ipynb b/notebooks/templates/install-validmind/_install-initialize-with-validation.ipynb index 30cd6bb0c..14320562d 100644 --- a/notebooks/templates/install-validmind/_install-initialize-with-validation.ipynb +++ b/notebooks/templates/install-validmind/_install-initialize-with-validation.ipynb @@ -125,7 +125,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ] }, { diff --git a/notebooks/tutorials/development/1-set_up_validmind.ipynb b/notebooks/tutorials/development/1-set_up_validmind.ipynb index 158cf4c7a..df3c6423e 100644 --- a/notebooks/tutorials/development/1-set_up_validmind.ipynb +++ b/notebooks/tutorials/development/1-set_up_validmind.ipynb @@ -262,7 +262,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ], "id": "3339f683" }, diff --git a/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb b/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb index 72ccaa027..e44ae644c 100644 --- a/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb +++ b/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb @@ -316,7 +316,9 @@ "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", - "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:" + "3. Next, [load your model identifier credentials from an `.env` file](https://docs.validmind.ai/developer/quickstart/store-credentials-in-env-file.html) or replace the placeholder with your own code snippet:", + "\n", + "If your organization authenticates with OAuth 2.0 / OIDC instead of API keys, see [Authenticate with OIDC device flow](https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html) or try the [OIDC device-flow quickstart notebook](https://docs.validmind.ai/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.html).\n" ], "id": "b375b341" },