Skip to content

airt user

Usage:

$ airt user [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • create: Create a new user in airt service.
  • disable: Disable a user in airt service.
  • enable: Enable a disabled user in airt service.
  • ls: Display the list of available users.
  • update: Update user details in airt service.

airt user create

Create a new user in airt service.

Usage:

$ airt user create [OPTIONS]

Options:

  • -un, --username TEXT: The username for the new user. If the passed username is already available in airt service,then an error message will be diplayed indicating the same. [required]
  • -fn, --first_name TEXT: The first name for the new user. [required]
  • -ln, --last_name TEXT: The last name for the new user. [required]
  • -e, --email TEXT: The email for the new user. If the passed email is already available in airt service, then an error message will be diplayed indicating the same. [required]
  • -p, --password TEXT: The password for the new user. [required]
  • -su, --super_user: If set to True, then the new user will have super user privilages. If None, then the default value False will be used. [default: False]
  • -qt, --quota: If set to True, then the user will have access to all the routes. If None, then the default value False will be used and the user will have access only to DataSource routes. [default: False]
  • -q, --quiet: Output user id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt user disable

Disable a user in airt service.

Usage:

$ airt user disable [OPTIONS] ID

Arguments:

  • ID: The user id to disabled in airt service. [required]

Options:

  • -q, --quiet: Output user id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt user enable

Enable a disabled user in airt service.

Usage:

$ airt user enable [OPTIONS] ID

Arguments:

  • ID: The id of the disabled user in airt service. [required]

Options:

  • -q, --quiet: Output user id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt user ls

Display the list of available users.

Usage:

$ airt user ls [OPTIONS]

Options:

  • -o, --offset INTEGER: The number of records to offset at the beginning of the users list. If None, then the default value 0 will be used. [default: 0]
  • -l, --limit INTEGER: The maximum number of records to return from the server. If None, then the default value 100 will be used. [default: 100]
  • --disabled: If set to True, then both active and disabled users will be displayed. If None, then the default value False will be used which will display only the list of active users. [default: False]
  • -q, --quiet: Output only ids of users separated by space [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt user update

Update user details in airt service.

Usage:

$ airt user update [OPTIONS]

Options:

  • -id, --user_id INTEGER: The id of the user in airt service. [required]
  • -un, --username TEXT: New username for the user_id in airt service. If None (default value), then the username won't be updated for the user.
  • -fn, --first_name TEXT: New first_name for the user_id in airt service. If None (default value), then the first_name won't be updated for the user.
  • -ln, --last_name TEXT: New last_name for the user_id in airt service. If None (default value), then the last_name won't be updated for the user.
  • -e, --email TEXT: New email for the user_id in airt service. If None (default value), then the email won't be updated for the user.
  • -p, --password TEXT: New password for the user_id in airt service. If None (default value), then the password won't be updated for the user.
  • -q, --quiet: Output user id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.
Back to top