Axonius
App Vendor: Axonius
App Category: IT Services, Network Security
Connector Version: 1.0.3
API Version: 1.0.0
About App
Axonius cybersecurity asset management solution offers a comprehensive IT asset inventory, empowering users to enforce their network security policies.
The Axonius app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Get All Device Sets | The action retrieves all the device sets. |
Get Device Assets From Saved Query | The action retrieves device assets from the saved query with the provided name. |
Get Device Asset By ID | The action retrieves the device asset by ID. |
Get Device Saved Query By Name | The action fetches the device saved query with the provided name. |
Get Device Saved Query By UUID | The action fetches the device saved query with the provided UUID. |
Get Device Saved Query By Tags | The action retrieves the device saved query with the provided tags. |
Get All Device Saved Queries | The action retrieves all the device saved queries. |
Add Device Saved Query | The action adds the user-provided saved query. |
Get All Device Schema | The action retrieves the schema for all device adaptors and their fields. |
Get Device Field Details | The action retrieves the details for the provided device fields. |
Get Device Field Validation Details | The action retrieves fully qualified device field validation details. |
Get All User Sets | The action retrieves all the user sets. |
Get User Assets From Saved Query | The action retrieves the user assets from the saved query. |
Get User Asset By ID | The action retrieves the user asset by ID. |
Get User Saved Query By Name | The action fetches the user-saved query with the provided name. |
Get User Saved Query By UUID | The action fetches the user-saved query with the provided UUID. |
Get User Saved Query By Tags | The action retrieves the user-saved query with the provided tags. |
Add Users Saved Query | The action adds the user-provided saved query. |
Get All User Saved Queries | The action retrieves all the user-saved queries. |
Get All User Schema | The action retrieves the schema for all user adaptors and their fields. |
Get User Field Details | The action retrieves the user field details. |
Get User Field Validation Details | The action retrieves field validation details of a user field. |
Configuration Parameters
The following configuration parameters are required for the Axonius app to communicate with the Axonius enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL for the Axonius application. Example: "https://yourdomain.tld" | Text | Required | |
API Key | Enter the API key to authenticate the Axonius application. Example: "dXNlcm5hbWU6MTIzNDU2Nzg5M" | Text | Required | |
API Secret | Enter the API secret key to authenticate the Axonius application. Example: "5678901234567890" | Password | Required | |
SSL Verification | Enter if you want to perform certificate verification on SSL connections. Example: Yes/No | Boolean | Optional | Allowed values:
Default value:
|
Action: Get All Device Sets
The action retrieves all the device sets.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Field list | Enter the field lists to return the associated device sets. Example: $LIST[os.type, aws:aws_device_type] | List | Optional | |
Fields regex | Enter the field regex list to return the associated device sets. Example: $LIST[^os.] | List | Optional | |
Device adapter | Enter the device adapter details to return the associated device sets. Example: "active_directory" | Text | Optional | |
Fuzzy match fields | Enter the fuzzy match fields as a list to return the associated device sets. Example: $LIST[last, os] | List | Optional | |
History date | Enter all device sets for a given date in history. Example: "2020-01-30" | Text | Optional | |
Sort field | Enter the sorting preferences to sort results. Example: "name" | Text | Optional | |
Fields default | Specify if you want to return assets with default fields. Example: Yes/No | Boolean | Optional | Allowed values:
Default value:
|
Limit | Enter the maximum number of results to return. Example: 12 | Integer | Optional | Default value:
|
Example Request
[
{
"field_list":[
"os.type",
"aws:aws_device_type"
],
"fields_regex":[
"^os",
"os.type"
],
"fields_root":"active_directory",
"fields_fuzzy":[
"last",
"os"
],
"history_date":"2020-01-30",
"sort_field":"name",
"fields_default":false,
"limit":12
}
]Action: Get Device Assets From Saved Query
The action retrieves device assets from the saved query with the provided name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query name | Enter the name of the saved query for which you want to return results. Example: "My Saved Query" | Text | Required | |
Flatten complex fields | Enter if you want to flatten complex fields. Example: Yes/No | Boolean | Optional | Allowed values:
Default value:
|
Example Request
[
{
"saved_query_name": "My Saved Query",
"field_flatten": True
}
]Action: Get Device Asset By ID
The action retrieves the device asset by ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Asset ID | Enter the asset ID. Example: "3d69adf54879faade7a44068e4ecea6e" | Text | Required |
Example Request
[
{
"asset_id": "3d69adf54879faade7a44068e4ecea6e"
}
]Action: Get Device Saved Query By Name
The action fetches the device saved query with the provided name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query name | Enter the saved query name to get the device. Example: "My Saved Query" | Text | Required |
Example Request
[
{
"name": "My Saved Query"
}
]Action: Get Device Saved Query By UUID
The action fetches the device saved query with the provided UUID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query UUID | Enter the device saved query UUID. Example: "5f76721ce4557d5cba93f59e" | Text | Required |
Example Request
[
{
"value": "5f76721ce4557d5cba93f59e"
}
]Action: Get Device Saved Query By Tags
The action retrieves the device saved query with the provided tags.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query tags | Specify the device saved query tags to retrieve. Example: $LIST[ad, aws] | List | Required |
Example Request
[
{
"field_list":[
"ad",
"aws"
],
}
]Action: Get All Device Saved Queries
The action retrieves all the device-saved queries.
Action Input Parameters
This action does not require any input parameter.
Action: Add Device Saved Query
The action adds the user-provided saved query.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Content | Enter the saved query content. Example: "Sample content" | Text | Required | |
Name | Enter the saved query name. Example: "My Saved Query" | Text | Required | |
Description | Enter the saved query description. Example: "Saved Query Description" | Text | Required | |
Tags | Enter the tags for the device saved query. Example: $LIST[ad, aws] | List | Required |
Example Request
[
{
"content":"Sample content",
"name":"My Saved Query",
"description":"Saved Query Description",
"tags":[
"ad",
"aws"
]
}
]Action: Get All Device Schema
The action retrieves the schema for all device adaptors and their fields.
Action Input Parameters
This action does not require any input parameter.
Action: Get Device Field Details
The action retrieves the details for the provided device fields.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Fields | Enter the fields to retrieve details. Example: $LIST[hostname,id,aws:aws_device_type] | List | Required |
Example Request
[
{
"fields":[
"hostname",
"id",
"aws:aws_device_type"
]
}
]Action: Get Device Field Validation Details
The action retrieves fully qualified field names used to get asset data.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Field | Enter the base name, qual name, or title of a field. Example: "Host" | Text | Optional | |
Field regex | Enter the regex against which to compare fields. Example: "^host" | Text | Optional | |
Fully qualified field name | Enter the fully qualified field name. Example: "Device Host" | Text | Optional | |
Fuzzy match string | Enter the string against which you want fuzzy match fields. Example: "hostname" | Text | Optional | |
Return error fields | Enter your preference to return error fields. Example: Yes/No | Boolean | Optional | Allowed values:
Default value: Yes |
Adapter name | Enter an adapter from which to return all root fields. Example: "active_directory" | Text | Optional | |
Return default fields | Enter your preference to include the default fields defined in the parent API object. Example: Yes/No | Boolean | Optional | Allowed values:
Default value: Yes |
Example Request
[
{
"fields": "Host",
"fields_regex": "^host",
"fields_manual": "Device Host",
"fields_fuzzy": "hostname",
"fields_error": True,
"fields_root": "active_directory",
"fields_default": True
}
]Action: Get All User Sets
The action retrieves all the user sets.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Field list | Enter the field lists to retrieve associated users. Only the user sets with all of the listed fields will be returned. Example: $LIST[os.type, aws:aws_device_type] | List | Optional | |
Fields regex | Enter the field regex to retrieve associated users. Only the user sets with all of the listed fields will be returned. Example: $LIST[^os.] | List | Optional | |
Device adapter | Enter the device adapter details to retrieve associated users. Only the users with all the root fields will be returned. Example: "active_directory" | Text | Optional | |
Fuzzy match fields | Enter the fuzzy match fields to retrieve user sets. Only the user sets with fields that fuzzy match the items will be returned. Example: $LIST[last, os] | List | Optional | |
History date | Enter all the user sets for a provided date in the history. Example: "2020-01-30" | Text | Optional | |
Sort field | Enter your preference to sort the results. Example: "name" | Text | Optional | |
Fields default | Enter your preference to return users with default fields. Example: Yes/No | Boolean | Optional | Allowed values:
Default value: No |
Limit | Enter the maximum number of results to return. Example: 20 | Integer | Optional | Default value: 10 |
Example Request
[
{
"field_list":[
"os.type",
"aws:aws_device_type"
],
"fields_regex":[
"^os."
]"fields_root":"active_directory",
"fields_fuzzy":[
"last",
"os"
],
"history_date":"2020-01-30",
"sort_field":"name",
"fields_default":false,
"limit":20
}
]Action: Get User Assets From Saved Query
The action retrieves the user assets from the saved query.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query name | Enter the name of the saved query to return the results. Example: "My Saved Query" | Text | Required | |
Flatten complex fields | Enter your preference to flatten complex fields. Example: Yes/No | Boolean | Optional |
Example Request
[
{
"saved_query_name": "My Saved Query",
"field_flatten": False
}
]Action: Get User Asset By ID
The action retrieves the user asset by ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Asset ID | Enter the user asset ID to retrieve the details. Example: "3d69adf54879faade7a44068e4ecea6e" | Text | Required |
Example Request
[
{
"asset_id": "3d69adf54879faade7a44068e4ecea6e"
}
]Action: Get User Saved Query By Name
The action fetches the user-saved query with the provided name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query name | Enter the user saved query name. Example: "My Saved Query" | Text | Required |
Example Request
[
{
"name": "My Saved Query"
}
]Action: Get User Saved Query By UUID
The action fetches the user saved query with the provided UUID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Saved query UUID | Enter the UUID to retrieve the user saved query. Example: "5f76721ce4557d5cba93f59e" | Text | Required |
Example Request
[
{
"value": "5f76721ce4557d5cba93f59e"
}
]Action: Get User Saved Query By Tags
The action retrieves the user saved query with the provided tags.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Tags | Enter the tags to retrieve the user saved query. Example: $LIST[ad, aws] | List | Required |
Example Request
[
{
"tags":[
"ad",
"aws"
]
}
]Action: Add Users Saved Query
The action adds the user-provided saved query.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Content | Enter the saved query content. Example: "Sample Content" | Text | Required | |
Name | Enter the saved query name. Example: "My Saved Query" | Text | Required | |
Description | Enter the description to add user saved query. Example: "Sample Description" | Text | Required | |
Tags | Enter the tags to add to the user saved query. Example: $LIST[ad, aws] | List | Required |
Example Request
[
{
"content":"Sample Content",
"name":"My Saved Query",
"description":"Sample Description",
"tags":[
"ad",
"aws"
]
}
]Action: Get All Device Saved Queries
The action retrieves all the device-saved queries.
Action Input Parameters
This action does not require any input parameter.
Action: Get All User Schema
The action retrieves the schema for all user adaptors and their fields.
Action Input Parameters
This action does not require any input parameter.
Action: Get User Field Details
The action retrieves the user field details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Fields | Enter the fields to retrieve details. Example: $LIST[hostname, ID, aws:aws_device_type] | List | Required |
Example Request
[
{
"fields":[
"hostname",
"ID",
"aws:aws_device_type"
]
}
]Action: Get User Field Validation Details
The action retrieves field validation details of a user field.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Field | Enter the base name, qual name, or title of a field. Example: "Host" | Text | Optional | |
Field regex | Enter the regex against which to compare fields. Example: "^host" | Text | Optional | |
Fully qualified field name | Enter the fully qualified field name. Example: "Device Host" | Text | Optional | |
Fuzzy match string | Enter the string against which you want fuzzy match fields. Example: "Hostname" | Text | Optional | |
Return error fields | Enter your preference to return error fields. Example: Yes/No | Boolean | Optional | Allowed values:
Default value: No |
Adapter name | Enter an adapter from which to return all root fields. Example: "active_directory" | Text | Optional | |
Return default fields | Enter your preference to include the default fields defined in the parent API object. Example: Yes/No | Boolean | Optional | Allowed values:
Default value: Yes |
Example Request
[
{
"fields": "Host",
"fields_regex": "^host",
"fields_manual": "Device Host",
"fields_fuzzy": "hostname",
"fields_error": True,
"fields_root": "active_directory",
"fields_default": True
}
]