Axonius-api-client

API Library

Query Wizard Fixes

- fixed error when using is_ipv4 and is_ipv6 operators, i.e.

simple public_ips is_ipv4
simple public_ips is_ipv6


Query Wizard Enhancements

- Added support for specifying data scopes, i.e.:

simple data_scope equals Name Of Data Scope
simple data_scope equals UUID_OF_DATA_SCOPE


- Saved query supports using name or UUID, i.e.

simple sq equals Name Of Saved Query
simple sq equals UUID_OF_SQ


- Adapter name supports using short internal name, full internal name, or title, ie.e:

short internal name
simple adapters equals aws
full internal name
simple adapters equals aws_adapter
title
simple adapters equals tanium asset


- reworked custom enums into callbacks
- added better caching controls

What's Changed
* bonzai by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/189
* 4.30.2 by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/190


**Full Changelog**: https://github.com/Axonius/axonius_api_client/compare/4.30.1...4.30.2

AXONSHELL

AXONSHELL enhancements

- NEW COMMAND GROUP:
- `axonshell system data-scopes` - work with data scopes, commands:
- `axonshell system data-scopes create` - Create a data scope.
- `axonshell system data-scopes delete` - Delete a data scope.
- `axonshell system data-scopes get` - Get data scopes.
- `axonshell system data-scopes update-description` - Update the description of a data scope.
- `axonshell system data-scopes update-device-scopes` - Update the device asset scopes of a data scope.
- `axonshell system data-scopes update-name` - Update the name of a data scope.
- `axonshell system data-scopes update-user-scopes` - Update the user asset scopes of a data scope.

- NEW ARGUMENTS:
- For command `axonshell system roles add`:
- `--data-scope/-ds` - Specify a data scope to associate with the role

- NEW COMMANDS:
- For command group `axonshell system roles`:
- `axonshell system roles update-data-scope` - Update a roles data scope.
- `axonshell system roles get-perms` - Get a print out of all role permission categories and actions.

- MODIFIED ARGUMENTS:
- For all commands in command group `axonshell system roles`:
- `--export-format/-xf`:
- Now supports `str-args`
- `str` format changed, to get the old str format use `str-args`
- Default format is now `table`
- Added more metadata to output

API Library

API Library Enhancements
- `client.data_scopes` - new api model for working with data scopes
- `client.data_scopes.get` - get data scopes
- `client.data_scopes.get_safe` - get data scopes (will not error if data scope feature not enabled)
- `client.data_scopes.build_role_data_scope` - build a data scope restriction for use in a system role
- `client.data_scopes.create` - create a data scope
- `client.data_scopes.delete` - delete a data scope
- `client.data_scopes.update_name` - update the name of a data scope
- `client.data_scopes.update_description` - update the description of a data scope
- `client.data_scopes.update_user_scopes` - update the user asset scopes of a data scope
- `client.data_scopes.update_device_scopes` - update the device asset scopes of a data scope
- `client.data_scopes.check_feature_enabled` - throw an exception if data scope feature is not enabled
- `client.data_scopes.is_feature_enabled` - check if data scope feature is enabled
- `client.data_scopes.check_exists` - check if a data scope already exists with a name
- `client.data_scopes.get_asset_scopes` - get all saved query's that are asset scopes for users and devices
- `client.data_scopes._get` - private direct API method to get data scopes
- `client.data_scopes._delete` - private direct API method to delete a data scope
- `client.data_scopes._create` - private direct API method to create a data scope
- `client.data_scopes._update` - private direct API method to update a data scope
- `client.data_scopes._update_from_model` - private direct API method to update a data scope

- `client.system_roles` - new methods:
- `client.system_roles.update_data_scope` - Update the data scope for a role

- `client.system_roles.add` - new arguments:
- `data_scope` optional string with name or UUID of data scope for the role

What's Changed
* 4.30.1 by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/188


**Full Changelog**: https://github.com/Axonius/axonius_api_client/compare/4.30.0...4.30.1

AXONSHELL

AXONSHELL enhancements

- NEW COMMAND GROUP: axonshell enforcements - work with enforcement center
- `axonshell enforcements copy` - Copy an Enforcement Set.
- `axonshell enforcements create` - Create an Enforcement Set.
- `axonshell enforcements delete` - Delete an Enforcement Set.
- `axonshell enforcements get` - Get Enforcement Sets.
- `axonshell enforcements get-action-types` - Get Action Types.
- `axonshell enforcements update-action-add` - Add an action to a set.
- `axonshell enforcements update-action-main` - Update the main action of a set.
- `axonshell enforcements update-action-remove` - Remove an action from a set.
- `axonshell enforcements update-name` - Update the name of a set.
- `axonshell enforcements update-on-count-above` - Update only run when asset count is above N.
- `axonshell enforcements update-on-count-below` - Update only run when asset count is below N.
- `axonshell enforcements update-on-count-decreased` - Update only run when asset count decreases.
- `axonshell enforcements update-on-count-increased` - Update only run when asset count increases.
- `axonshell enforcements update-only-new-assets` - Update only run against new assets.
- `axonshell enforcements update-query` - Update the query of a set.
- `axonshell enforcements update-query-remove` - Remove the query from a set.
- `axonshell enforcements update-schedule-daily` - Update a set to run daily.
- `axonshell enforcements update-schedule-discovery` - Update a set to run on discovery.
- `axonshell enforcements update-schedule-hourly` - Update a set to run hourly.
- `axonshell enforcements update-schedule-monthly` - Update a set to run monthly.
- `axonshell enforcements update-schedule-never` - Update a set to never run.
- `axonshell enforcements update-schedule-weekly` - Update a set to run weekly.


