Skip to content

Commit a460a89

Browse files
committed
Updated per latest UI
1 parent 3b94c7c commit a460a89

File tree

4 files changed

+18
-14
lines changed

4 files changed

+18
-14
lines changed
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Access Key Updates (Manage)
2+
title: Access Keys Enhancements (Manage)
33
image: https://help.sumologic.com/img/sumo-square.png
44
keywords:
55
- access keys
@@ -11,20 +11,20 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1111

1212
<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
1313

14-
We're excited to announce updates to how you create and manage access keys.
14+
We're excited to announce enhancements to how you create and manage access keys.
1515

16-
### Scopes
17-
18-
You can now create permission scopes for access keys. Scopes limit the API endpoints an access key can be used to call. This allows you to specify only the permissions the access key needs to accomplish a specific task, making the key more secure.
16+
### Personal Access Keys
1917

20-
<img src={useBaseUrl('/img/security/custom-scopes-example.png')} alt="Custom scopes detail" style={{border: '1px solid gray'}} width="500"/>
18+
The **My Access Keys** section has been moved out of **Preferences** to its own tab and renamed **Personal Access Keys**. To access:
19+
* [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences > Personal Access Keys**.
20+
* [**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select your username, and then under **Preferences** select **Personal Access Keys**. You can also click the **Go To...** menu at the top of the screen and select **Personal Access Keys**.
2121

22-
### Personal access keys
22+
<img src={useBaseUrl('/img/security/access-key-preferences-page.png')} alt="Personal access keys" style={{border: '1px solid gray'}} width="800"/>
2323

24-
The **My Access Keys** section has been moved out of **Preferences** to its own screen and renamed **Personal Access Keys**.
24+
### Scopes
2525

26-
To access, select **Personal Access Keys** from your user options menu:<br/><img src={useBaseUrl('/img/security/personal-access-keys-menu-option.png')} alt="Personal Access Keys menu option" width="200"/>
26+
You can now create permission scopes for access keys. Scopes limit the API endpoints an access key can be used to call. This allows you to specify only the permissions the access key needs to accomplish a specific task, making the key more secure.
2727

28-
Your access keys are displayed on the **Personal Access Keys** tab:<br/><img src={useBaseUrl('/img/security/access-key-preferences-page.png')} alt="Personal access keys" style={{border: '1px solid gray'}} width="800"/>
28+
<img src={useBaseUrl('/img/security/custom-scopes-example.png')} alt="Custom scopes detail" style={{border: '1px solid gray'}} width="500"/>
2929

3030
[Learn more](/docs/manage/security/access-keys).

docs/manage/security/access-keys.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,18 @@ Managing Access Keys (how to).
3939

4040
### From the Personal Access Keys page
4141

42-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Personal Access Keys**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select your username, and then under **Preferences** select **Personal Access Keys**.
43-
1. On the **Personal Access Keys** tab, click **+ Add**.<br/><img src={useBaseUrl('/img/security/access-key-preferences-page.png')} alt="Personal Access Keys page" style={{border: '1px solid gray'}} width="800"/><br/>The **Add New Access Key** window appears.<br/><img src={useBaseUrl('/img/security/create-access-key.png')} alt="Add New Access Key screen" style={{border: '1px solid gray'}} width="500"/>
42+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences > Personal Access Keys**.<br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select your username, and then under **Preferences** select **Personal Access Keys**. You can also click the **Go To...** menu at the top of the screen and select **Personal Access Keys**.
43+
1. On the **Personal Access Keys** tab, click **+ Add Access Key**.<br/><img src={useBaseUrl('/img/security/access-key-preferences-page.png')} alt="Personal Access Keys page" style={{border: '1px solid gray'}} width="800"/><br/>The **Add New Access Key** window appears.<br/><img src={useBaseUrl('/img/security/create-access-key.png')} alt="Add New Access Key screen" style={{border: '1px solid gray'}} width="500"/>
4444
1. **Name**. Enter a name for your access key.
4545
1. **Allowed CORS Domains (optional)**. Create an allowlist of domains from which the access key can be used to access Sumo Logic APIs. For more information, see [CORS support](#cors-support).
4646
:::note
4747
Enter the domains in the [Origin format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) described in Mozilla help. The URL pattern must include the HTTPS protocol and a domain name. A port is optional.
4848
:::
4949
1. **Scopes**. For additional security, you can select scopes to give the key only the permissions you specify.
50+
:::note
51+
The user who will be utilizing the access key needs to have all the same [role capabilities](/docs/manage/users-roles/roles/role-capabilities) as the scopes on the access key. Otherwise, once the user views the access key details, the scopes will be displayed as red in the UI red with a message that the user does not have rights for those scopes.
52+
:::
53+
Select the scopes for the key:
5054
* **Default**. The key has all permissions.
5155
* **Custom**. The key has only the specified permissions. <br/><img src={useBaseUrl('/img/security/access-key-scopes.png')} alt="Access key scopes" style={{border: '1px solid gray'}} width="400"/><br/>Select the **View** and **Manage** permissions that you want the access key to have using the available categories.<br/><img src={useBaseUrl('/img/security/custom-scopes-detail.png')} alt="Custom scopes detail" style={{border: '1px solid gray'}} width="400"/>
5256
1. Click **Save** to generate the key.
@@ -61,7 +65,7 @@ All personal access keys created in the organization are displayed in the **Acce
6165

6266
Administrators can create access keys under **Access Keys** as an alternative to doing it [from the Personal Access Keys page](#from-the-personal-access-keys-page).
6367

64-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Security > Access Keys**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Administration**, and then under **Account Security Settings** select **Access Keys**. You can also click the **Go To...** menu at the top of the screen and select **Access Keys**.
68+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Security > Access Keys**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Administration**, and then under **Account Security Settings** select **Access Keys**. You can also click the **Go To...** menu at the top of the screen and select **Access Keys**.
6569
1. At the top right of the table, click **+ Add Access Key**. <br/><img src={useBaseUrl('/img/security/access-key-security-page.png')} alt="Sumo Logic interface showing a list of access keys with options to add a new access key, search access keys, and statuses of existing keys." width="700"/>
6670
1. Follow the steps from [the previous section](#from-the-personal-access-keys-page), starting with step 3.
6771

@@ -89,7 +93,7 @@ an Access-Control-Allow-Origin header.
8993

9094
### Personal access keys
9195

92-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Personal Access Keys**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select your username, and then under **Preferences** select **Personal Access Keys**.
96+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences > Personal Access Keys**.<br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select your username, and then under **Preferences** select **Personal Access Keys**. You can also click the **Go To...** menu at the top of the screen and select **Personal Access Keys**.
9397
1. Hover your mouse over an access key and click the three-dot kebab icon to reveal the modification options:<br/><img src={useBaseUrl('/img/security/my-access-keys1.png')} alt="User profile in Sumo Logic displaying username, security settings, and a list of access keys with options to deactivate, edit, or delete them." style={{border: '1px solid gray'}} width="800"/>
9498
* **Edit**. Opens up a window where you can modify the allowlist for your access key.
9599
* **Activate/Deactivate**. Depending on the current status of your access key, you'll see either an **Activate** or **Deactivate** option. If you deactivate an access key, Sumo Logic will retain the key credentials, but render the key useless. By default, Sumo Logic will deactivate an access key if it has gone unused for more than 30 days, though the [Access Keys deactivation policy](#access-keys-deactivation-policy) can be updated by a Sumo Logic administrator. You can reactivate a key at any time to begin using it again.
15.3 KB
Loading
26.6 KB
Loading

0 commit comments

Comments
 (0)