Skip to content

compiler-admin user

compiler-admin user

Work with users in the Compiler org.

Usage:

compiler-admin user [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • backupcodes: Get backup codes for the user, creating a new set if needed.
  • convert: Convert a user of one type to another.
  • create: Create a new user account.
  • deactivate: Deactivate (but do not delete) a user.
  • delete: Delete a user account.
  • offboard: Fully offboard a user from Compiler.
  • reactivate: Reactivate a previously deactivated user.
  • reset: Reset a user’s password.
  • restore: Restore an email backup from a prior offboarding.
  • signout: Sign a user out from all active sessions.

compiler-admin user backupcodes

Get backup codes for the user, creating a new set if needed.

Usage:

compiler-admin user backupcodes [OPTIONS] USERNAME

Options:

  --help  Show this message and exit.

compiler-admin user convert

Convert a user of one type to another.

Usage:

compiler-admin user convert [OPTIONS] USERNAME {contractor|partner|staff}

Options:

  -f, --force  Don't ask for confirmation.
  --help       Show this message and exit.

compiler-admin user create

Create a new user account.

The user’s password is randomly generated and requires reset on first login.

Extra args are passed along to GAM as options.

https://github.com/GAM-team/GAM/wiki/Users#create-a-user

Usage:

compiler-admin user create [OPTIONS] USERNAME [GAM_ARGS]...

Options:

  -n, --notify TEXT  An email address to send the new password notification.
  --help             Show this message and exit.

compiler-admin user deactivate

Deactivate (but do not delete) a user.

Usage:

compiler-admin user deactivate [OPTIONS] USERNAME

Options:

  -f, --force                Don't ask for confirmation.
  -n, --notify TEXT          An email address to send the new password
                             notification.
  -e, --recovery-email TEXT  An email address to use as the new recovery
                             email. Without a value, clears the recovery
                             email.
  -p, --recovery-phone TEXT  A phone number to use as the new recovery phone
                             number. Without a value, clears the recovery
                             phone number.
  --help                     Show this message and exit.

compiler-admin user delete

Delete a user account.

Usage:

compiler-admin user delete [OPTIONS] USERNAME

Options:

  -f, --force  Don't ask for confirmation.
  --help       Show this message and exit.

compiler-admin user offboard

Fully offboard a user from Compiler.

Deactivate, back up email, transfer Calendar/Drive, and optionally delete.

Usage:

compiler-admin user offboard [OPTIONS] USERNAME

Options:

  -a, --alias TEXT   Another account to assign username as an alias.
  -d, --delete       Also delete the account.
  -f, --force        Don't ask for confirmation.
  -n, --notify TEXT  An email address to send the new password notification.
  --help             Show this message and exit.

compiler-admin user reactivate

Reactivate a previously deactivated user.

Usage:

compiler-admin user reactivate [OPTIONS] USERNAME

Options:

  -f, --force                Don't ask for confirmation.
  -n, --notify TEXT          An email address to send the new password
                             notification.
  -e, --recovery-email TEXT  An email address to use as the new recovery
                             email.
  -p, --recovery-phone TEXT  A phone number to use as the new recovery phone
                             number.
  -s, --staff                Reactivate the user as a staff member. The
                             default is contractor.
  --help                     Show this message and exit.

compiler-admin user reset

Reset a user’s password.

Usage:

compiler-admin user reset [OPTIONS] USERNAME

Options:

  -f, --force        Don't ask for confirmation.
  -n, --notify TEXT  An email address to send the new password notification.
  --help             Show this message and exit.

compiler-admin user restore

Restore an email backup from a prior offboarding.

Usage:

compiler-admin user restore [OPTIONS] USERNAME

Options:

  --help  Show this message and exit.

compiler-admin user signout

Sign a user out from all active sessions.

Usage:

compiler-admin user signout [OPTIONS] USERNAME

Options:

  -f, --force  Don't ask for confirmation.
  --help       Show this message and exit.