Accounts and Authentication

Authentication, Accounts, and User Management

auth - Manage EEN auth

NAME

auth – EEN authentication commands

SYNOPSIS

een auth [COMMAND] [options]

DESCRIPTION

The een auth command provides utilities for logging in and out of Eagle Eye Networks.

COMMANDS

login

Log in to EEN using the provided credentials.

Required options:

  • --username <username>
    Username for login (e.g., --username [email protected]).

  • --password <password>
    Password for login. Use quotes around the password if it contains special characters (e.g., --password "MyP@ssw0rd!").

Optional options:

  • --debug
    Enable detailed debug output for troubleshooting.

Notes:

  • If the shell misinterprets special characters, ensure the password is wrapped in quotes.

logout

Log out from EEN.

Options:

  • --debug
    Enable detailed debug output for troubleshooting.

EXAMPLES

  • To login
een auth login --username johndoe --password secret --debug
  • To logout
een auth logout --debug

user - Manage Users

NAME

user - manage and interact with users.

SYNOPSIS

een user [COMMAND] [OPTIONS]

DESCRIPTION

The user command allows you to manage users, list user permissions, and export user data in various formats.

COMMANDS

list

List users.

Options:

  • --csv
    Export all users in CSV format.
  • --google-sheet
    Export users in CSV format and upload to Google Sheets.
  • --v1
    Use v1 APIs for listing users.
  • -f, --file-name [file name]
    Specify the file name to save the output under. Use with the --csv option to generate a report.
  • --html
    Generate an HTML report for user permissions.
  • --no-prompt
    Skip all user confirmation prompts.
  • --debug
    Enable detailed debug output for troubleshooting.
  • -l
    Display user details, including name, email, last login, status, and permissions.
  • -e
    Display user email addresses.
  • -fn
    Display user first names.
  • -ln
    Display user last names.
  • -s
    Display user statuses.
  • -p
    Display user permissions.

Actions:

  • If --html is specified, generate a user permissions report.
  • If --csv and --v1 are both specified, export users in CSV format using v1 APIs.
  • If --csv is specified, export users in CSV format.
  • If --google-sheet is specified, export and upload user data to Google Sheets.
  • If --v1 is specified, list users using v1 APIs.

EXAMPLES

  • To list all users:
een user list
  • To list users in CSV format:
een user list --csv -f users.csv
  • To generate an HTML report of user permissions:
een user list --html

account - Manage User Accounts

NAME

account - manage and interact with user accounts.

SYNOPSIS

een account [COMMAND] [OPTIONS]

DESCRIPTION

The account command allows you to manage reseller accounts, list all accounts, and switch between sub-accounts.

COMMANDS

list

List all accounts of the reseller account.

Options:

  • --debug
    Enable detailed debug output for troubleshooting.
  • -l
    Display account details, including account ID, account name, and account type.
  • --account-id [account ID]
    Specify an account ID to list its details.
  • -s
    List sub-accounts (only applicable for reseller accounts).

switch

Switch to an account.

Options:

  • --sub-account-id [sub-account ID]
    Specify the Sub Account ID to switch to from the reseller account.
  • --account-id [account ID]
    Specify the Account ID to switch between logged-in accounts.
  • --debug
    Enable detailed debug output for troubleshooting.

EXAMPLES

  • To list all accounts of the reseller:
een account list --debug
  • To switch to a specific sub-account:
een account switch --sub-account-id <sub-account ID> --debug
  • To switch to a specific account:
een account switch --account-id <account ID> --debug