auth0 / jupiterone-python-sdk

A Python client for jupiterone.io
MIT License
10 stars 17 forks source link

Add parameter methods #18

Closed Flipadelphian closed 3 months ago

Flipadelphian commented 11 months ago

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Add methods to JupiterOneClient that enable reading, creating, modifying, and deleting parameters within the JupiterOne tenant as described at https://docs.jupiterone.io/features/admin/parameters#usage-api-operations-and-queries

Parameters can be used in JupiterOne queries by replacing static values with ${param.name_of_parameter}, which JupiterOne provides an example of here.

These parameters can also be used in queries for both Dashboards (for point-in-time statuses) and Questions (for historic lookbacks) based on values that are subject to change. For example, a parameter "latest_OS_version" can be set and changed to show how many devices are up-to-date on OS patches.

References

Resolves https://github.com/auth0/jupiterone-python-sdk/issues/17

Testing

Pytest test cases have been added for each new method.

Checklist

bsmith-auth0 commented 3 months ago

Hi @Flipadelphian ,

We will be archiving this repo in favor of the new official JupiterOne Python SDK. If you are still interested in contributing, please open this PR on the new repo.