CircleCI

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

Installation guide

Installation

info

You will need to retrieve your User ID, VSC Username, and API Key in CircleCI for this integration. See their documentation for more information.

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 a configuration requires the following:

• The 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.

• Your CircleCI User ID, VCS Username, and CircleCI API Key.

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.

CircleCI data model

Data Model

Entities

The following entities are created:

Resources	Entity _type	Entity _class
Account	circleci_account	Account
Context	circleci_context	Configuration
Context Environment Variable	circleci_context_environment_variable	Configuration
Pipeline	circleci_pipeline	Configuration
Pipeline Workflow	circleci_workflow	Configuration
Project	circleci_project	Repository
Project Environment Variable	circleci_project_environment_variable	Configuration
User	circleci_user	User
UserGroup	circleci_user_group	Group
Workflow Job	circleci_job	Task

Relationships

The following relationships are created:

Source Entity _type	Relationship _class	Target Entity _type
circleci_account	HAS	circleci_user
circleci_account	HAS	circleci_user_group
circleci_context	HAS	circleci_context_environment_variable
circleci_pipeline	HAS	circleci_workflow
circleci_project	USES	circleci_context_environment_variable
circleci_project	HAS	circleci_pipeline
circleci_project	HAS	circleci_project_environment_variable
circleci_user_group	HAS	circleci_project
circleci_user_group	HAS	circleci_user
circleci_workflow	HAS	circleci_job