4.4.2. User assets

API for working with user assets.

class axonius_api_client.api.assets.users.Users(auth, **kwargs)[source]

Bases: axonius_api_client.api.assets.asset_mixin.AssetMixin

API for working with user assets.

Examples

For all examples for this asset type, create a client using axonius_api_client.connect.Connect and assume apiobj is client.users

>>> apiobj = client.users
Parameters

auth (axonius_api_client.auth.models.Model) –

ASSET_TYPE: str = 'users'
property fields_default: List[str]

Fields to use by default for getting assets.

Return type

typing.List[str]

get_by_usernames(values, **kwargs)[source]

Build a query to get assets where FIELD_USERNAME in values.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_username_regex(value, **kwargs)[source]

Build a query to get assets where FIELD_USERNAME regex matches value.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_username(value, **kwargs)[source]

Build a query to get assets where FIELD_USERNAME == value.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_mails(values, **kwargs)[source]

Build a query to get assets where FIELD_MAIL in values.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_mail_regex(value, **kwargs)[source]

Build a query to get assets where FIELD_MAIL regex matches value.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_mail(value, **kwargs)[source]

Build a query to get assets where FIELD_MAIL == value.

Parameters
Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

FIELD_USERNAME: str = 'specific_data.data.username'

User Name field.

FIELD_MAIL: str = 'specific_data.data.mail'

Mail field.

FIELD_DOMAIN: str = 'specific_data.data.domain'

Domain field.

FIELD_IS_ADMIN: str = 'specific_data.data.is_admin'

Is Admin field.

FIELD_MAIN: str = 'specific_data.data.username'

Field name of the main identifier.

FIELDS_API: List[str] = ['internal_axon_id', 'adapters', 'labels', 'adapter_list_length']

Field names that are always returned by the REST API no matter what fields are selected

FIELD_ADAPTERS: str = 'adapters'

Field name for list of adapters on an asset.

FIELD_ADAPTER_LEN: str = 'adapter_list_length'

Field name for count of adapters on an asset.

FIELD_AXON_ID: str = 'internal_axon_id'

Field name for asset unique ID.

FIELD_LAST_SEEN: str = 'specific_data.data.last_seen'

Field name for last time an adapter saw the asset.

FIELD_SIMPLE: str = 'specific_data.data.username'

Field name of a simple field.

FIELD_TAGS: str = 'labels'

Field name for getting tabs (labels).

__init__(auth, **kwargs)

Mixins for API Models.

Parameters
__repr__()

Show info for this model object.

Return type

str

__str__()

Show info for this model object.

Return type

str

_build_query(inner, not_flag=False, pre='', post='')

Query builder with basic functionality.

Notes

It is better to use wizard, wizard_text, or wizard_csv to build queries!

Parameters
  • inner (str) – inner query portion to wrap in parens and prefix with not

  • not_flag (bool) – prefix query with ‘not’

  • pre (str) – query to add to the beginning of the query

  • post (str) – query to add to the end of the query

Return type

str

_count(filter=None, history=None, use_cache_entry=False)

Private API method to get the count of assets.

Parameters
  • filter (typing.Optional[str]) – if supplied, only return the count of assets that match the query

  • history (typing.Optional[str]) – return count for a given historical date

  • use_cache_entry (bool) –

Return type

axonius_api_client.api.json_api.assets.Count

_destroy(destroy, history)

Private API method to destroy ALL assets.

Parameters
  • destroy (bool) – Must be true in order to actually perform the delete

  • history (bool) – Also delete all historical information

Return type

dict

_get(always_cached_query=False, use_cache_entry=False, include_details=False, include_notes=False, get_metadata=True, use_cursor=True, sort_descending=False, history=None, filter=None, cursor_id=None, sort=None, excluded_adapters=None, field_filters=None, fields=None, offset=0, limit=2000)

Private API method to get a page of assets.

