users
Manage users within your Code42 environment.
users [OPTIONS] COMMAND [ARGS]...
add-alias
Add a cloud alias for a given user.
A cloud alias is the username an employee uses to access cloud services such as Google Drive or Box. Adding a cloud alias allows Incydr to link a user’s cloud activity with their Code42 username. Each user has a default cloud alias of their Code42 username. You can add one additional alias.
users add-alias [OPTIONS] USERNAME ALIAS
Options
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
- ALIAS
Required argument
add-role
Add the specified role to the user with the specified username.
users add-role [OPTIONS]
Options
- --username <username>
Username of the target user.
- --role-name <role_name>
Name of role to add.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
bulk
Tools for managing users in bulk.
users bulk [OPTIONS] COMMAND [ARGS]...
add-alias
Add aliases to a list of users from the provided CSV in format: username,alias.
A cloud alias is the username an employee uses to access cloud services such as Google Drive or Box. Adding a cloud alias allows Incydr to link a user’s cloud activity with their Code42 username. Each user has a default cloud alias of their Code42 username. You can add one additional alias.
users bulk add-alias [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
add-roles
Add roles to a list of users from the provided CSV in format: username,role_name
users bulk add-roles [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
deactivate
Deactivate a list of users from the provided CSV in format: username
users bulk deactivate [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
generate-template
Generate the CSV template needed for bulk user commands.
users bulk generate-template [OPTIONS] [update|move|add-alias|remove-
alias|update-risk-profile]
Options
- -p, --path <path>
Write template file to specific file path/name.
Arguments
- CMD
Required argument
move
Change the organization of the list of users from the provided CSV in format: username,org_id
users bulk move [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
reactivate
Reactivate a list of users from the provided CSV in format: username
users bulk reactivate [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
remove-alias
Remove aliases from a list of users from the provided CSV in format: username,alias
users bulk remove-alias [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
remove-roles
Remove roles from a list of users from the provided CSV in format: username,role_name
users bulk remove-roles [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
update
Update a list of users from the provided CSV in format: user_id,username,email,password,first_name,last_name,notes,archive_size_quota
users bulk update [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
update-risk-profile
Update user risk profile data from the provided CSV in format: username,start_date,end_date,notes
To clear a value, set column item to the string: ‘null’.
users bulk update-risk-profile [OPTIONS] CSV_FILE
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- --append-notes
Append provided note value to already existing note on a new line. Defaults to overwrite.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- CSV_FILE
Required argument
deactivate
Deactivate a user.
users deactivate [OPTIONS] USERNAME
Options
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
list
List users in your Code42 environment.
users list [OPTIONS]
Options
- --org-uid <org_uid>
Limit users to only those in the organization you specify. Note that child orgs are included.
- --role-name <role_name>
Limit results to only users having the specified role.
- --active
Limits results to only active users.
- --inactive
Limits results to only deactivated users.
- --include-legal-hold-membership
Include legal hold membership in output.
- --include-roles
Include user roles.
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
list-aliases
List the cloud aliases for a given user.
Each user has a default cloud alias of their Code42 username with up to one additional alias.
users list-aliases [OPTIONS] USERNAME
Options
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
move
Change the organization of the user with the given username to the org with the given org UID.
users move [OPTIONS]
Options
- --username <username>
Required The username of the user to move.
- --org-id <org_id>
Required The unique identifier (UID) for the organization to which the user will be moved.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
orgs
Tools for viewing user orgs.
users orgs [OPTIONS] COMMAND [ARGS]...
list
List all orgs.
users orgs list [OPTIONS]
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
show
Show org details.
users orgs show [OPTIONS] ORG_UID
Options
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- ORG_UID
Required argument
reactivate
Reactivate a user.
users reactivate [OPTIONS] USERNAME
Options
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
remove-alias
Remove a cloud alias for a given user.
users remove-alias [OPTIONS] USERNAME ALIAS
Options
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
- ALIAS
Required argument
remove-role
Remove the specified role to the user with the specified username.
users remove-role [OPTIONS]
Options
- --role-name <role_name>
Name of role to remove.
- --username <username>
Username of the target user.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
show
Show user details.
users show [OPTIONS] USERNAME
Options
- --include-legal-hold-membership
Include legal hold membership in output.
- -f, --format <format>
The output format of the result. Defaults to table format.
- Options
TABLE | CSV | JSON | RAW-JSON
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
update
Update a user with the specified unique identifier.
users update [OPTIONS]
Options
- --user-id <user_id>
Required The unique identifier of the user to be modified.
- --username <username>
The new username for the user.
- --password <password>
The new password for the user.
- --email <email>
The new email for the user.
- --first-name <first_name>
The new first name for the user.
- --last-name <last_name>
The new last name for the user.
- --notes <notes>
Notes about this user.
- --archive-size-quota <archive_size_quota>
The total size (in bytes) allowed for this user.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
update-departure-date
Sets the end_date on a User’s risk profile (useful for users on the Departing Watchlist). Date format: %Y-%m-%d
users update-departure-date [OPTIONS] USERNAME [[%Y-%m-%d]]
Options
- --clear
Clears the current end_date value.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
- DATE
Optional argument
update-risk-profile-notes
Sets the notes value of a User’s risk profile.
WARNING: Overwrites any existing note value.
users update-risk-profile-notes [OPTIONS] USERNAME [NOTE]
Options
- --clear
Clears the current notes value.
- --append
Appends provided note to existing note text as a new line.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
- NOTE
Optional argument
update-start-date
Sets the start_date on a User’s risk profile (useful for users on the New Hire Watchlist). Date format: %Y-%m-%d
users update-start-date [OPTIONS] USERNAME DATE
Options
- --clear
Clears the current start_date value.
- -d, --debug
Turn on debug logging.
- --totp <totp>
TOTP token for multi-factor authentication.
- --profile <profile>
The name of the Code42 CLI profile to use when executing this command.
Arguments
- USERNAME
Required argument
- DATE
Optional argument