Skip to content

Command Reference

All commands follow this structure:

Terminal window
authaction <command> <subcommand> [options]

Pass --help to any command for usage details:

Terminal window
authaction users --help
authaction users list --help

FlagDescription
--tenant <name>Override the active tenant
--region <region>Target region: eu | us | au | ca | cn | in | gb | jp (default: eu)
--jsonOutput raw JSON instead of a formatted table
--versionPrint the CLI version
--helpShow help for any command

Authenticate via browser-based OAuth2 flow. Stores a token locally.

Terminal window
authaction login

Remove stored credentials.

Terminal window
authaction logout

Display the currently authenticated user.

Terminal window
authaction whoami

Set default tenant and region interactively.

Terminal window
authaction configure

List all tenants in your account.

Terminal window
authaction tenants list [--json]

Get details for a specific tenant.

Terminal window
authaction tenants get <tenantId> [--json]

Create a new tenant (interactive prompt).

Terminal window
authaction tenants create

Set the active tenant for subsequent commands.

Terminal window
authaction use-tenant my-tenant

List applications in the active tenant.

Terminal window
authaction apps list [--type spa|m2m|passkey-plus] [--page <n>] [--json]

Get details for an application.

Terminal window
authaction apps get <appId> [--json]

Create a new application (interactive prompt).

Terminal window
authaction apps create

Delete an application.

Terminal window
authaction apps delete <appId>

List users in the active tenant.

Terminal window
authaction users list [--email <email>] [--connection <id>] [--page <n>] [--json]

Get details for a user.

Terminal window
authaction users get <userId> [--json]

Create a new user (interactive prompt).

Terminal window
authaction users create

Update a user’s details (interactive prompt).

Terminal window
authaction users update <userId>

Delete a user.

Terminal window
authaction users delete <userId>

List roles in the active tenant.

Terminal window
authaction roles list [--json]

Get details for a role.

Terminal window
authaction roles get <roleId> [--json]

Create a new role (interactive prompt).

Terminal window
authaction roles create

Delete a role.

Terminal window
authaction roles delete <roleId>

List identity connections in the active tenant.

Terminal window
authaction connections list [--json]

Get details for a connection.

Terminal window
authaction connections get <connectionId> [--json]

Create a new connection (interactive prompt).

Terminal window
authaction connections create

authaction connections delete <connectionId>

Section titled “authaction connections delete <connectionId>”

Delete a connection.

Terminal window
authaction connections delete <connectionId>

List organizations in the active tenant.

Terminal window
authaction organizations list [--page <n>] [--json]

Get details for an organization.

Terminal window
authaction organizations get <orgId> [--json]

Create a new organization (interactive prompt).

Terminal window
authaction organizations create

Delete an organization.

Terminal window
authaction organizations delete <orgId>

List API servers in the active tenant.

Terminal window
authaction api-servers list [--json]

Get details for an API server.

Terminal window
authaction api-servers get <apiServerId> [--json]

Create a new API server (interactive prompt).

Terminal window
authaction api-servers create

authaction api-servers delete <apiServerId>

Section titled “authaction api-servers delete <apiServerId>”

Delete an API server.

Terminal window
authaction api-servers delete <apiServerId>

List plans in the active tenant.

Terminal window
authaction plans list [--json]

Get details for a plan.

Terminal window
authaction plans get <planId> [--json]

Create a new plan (interactive prompt).

Terminal window
authaction plans create

Delete a plan.

Terminal window
authaction plans delete <planId>

Get the current SMTP configuration for the active tenant.

Terminal window
authaction smtp get [--json]

Configure SMTP settings (interactive prompt).

Terminal window
authaction smtp configure

Send a test email via the configured SMTP provider.

Terminal window
authaction emails send

List members of the active tenant.

Terminal window
authaction tenant-members list [--json]

Invite a new member to the active tenant (interactive prompt).

Terminal window
authaction tenant-members invite

authaction tenant-members remove <memberId>

Section titled “authaction tenant-members remove <memberId>”

Remove a member from the active tenant.

Terminal window
authaction tenant-members remove <memberId>