From 2fcb9306249d94008eef044c2691cfc4cee71a94 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Wed, 15 Jan 2025 14:44:43 +0100 Subject: [PATCH] Update --- docs/dev/reference/apis/billing-client.md | 2 +- docs/dev/reference/apis/data-client.md | 2 +- docs/operate/control/api-keys.md | 6 ++++++ static/include/app/apis/generated/app.md | 2 +- static/include/app/apis/overrides/protos/app.RotateKey.md | 2 +- 5 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/dev/reference/apis/billing-client.md b/docs/dev/reference/apis/billing-client.md index 422c2dc0cb..d0d6f026da 100644 --- a/docs/dev/reference/apis/billing-client.md +++ b/docs/dev/reference/apis/billing-client.md @@ -33,7 +33,7 @@ You will also need an API key and API key ID to authenticate your session. Your API key needs to have [Org owner permissions](/manage/manage/rbac/#organization-settings-and-roles) to use the billing client API. To get an API key (and corresponding ID), you have two options: -- [Create an API key using the Viam app](/cloud/rbac/#add-an-api-key) +- [Create an API key using the Viam app](/operate/control/api-keys/#add-an-api-key) - [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key) The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `BillingClient`: diff --git a/docs/dev/reference/apis/data-client.md b/docs/dev/reference/apis/data-client.md index ff09a1704b..d5eed3dd42 100644 --- a/docs/dev/reference/apis/data-client.md +++ b/docs/dev/reference/apis/data-client.md @@ -49,7 +49,7 @@ To use the Viam data client API, you first need to instantiate a [`ViamClient`]( You will also need an API key and API key ID to authenticate your session. To get an API key (and corresponding ID), you have two options: -- [Create an API key using the Viam app](/cloud/rbac/#add-an-api-key) +- [Create an API key using the Viam app](/operate/control/api-keys/#add-an-api-key) - [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key) The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates a `DataClient`: diff --git a/docs/operate/control/api-keys.md b/docs/operate/control/api-keys.md index 31715c317a..e432511cb0 100644 --- a/docs/operate/control/api-keys.md +++ b/docs/operate/control/api-keys.md @@ -38,3 +38,9 @@ See [Permissions](/manage/manage/rbac/) for information about the privilege each To change the entities it is able to access, click **+ Grant additional access**. Select which organization, location, or machine you want the key to grant access to. Click **Choose** to confirm your selection. + +## Rotate an API key + +If you ever need to rotate an API key, click on the **Generate Key** button on the organization setting page to generate a new key. + +Viam supports flexible key rotation with up to two keys in use at one time. After generating a new secret key, update all references to the key in your code as soon as possible and then remove the old key. diff --git a/static/include/app/apis/generated/app.md b/static/include/app/apis/generated/app.md index a3bc179e47..76cb7ba8f1 100644 --- a/static/include/app/apis/generated/app.md +++ b/static/include/app/apis/generated/app.md @@ -2214,7 +2214,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/ ### RotateKey -Rotate an [API key](/manage/manage/access/#rotate-an-api-key). +Rotate an [API key](/operate/control/api-keys/#rotate-an-api-key). {{< tabs >}} {{% tab name="Python" %}} diff --git a/static/include/app/apis/overrides/protos/app.RotateKey.md b/static/include/app/apis/overrides/protos/app.RotateKey.md index 08daca68ff..f6899fb214 100644 --- a/static/include/app/apis/overrides/protos/app.RotateKey.md +++ b/static/include/app/apis/overrides/protos/app.RotateKey.md @@ -1 +1 @@ -Rotate an [API key](/manage/manage/access/#rotate-an-api-key). +Rotate an [API key](/operate/control/api-keys/#rotate-an-api-key).