Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Jan 15, 2025
1 parent ac61e7b commit 2fcb930
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/billing-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/reference/apis/data-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
6 changes: 6 additions & 0 deletions docs/operate/control/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion static/include/app/apis/generated/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
Expand Down
2 changes: 1 addition & 1 deletion static/include/app/apis/overrides/protos/app.RotateKey.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 2fcb930

Please sign in to comment.