Axonius Bot for Slack

This is a Slack bot for Axonius.

It enables users in Slack to interact with an Axonius instance in a number of ways:

• Get a report of objects in JSON format sent to you in a new thread.
• You can search for user objects by username, email (using regex or not).
• You can search for device objects by hostname, IP address, or MAC address (using regex or not).
• You can search for user or device objects by a query built in the Query Wizard of the Axonius GUI.
• You can add or remove labels in the thread that is started up for returned objects.

You can:

• See the Quickstart Guide in order to… get started quickly.
• See Using the Axonius Bot in Slack for examples of interacting with the bot in Slack.

To ask questions, request features, or report a bug:

• File an issue on the Issue Tracker
• Email apiclient@axonius.com

This is publicly available in a few places:

• GitHub
• Docker
• PyPi

This was built with the help of a few packages:

• Click: For building the command line interface.
• Axonius API Client: For interacting with the Axonius API.
• Slack Machine: For interacting with the Slack API.

Table of Contents

• 1. Quickstart Guide
• 2. Installing
  • 2.1. Prerequisites
    • 2.1.1. Connection to the Slack API
    • 2.1.2. Connection to the Axonius instance
  • 2.2. Variables
    • 2.2.1. Required Variables
    • 2.2.2. Optional Variables
  • 2.3. Getting tokens
    • 2.3.1. Steps to generate an API token for a Slack bot
    • 2.3.2. Steps to get an Axonius API Key and API Secret
  • 2.4. Install using Docker
    • 2.4.1. Download Docker image
    • 2.4.2. Configure bot in Docker
    • 2.4.3. Test bot in Docker
    • 2.4.4. Run bot in Docker
    • 2.4.5. Run bot in production mode in Docker
  • 2.5. Instal using pipenv
    • 2.5.1. Install package using pipenv
    • 2.5.2. Configure bot in Pipenv
    • 2.5.3. Test bot in Pipenv
    • 2.5.4. Run bot in Pipenv
• 3. Using the Axonius Bot in Slack
  • 3.1. Count commands
  • 3.2. Get commands
    • 3.2.1. Get device commands
    • 3.2.2. Get user commands
  • 3.3. Saved Query commands
    • 3.3.1. Saved Query list commands
    • 3.3.2. Saved Query get commands
  • 3.4. Fields commands
    • 3.4.1. List fields
    • 3.4.2. Add fields
    • 3.4.3. Delete fields
    • 3.4.4. Errors with adding or deleting fields
  • 3.5. Thread Example Responses
    • 3.5.1. Found response
    • 3.5.2. Found response using regex
    • 3.5.3. Not found response
  • 3.6. Thread sub-commands
  • 3.7. Other commands
• 4. Commit history
• 5. Todo Items

Indices and tables

• Index
• Module Index
• Search Page