API Library

API Library Enhancements
- client.enforcements: reworked completely, methods:
- `client.enforcements.attach_full_set()` - get the full details of an enforcement set and attach the basic details
- `client.enforcements.check_set_exists` - check if an enforcement set exists with the given name
- `client.enforcements.copy` - duplicate an enforcement set
- `client.enforcements.create` - create an enforcement set
- `client.enforcements.delete` - delete an enforcement set
- `client.enforcements.get_action_type` - get a single action type
- `client.enforcements.get_action_types` - get all action types
- `client.enforcements.get_set` - get a single enforcement set
- `client.enforcements.get_set_action` - create an action object for inclusion in an enforcement set
- `client.enforcements.get_sets` - get all enforcement sets
- `client.enforcements.get_sets_generator` - get all enforcement sets using a generator
- `client.enforcements.get_trigger_view` - get the associated saved query name and type for inclusion in an enforcement set
- `client.enforcements.update_action_add` - add an action to an action category (post, sucesss, failure) for an enforcement set
- `client.enforcements.update_action_main` - update the main action of an enforcement set
- `client.enforcements.update_action_remove` - remove an action from an action category (post, sucesss, failure) for an enforcement set
- `client.enforcements.update_from_model` - update an enforcement set
- `client.enforcements.update_name` - update the name of an enforcement set
- `client.enforcements.update_on_count_above` - update the on_count_above condition for an enforcement set
- `client.enforcements.update_on_count_below` - update the on_count_below condition for an enforcement set
- `client.enforcements.update_on_count_decreased` - update the on_count_decreased condition for an enforcement set
- `client.enforcements.update_on_count_increased` - update the on_count_increased condition for an enforcement set
- `client.enforcements.update_only_new_assets` - update the only_new_assets condition for an enforcement set
- `client.enforcements.update_query` - update the saved query name and type for an enforcement set
- `client.enforcements.update_query_remove` - remove the saved query trigger from an enforcement set
- `client.enforcements.update_schedule_daily` - change the schedule to run daily for an enforcement set
- `client.enforcements.update_schedule_discovery` - change the schedule to run every discovery for an enforcement set
- `client.enforcements.update_schedule_hourly` - change the schedule to run hourly for an enforcement set
- `client.enforcements.update_schedule_monthly` - change the schedule to run monthly for an enforcement set
- `client.enforcements.update_schedule_never` - change the schedule to never run for an enforcement set
- `client.enforcements.update_schedule_weekly` - change the schedule to run weekly for an enforcement set
- `client.enforcements._copy` - private method to copy an enforcement set
- `client.enforcements._create` - private method to create an enforcement set
- `client.enforcements._delete` - private method to delete an enforcement set
- `client.enforcements._get_action_types` - private method to get action types
- `client.enforcements._get_set` - private method to get an enforcement set by UUID
- `client.enforcements._get_sets` - private method to get all enforcement sets
- `client.enforcements._triggers_map` - map of trigger query types to api objects
- `client.enforcements._update` - private method to update an enforcement set

- client.instances: new methods:
- `client.instances.api_version - get the current API version of the REST API
- `client.instances.api_versions - get all available API versions of the REST API
- `client.instances._get_api_version` - private method to get current API version of the REST API
- `client.instances._get_api_versions`- private method to get all available versions of the REST API

What's Changed
* backmerge by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/180
* windows does not support : in filename by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/181
* Bugfix/assets export csv/empty column names by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/183
* 4.30.0 by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/185


**Full Changelog**: https://github.com/Axonius/axonius_api_client/compare/4.20.3...4.30.0

AXONSHELL

AXONSHELL bugfixes

- axonshell devices/users get
- empty column headers for --export-format csv

AXONSHELL

AXONSHELL bugfixes

- axonshell devices/users get
- Fixed support for templating in --export-path and --export-file, windows does not support ':' in filename

What's Changed
* windows does not support : in filename by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/181
* 4.20.4 by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/182


**Full Changelog**: https://github.com/Axonius/axonius_api_client/compare/4.20.3...4.20.4

AXONSHELL

AXONSHELL enhancments

- axonshell devices/users get
- Added support for templating in --export-path and --export-file, templates supported:
- **{DATE}** - will be replaced with current datetime stamp in UTC format
- **{HISTORY_DATE}** - will be replaced with date of history snapshot chosen or current datetime stamp in UTC format

What's Changed
* Feature/asset export file templating by lifehackjim in https://github.com/Axonius/axonius_api_client/pull/179


**Full Changelog**: https://github.com/Axonius/axonius_api_client/compare/4.20.2...4.20.3