Skip to content

Commit 2269b0f

Browse files
authored
DOCS-232 - Personal access keys (#4589)
* First pass * Second pass * Clean up links * Change link text * Updated per latest UI * Cleanup * Revise screenshots * Change release note date to Dec 6 2024 * Change release note date to Dec 9 2024 * Change release note date to Dec 12 2024 * Change release note date to Jan 3 2025 * Fix broken anchor link * Change release note date to Jan 16 2025
1 parent 97c2987 commit 2269b0f

File tree

60 files changed

+147
-156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+147
-156
lines changed

blog-service/2023/12-31.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,7 @@ We're excited to announce the release of our new cloud-to-cloud source for Trell
758758

759759
We’re happy to announce a new security option allowing administrators to set a custom policy for the number of days an API Access Key can go unused before being automatically deactivated. This setting allows administrators to tailor the feature to suit their organization’s specific security requirements. This enhances the security of your account by reducing the risk of unauthorized access through abandoned access keys. This ensures that only active access keys can be used to access your account and its resources.
760760

761-
[Learn more](/docs/manage/security/access-keys#edit-deactivate-or-delete-an-access-key).
761+
[Learn more](/docs/manage/security/access-keys#access-keys-deactivation-policy).
762762

763763

764764
---

blog-service/2025-01-16-manage.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Access Keys Enhancements (Manage)
3+
image: https://help.sumologic.com/img/sumo-square.png
4+
keywords:
5+
- access keys
6+
- manage
7+
hide_table_of_contents: true
8+
---
9+
10+
import useBaseUrl from '@docusaurus/useBaseUrl';
11+
12+
<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>
13+
14+
We're excited to announce enhancements to how you create and manage access keys.
15+
16+
### Personal Access Keys
17+
18+
The **My Access Keys** section has been moved out of **Preferences** to its own tab and renamed **Personal Access Keys**.
19+
20+
<img src={useBaseUrl('/img/security/access-key-preferences-page.png')} alt="Personal access keys" style={{border: '1px solid gray'}} width="800"/>
21+
22+
To open the Personal Access Keys tab:
23+
* [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences > Personal Access Keys**.
24+
* [**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**.
25+
26+
### Scopes
27+
28+
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.
29+
30+
[Learn more](/docs/manage/security/access-keys).
31+
32+
<img src={useBaseUrl('/img/security/custom-scopes-example.png')} alt="Custom scopes example" style={{border: '1px solid gray'}} width="500"/>

docs/cse/integrations/insight-enrichment-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ The following parameters control general server behaviors, as opposed to enrichm
151151
| Setting | Required? | Description |
152152
|:--|:--|:--|
153153
| `URL` | yes | The URL for your API endpoint. For more information, see [Sumo Logic API Authentication, Endpoints, and Security](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security). |
154-
| `api_id` | yes | Enter your Sumo Logic Access ID. For more information, see [Manage your access keys on Preferences page](/docs/manage/security/access-keys#from-the-preferences-page). |
154+
| `api_id` | yes | Enter your Sumo Logic Access ID. For more information, see [Access Keys](/docs/manage/security/access-keys). |
155155
| `api_key` | yes | Enter your Sumo Logic Access Key.|
156156
| `log_level` | no | Log level the server should use. The options are:<br/><br/>-`error`. Only display error messages.<br/>-`info`. Display informational messages. This is the recommended value.<br/>-`debug`. Displays debug (or trace) data. Recommended only when debugging.<br/><br/>Default: `info` |
157157
| `poll_interval` | no | How often the Insight Enrichment Server should check for new insights. You can specify the interval in seconds (s), minutes (m), or hours (h).<br/><br/>Default: 10s |

docs/cse/integrations/security-incident-response-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Your Cloud SIEM role must allow you to use API keys and to retrieve and modify i
3636

3737
In this step, you make a copy of your API credentials, which you'll need to supply when you install the SIR-Cloud SIEM integration in [Step 5](#step-5-install-the-sir-cloud-siem-integration) below. 
3838

39-
You’ll need to supply a Sumo Logic Access ID and Access Key. If necessary, you can create those on your **Preferences** page in the Sumo Logic UI. For more information, see [Create an access key on Preferences page](/docs/manage/security/access-keys#from-the-preferences-page).
39+
You’ll need to supply a Sumo Logic Access ID and Access Key. If necessary, you can create those in the Sumo Logic UI. For more information, see [Access Keys](/docs/manage/security/access-keys).
4040

4141
## Step 2: Install ServiceNow plugins
4242

docs/get-started/account-settings-preferences.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,6 @@ To set up 2-Step Verification, you will need to install a Time-Based One-Time Pa
6666
1. Scan the QR code displayed on your screen with your TOTP App.
6767
1. After the TOTP App is configured, enter two consecutive authentication codes.
6868

69-
## My Access Keys
70-
71-
In Sumo Logic, you'll need an access key to register new Collectors and use Sumo Logic APIs. If you have a role that grants the **Create Access Keys** capability, you can create and manage your own Access Keys. For more information, see [Access Keys](/docs/manage/security/access-keys).
72-
7369
## My Preferences
7470

7571
Preference settings are only changed for your personal account; they do not affect any other users in your organization. Any changes you make to your preferences take effect the next time you sign in, not during the current session.

docs/get-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Let's get started!
4444
<div className="box smallbox card">
4545
<div className="container">
4646
<a href="/docs/get-started/account-settings-preferences"><img src={useBaseUrl('img/icons/business/user-permissions.png')} alt="icon" width="40"/><h4>Account Preferences</h4></a>
47-
<p>Account settings, access keys, and credentials.</p>
47+
<p>Account settings and credentials.</p>
4848
</div>
4949
</div>
5050
<div className="box smallbox card">

docs/get-started/sumo-logic-ui-classic.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,6 @@ To manage your personal Sumo Logic account preferences, do the following:
208208
1. In the Preferences page that appears on the right, you can modify settings in the following areas:
209209
* **My Profile**: username and password
210210
* **My Security Settings**: enable and disable 2-step verification
211-
* **My Access Keys**: add, edit, and remove access keys
212211
* **My Preferences**: your account session settings
213212

214213
For more information, see the [Preferences Page](account-settings-preferences.md).

docs/get-started/sumo-logic-ui.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,6 @@ To manage your personal Sumo account preferences:
128128
1. From the top nav bar, click the person icon, and then from the dropdown, select **Preferences**.<br/><img src={useBaseUrl('img/get-started/acct-pref.png')} alt="Account Preferences" width="300"/>
129129
1. In the Preferences page, you can modify the following settings:
130130
* **My Profile**. Username and password.
131-
* **My Access Keys**. Add, edit, and remove access keys.
132131
* **My Preferences**. Your account session settings.
133132

134133
For more information, see [Account Preferences and Credentials](account-settings-preferences.md).

docs/integrations/amazon-aws/global-intelligence-guardduty.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ These tasks require the Manage Collectors and Manage Access Keys [role capabilit
155155

156156
In this step, you need to generate access key and access ID from the Sumo Logic console. To generate an access key and access ID, do the following:
157157

158-
1. Follow the instructions as described in this [Sumo Logic Access Key](/docs/manage/security/access-keys#create-an-access-key)) document.
158+
1. Follow the instructions as described in [Access Keys](/docs/manage/security/access-keys).
159159
2. Copy down both the values as you’ll need them to deploy the Sumo Logic GuardDuty Benchmark SAM App.
160160

161161

docs/integrations/amazon-aws/guardduty-benchmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This section shows you how to generate an access key and access ID for log colle
5454
In this step, you need to generate access key and access ID from the Sumo Logic console.
5555

5656
To generate an access key and access ID, do the following:
57-
1. Follow the instructions as described in this [Sumo Logic Access Key](/docs/manage/security/access-keys#create-an-access-key)) document.
57+
1. Follow the instructions as described in [Access Keys](/docs/manage/security/access-keys#create-an-access-key).
5858
2. Copy down both the values as you’ll need them to deploy the Sumo Logic GuardDuty Benchmark SAM App.
5959

6060

0 commit comments

Comments
 (0)