Parameters
  • query – if supplied, only return the assets that match the query

  • fields (typing.Optional[dict]) – CSV or list of fields to include in return

  • row_start – start at row N

  • page_size – fetch N assets

  • include_details (bool) – include details fields showing the adapter source of agg values

  • sort_field – sort the returned assets on a given field

  • sort_descending (bool) – reverse the sort of the returned assets

  • history_date – return assets for a given historical date

  • cursor – cursor returned by previous call to continue paging through

  • always_cached_query (bool) –

  • use_cache_entry (bool) –

  • include_notes (bool) –

  • get_metadata (bool) –

  • use_cursor (bool) –

  • history (typing.Optional[str]) –

  • filter (typing.Optional[str]) –

  • cursor_id (typing.Optional[str]) –

  • sort (typing.Optional[str]) –

  • excluded_adapters (typing.Optional[dict]) –

  • field_filters (typing.Optional[dict]) –

  • offset (int) –

  • limit (int) –

Return type

axonius_api_client.api.json_api.assets.AssetsPage

_get_by_id(id)

Private API method to get the full metadata of all adapters for a single asset.

Parameters

id (str) – asset to get all metadata for

Return type

axonius_api_client.api.json_api.assets.AssetById

_handle_wiz_entries(wiz_entries=None)

Pass.

Parameters

wiz_entries (typing.Union[typing.List[dict], typing.List[str], dict, str, None]) –

Return type

typing.Optional[dict]

_history_dates()

Private API method to get all known historical dates.

Return type

axonius_api_client.api.json_api.generic.DictValue

_init(**kwargs)

Post init method for subclasses to use for extra setup.

count(query=None, history_date=None, wiz_entries=None)

Get the count of assets from a query.

Examples

Get count of all assets

>>> count = apiobj.count()

Get count of all assets for a given date

>>> count = apiobj.count(history_date="2020-09-29")

Get count of assets matching a query built by the GUI query wizard

>>> query='(specific_data.data.name == "test")'
>>> count = apiobj.count(query=query)

Get count of assets matching a query built by the API client query wizard

>>> entries = [{'type': 'simple', 'value': 'name equals test'}]
>>> count = apiobj.count(wiz_entries=entries)
Parameters
Return type

int

count_by_saved_query(name, history_date=None)

Get the count of assets for a query defined in a saved query.

Examples

Get count of assets returned from a saved query

>>> count = apiobj.count_by_saved_query(name="test")

Get count of assets returned from a saved query for a given date

>>> count = apiobj.count_by_saved_query(name="test", history_date="2020-09-29")
Parameters
Return type

int

destroy(destroy, history)

Delete ALL assets.

Notes

Enable the Enable API destroy endpoints setting under Settings > Global Settings > API Settings > Enable advanced API settings for this method to function.

Parameters
  • destroy (bool) – Must be true in order to actually perform the delete

  • history (bool) – Also delete all historical information

Return type

dict

get(generator=False, **kwargs)

Get assets from a query.

Examples

Get all assets with the default fields defined in the API client

>>> assets = apiobj.get()

Get all assets using an iterator

>>> assets = [x for x in apiobj.get(generator=True)]

Get all assets with fields that equal names

>>> assets = apiobj.get(fields=["os.type", "aws:aws_device_type"])

Get all assets with fields that fuzzy match names and no default fields

>>> assets = apiobj.get(fields_fuzzy=["last", "os"], fields_default=False)

Get all assets with fields that regex match names a

>>> assets = apiobj.get(fields_regex=["^os\."])

Get all assets with all root fields for an adapter

>>> assets = apiobj.get(fields_root="aws")

Get all assets for a given date in history and sort the rows on a field

>>> assets = apiobj.get(history_date="2020-09-29", sort_field="name")

Get all assets with details of which adapter connection provided the agg data

>>> assets = apiobj.get(include_details=True)

Get assets matching a query built by the GUI query wizard

>>> query='(specific_data.data.name == "test")'
>>> assets = apiobj.get(query=query)

Get assets matching a query built by the API client query wizard

>>> entries=[{'type': 'simple', 'value': 'name equals test'}]
>>> assets = apiobj.get(wiz_entries=entries)

See also

This method is used by all other get* methods under the hood and their kwargs are passed thru to this method and passed to get_generator() which are then passed to whatever callback is used based on the export argument.

If export is not supplied, see axonius_api_client.api.asset_callbacks.base.Base.args_map().

If export equals json, see axonius_api_client.api.asset_callbacks.base_json.Json.args_map().

If export equals csv, see axonius_api_client.api.asset_callbacks.base_csv.Csv.args_map().

If export equals json_to_csv, see axonius_api_client.api.asset_callbacks.base_json_to_csv.JsonToCsv.args_map().

