3.2.26. users get-by-mail

This command lets you search for users by email address and export the data to CSV or JSON.

3.2.26.1. Output feeds

The output from this command is able to be supplied as input to these commands:

3.2.26.2. Common Options

3.2.26.3. Common Examples

3.2.26.4. Help Page

3.2.26.4.1. axonshell users get-by-mail

Get assets with matching email addresses.

axonshell users get-by-mail [OPTIONS]

Options

-u, --url <url>

URL of Axonius instance. [required]

-k, --key <key>

API Key of user in Axonius instance. [required]

-s, --secret <secret>

API Secret of user in Axonius instance. [required]

-xf, --export-file <export_file>

Export to a file in export-path instead of printing to STDOUT. [default: ]

-xp, --export-path <export_path>

Path to create -xf/–export-file in (default is current working directory).

-xt, --export-format <export_format>

Format to use for STDOUT (or -xf/–export-file if supplied). [default: json]

Options:csv|json|table
-xo, --export-overwrite

Overwrite -xf/–export-file if exists.

-xd, --export-delim <export_delim>

Change the cell delimiter for CSV format from the default of carriage return.

-xtf, --export-table-format <export_table_format>

Format to use for –export-format ‘table’. [default: fancy_grid]

Options:fancy_grid|github|grid|html|jira|latex|latex_booktabs|latex_raw|mediawiki|moinmoin|orgtbl|pipe|plain|presto|psql|rst|simple|textile|tsv|youtrack
-f, --field <fields>

Fields (columns) to include in the format of adapter:field.

-fr, --field-regex <fields_regex>

Fields (columns) to include in the format of adapter:field (regex).

-nfd, --no-fields-default

Exclude default fields for this object type.

-mr, --max-rows <max_rows>

Only return this many rows.

-qpre, --query-pre <query_pre>

Query to add to the begginning of the query built to search for -v/–value. [default: ]

-qpost, --query-post <query_post>

Query to add to the end of the query built to search for -v/–value. [default: ]

-vn, --value-not

Search for NOT –value.

-vx, --value-regex

Consider –value values as regular expressions.

-v, --value <values>

Values to search for. [required]