Skip to content

airt user

A set of commands for managing users in the server.

Usage:

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

Options:

  • --install-completion [bash|zsh|fish|powershell|pwsh]: Install completion for the specified shell.
  • --show-completion [bash|zsh|fish|powershell|pwsh]: Show completion for the specified shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • create: Create a new user in the server.
  • disable: Disable a user in the server.
  • enable: Enable a disabled user in the server.
  • ls: Return the list of users available in the...
  • update: Update existing user details in the server.

airt user create

Create a new user in the server.

Usage:

$ airt user create [OPTIONS]

Options:

  • -un, --username TEXT: The username for the new user. [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. [required]
  • -p, --password TEXT: The password for the new user. [required]
  • -st, --subscription_type TEXT: User subscription type. Currently, the API supports only the following subscription types small, medium and large. [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 to create a non-super user.
  • -q, --quiet: Output user id only.
  • -d, --debug: Set logger level to DEBUG and output everything.
  • --help: Show this message and exit.

airt user disable

Disable a user in the server.

Usage:

$ airt user disable [OPTIONS] ID

Arguments:

  • ID: User id to disabled. [required]

Options:

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

airt user enable

Enable a disabled user in the server.

Usage:

$ airt user enable [OPTIONS] ID

Arguments:

  • ID: User id to enable. [required]

Options:

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

airt user ls

Return the list of users available in the server.

Usage:

$ airt user ls [OPTIONS]

Options:

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

airt user update

Update existing user details in the server.

Usage:

$ airt user update [OPTIONS]

Options:

  • -id, --user_id INTEGER: User id in the server. [required]
  • -un, --username TEXT: New username for the user.
  • -fn, --first_name TEXT: New first name for the user.
  • -ln, --last_name TEXT: New last name for the user.
  • -e, --email TEXT: New email for the user.
  • -p, --password TEXT: New password for the user.
  • -q, --quiet: Output user id only.
  • -d, --debug: Set logger level to DEBUG and output everything.
  • --help: Show this message and exit.
Back to top