If export equals table, see axonius_api_client.api.asset_callbacks.base_table.Table.args_map().

If export equals xlsx, see axonius_api_client.api.asset_callbacks.base_xlsx.Xlsx.args_map().

Parameters
  • generator (bool) – return an iterator for assets that will yield rows as they are fetched

  • **kwargs – passed to get_generator()

Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_id(id)

Get the full data set of all adapters for a single asset.

Examples

>>> asset = apiobj.get_by_id(id="3d69adf54879faade7a44068e4ecea6e")
Parameters

id (str) – internal_axon_id of asset to get all data set for

Raises

NotFoundError – if id is not found

Return type

dict

get_by_saved_query(name, **kwargs)

Get assets that would be returned by a saved query.

Examples

First, create a client using axonius_api_client.connect.Connect and assume apiobj is client.devices or client.users

>>> apiobj = client.devices

Get assets from a saved query with complex fields flattened

>>> assets = apiobj.get_by_saved_query(name="test", field_flatten=True)

Notes

The query and the fields defined in the saved query will be used to get the assets.

Parameters
  • name (str) – name of saved query to get assets from

  • **kwargs – passed to get()

Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_value(value, field, not_flag=False, pre='', post='', field_manual=False, **kwargs)

Build a query to get assets where field equals a value.

Notes

It is better to use wizard, wizard_text, or wizard_csv to build queries!

Parameters
  • value (str) – value that must equal field

  • field (str) – name of field to query against

  • not_flag (bool) – prefix query with ‘not’

  • pre (str) – query to add to the beginning of the query

  • post (str) – query to add to the end of the query

  • field_manual (bool) – consider supplied field as a fully qualified field name

  • **kwargs – passed to get()

Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_value_regex(value, field, cast_insensitive=True, not_flag=False, pre='', post='', field_manual=False, **kwargs)

Build a query to get assets where field regex matches a value.

Notes

It is better to use wizard, wizard_text, or wizard_csv to build queries!

Parameters
  • value (str) – regex that must match field

  • field (str) – name of field to query against

  • case_insensitive – ignore case when performing the regex match

  • not_flag (bool) – prefix query with ‘not’

  • pre (str) – query to add to the beginning of the query

  • post (str) – query to add to the end of the query

  • field_manual (bool) – consider supplied field as a fully qualified field name

  • **kwargs – passed to get()

  • cast_insensitive (bool) –

Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_by_values(values, field, not_flag=False, pre='', post='', field_manual=False, **kwargs)

Build a query to get assets where field in values.

Notes

It is better to use wizard, wizard_text, or wizard_csv to build queries!

Parameters
  • values (typing.List[str]) – list of values that must match field

  • field (str) – name of field to query against

  • not_flag (bool) – prefix query with ‘not’

  • pre (str) – query to add to the beginning of the query

  • post (str) – query to add to the end of the query

  • field_manual (bool) – consider supplied field as a fully qualified field name

  • **kwargs – passed to get()

Return type

typing.Union[typing.Generator[dict, None, None], typing.List[dict]]

get_generator(query=None, fields=None, fields_manual=None, fields_regex=None, fields_fuzzy=None, fields_default=True, fields_root=None, fields_error=True, max_rows=None, max_pages=None, row_start=0, page_size=2000, page_start=0, page_sleep=0, export='base', include_notes=False, include_details=False, sort_field=None, sort_descending=False, history_date=None, wiz_entries=None, **kwargs)

Get assets from a query.

Parameters
Return type

typing.Generator[dict, None, None]

history_dates()

Get all known historical dates.

Return type

dict

LOG: logging.Logger

Logger for this object.

auth

axonius_api_client.auth.models.Mixins authentication object.

http

axonius_api_client.http.Http client to use to send requests,

FIELD_COMPLEX: str = 'specific_data.data.associated_devices'

Field name of a complex field.

FIELD_COMPLEX_SUB: str = 'device_caption'

Field name of a complex sub field.

wizard: str = None

Query wizard for python objects.

Type

axonius_api_client.api.wizards.wizard.Wizard

wizard_text: str = None

Query wizard for text files.

Type

axonius_api_client.api.wizards.wizard_text.WizardText

wizard_csv = None

Query wizard for CSV files.

Type

axonius_api_client.api.wizards.wizard_csv.WizardCsv