From bcd13c593dddd2c51dfa1ee8d9bfc11c5e53083b Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Fri, 8 Jun 2018 13:12:46 -0700 Subject: [PATCH] updates per Denise's feedback --- .../v2.x/en/concepts/api-keys/_index.md | 2 +- .../tasks/{miscellaneous => api-key}/_index.md | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) rename content/rancher/v2.x/en/tasks/{miscellaneous => api-key}/_index.md (75%) diff --git a/content/rancher/v2.x/en/concepts/api-keys/_index.md b/content/rancher/v2.x/en/concepts/api-keys/_index.md index 9b1e8e84f75..0f09c8a73ac 100644 --- a/content/rancher/v2.x/en/concepts/api-keys/_index.md +++ b/content/rancher/v2.x/en/concepts/api-keys/_index.md @@ -10,6 +10,6 @@ Before you can use the Rancher CLI or write a program that calls the Rancher API ### API Keys and User Authentication -After logging into Rancher, you can generate API keys for accessing Rancher externally using your user settings. Typically, you should assign API keys to an application or a project. Using API keys for authentication is more secure than using passwords. If you need to revoke access to the Rancher API, you can delete the API key. +After logging into Rancher, you can generate API keys for accessing Rancher externally using your user settings. If you need to revoke access to the Rancher API, you can delete the API key. For instructions on how to create an API key, see [Creating an API Key]({{< baseurl >}}/rancher/v2.x/en/tasks/miscellaneous/). diff --git a/content/rancher/v2.x/en/tasks/miscellaneous/_index.md b/content/rancher/v2.x/en/tasks/api-key/_index.md similarity index 75% rename from content/rancher/v2.x/en/tasks/miscellaneous/_index.md rename to content/rancher/v2.x/en/tasks/api-key/_index.md index 01723b339f9..35f00169b37 100644 --- a/content/rancher/v2.x/en/tasks/miscellaneous/_index.md +++ b/content/rancher/v2.x/en/tasks/api-key/_index.md @@ -1,7 +1,9 @@ --- -title: Miscellaneous Tasks +title: Creating an API Key weight: 3725 draft: true +alias: + -/rancher/v2.x/en/tasks/miscellaneous --- -Because sometimes there's just no logical place `¯\_(ツ)_/¯`. - -### Creating an API Key - Create a Rancher API key so that other applications can make requests to the Rancher API. You can create API keys using the Rancher UI. 1. From any Rancher view, select **User Avatar** > **API & Keys** from the menu on the upper-right. 2. Click **Add Key**. -3. **Optional:** Enter a description for the API key and select an expiration period. +3. **Optional:** Enter a description for the API key and select an expiration period. We recommend setting an expiration date. - Shorter expiration periods are more secure. + The API key won't be valid after expiration. Shorter expiration periods are more secure. 4. Click **Create**. **Step Result:** Your API Key is created. Your API **Endpoint**, **Access Key**, **Secret Key**, and **Bearer Token** are displayed. The **Bearer Token** is your **Access Key** and **Secret Key** concatenated together. + Use the **Bearer Token** to authenticate with Rancher CLI. + 5. Copy the information displayed to a secure location. This information is only displayed once, so if you lose your key, you'll have to make a new one. ### Deleting API Keys -As a security best practice, we recommend using the minimum viable expiration period. You should delete API keys: +You should delete API keys: -- That have expired. - That may have been compromised. +- That have expired. To delete an API, select the stale key and click **Delete**. \ No newline at end of file