Skip to main content

Manage IAM keys

AI summary
Explains how to use IAM keys to authenticate external systems with Imply Lumi for event operations. Use the Manager role to create keys and add integrations to them. You can reuse keys across integrations and manage them through the Keys page.

About AI summaries.

In Imply Lumi, an IAM key provides the central point of access for sending and searching events. This topic guides you through creating and managing IAM keys.

Prerequisites

To create and manage IAM keys, you need access to Lumi with the Manager or higher role. For more information on roles, see Manage roles.

Create an IAM key

You can create an IAM key from the Keys page or while configuring an integration on the Integrations page. Select a tab to view instructions for that approach.

To create an IAM key from the Keys page:

  1. From the Lumi navigation menu, click Keys.
  2. Click + Create key.
  3. Enter IAM key details:
    • Name: Name of the IAM key.
    • Description: Optional description for the IAM key.
    • Global attributes: Optional values for the environment and team.
      These create system attributes on incoming events when you use an ingestion integration.
  4. Click Create. The key is inactive until you add an integration.
  5. Click + Add integration, and select an integration to use with the key. Add integration
  6. Configure any IAM key attributes supported by the integration.
  7. Click Save.

View an IAM key

Access the Keys page from the Lumi navigation menu to view IAM keys.

View all keys

The Keys page shows the following details for an IAM key:

  • Key name and ID
  • Integrations added to the key
  • When the key was created and last active
  • Ingestion metrics for events with timestamps from the past 24 hours
  • Unparsable events, if any occurred

Click the information icon next to a key to view its description and token. You can use the search bar to filter keys by name, integration type, or IAM key ID.

View IAM keys

View key details and metrics

Select an IAM key to view its details. The Integrations pane shows activity from the IAM key for each receiver. Hover over a bar to see usage during that hour. The metrics shown depends on the integration type:

  • For application integrations, a green bar indicates the number of searches run in that hour.
  • For ingestion integrations, the color of the bar indicates the event status, where green sums the number of successful events and yellow sums the number of unparsable events.

View IAM key details

Update an IAM key

info

The changes you make to the IAM key or its properties can affect your access to add and query events.

To update an IAM key:

  1. From the Lumi navigation menu, click Keys and select your key.
  2. Make the desired changes:
    • To update the global attributes, click the edit icon in Global attributes.
    • To update the description, click the edit icon in Description.
    • To add a new integration, click Add integration and make your selection.
    • To remove an integration, click the ellipsis for the integration, then select Remove.
    • To update the attributes for an integration, click the ellipsis for the integration, then select Edit attributes.

Edit IAM key details

Delete an IAM key

Deleting an IAM key is a permanent action. It affects all integrations relying on that IAM key for authentication. Before you delete an IAM key, update any related integrations with a new IAM key so the integration can operate without interruprion.

To delete an IAM key:

  1. From the Lumi navigation menu, click Keys.
  2. Click the ellipsis next to the IAM key you want to delete.
  3. Click Delete.
  4. When prompted, type the name of the IAM key you want to delete; then click Delete.

Learn more

For more information, see the following topics: