Skip to content

Installation & Authentication

  • Node.js 18 or later

Install the CLI globally via npm:

Terminal window
npm install -g @authaction/cli

Verify the installation:

Terminal window
authaction --version

Authenticate with your AuthAction account. This opens a browser window to complete the OAuth2 login flow and stores a token locally.

Terminal window
authaction login

After logging in, confirm who you are authenticated as:

Terminal window
authaction whoami

Most commands operate on a specific tenant. Set the active tenant so you don’t have to pass --tenant on every command:

Terminal window
authaction use-tenant <tenant-name>

You can still override the active tenant per-command with the --tenant flag.

Tenant data is stored in a specific region. Commands that interact with tenant resources accept a --region flag:

eu | us | au | ca | cn | in | gb | jp

The default region is eu. Set --region explicitly when your tenant is in a different region, or configure it once using:

Terminal window
authaction configure

Remove the stored credentials from your machine:

Terminal window
authaction logout