Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Add integration benfits #13

Merged
merged 2 commits into from
Apr 9, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 55 additions & 7 deletions docs/jupiterone.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,61 @@
# JupiterOne Managed Integration for Snipe-IT
# Integration with JupiterOne

## Overview
## Snipe-IT + JupiterOne Integration Benefits

JupiterOne provides a managed integration for Snipe-IT. The integration connects
directly to [Snipe-IT REST API][1] to hardware and asset information.
- Visualize Snipe-IT account locations, hardware, and hardware owners in the
JupiterOne graph.
- Map Snipe-IT users to the hardware they have or own.
- Monitor changes to locations, hardware, and hardware owners using using
JupiterOne alerts.

Configure the integration by providing an API Token with read-only permissions.
Obtain an API token from the bottom of the "Manage API Keys" page in your
Snipe-IT account.
## How it Works

- JupiterOne periodically fetches Snipe-IT hardware and owners data to update the graph.
- Write JupiterOne queries to review and monitor updates to the graph.
- Configure alerts to take action when the JupiterOne graph changes.

## Requirements

- JupiterOne requires the hostname of your Snipe-IT account as well as an
API Token configured for read access.
- You must have permission in JupiterOne to install new integrations.

## Support

If you need help with this integration, please contact
[JupiterOne Support](https://support.jupiterone.io).

## Integration Walkthrough

### In Snipe-IT

See the [Snipe-IT API docs](https://snipe-it.readme.io/reference) for information
on how to generate an API token.

### In JupiterOne

1. From the configuration **Gear Icon**, select **Integrations**.
2. Scroll to the **Snipe-IT** 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 Snipe-IT
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.
- Enter the **Hostname** of your Snipe-IT account.
- Enter the **API Token** generated in your Snipe-IT account, configured for
read access.
4. Click **Create Configuration** once all values are provided.

## How to Uninstall

1. From the configuration **Gear Icon**, select **Integrations**.
2. Scroll to the **Snipe-IT** 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.

<!-- {J1_DOCUMENTATION_MARKER_START} -->
<!--
Expand Down