users¶
Manage users within your Code42 environment.
users [OPTIONS] COMMAND [ARGS]...
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]...
generate-template¶
Generate the CSV template needed for bulk user commands.
users bulk generate-template [OPTIONS] [update|move]
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
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
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.
-
-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.
move¶
Change the organization of the user with the given username to the org with the given org ID.
users move [OPTIONS]
Options
-
--username<username>¶ Required The username of the user to move.
-
--org-id<org_id>¶ Required The identifier 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.
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.
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.