watchlists

Manage watchlist user memberships.

watchlists [OPTIONS] COMMAND [ARGS]...

add

Add a user to a watchlist.

watchlists add [OPTIONS] [USER_ID|USERNAME]

Options

--watchlist-id <watchlist_id>

ID of the watchlist.

--watchlist-type <watchlist_type>

Type of watchlist to add user to.

Options

CONTRACT_EMPLOYEE | DEPARTING_EMPLOYEE | ELEVATED_ACCESS_PRIVILEGES | FLIGHT_RISK | HIGH_IMPACT_EMPLOYEE | NEW_EMPLOYEE | PERFORMANCE_CONCERNS | POOR_SECURITY_PRACTICES | SUSPICIOUS_SYSTEM_ACTIVITY

-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

[USER_ID|USERNAME]

Required argument

bulk

Tools for executing bulk watchlist actions.

watchlists bulk [OPTIONS] COMMAND [ARGS]...

add

Bulk add users to watchlists using a CSV file. Requires either a watchlist_id or watchlist_type column header to identify the watchlist, and either a user_id or username column header to identify the user to add.

watchlists 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.

watchlists 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 watchlists using a CSV file. Requires either a watchlist_id or watchlist_type column header to identify the watchlist, and either a user_id or username header to identify the user to remove.

watchlists bulk remove [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

list

List all watchlists.

watchlists 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.

list-members

List all members on a given watchlist.

watchlists list-members [OPTIONS]

Options

--watchlist-id <watchlist_id>

ID of the watchlist.

--watchlist-type <watchlist_type>

Type of watchlist to list.

Options

CONTRACT_EMPLOYEE | DEPARTING_EMPLOYEE | ELEVATED_ACCESS_PRIVILEGES | FLIGHT_RISK | HIGH_IMPACT_EMPLOYEE | NEW_EMPLOYEE | PERFORMANCE_CONCERNS | POOR_SECURITY_PRACTICES | SUSPICIOUS_SYSTEM_ACTIVITY

--only-included-users

Restrict results to users explicitly added to watchlist via API or Console. Users added implicitly via group membership or other dynamic rule will not be listed.

-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.

remove

Remove a user from a watchlist.

watchlists remove [OPTIONS] [USER_ID|USERNAME]

Options

--watchlist-id <watchlist_id>

ID of the watchlist.

--watchlist-type <watchlist_type>

Type of watchlist to remove user from.

Options

CONTRACT_EMPLOYEE | DEPARTING_EMPLOYEE | ELEVATED_ACCESS_PRIVILEGES | FLIGHT_RISK | HIGH_IMPACT_EMPLOYEE | NEW_EMPLOYEE | PERFORMANCE_CONCERNS | POOR_SECURITY_PRACTICES | SUSPICIOUS_SYSTEM_ACTIVITY

-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

[USER_ID|USERNAME]

Required argument