IAM Command-Line Interface (CLI)

The iam CLI is a command-line tool providing commands used to manage Airlock IAM instances and the IAM configuration.

Run iam -h / iam --help to get general usage and help information.
Run iam <subcommand> -h / iam <subcommand> --help to get usage and help for a given subcommand. E.g., iam config -h or iam reset --help.

The code block below shows the entire Help text (which appears after running iam -h):

Example

Usage: iam [-hV] 
       iam COMMAND [COMMAND-OPTIONS] 
 
Airlock IAM is a comprehensive authentication and identity management solution for web applications and services 
 
Options: 
  -h, --help      Show this help message and exit 
  -V, --version   Print version information and exit 
 
Commands: 
  run                 Runs Airlock IAM 
  init                Initializes one or more new instances with a default configuration 
  upgrade             Upgrades an instance or a plugin configuration file to the current IAM version 
  config              Validates, manipulates, or converts the IAM configuration (see subcommand help for details) 
  reset               Reset the plugin configuration file. 
  sensitive-values    Manages sensitive values for an instance 
  run-task            Runs a given Service Container task 
  info                Displays resolved parameters of an instance 
  status              Displays status information about an instance 
  systemd             Creates systemd service files 
  bash-install        Installs bash auto completion and environment for the CLI 
  build-trust-store   Builds a trust store file containing trusted certificates 
  default-parameters  Shows descriptions and default values for all available application parameters (instance. 
                        properties template) 
 
Exit Codes for all subcommands (if not specified otherwise): 
  0   Action was completed successfully. 
  1   Action could not be completed due to an error. 
 
Run 'iam COMMAND --help' for more information on a command.

Subcommands

Following the initial command iam, you can specify one subcommand.
Subcommands must be added without a dash (-). For example:
Example
```
iam init
```

Further information and links