Skip to content

Latest commit

 

History

History
120 lines (87 loc) · 4.5 KB

jupiterone.md

File metadata and controls

120 lines (87 loc) · 4.5 KB
Raw

Integration with JupiterOne

{{provider}} + JupiterOne Integration Benefits

TODO: Iterate the benefits of ingesting data from the provider into JupiterOne. Consider the following examples:

  • Visualize {{provider}} services, teams, and users in the JupiterOne graph.
  • Map {{provider}} users to employees in your JupiterOne account.
  • Monitor changes to {{provider}} users using JupiterOne alerts.

How it Works

TODO: Iterate significant activities the integration enables. Consider the following examples:

  • JupiterOne periodically fetches services, teams, and users from {{provider}} to update the graph.
  • Write JupiterOne queries to review and monitor updates to the graph, or leverage existing queries.
  • Configure alerts to take action when JupiterOne graph changes, or leverage existing alerts.

Requirements

TODO: Iterate requirements for setting up the integration. Consider the following examples:

  • {{provider}} supports the OAuth2 Client Credential flow. You must have a Administrator user account.
  • JupiterOne requires a REST API key. You need permission to create a user in {{provider}} that will be used to obtain the API key.
  • You must have permission in JupiterOne to install new integrations.

Support

If you need help with this integration, please contact JupiterOne Support.

Integration Walkthrough

In {{provider}}

TODO: List specific actions that must be taken in the provider. Remove this section when there are no actions to take in the provider.

  1. Generate a REST API key

In JupiterOne

TODO: List specific actions that must be taken in JupiterOne. Many of the following steps will be reusable; take care to be sure they remain accurate.

  1. From the configuration Gear Icon, select Integrations.
  2. Scroll to the {{provider}} integration tile and click it.
  3. Click the Add Configuration button and configure the following settings:
  • Enter the Account Name by which you'd like to identify this {{provider}} account in JupiterOne. Ingested entities will have this value stored in tag.AccountName when Tag with Account Name is checked.
  • Enter a Description that will further assist your team when identifying the integration instance.
  • Select a Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as DISABLED and manually execute the integration.
  • {{additional provider-specific settings}} Enter the {{provider}} API Key generated for use by JupiterOne.
  1. Click Create Configuration once all values are provided.

How to Uninstall

TODO: List specific actions that must be taken to uninstall the integration. Many of the following steps will be reusable; take care to be sure they remain accurate.

  1. From the configuration Gear Icon, select Integrations.
  2. Scroll to the {{provider}} integration tile and click it.
  3. Identify and click the integration to delete.
  4. Click the trash can icon.
  5. Click the Remove button to delete the integration.

Data Model

Entities

The following entities are created:

Resources Entity _type Entity _class
Account acme_account Account
User acme_user User
UserGroup acme_group UserGroup

Relationships

The following relationships are created:

Source Entity _type Relationship _class Target Entity _type
acme_account HAS acme_group
acme_account HAS acme_user
acme_group HAS acme_user