Skip to content

DOCS-232 - Personal access keys #4589

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

Merged
merged 19 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion blog-service/2023/12-31.md
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,7 @@ We're excited to announce the release of our new cloud-to-cloud source for Trell

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.

To access this feature, log in to your account and navigate to **Administration > Security > Policies**. From there, you can set your preferred policy for deactivation of unused access keys. [Learn more](/docs/manage/security/access-keys#edit-deactivate-or-delete-an-access-key).
To access this feature, log in to your account and navigate to **Administration > Security > Policies**. From there, you can set your preferred policy for deactivation of unused access keys. [Learn more](/docs/manage/security/access-keys#edit-deactivate-or-delete-access-keys).


---
Expand Down
32 changes: 32 additions & 0 deletions blog-service/2024-12-03-manage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Access Keys Enhancements (Manage)
image: https://help.sumologic.com/img/sumo-square.png
keywords:
- access keys
- manage
hide_table_of_contents: true
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<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>

We're excited to announce enhancements to how you create and manage access keys.

### Personal Access Keys

The **My Access Keys** section has been moved out of **Preferences** to its own tab and renamed **Personal Access Keys**.

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

To open the Personal Access Keys tab:
* [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences > Personal Access Keys**.
* [**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**.

### Scopes

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.

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

<img src={useBaseUrl('/img/security/custom-scopes-example.png')} alt="Custom scopes detail" style={{border: '1px solid gray'}} width="500"/>
2 changes: 1 addition & 1 deletion docs/cse/integrations/insight-enrichment-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The following parameters control general server behaviors, as opposed to enrichm
| Setting | Required? | Description |
|:--|:--|:--|
| `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). |
| `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). |
| `api_id` | yes | Enter your Sumo Logic Access ID. For more information, see [Access Keys](/docs/manage/security/access-keys). |
| `api_key` | yes | Enter your Sumo Logic Access Key.|
| `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` |
| `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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Your Cloud SIEM role must allow you to use API keys and to retrieve and modify I

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. 

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).
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).

## Step 2: Install ServiceNow plugins

Expand Down
4 changes: 0 additions & 4 deletions docs/get-started/account-settings-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ To set up 2-Step Verification, you will need to install a Time-Based One-Time Pa
1. Scan the QR code displayed on your screen with your TOTP App.
1. After the TOTP App is configured, enter two consecutive authentication codes.

## My Access Keys

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).

## My Preferences

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Let's get started!
<div className="box smallbox card">
<div className="container">
<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>
<p>Account settings, access keys, and credentials.</p>
<p>Account settings and credentials.</p>
</div>
</div>
<div className="box smallbox card">
Expand Down
1 change: 0 additions & 1 deletion docs/get-started/sumo-logic-ui-classic.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,6 @@ To manage your personal Sumo Logic account preferences, do the following:
1. In the Preferences page that appears on the right, you can modify settings in the following areas:
* **My Profile**: username and password
* **My Security Settings**: enable and disable 2-step verification
* **My Access Keys**: add, edit, and remove access keys
* **My Preferences**: your account session settings

For more information, see the [Preferences Page](account-settings-preferences.md).
Expand Down
1 change: 0 additions & 1 deletion docs/get-started/sumo-logic-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ To manage your personal Sumo account preferences:
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"/>
1. In the Preferences page, you can modify the following settings:
* **My Profile**. Username and password.
* **My Access Keys**. Add, edit, and remove access keys.
* **My Preferences**. Your account session settings.

For more information, see [Account Preferences and Credentials](account-settings-preferences.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ These tasks require the Manage Collectors and Manage Access Keys [role capabilit

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:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/amazon-aws/guardduty-benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This section shows you how to generate an access key and access ID for log colle
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:
1. Follow the instructions as described in this [Sumo Logic Access Key](/docs/manage/security/access-keys#create-an-access-key)) document.
1. Follow the instructions as described in [Access Keys](/docs/manage/security/access-keys#create-an-access-key).
2. Copy down both the values as you’ll need them to deploy the Sumo Logic GuardDuty Benchmark SAM App.


Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/app-development/jfrog-xray.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ When you configure the HTTP source, make sure to save the HTTP Source Address UR

To add a hosted collector and HTTP source:
1. Create a new Sumo Logic hosted collector by performing the steps in [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
2. Create a new HTTP source on the hosted collector created above by following [these instructions](/docs/send-data/hosted-collectors/http-source/logs-metrics).
2. Create a new HTTP source on the hosted collector created above by following instructions in [HTTP Logs and Metrics Source]](/docs/send-data/hosted-collectors/http-source/logs-metrics).


### Step 5: Set up a collection method for JFrog Xray
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/containers-orchestration/activemq.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ The monitors are disabled by default. Once you have installed the alerts using t

### Method 2: Install the alerts using a Terraform script

1. Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these[ instructions](/docs/manage/security/access-keys#from-the-preferences-page). To find out which deployment your Sumo Logic account is in, see [Sumo Logic endpoints](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
1. Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using instructions in [Access Keys](/docs/manage/security/access-keys). To find out which deployment your Sumo Logic account is in, see [Sumo Logic endpoints](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
3. Download the Sumo Logic Terraform package for ActiveMQ alerts: The alerts package is available in the Sumo Logic github[ repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/ActiveMQ). You can either download it through the “git clone” command or as a zip file.
4. Alert Configuration: After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/ActiveMQ/`.
Expand Down Expand Up @@ -555,10 +555,10 @@ Locate and install the app you need from the **App Catalog**. If you want to see
1. From the **App Catalog**, search for and select the app.
2. Select the version of the service you're using and click **Add to Library**.
3. To install the app, complete the following fields.
1. **App Name.** You can retain the existing name, or enter a name of your choice for the app.
1. **App Name.** You can retain the existing name, or enter a name of your choice for the app.
2. **Data Source.** Choose **Enter a Custom Data Filter** and enter a custom ActiveMQ cluster filter. Examples:
* For all ActiveMQ clusters: `messaging_cluster=*`
* For a specific cluster: `messaging_cluster=activemq.dev.01`.
* For a specific cluster: `messaging_cluster=activemq.dev.01`.
* Clusters within a specific environment: `messaging_cluster=activemq-1` and `environment=prod` (This assumes you have set the optional environment tag while configuring collection).
4. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
5. Click **Add to Library**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,8 @@ In collector version 19.216-22 and later, when you configure the sourceCategory
You build templates for sourceCategory and sourceHost specifying component variables in this form: `{{NAMESPACE.VAR_NAME}}`.

Where:
* `NAMESPACE` is a namespace that indicates the variable type.
* `VAR_NAME` is the variable name. These are case-sensitive.
* `NAMESPACE` is a namespace that indicates the variable type.
* `VAR_NAME` is the variable name. These are case-sensitive.

The table below defines the types of variables you can use.

Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/containers-orchestration/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ The monitors are disabled by default. Once you have installed the alerts using t

### Method B: Using a Terraform script

1. Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these[ instructions](/docs/manage/security/access-keys#from-the-preferences-page). Identify which deployment your Sumo Logic account is in using [this link](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
1. Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using instructions in [Access Keys](/docs/manage/security/access-keys). Identify which deployment your Sumo Logic account is in using [this link](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
3. Download the Sumo Logic Terraform package for Kafka alerts. The alerts package is available in the Sumo Logic [GitHub repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/Kafka). You can either download it through the “git clone” command or as a zip file.
4. Alert Configuration. After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/Kafka`.
Expand Down Expand Up @@ -489,10 +489,10 @@ Locate and install the app you need from the **App Catalog**. If you want to see
Version selection is not available for all apps.
:::
3. To install the app, complete the following fields.
* **App Name.** You can retain the existing name, or enter a name of your choice for the app.
* **App Name.** You can retain the existing name, or enter a name of your choice for the app.
* **Data Source.** Choose **Enter a Custom Data Filter**, and enter a custom Kafka cluster filter. Examples:
* For all Kafka clusters `messaging_cluster=*`
* For a specific cluster: `messaging_cluster=Kafka.dev.01`.
* For a specific cluster: `messaging_cluster=Kafka.dev.01`.
* Clusters within a specific environment: `messaging_cluster=Kafka-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection.
4. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
5. Click **Add to Library**.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/containers-orchestration/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The monitors are disabled by default. Once you have installed the alerts using t

### Method B: Using a Terraform script

1. Generate a Sumo Logic access key and ID for a user that has the **Manage Monitors** role capability in Sumo Logic using [these instructions](/docs/manage/security/access-keys). There, you'll need to identify which deployment your Sumo Logic account is in ([learn more](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security)).
1. Generate a Sumo Logic access key and ID for a user that has the **Manage Monitors** role capability in Sumo Logic using instructions in [Access Keys](/docs/manage/security/access-keys). There, you'll need to identify which deployment your Sumo Logic account is in ([learn more](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security)).
1. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
1. Download the Sumo Logic Terraform package for Kubernetes alerts. The alerts package is available in the [Sumo Logic GitHub repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/kubernetes). You can either download it through the `git clone` command or as a zip file.
1. **Alert Configuration**. After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/kubernetes/`.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/containers-orchestration/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ There are limits to how many alerts can be enabled. For more information, see [M

#### Method B: Install Monitors using a Terraform script

1. Generate an access key and access ID for a user that has the **Manage Monitors** role capability. For instructions see [Access Keys](/docs/manage/security/access-keys#from-the-preferences-page).
1. Generate an access key and access ID for a user that has the **Manage Monitors** role capability. For instructions see [Access Keys](/docs/manage/security/access-keys).
2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later, and install it.
3. Download the Sumo Logic Terraform package for MySQL monitors: The alerts package is available in the Sumo Logic GitHub [repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/mysql). You can either download it using the git clone command or as a zip file.
4. Alert Configuration: After extracting the package, navigate to the terraform-sumologic-sumo-logic-monitor/monitor_packages/RabbitMQ/ directory.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/databases/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ There are limits to how many alerts can be enabled. For more information, see [M

### Method B: Using a Terraform script

1. Generate an access key and access ID for a user that has the **Manage Monitors** role capability. For instructions, see [Access Keys](/docs/manage/security/access-keys#from-the-preferences-page).
1. Generate an access key and access ID for a user that has the **Manage Monitors** role capability. For instructions, see [Access Keys](/docs/manage/security/access-keys).
2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later and install it.
3. Download the Sumo Logic Terraform package for Cassandra monitors. The alerts package is available in the Sumo Logic GitHub [repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/Memcached). You can either download it using the git clone command or as a zip file.
4. Alert Configuration. After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/` directory.
Expand Down
Loading
Loading