Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarification on scoped api keys #1416

Merged
merged 1 commit into from
May 7, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/rancher/v2.x/en/user-settings/api-keys/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ API Keys are composed of four components:

2. Click **Add Key**.

3. **Optional:** Enter a description for the API key and select an expiration period. We recommend setting an expiration date.
3. **Optional:** Enter a description for the API key and select an expiration period or a scope. We recommend setting an expiration date.

The API key won't be valid after expiration. Shorter expiration periods are more secure.

A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authroized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints]({{< baseurl >}}/v2.x/en/cluster-provisioning/rke-clusters/options/#authorized-cluster-endpoint) for more information.

4. Click **Create**.

Expand Down