Auth0 Signals Command Line Interface

The Signals Command-Line Interface offers a tool to take advantage of all the features of the API right from the command line interface of the user’s favorite Operating System. Microsoft Windows, Apple macOS, and several popular GNU/Linux distributions can run Signals CLI. But if the Operating system can execute Python, it can run the CLI.

Supported Python Versions

This client supports Python 2 and 3 for versions 2.7+ and 3.4+, respectively. Python 2 users should use Python 2.7.9+ to take advantage of the SSL Certificate Validation feature not included in earlier versions.

Installation

PIP

A user can install the Signals CLI with pip:

pip install apilityio-cli

EASY_INSTALL

A user installs the Signals CLI with easy_install too:

$ easy_install apilityio-cli

Verify installation

To verify if the command has been succesfully installed, the user can open a terminal in the target Operating System and type the apility command as follows:

$ apility
 usage: apility [-h] [--apikey APIKEY] [--config CONFIG]
                      [--format {XML,CSV,TEXT,JSON}]
                      [--tableonly TABLEONLY] [--rows ROWS] [--page PAGE]
                      [--timestamp TIMESTAMP]
                      {badip,baddomain,bademail,geoip,asip,asnum,whoisip,historyip,historydomain,historyemail,getquarantine}
                      parameter
 apility: error: the following arguments are required: command, parameter

If the command is not found in the PATH of the user’s session, probably the tool has not been installed correctly.

Get an API Key

If the user does not provide a valid API KEY, the CLI tool will work in anonymous mode. In this mode, the API has a limit of 100 hits per day and per IP address, enough for quick testing and occasional use. If the user needs more hits, then it has to register in the Auth0 Signals site. All registered users have 40000 hits per day available.

Configuracion and instructions

The user can configure the Signals CLI following the instructions found on the tool page. This page will also detail all the available commands and how to use them.

Collaborate!

Do you have an issue using the Signals CLI? Or perhaps some feedback for how we can improve them? Feel free to let us know on the Github issue tracker.

1 Like