Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IN-152] Automox XSOAR Documentation #3

Merged
merged 10 commits into from
Mar 24, 2022
2 changes: 2 additions & 0 deletions Packs/Automox/Integrations/Automox/Automox.py
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,7 @@ def list_devices(client: Client, args: Dict[str, Any]) -> CommandResults:
result = client.list_devices(org_id, group_id, limit, page)

excluded_keys = [
'compatibility_checks',
'os_version_id',
'instance_id',
'detail',
Expand Down Expand Up @@ -541,6 +542,7 @@ def list_organization_users(client: Client, args: Dict[str, Any]) -> CommandResu
'prefs',
'orgs.trial_end_time',
'orgs.trial_expired',
'orgs.access_key',
ax-jmiller marked this conversation as resolved.
Show resolved Hide resolved
]

for i in range(len(result)):
Expand Down
81 changes: 33 additions & 48 deletions Packs/Automox/Integrations/Automox/Automox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -234,22 +234,22 @@ script:
type: String
- name: automox-organizations-list
arguments:
- name: limit
description: 'The maximum number of results to return per page.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 50
secret: false
- name: page
description: 'The page of results to return.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 0
secret: false
- name: limit
description: 'The maximum number of results to return per page.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 50
secret: false
- name: page
description: 'The page of results to return.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 0
secret: false
deprecated: false
description: 'List all Automox organizations based on user permissions.'
execution: false
Expand Down Expand Up @@ -278,22 +278,22 @@ script:
- name: automox-organization-users-list
description: 'List all Automox users within an organization.'
arguments:
- name: limit
description: 'The maximum number of results to return per page.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 50
secret: false
- name: page
description: 'The page of results to return.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 0
secret: false
- name: limit
description: 'The maximum number of results to return per page.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 50
secret: false
- name: page
description: 'The page of results to return.'
type: 'number'
isArray: false
required: false
default: false
defaultValue: 0
secret: false
deprecated: false
execution: false
outputs:
Expand Down Expand Up @@ -783,21 +783,6 @@ script:
deprecated: false
execution: false
outputs:
- contextPath: Automox.Policies.id
description: 'Identifier of policy'
type: Number
- contextPath: Automox.Policies.organization_id
description: 'Identifier of organization'
type: Number
- contextPath: Automox.Policies.name
description: 'Name of policy'
type: String
- contextPath: Automox.Policies.policy_type_name
description: 'Policy type name'
type: String
- contextPath: Automox.Policies.server_groups
description: 'List of identifiers for device groups assigned to the policy'
type: Number
- name: automox-device-delete
description: "Delete a device from Automox"
arguments:
Expand Down Expand Up @@ -1087,7 +1072,7 @@ script:
script: '-'
type: python
subtype: python3
dockerimage: demisto/python3:3.10.1.26972
dockerimage: demisto/python3:3.10.1.27636
fromversion: 5.5.0
tests:
- No tests (auto formatted)
656 changes: 653 additions & 3 deletions Packs/Automox/Integrations/Automox/README.md

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions Packs/Automox/Playbooks/Upload_Vulnerability_Report_to_Automox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
This sub-playbook takes the entryId of a vendor-generated vulnerability report CSV and uploads it to Automox for remediation.

## Dependencies
This playbook uses the following sub-playbooks, integrations, and scripts.

### Sub-playbooks
* GenericPolling

### Integrations
* Automox

### Scripts
This playbook does not use any scripts.

### Commands
* automox-vulnerability-sync-file-upload
* automox-vulnerability-sync-batch-get
* automox-vulnerability-sync-batch-action

## Playbook Inputs
---

| **Name** | **Description** | **Default Value** | **Required** |
| --- | --- | --- | --- |
| entry_id | The entryId of a vendor-generated vulnerability report. | | Required |

## Playbook Outputs
---
There are no outputs for this playbook.

## Playbook Image
---
![Upload Vulnerabilities to Automox](../doc_files/Upload_Vulnerability_Report_Image.png)
15 changes: 15 additions & 0 deletions Packs/Automox/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# Automox Content Pack for XSOAR
The Automox Content Pack for XSOAR empowers users by providing the resources to administrate your IT organization, and remediate vulnerabilities with ease. Use the Automox integration to create device groups, update devices, and run policies. This content pack also includes a sub-playbook to use in your vulnerability remediation workflows to identify vulnerable devices and automatically generate the remediation tasks necessary to patch them in the Automox platform.

# What does this pack do?
ax-jmiller marked this conversation as resolved.
Show resolved Hide resolved
- Upload Vulnerability Reports
- Get and approve/reject batches of tasks
- Get, update, and delete device groups
- Get and update devices
- Get organizations and their users
- Get and run policies

This pack includes:
- Integrations:
- **Automox**: Administrate your IT organization from XSOAR with comprehensive commands for your Automox instance.
- Playbooks:
- **Upload Vulnerability Report to Automox**: This sub-playbook enables you to upload vulnerability data with ease. This playbook accepts the entryId of a vulnerability report CSV, and uploads it to Automox. After upload, remediation tasks are identified and created automatically for affected devices.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 30 additions & 5 deletions Packs/Automox/pack_metadata.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,44 @@
{
"name": "Automox",
"description": "Automox Content Pack for Demisto",
"description": "This pack empowers you with comprehensive solutions to manage your Automox device fleet with ease!",
"support": "partner",
"currentVersion": "1.0.0",
"author": "Automox Inc.",
"url": "https://www.automox.com/",
"email": "[email protected]",
"categories": [
"Endpoint"
"Endpoint",
"Vulnerability Management"
],
"tags": [
"IT",
"Network",
"Security",
"Use Case",
"New"
],
"useCases": [
ax-jmiller marked this conversation as resolved.
Show resolved Hide resolved
"IT Services",
"Vulnerability Management"
],
"keywords": [
"Automox",
"Patch",
"Endpoint",
"Vulnerability",
"CVE"
],
"tags": [],
"useCases": [],
"keywords": [],
"marketplaces": [
"xsoar",
"marketplacev2"
],
"dependencies": {
"CommonPlaybooks": {
"mandatory": true,
"display_name": "Common Playbooks"
}
},
"displayedImages": [
"CommonPlaybooks"
]
}