Snipe-IT
Visualizes Snipe-IT information, map Snipe-IT users to hardware, and monitors changes through queries and alerts.
- Installation
- Data Model
- Types
Installation
You will need to create a read-access Snipe-IT API key for this integration. See their documentation for more information on obtaining your key for use with JupiterOne.
Configuration in JupiterOne
To install the Snipe-IT integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Snipe-IT. Click New Instance to begin configuring your integration.
Creating an instance requires the following:
-
The Account Name used to identify the Snipe-IT account in JupiterOne. Ingested entities will have this value stored in
tag.AccountNamewhen theAccountNametoggle 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
DISABLEDand manually execute the integration. -
Your Snipe-IT Hostname and API Token (configured for read access).
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.
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | snipeit_account | Account |
| Consumable | snipeit_consumable_resource | Resource |
| Hardware | snipeit_hardware | Device |
| License | snipeit_licensed_application | Application |
| Location | snipeit_location | Site |
| Service | snipeit_service | Service |
| User | snipeit_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
snipeit_account | PROVIDES | snipeit_service |
snipeit_account | MANAGES | snipeit_location |
snipeit_account | MANAGES | snipeit_hardware |
snipeit_account | HAS | snipeit_consumable_resource |
snipeit_account | HAS | snipeit_licensed_application |
snipeit_account | HAS | snipeit_user |
snipeit_hardware | INSTALLED | snipeit_licensed_application |
snipeit_user | HAS | snipeit_hardware |
snipeit_user | USES | snipeit_consumable_resource |
Mapped Relationships
The following mapped relationships are created:
Source Entity _type | Relationship _class | Target Entity _type | Direction |
|---|---|---|---|
snipeit_location | HAS | snipeit_hardware | FORWARD |
snipeit_user | IS | snipeit_person | FORWARD |
Snipeit Account
snipeit_account inherits from Account
| Property | Type | Description | Specifications |
|---|---|---|---|
description | string | ||
displayName * | string | ||
name * | string | ||
vendor * | string |
Snipeit Consumable Resource
snipeit_consumable_resource inherits from Resource
| Property | Type | Description | Specifications |
|---|---|---|---|
availableActions.checkin | boolean | Please use isCheckinActionAvailable instead. | deprecated: true |
availableActions.checkout | boolean | Please use isCheckoutActionAvailable instead. | deprecated: true |
availableActions.delete | boolean | Please use isDeleteActionAvailable instead. | deprecated: true |
availableActions.update | boolean | Please use isUpdateActionAvailable instead. | deprecated: true |
category.id | number | Please use categoryId instead. | deprecated: true |
category.name | string | Please use categoryName instead. | deprecated: true |
categoryId | number | ||
categoryName | string | ||
company.id | number | Please use companyId instead. | deprecated: true |
company.name | string | Please use companyName instead. | deprecated: true |
companyId | number | ||
companyName | string | ||
consumableId * | number | ||
image | string | null | ||
isCheckinActionAvailable | boolean | ||
isCheckoutActionAvailable | boolean | ||
isDeleteActionAvailable | boolean | ||
isUpdateActionAvailable | boolean | ||
isUserAbleToCheckout | boolean | ||
itemNo | string | ||
location.id | number | Please use locationId instead. | deprecated: true |
location.name | string | Please use locationName instead. | deprecated: true |
locationId | number | ||
locationName | string | ||
manufacturer.id | number | Please use manufacturerId instead. | deprecated: true |
manufacturer.name | string | Please use manufacturerName instead. | deprecated: true |
manufacturerId | number | ||
manufacturerName | string | ||
minAmt | number | ||
modelNumber | string | null | ||
notes | array of strings | ||
orderNumber | string | ||
purchaseCost | string | null | ||
purchaseDate | number | Please use purchasedOn instead. | deprecated: true |
purchasedOn | number | ||
qty | number | ||
remaining | number | ||
userCanCheckout | boolean | Please use isUserAbleToCheckout instead. | deprecated: true |
Snipeit Hardware
snipeit_hardware inherits from Device
| Property | Type | Description | Specifications |
|---|---|---|---|
assignedName | string | ||
assignedType | string | Any of: userassetlocation | |
byod * | boolean | Please use BYOD instead. | deprecated: true |
company | string | null | ||
EOL * | boolean | ||
locationId | number | ||
purchaseCost | string | null | ||
statusMeta * | string | ||
statusName * | string | ||
supplier | string |
Snipeit Licensed Application
snipeit_licensed_application inherits from Application
| Property | Type | Description | Specifications |
|---|---|---|---|
availableActions.checkin | boolean | Please use availableActionsCheckin instead. | deprecated: true |
availableActions.checkout | boolean | Please use availableActionsCheckout instead. | deprecated: true |
availableActions.delete | boolean | Please use availableActionsDelete instead. | deprecated: true |
availableActions.update | boolean | Please use availableActionsUpdate instead. | deprecated: true |
availableActionsCheckin | boolean | ||
availableActionsCheckout | boolean | ||
availableActionsDelete | boolean | ||
availableActionsUpdate | boolean | ||
category.id | number | Please use categoryId instead. | deprecated: true |
category.name | string | Please use categoryName instead. | deprecated: true |
categoryId | number | ||
categoryName | string | ||
company | string | ||
depreciation | string | ||
expirationDate | number | Please use expirationOn instead. | deprecated: true |
expirationOn | number | ||
freeSeatsCount | number | ||
licenseEmail | string | ||
licenseId | number | ||
licenseName | string | ||
maintained | boolean | ||
manufacturer.id | number | Please use manufacturerId instead. | deprecated: true |
manufacturer.name | string | Please use manufacturerName instead. | deprecated: true |
manufacturerId | number | ||
manufacturerName | string | ||
notes | array of strings | ||
orderNumber | string | ||
productKey | string | ||
purchaseCost | string | null | ||
purchaseDate | number | Please use purchasedOn instead. | deprecated: true |
purchasedOn | number | ||
purchaseOrder | string | ||
reassignable | boolean | ||
seats | number | ||
supplier.id | number | Please use supplierId instead. | deprecated: true |
supplier.name | string | Please use supplierName instead. | deprecated: true |
supplierId | number | ||
supplierName | string | ||
terminationDate | number | Please use terminationOn instead. | deprecated: true |
terminationOn | number | ||
userCanCheckout | boolean |
Snipeit Location
snipeit_location inherits from Site
| Property | Type | Description | Specifications |
|---|---|---|---|
address | string | null | ||
address2 | string | null | ||
assetsCount * | number | ||
assignedAssetsCount * | number | ||
city * | string | ||
country * | string | ||
currency | string | null | ||
image | string | null | ||
isCloneActionAvailable | boolean | ||
isDeleteActionAvailable | boolean | ||
isUpdateActionAvailable | boolean | ||
locationId * | number | ||
rtdAssetsCount * | number | ||
state | string | null | ||
usersCount * | number | ||
zip | string | null |
Snipeit Service
snipeit_service inherits from Service
Snipeit User
snipeit_user inherits from User
| Property | Type | Description | Specifications |
|---|---|---|---|
accessoriesCount | number | ||
address | string | null | ||
assetsCount | number | ||
avatar | string | ||
city | string | null | ||
company.id | number | Please use companyId instead. | deprecated: true |
company.name | string | Please use companyName instead. | deprecated: true |
companyId | number | ||
companyName | string | ||
consumablesCount | number | ||
country | string | null | ||
createdBy.id | number | Please use createdById instead. | deprecated: true |
createdBy.name | string | Please use createdByName instead. | deprecated: true |
createdById | number | ||
createdByName | string | ||
deletedAt | number | ||
department.id | number | Please use departmentId instead. | deprecated: true |
department.name | string | Please use departmentName instead. | deprecated: true |
departmentId | number | ||
departmentName | string | ||
employeeNum | string | null | ||
isLdapImport | boolean | ||
jobtitle | string | null | ||
lastLogin | number | ||
ldapImport | boolean | Please use isLdapImport instead. | deprecated: true |
licensesCount | number | ||
locale | string | ||
location.id | number | Please use locationId instead. | deprecated: true |
location.name | string | Please use locationName instead. | deprecated: true |
locationId | number | ||
locationName | string | ||
manager.id | number | Please use managerId instead. | deprecated: true |
manager.name | string | Please use managerName instead. | deprecated: true |
managerId | number | ||
managerName | string | ||
permissions.accessories.checkin | string | ||
permissions.accessories.checkout | string | ||
permissions.accessories.create | string | ||
permissions.accessories.delete | string | ||
permissions.accessories.edit | string | ||
permissions.accessories.view | string | ||
permissions.admin | string | ||
permissions.assets.audit | string | ||
permissions.assets.checkin | string | ||
permissions.assets.checkout | string | ||
permissions.assets.create | string | ||
permissions.assets.delete | string | ||
permissions.assets.edit | string | ||
permissions.assets.view | string | ||
permissions.assets.view.requestable | string | ||
permissions.categories.create | string | ||
permissions.categories.delete | string | ||
permissions.categories.edit | string | ||
permissions.categories.view | string | ||
permissions.companies.create | string | ||
permissions.companies.delete | string | ||
permissions.companies.edit | string | ||
permissions.companies.view | string | ||
permissions.components.checkin | string | ||
permissions.components.checkout | string | ||
permissions.components.create | string | ||
permissions.components.delete | string | ||
permissions.components.edit | string | ||
permissions.components.view | string | ||
permissions.consumables.checkout | string | ||
permissions.consumables.create | string | ||
permissions.consumables.delete | string | ||
permissions.consumables.edit | string | ||
permissions.consumables.view | string | ||
permissions.customfields.create | string | ||
permissions.customfields.delete | string | ||
permissions.customfields.edit | string | ||
permissions.customfields.view | string | ||
permissions.departments.create | string | ||
permissions.departments.delete | string | ||
permissions.departments.edit | string | ||
permissions.departments.view | string | ||
permissions.depreciations.create | string | ||
permissions.depreciations.delete | string | ||
permissions.depreciations.edit | string | ||
permissions.depreciations.view | string | ||
permissions.import | string | ||
permissions.kits.create | string | ||
permissions.kits.delete | string | ||
permissions.kits.edit | string | ||
permissions.kits.view | string | ||
permissions.licenses.checkout | string | ||
permissions.licenses.create | string | ||
permissions.licenses.delete | string | ||
permissions.licenses.edit | string | ||
permissions.licenses.files | string | ||
permissions.licenses.keys | string | ||
permissions.licenses.view | string | ||
permissions.locations.create | string | ||
permissions.locations.delete | string | ||
permissions.locations.edit | string | ||
permissions.locations.view | string | ||
permissions.manufacturers.create | string | ||
permissions.manufacturers.delete | string | ||
permissions.manufacturers.edit | string | ||
permissions.manufacturers.view | string | ||
permissions.models.create | string | ||
permissions.models.delete | string | ||
permissions.models.edit | string | ||
permissions.models.view | string | ||
permissions.reports.view | string | ||
permissions.self.api | string | ||
permissions.self.checkoutAssets | string | ||
permissions.self.editLocation | string | ||
permissions.self.twoFactor | string | ||
permissions.statuslabels.create | string | ||
permissions.statuslabels.delete | string | ||
permissions.statuslabels.edit | string | ||
permissions.statuslabels.view | string | ||
permissions.superuser | string | integer | ||
permissions.suppliers.create | string | ||
permissions.suppliers.delete | string | ||
permissions.suppliers.edit | string | ||
permissions.suppliers.view | string | ||
permissions.users.create | string | ||
permissions.users.delete | string | ||
permissions.users.edit | string | ||
permissions.users.view | string | ||
phone | string | null | ||
remote * | boolean | ||
state | string | null | ||
twoFactorEnrolled * | boolean | ||
userId | number | ||
website | string | null | ||
zip | string | null |