departing-employee¶
Add and remove employees from the Departing Employees detection list.
departing-employee [OPTIONS] COMMAND [ARGS]...
add¶
Add a user to the Departing Employees detection list.
departing-employee add [OPTIONS] USERNAME
Options
-
--departure-date
<departure_date>
¶ The date the employee is departing. Format: yyyy-MM-dd.
-
--cloud-alias
<cloud_alias>
¶ If the employee has an email alias other than their Code42 username that they use for cloud services such as Google Drive, OneDrive, or Box, add and monitor the alias. WARNING: Adding a cloud alias will override any existing cloud alias for this user.
-
--notes
<notes>
¶ Optional notes about the employee.
-
-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
bulk¶
Tools for executing bulk departing employee actions.
departing-employee bulk [OPTIONS] COMMAND [ARGS]...
add¶
Bulk add users to the Departing Employees detection list using a CSV file with format: username,cloud_alias,departure_date,notes.
departing-employee bulk add [OPTIONS] CSV_FILE
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
-
CSV_FILE
¶
Required argument
generate-template¶
Generate the CSV template needed for bulk adding/removing users.
departing-employee bulk generate-template [OPTIONS] [add|remove]
Options
-
-p
,
--path
<path>
¶ Write template file to specific file path/name.
Arguments
-
CMD
¶
Required argument
remove¶
Bulk remove users from the Departing Employees detection list using a line-separated file of usernames.
departing-employee bulk remove [OPTIONS] FILE
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
-
FILE
¶
Required argument
list¶
Lists the users on the Departing Employees list.
departing-employee list [OPTIONS]
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.
-
-f
,
--format
<format>
¶ The output format of the result. Defaults to table format.
Options: TABLE|CSV|JSON|RAW-JSON
-
--filter
<filter>
¶ Departing employee filter options. Defaults to ALL.
Options: EXFILTRATION_24_HOURS|EXFILTRATION_30_DAYS|LEAVING_TODAY|ALL
remove¶
Remove a user from the Departing Employees detection list.
departing-employee remove [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