Skip to main content

CircleCI

Visualize CircleCI users, user groups, pipelines, and projects, map CircleCI users to employees, and monitor changes through queries and alerts.

Installation​

info

You will need your CircleCI User ID, VCS username, and a Personal API Token to configure this integration. Find your User ID and create a token in CircleCI under User Settings > Account Integrations and User Settings > Personal API Tokens. See Managing API Tokens for details.

Required Permissions in CircleCI​

The API Key must have read-only access to the following resources:

  • User Information (/api/v2/me) - to retrieve user and collaboration details
  • Pipelines (/api/v2/pipeline) - to retrieve pipeline configurations and executions
  • Workflows (/api/v2/pipeline/{id}/workflow) - to retrieve workflow details
  • Jobs (/api/v2/workflow/{id}/job) - to retrieve job executions
  • Projects (/api/v2/project/{project_slug}) - to retrieve project configurations
  • Environment Variables (/api/v2/project/{project_slug}/envvar) - to list project environment variable names (values are not exposed)
  • Contexts (/api/v2/context) - to retrieve context configurations
  • Context Environment Variables (/api/v2/context/{id}/environment-variable) - to list context variable names
  • Context Restrictions (/api/v2/context/{id}/restrictions) - to retrieve context access restrictions

The integration uses the CircleCI v2 API with token-based authentication and requires no write or modification permissions.

Configuration in JupiterOne​

To install the CircleCI integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select CircleCI. Click New Instance to begin configuring your integration.

Creating an instance requires the following:

  • Account Name used to identify the CircleCI account in JupiterOne. Ingested entities will have this value stored in tag.AccountName when the AccountName toggle is enabled.

  • Description to assist in identifying the integration instance, if desired.

  • Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as DISABLED and manually execute the integration.

  • User ID — your CircleCI user ID. Find this under User Settings > Account Integrations in the CircleCI web app.

  • VCS username — your version control system username (for example, your GitHub or Bitbucket username).

  • API Key — a CircleCI Personal API Token. Generate one in the CircleCI web app under User Settings > Personal API Tokens.

Click Create once all values are provided to finalize the integration.

Next steps​

Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.