Log API Credentials

Table of Contents

Overview

Create a Credential

Step 1 - Console Login and Navigation to Log API Config

Step 2 - New Credential Form

Step 3 - Securely Store Your Credential

Manage Credentials

Overview

The Cirrus Log API is a REST-based API that retrieves event logs which can be imported into an enterprise log management system, such as a Security Event and Incident Management (SIEM) tool. To enable Log API, you will need to purchase the Add-On service. Once that has been enabled, you have the ability to create and manage credentials yourself within the Cirrus Console.

Create a Credential

Step 1 - Console Login and Navigation to Log API Config

Login to the Cirrus Console by clicking the “Cirrus Console” button from the Cirrus Identity website top navigation bar. Once logged in, select your organization from the list under “My Organizations”.

In the left navigation bar, select the “Cirrus API Access” menu item.

Depending on your subscription, you may see more than one API listed. Select the "Log API" option.

Step 2 - New Credential Form

The next screen will display a list of credentials that have been created for your organization. Click the “New Credential” button.

The form will ask for a brief description of the credential. This description will appear in the list after creation so that you and other users at your organization can identify the credential. If you are creating credentials for a specific purpose, i.e. testing or integration to SIEM, then it can be useful to include that information in the description for future identification.

Once the description has been entered, click the “Create” button.  

Step 3 - Securely Store Your Credential

Once your credential has been created, you will see the details for the credential. Please store these values in a password manager or secret store designated by your organization's secret management standards. Once you have done this, click "OK".

That’s it, you can now use your credential to access Log API. Details on how to use can be found at Cirrus Identity Log API.

Manage Credentials

After creation, you are no longer able to access the password for your credential. The username, description, and other details are accessible in the list to identify active credentials and remove them. If you lose the password for any reason, you will need to delete the credential and create a new one.

© Copyright Cirrus Identity, Inc.