Snipe-IT
Visualizes Snipe-IT information, map Snipe-IT users to hardware, and monitors changes through queries and alerts.
- Installation guide
- Snipe-IT data model
- Snipe-IT 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 a configuration requires the following:
The Account Name used to identify the Snipe-IT account in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when theAccountName
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 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.
Data Model
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 | HAS | snipeit_consumable_resource |
snipeit_account | MANAGES | snipeit_hardware |
snipeit_account | HAS | snipeit_licensed_application |
snipeit_account | MANAGES | snipeit_location |
snipeit_account | PROVIDES | snipeit_service |
snipeit_account | HAS | snipeit_user |
snipeit_hardware | INSTALLED | snipeit_licensed_application |
snipeit_user | USES | snipeit_consumable_resource |
snipeit_user | HAS | snipeit_hardware |
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 |
---|---|---|---|
name * | string | ||
displayName * | string | ||
description | string | ||
vendor * | string |
Snipeit Service
snipeit_service
inherits from Service
Snipeit Location
snipeit_location
inherits from Site
Property | Type | Description | Specifications |
---|---|---|---|
locationId * | number | ||
image | string | null | ||
address | string | null | ||
address2 | string | null | ||
city * | string | ||
state | string | null | ||
country * | string | ||
zip | string | null | ||
assignedAssetsCount * | number | ||
assetsCount * | number | ||
rtdAssetsCount * | number | ||
usersCount * | number | ||
currency | string | null | ||
isUpdateActionAvailable | boolean | ||
isDeleteActionAvailable | boolean | ||
isCloneActionAvailable | boolean |
Snipeit Hardware
snipeit_hardware
inherits from Device
Property | Type | Description | Specifications |
---|---|---|---|
assignedType | string | Any of: user asset location | |
assignedName | string | ||
company | string | null | ||
byod * | boolean | Please use BYOD instead. | deprecated: true |
supplier | string | ||
EOL * | boolean | ||
locationId | number | ||
statusMeta * | string | ||
statusName * | string | ||
purchaseCost | string | null |
Snipeit Consumable Resource
snipeit_consumable_resource
inherits from Resource
Property | Type | Description | Specifications |
---|---|---|---|
consumableId * | number | ||
image | string | null | ||
category.id | number | Please use categoryId instead. | deprecated: true |
categoryId | number | ||
category.name | string | Please use categoryName instead. | deprecated: true |
categoryName | string | ||
company.id | number | Please use companyId instead. | deprecated: true |
companyId | number | ||
company.name | string | Please use companyName instead. | deprecated: true |
companyName | string | ||
itemNo | string | ||
location.id | number | Please use locationId instead. | deprecated: true |
locationId | number | ||
location.name | string | Please use locationName instead. | deprecated: true |
locationName | string | ||
manufacturer.id | number | Please use manufacturerId instead. | deprecated: true |
manufacturerId | number | ||
manufacturer.name | string | Please use manufacturerName instead. | deprecated: true |
manufacturerName | string | ||
minAmt | number | ||
modelNumber | string | null | ||
remaining | number | ||
orderNumber | string | ||
purchaseCost | string | null | ||
purchaseDate | number | Please use purchasedOn instead. | deprecated: true |
purchasedOn | number | ||
qty | number | ||
notes | array of string s | ||
userCanCheckout | boolean | Please use isUserAbleToCheckout instead. | deprecated: true |
isUserAbleToCheckout | boolean | ||
availableActions.checkout | boolean | Please use isCheckoutActionAvailable instead. | deprecated: true |
isCheckoutActionAvailable | boolean | ||
availableActions.checkin | boolean | Please use isCheckinActionAvailable instead. | deprecated: true |
isCheckinActionAvailable | boolean | ||
availableActions.update | boolean | Please use isUpdateActionAvailable instead. | deprecated: true |
isUpdateActionAvailable | boolean | ||
availableActions.delete | boolean | Please use isDeleteActionAvailable instead. | deprecated: true |
isDeleteActionAvailable | boolean |
Snipeit Licensed Application
snipeit_licensed_application
inherits from Application
Property | Type | Description | Specifications |
---|---|---|---|
licenseId | number | ||
company | string | ||
manufacturer.id | number | Please use manufacturerId instead. | deprecated: true |
manufacturerId | number | ||
manufacturer.name | string | Please use manufacturerName instead. | deprecated: true |
manufacturerName | string | ||
productKey | string | ||
orderNumber | string | ||
purchaseOrder | string | ||
purchaseDate | number | Please use purchasedOn instead. | deprecated: true |
purchasedOn | number | ||
terminationDate | number | Please use terminationOn instead. | deprecated: true |
terminationOn | number | ||
depreciation | string | ||
purchaseCost | string | null | ||
notes | array of string s | ||
expirationDate | number | Please use expirationOn instead. | deprecated: true |
expirationOn | number | ||
seats | number | ||
freeSeatsCount | number | ||
licenseName | string | ||
licenseEmail | string | ||
reassignable | boolean | ||
maintained | boolean | ||
supplier.id | number | Please use supplierId instead. | deprecated: true |
supplierId | number | ||
supplier.name | string | Please use supplierName instead. | deprecated: true |
supplierName | string | ||
category.id | number | Please use categoryId instead. | deprecated: true |
categoryId | number | ||
category.name | string | Please use categoryName instead. | deprecated: true |
categoryName | string | ||
userCanCheckout | boolean | ||
availableActions.checkout | boolean | Please use availableActionsCheckout instead. | deprecated: true |
availableActionsCheckout | boolean | ||
availableActions.checkin | boolean | Please use availableActionsCheckin instead. | deprecated: true |
availableActionsCheckin | boolean | ||
availableActions.update | boolean | Please use availableActionsUpdate instead. | deprecated: true |
availableActionsUpdate | boolean | ||
availableActions.delete | boolean | Please use availableActionsDelete instead. | deprecated: true |
availableActionsDelete | boolean |
Snipeit User
snipeit_user
inherits from User
Property | Type | Description | Specifications |
---|---|---|---|
userId | number | ||
avatar | string | ||
remote * | boolean | ||
locale | string | ||
employeeNum | string | null | ||
manager.id | number | Please use managerId instead. | deprecated: true |
managerId | number | ||
manager.name | string | Please use managerName instead. | deprecated: true |
managerName | string | ||
jobtitle | string | null | ||
phone | string | null | ||
website | string | null | ||
address | string | null | ||
city | string | null | ||
state | string | null | ||
country | string | null | ||
zip | string | null | ||
email | string | Format: email | |
department.id | number | Please use departmentId instead. | deprecated: true |
departmentId | number | ||
department.name | string | Please use departmentName instead. | deprecated: true |
departmentName | string | ||
location.id | number | Please use locationId instead. | deprecated: true |
locationId | number | ||
location.name | string | Please use locationName instead. | deprecated: true |
locationName | string | ||
ldapImport | boolean | Please use isLdapImport instead. | deprecated: true |
isLdapImport | boolean | ||
twoFactorEnrolled * | boolean | ||
assetsCount | number | ||
licensesCount | number | ||
accessoriesCount | number | ||
consumablesCount | number | ||
company.id | number | Please use companyId instead. | deprecated: true |
companyId | number | ||
company.name | string | Please use companyName instead. | deprecated: true |
companyName | string | ||
createdBy.id | number | Please use createdById instead. | deprecated: true |
createdById | number | ||
createdBy.name | string | Please use createdByName instead. | deprecated: true |
createdByName | string | ||
lastLogin | number | ||
deletedAt | number |