v1.14.4
User Guides
Get started with the Code42 command-line interface (CLI)
Configure a profile
Ingest data into a SIEM
Manage legal hold users
Clean up your environment by deactivating devices
Write custom extension scripts using the Code42 CLI and Py42
Manage users
Configure trusted activities
Configure alert rules
Add and manage cases
Perform bulk actions
Manage watchlist members
(DEPRECATED) Manage detection list users
Commands
Alert Rules
Alerts
Audit Logs
Cases
Devices
Legal Hold
Profile
Security Data
Trusted Activities
Users
Watchlists
(DEPRECATED) Departing Employee
(DEPRECATED) High Risk Employee
code42cli
»
Index
Edit on GitHub
Index
Symbols
|
A
|
C
|
D
|
H
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
--active
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--actor
alerts-search command line option
alerts-send-to command line option
security-data-search command line option
security-data-send-to command line option
--actor-contains
alerts-search command line option
alerts-send-to command line option
--actor-ip
audit-logs-search command line option
audit-logs-send-to command line option
--actor-user-id
audit-logs-search command line option
audit-logs-send-to command line option
--actor-username
audit-logs-search command line option
audit-logs-send-to command line option
--advanced-query
alerts-search command line option
alerts-send-to command line option
security-data-search command line option
security-data-send-to command line option
--affected-user-id
audit-logs-search command line option
audit-logs-send-to command line option
--affected-username
audit-logs-search command line option
audit-logs-send-to command line option
--append
users-update-risk-profile-notes command line option
--append-notes
users-bulk-update-risk-profile command line option
--archive-size-quota
users-update command line option
--assignee
cases-create command line option
cases-list command line option
cases-update command line option
--assume-yes
profile-delete command line option
profile-delete-all command line option
--begin
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
security-data-search command line option
security-data-send-to command line option
--begin-create-time
cases-list command line option
--begin-update-time
cases-list command line option
--c42-username
security-data-search command line option
security-data-send-to command line option
--case-number
cases-file-events-add command line option
cases-file-events-remove command line option
--certs
alerts-send-to command line option
audit-logs-send-to command line option
security-data-send-to command line option
--change-device-name
devices-bulk-deactivate command line option
devices-deactivate command line option
--clear
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
--cloud-alias
departing-employee-add command line option
high-risk-employee-add command line option
--columns
security-data-search command line option
,
[1]
security-data-send-to command line option
--created-after
devices-list command line option
--created-before
devices-list command line option
--debug
alert-rules-add-user command line option
alert-rules-bulk-add command line option
alert-rules-bulk-remove command line option
alert-rules-list command line option
alert-rules-remove-user command line option
alert-rules-show command line option
alerts-bulk-update command line option
alerts-clear-checkpoint command line option
alerts-search command line option
alerts-send-to command line option
alerts-show command line option
alerts-update command line option
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
cases-create command line option
cases-export command line option
cases-file-events command line option
cases-file-events-add command line option
cases-file-events-bulk-add command line option
cases-file-events-bulk-remove command line option
cases-file-events-list command line option
cases-file-events-remove command line option
cases-list command line option
cases-show command line option
cases-update command line option
departing-employee-add command line option
departing-employee-bulk-add command line option
departing-employee-bulk-remove command line option
departing-employee-list command line option
departing-employee-remove command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-bulk-add command line option
high-risk-employee-bulk-add-risk-tags command line option
high-risk-employee-bulk-remove command line option
high-risk-employee-bulk-remove-risk-tags command line option
high-risk-employee-list command line option
high-risk-employee-remove command line option
high-risk-employee-remove-risk-tags command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-reset-pw command line option
profile-update command line option
security-data-clear-checkpoint command line option
security-data-saved-search command line option
security-data-saved-search-list command line option
security-data-saved-search-show command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-bulk-create command line option
trusted-activities-bulk-remove command line option
trusted-activities-bulk-update command line option
trusted-activities-create command line option
trusted-activities-list command line option
trusted-activities-remove command line option
trusted-activities-update command line option
users-add-alias command line option
users-add-role command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-deactivate command line option
users-list command line option
users-list-aliases command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-alias command line option
users-remove-role command line option
users-show command line option
users-update command line option
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
watchlists-add command line option
watchlists-bulk-add command line option
watchlists-bulk-remove command line option
watchlists-list command line option
watchlists-list-members command line option
watchlists-remove command line option
--departure-date
departing-employee-add command line option
--description
alerts-search command line option
alerts-send-to command line option
cases-create command line option
cases-update command line option
trusted-activities-create command line option
trusted-activities-update command line option
--disable-ssl-errors
profile-create command line option
profile-update command line option
--email
users-update command line option
--end
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
security-data-search command line option
security-data-send-to command line option
--end-create-time
cases-list command line option
--end-update-time
cases-list command line option
--event-id
cases-file-events-add command line option
cases-file-events-remove command line option
--event-type
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
--exclude-actor
alerts-search command line option
alerts-send-to command line option
--exclude-actor-contains
alerts-search command line option
alerts-send-to command line option
--exclude-most-recently-connected
devices-list command line option
--exclude-rule-id
alerts-search command line option
alerts-send-to command line option
--exclude-rule-name
alerts-search command line option
alerts-send-to command line option
--exclude-rule-type
alerts-search command line option
alerts-send-to command line option
--file-category
security-data-search command line option
security-data-send-to command line option
--file-name
security-data-search command line option
security-data-send-to command line option
--file-path
security-data-search command line option
security-data-send-to command line option
--filter
departing-employee-list command line option
high-risk-employee-list command line option
--findings
cases-create command line option
cases-update command line option
--first-name
users-update command line option
--format
alert-rules-list command line option
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
cases-file-events-list command line option
cases-list command line option
cases-show command line option
departing-employee-list command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-list command line option
devices-list-backup-sets command line option
high-risk-employee-list command line option
legal-hold-list command line option
legal-hold-search-events command line option
security-data-saved-search-list command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-list command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-list command line option
users-orgs-list command line option
users-orgs-show command line option
users-show command line option
watchlists-list command line option
watchlists-list-members command line option
--ignore-cert-validation
alerts-send-to command line option
audit-logs-send-to command line option
security-data-send-to command line option
--inactive
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--include-all
alerts-search command line option
alerts-send-to command line option
security-data-search command line option
--include-backup-usage
devices-list command line option
--include-file-events
cases-show command line option
--include-inactive
legal-hold-show command line option
--include-legal-hold-membership
devices-list command line option
users-list command line option
users-show command line option
--include-non-exposure
security-data-search command line option
security-data-send-to command line option
--include-observations
alerts-show command line option
--include-policy
legal-hold-show command line option
--include-roles
users-list command line option
--include-settings
devices-list command line option
--include-total-storage
devices-list command line option
--include-usernames
devices-list command line option
devices-list-backup-sets command line option
--last-connected-after
devices-list command line option
--last-connected-before
devices-list command line option
--last-name
users-update command line option
--matter-id
legal-hold-add-user command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
--md5
security-data-search command line option
security-data-send-to command line option
--name
cases-list command line option
cases-update command line option
profile-create command line option
profile-update command line option
--new-device-name
devices-rename command line option
--note
alerts-update command line option
--notes
departing-employee-add command line option
high-risk-employee-add command line option
users-update command line option
--only-included-users
watchlists-list-members command line option
--or-query
alerts-search command line option
alerts-send-to command line option
security-data-search command line option
security-data-send-to command line option
--org-id
users-move command line option
--org-uid
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--password
profile-create command line option
profile-update command line option
users-update command line option
--path
alert-rules-bulk-generate-template command line option
alerts-bulk-generate-template command line option
cases-export command line option
cases-file-events-bulk-generate-template command line option
departing-employee-bulk-generate-template command line option
devices-bulk-generate-template command line option
high-risk-employee-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
trusted-activities-bulk-generate-template command line option
users-bulk-generate-template command line option
watchlists-bulk-generate-template command line option
--process-owner
security-data-search command line option
security-data-send-to command line option
--profile
alert-rules-add-user command line option
alert-rules-bulk-add command line option
alert-rules-bulk-remove command line option
alert-rules-list command line option
alert-rules-remove-user command line option
alert-rules-show command line option
alerts-bulk-update command line option
alerts-clear-checkpoint command line option
alerts-search command line option
alerts-send-to command line option
alerts-show command line option
alerts-update command line option
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
cases-create command line option
cases-export command line option
cases-file-events command line option
cases-file-events-add command line option
cases-file-events-bulk-add command line option
cases-file-events-bulk-remove command line option
cases-file-events-list command line option
cases-file-events-remove command line option
cases-list command line option
cases-show command line option
cases-update command line option
departing-employee-add command line option
departing-employee-bulk-add command line option
departing-employee-bulk-remove command line option
departing-employee-list command line option
departing-employee-remove command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-bulk-add command line option
high-risk-employee-bulk-add-risk-tags command line option
high-risk-employee-bulk-remove command line option
high-risk-employee-bulk-remove-risk-tags command line option
high-risk-employee-list command line option
high-risk-employee-remove command line option
high-risk-employee-remove-risk-tags command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
security-data-clear-checkpoint command line option
security-data-saved-search command line option
security-data-saved-search-list command line option
security-data-saved-search-show command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-bulk-create command line option
trusted-activities-bulk-remove command line option
trusted-activities-bulk-update command line option
trusted-activities-create command line option
trusted-activities-list command line option
trusted-activities-remove command line option
trusted-activities-update command line option
users-add-alias command line option
users-add-role command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-deactivate command line option
users-list command line option
users-list-aliases command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-alias command line option
users-remove-role command line option
users-show command line option
users-update command line option
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
watchlists-add command line option
watchlists-bulk-add command line option
watchlists-bulk-remove command line option
watchlists-list command line option
watchlists-list-members command line option
watchlists-remove command line option
--protocol
alerts-send-to command line option
audit-logs-send-to command line option
security-data-send-to command line option
--purge-date
devices-bulk-deactivate command line option
devices-deactivate command line option
--risk-indicator
security-data-search command line option
security-data-send-to command line option
--risk-severity
security-data-search command line option
security-data-send-to command line option
--risk-tag
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-remove-risk-tags command line option
--role-name
users-add-role command line option
users-list command line option
users-remove-role command line option
--rule-id
alert-rules-add-user command line option
alert-rules-remove-user command line option
alerts-search command line option
alerts-send-to command line option
--rule-name
alerts-search command line option
alerts-send-to command line option
--rule-type
alerts-search command line option
alerts-send-to command line option
--saved-search
security-data-search command line option
security-data-send-to command line option
--server
profile-create command line option
profile-update command line option
--severity
alerts-search command line option
alerts-send-to command line option
--sha256
security-data-search command line option
security-data-send-to command line option
--source
security-data-search command line option
security-data-send-to command line option
--state
alerts-search command line option
alerts-send-to command line option
alerts-update command line option
--status
cases-list command line option
cases-update command line option
--subject
cases-create command line option
cases-list command line option
cases-update command line option
--tab-url
security-data-search command line option
security-data-send-to command line option
--totp
alert-rules-add-user command line option
alert-rules-bulk-add command line option
alert-rules-bulk-remove command line option
alert-rules-list command line option
alert-rules-remove-user command line option
alert-rules-show command line option
alerts-bulk-update command line option
alerts-clear-checkpoint command line option
alerts-search command line option
alerts-send-to command line option
alerts-show command line option
alerts-update command line option
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
cases-create command line option
cases-export command line option
cases-file-events command line option
cases-file-events-add command line option
cases-file-events-bulk-add command line option
cases-file-events-bulk-remove command line option
cases-file-events-list command line option
cases-file-events-remove command line option
cases-list command line option
cases-show command line option
cases-update command line option
departing-employee-add command line option
departing-employee-bulk-add command line option
departing-employee-bulk-remove command line option
departing-employee-list command line option
departing-employee-remove command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-bulk-add command line option
high-risk-employee-bulk-add-risk-tags command line option
high-risk-employee-bulk-remove command line option
high-risk-employee-bulk-remove-risk-tags command line option
high-risk-employee-list command line option
high-risk-employee-remove command line option
high-risk-employee-remove-risk-tags command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-update command line option
security-data-clear-checkpoint command line option
security-data-saved-search command line option
security-data-saved-search-list command line option
security-data-saved-search-show command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-bulk-create command line option
trusted-activities-bulk-remove command line option
trusted-activities-bulk-update command line option
trusted-activities-create command line option
trusted-activities-list command line option
trusted-activities-remove command line option
trusted-activities-update command line option
users-add-alias command line option
users-add-role command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-deactivate command line option
users-list command line option
users-list-aliases command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-alias command line option
users-remove-role command line option
users-show command line option
users-update command line option
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
watchlists-add command line option
watchlists-bulk-add command line option
watchlists-bulk-remove command line option
watchlists-list command line option
watchlists-list-members command line option
watchlists-remove command line option
--type
security-data-search command line option
security-data-send-to command line option
trusted-activities-list command line option
--use-checkpoint
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
security-data-search command line option
security-data-send-to command line option
--user-id
users-update command line option
--username
alert-rules-add-user command line option
alert-rules-remove-user command line option
legal-hold-add-user command line option
legal-hold-remove-user command line option
profile-create command line option
profile-update command line option
users-add-role command line option
users-move command line option
users-remove-role command line option
users-update command line option
--value
trusted-activities-update command line option
--watchlist-id
watchlists-add command line option
watchlists-list-members command line option
watchlists-remove command line option
--watchlist-type
watchlists-add command line option
watchlists-list-members command line option
watchlists-remove command line option
-b
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
security-data-search command line option
security-data-send-to command line option
-c
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
security-data-search command line option
security-data-send-to command line option
-d
alert-rules-add-user command line option
alert-rules-bulk-add command line option
alert-rules-bulk-remove command line option
alert-rules-list command line option
alert-rules-remove-user command line option
alert-rules-show command line option
alerts-bulk-update command line option
alerts-clear-checkpoint command line option
alerts-search command line option
alerts-send-to command line option
alerts-show command line option
alerts-update command line option
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
cases-create command line option
cases-export command line option
cases-file-events command line option
cases-file-events-add command line option
cases-file-events-bulk-add command line option
cases-file-events-bulk-remove command line option
cases-file-events-list command line option
cases-file-events-remove command line option
cases-list command line option
cases-show command line option
cases-update command line option
departing-employee-add command line option
departing-employee-bulk-add command line option
departing-employee-bulk-remove command line option
departing-employee-list command line option
departing-employee-remove command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-bulk-add command line option
high-risk-employee-bulk-add-risk-tags command line option
high-risk-employee-bulk-remove command line option
high-risk-employee-bulk-remove-risk-tags command line option
high-risk-employee-list command line option
high-risk-employee-remove command line option
high-risk-employee-remove-risk-tags command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-reset-pw command line option
profile-update command line option
security-data-clear-checkpoint command line option
security-data-saved-search command line option
security-data-saved-search-list command line option
security-data-saved-search-show command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-bulk-create command line option
trusted-activities-bulk-remove command line option
trusted-activities-bulk-update command line option
trusted-activities-create command line option
trusted-activities-list command line option
trusted-activities-remove command line option
trusted-activities-update command line option
users-add-alias command line option
users-add-role command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-deactivate command line option
users-list command line option
users-list-aliases command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-alias command line option
users-remove-role command line option
users-show command line option
users-update command line option
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
watchlists-add command line option
watchlists-bulk-add command line option
watchlists-bulk-remove command line option
watchlists-list command line option
watchlists-list-members command line option
watchlists-remove command line option
-e
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
audit-logs-send-to command line option
security-data-search command line option
security-data-send-to command line option
-f
alert-rules-list command line option
alerts-search command line option
alerts-send-to command line option
audit-logs-search command line option
cases-file-events-list command line option
cases-list command line option
cases-show command line option
departing-employee-list command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-list command line option
devices-list-backup-sets command line option
high-risk-employee-list command line option
legal-hold-list command line option
legal-hold-search-events command line option
security-data-saved-search-list command line option
security-data-search command line option
security-data-send-to command line option
trusted-activities-list command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
users-list command line option
users-orgs-list command line option
users-orgs-show command line option
users-show command line option
watchlists-list command line option
watchlists-list-members command line option
-m
legal-hold-add-user command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
-n
devices-rename command line option
profile-create command line option
profile-update command line option
-p
alert-rules-bulk-generate-template command line option
alerts-bulk-generate-template command line option
alerts-send-to command line option
audit-logs-send-to command line option
cases-file-events-bulk-generate-template command line option
departing-employee-bulk-generate-template command line option
devices-bulk-generate-template command line option
high-risk-employee-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
security-data-send-to command line option
trusted-activities-bulk-generate-template command line option
users-bulk-generate-template command line option
watchlists-bulk-generate-template command line option
-s
profile-create command line option
profile-update command line option
-t
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-remove-risk-tags command line option
security-data-search command line option
security-data-send-to command line option
-u
alert-rules-add-user command line option
alert-rules-remove-user command line option
legal-hold-add-user command line option
legal-hold-remove-user command line option
profile-create command line option
profile-update command line option
-y
profile-delete command line option
profile-delete-all command line option
[USER_ID|USERNAME]
watchlists-add command line option
watchlists-remove command line option
A
alert-rules-add-user command line option
--debug
--profile
--rule-id
--totp
--username
-d
-u
alert-rules-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
alert-rules-bulk-generate-template command line option
--path
-p
CMD
alert-rules-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
alert-rules-list command line option
--debug
--format
--profile
--totp
-d
-f
alert-rules-remove-user command line option
--debug
--profile
--rule-id
--totp
--username
-d
-u
alert-rules-show command line option
--debug
--profile
--totp
-d
RULE_ID
ALERT_ID
alerts-show command line option
alerts-update command line option
alerts-bulk-generate-template command line option
--path
-p
CMD
alerts-bulk-update command line option
--debug
--profile
--totp
-d
CSV_FILE
alerts-clear-checkpoint command line option
--debug
--profile
--totp
-d
CHECKPOINT_NAME
alerts-search command line option
--actor
--actor-contains
--advanced-query
--begin
--debug
--description
--end
--exclude-actor
--exclude-actor-contains
--exclude-rule-id
--exclude-rule-name
--exclude-rule-type
--format
--include-all
--or-query
--profile
--rule-id
--rule-name
--rule-type
--severity
--state
--totp
--use-checkpoint
-b
-c
-d
-e
-f
alerts-send-to command line option
--actor
--actor-contains
--advanced-query
--begin
--certs
--debug
--description
--end
--exclude-actor
--exclude-actor-contains
--exclude-rule-id
--exclude-rule-name
--exclude-rule-type
--format
--ignore-cert-validation
--include-all
--or-query
--profile
--protocol
--rule-id
--rule-name
--rule-type
--severity
--state
--totp
--use-checkpoint
-b
-c
-d
-e
-f
-p
HOSTNAME
alerts-show command line option
--debug
--include-observations
--profile
--totp
-d
ALERT_ID
alerts-update command line option
--debug
--note
--profile
--state
--totp
-d
ALERT_ID
ALIAS
users-add-alias command line option
users-remove-alias command line option
audit-logs-clear-checkpoint command line option
--debug
--profile
--totp
-d
CHECKPOINT_NAME
audit-logs-search command line option
--actor-ip
--actor-user-id
--actor-username
--affected-user-id
--affected-username
--begin
--debug
--end
--event-type
--format
--profile
--totp
--use-checkpoint
-b
-c
-d
-e
-f
audit-logs-send-to command line option
--actor-ip
--actor-user-id
--actor-username
--affected-user-id
--affected-username
--begin
--certs
--debug
--end
--event-type
--ignore-cert-validation
--profile
--protocol
--totp
--use-checkpoint
-b
-c
-d
-e
-p
HOSTNAME
C
CASE_NUMBER
cases-export command line option
cases-file-events-list command line option
cases-show command line option
cases-update command line option
cases-create command line option
--assignee
--debug
--description
--findings
--profile
--subject
--totp
-d
NAME
cases-export command line option
--debug
--path
--profile
--totp
-d
CASE_NUMBER
cases-file-events command line option
--debug
--profile
--totp
-d
cases-file-events-add command line option
--case-number
--debug
--event-id
--profile
--totp
-d
cases-file-events-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
cases-file-events-bulk-generate-template command line option
--path
-p
CMD
cases-file-events-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
cases-file-events-list command line option
--debug
--format
--profile
--totp
-d
-f
CASE_NUMBER
cases-file-events-remove command line option
--case-number
--debug
--event-id
--profile
--totp
-d
cases-list command line option
--assignee
--begin-create-time
--begin-update-time
--debug
--end-create-time
--end-update-time
--format
--name
--profile
--status
--subject
--totp
-d
-f
cases-show command line option
--debug
--format
--include-file-events
--profile
--totp
-d
-f
CASE_NUMBER
cases-update command line option
--assignee
--debug
--description
--findings
--name
--profile
--status
--subject
--totp
-d
CASE_NUMBER
CHECKPOINT_NAME
alerts-clear-checkpoint command line option
audit-logs-clear-checkpoint command line option
security-data-clear-checkpoint command line option
CMD
alert-rules-bulk-generate-template command line option
alerts-bulk-generate-template command line option
cases-file-events-bulk-generate-template command line option
departing-employee-bulk-generate-template command line option
devices-bulk-generate-template command line option
high-risk-employee-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
trusted-activities-bulk-generate-template command line option
users-bulk-generate-template command line option
watchlists-bulk-generate-template command line option
CSV_FILE
alert-rules-bulk-add command line option
alert-rules-bulk-remove command line option
alerts-bulk-update command line option
cases-file-events-bulk-add command line option
cases-file-events-bulk-remove command line option
departing-employee-bulk-add command line option
departing-employee-bulk-remove command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
high-risk-employee-bulk-add command line option
high-risk-employee-bulk-add-risk-tags command line option
high-risk-employee-bulk-remove command line option
high-risk-employee-bulk-remove-risk-tags command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
trusted-activities-bulk-create command line option
trusted-activities-bulk-remove command line option
trusted-activities-bulk-update command line option
users-bulk-add-alias command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-alias command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-bulk-update-risk-profile command line option
watchlists-bulk-add command line option
watchlists-bulk-remove command line option
D
DATE
users-update-departure-date command line option
users-update-start-date command line option
departing-employee-add command line option
--cloud-alias
--debug
--departure-date
--notes
--profile
--totp
-d
USERNAME
departing-employee-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
departing-employee-bulk-generate-template command line option
--path
-p
CMD
departing-employee-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
departing-employee-list command line option
--debug
--filter
--format
--profile
--totp
-d
-f
departing-employee-remove command line option
--debug
--profile
--totp
-d
USERNAME
DEVICE_GUID
devices-deactivate command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
devices-bulk-deactivate command line option
--change-device-name
--debug
--format
--profile
--purge-date
--totp
-d
-f
CSV_FILE
devices-bulk-generate-template command line option
--path
-p
CMD
devices-bulk-reactivate command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
devices-bulk-rename command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
devices-deactivate command line option
--change-device-name
--debug
--profile
--purge-date
--totp
-d
DEVICE_GUID
devices-list command line option
--active
--created-after
--created-before
--debug
--exclude-most-recently-connected
--format
--inactive
--include-backup-usage
--include-legal-hold-membership
--include-settings
--include-total-storage
--include-usernames
--last-connected-after
--last-connected-before
--org-uid
--profile
--totp
-d
-f
devices-list-backup-sets command line option
--active
--debug
--format
--inactive
--include-usernames
--org-uid
--profile
--totp
-d
-f
devices-reactivate command line option
--debug
--profile
--totp
-d
DEVICE_GUID
devices-rename command line option
--debug
--new-device-name
--profile
--totp
-d
-n
DEVICE_GUID
devices-show command line option
--debug
--profile
--totp
-d
DEVICE_GUID
H
high-risk-employee-add command line option
--cloud-alias
--debug
--notes
--profile
--risk-tag
--totp
-d
-t
USERNAME
high-risk-employee-add-risk-tags command line option
--debug
--profile
--risk-tag
--totp
-d
-t
USERNAME
high-risk-employee-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
high-risk-employee-bulk-add-risk-tags command line option
--debug
--profile
--totp
-d
CSV_FILE
high-risk-employee-bulk-generate-template command line option
--path
-p
CMD
high-risk-employee-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
high-risk-employee-bulk-remove-risk-tags command line option
--debug
--profile
--totp
-d
CSV_FILE
high-risk-employee-list command line option
--debug
--filter
--format
--profile
--totp
-d
-f
high-risk-employee-remove command line option
--debug
--profile
--totp
-d
USERNAME
high-risk-employee-remove-risk-tags command line option
--debug
--profile
--risk-tag
--totp
-d
-t
USERNAME
HOSTNAME
alerts-send-to command line option
audit-logs-send-to command line option
security-data-send-to command line option
L
legal-hold-add-user command line option
--debug
--matter-id
--profile
--totp
--username
-d
-m
-u
legal-hold-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
legal-hold-bulk-generate-template command line option
--path
-p
CMD
legal-hold-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
legal-hold-list command line option
--debug
--format
--profile
--totp
-d
-f
legal-hold-remove-user command line option
--debug
--matter-id
--profile
--totp
--username
-d
-m
-u
legal-hold-search-events command line option
--begin
--debug
--end
--event-type
--format
--matter-id
--profile
--totp
-d
-f
-m
legal-hold-show command line option
--debug
--include-inactive
--include-policy
--profile
--totp
-d
MATTER_ID
M
MATTER_ID
legal-hold-show command line option
N
NAME
cases-create command line option
NOTE
users-update-risk-profile-notes command line option
O
ORG_UID
users-orgs-show command line option
P
profile-create command line option
--debug
--disable-ssl-errors
--name
--password
--server
--totp
--username
-d
-n
-s
-u
profile-delete command line option
--assume-yes
-y
PROFILE_NAME
profile-delete-all command line option
--assume-yes
-y
profile-reset-pw command line option
--debug
-d
PROFILE_NAME
profile-show command line option
PROFILE_NAME
profile-update command line option
--debug
--disable-ssl-errors
--name
--password
--server
--totp
--username
-d
-n
-s
-u
profile-use command line option
PROFILE_NAME
PROFILE_NAME
profile-delete command line option
profile-reset-pw command line option
profile-show command line option
profile-use command line option
R
RESOURCE_ID
trusted-activities-remove command line option
trusted-activities-update command line option
RULE_ID
alert-rules-show command line option
S
SEARCH_ID
security-data-saved-search-show command line option
security-data-clear-checkpoint command line option
--debug
--profile
--totp
-d
CHECKPOINT_NAME
security-data-saved-search command line option
--debug
--profile
--totp
-d
security-data-saved-search-list command line option
--debug
--format
--profile
--totp
-d
-f
security-data-saved-search-show command line option
--debug
--profile
--totp
-d
SEARCH_ID
security-data-search command line option
--actor
--advanced-query
--begin
--c42-username
--columns
,
[1]
--debug
--end
--file-category
--file-name
--file-path
--format
--include-all
--include-non-exposure
--md5
--or-query
--process-owner
--profile
--risk-indicator
--risk-severity
--saved-search
--sha256
--source
--tab-url
--totp
--type
--use-checkpoint
-b
-c
-d
-e
-f
-t
security-data-send-to command line option
--actor
--advanced-query
--begin
--c42-username
--certs
--columns
--debug
--end
--file-category
--file-name
--file-path
--format
--ignore-cert-validation
--include-non-exposure
--md5
--or-query
--process-owner
--profile
--protocol
--risk-indicator
--risk-severity
--saved-search
--sha256
--source
--tab-url
--totp
--type
--use-checkpoint
-b
-c
-d
-e
-f
-p
-t
HOSTNAME
T
trusted-activities-bulk-create command line option
--debug
--profile
--totp
-d
CSV_FILE
trusted-activities-bulk-generate-template command line option
--path
-p
CMD
trusted-activities-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
trusted-activities-bulk-update command line option
--debug
--profile
--totp
-d
CSV_FILE
trusted-activities-create command line option
--debug
--description
--profile
--totp
-d
TYPE
VALUE
trusted-activities-list command line option
--debug
--format
--profile
--totp
--type
-d
-f
trusted-activities-remove command line option
--debug
--profile
--totp
-d
RESOURCE_ID
trusted-activities-update command line option
--debug
--description
--profile
--totp
--value
-d
RESOURCE_ID
TYPE
trusted-activities-create command line option
U
USERNAME
departing-employee-add command line option
departing-employee-remove command line option
high-risk-employee-add command line option
high-risk-employee-add-risk-tags command line option
high-risk-employee-remove command line option
high-risk-employee-remove-risk-tags command line option
users-add-alias command line option
users-deactivate command line option
users-list-aliases command line option
users-reactivate command line option
users-remove-alias command line option
users-show command line option
users-update-departure-date command line option
users-update-risk-profile-notes command line option
users-update-start-date command line option
users-add-alias command line option
--debug
--profile
--totp
-d
ALIAS
USERNAME
users-add-role command line option
--debug
--profile
--role-name
--totp
--username
-d
users-bulk-add-alias command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-add-roles command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-deactivate command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-generate-template command line option
--path
-p
CMD
users-bulk-move command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-reactivate command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-remove-alias command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-remove-roles command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-update command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-update-risk-profile command line option
--append-notes
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-deactivate command line option
--debug
--profile
--totp
-d
USERNAME
users-list command line option
--active
--debug
--format
--inactive
--include-legal-hold-membership
--include-roles
--org-uid
--profile
--role-name
--totp
-d
-f
users-list-aliases command line option
--debug
--profile
--totp
-d
USERNAME
users-move command line option
--debug
--org-id
--profile
--totp
--username
-d
users-orgs-list command line option
--debug
--format
--profile
--totp
-d
-f
users-orgs-show command line option
--debug
--format
--profile
--totp
-d
-f
ORG_UID
users-reactivate command line option
--debug
--profile
--totp
-d
USERNAME
users-remove-alias command line option
--debug
--profile
--totp
-d
ALIAS
USERNAME
users-remove-role command line option
--debug
--profile
--role-name
--totp
--username
-d
users-show command line option
--debug
--format
--include-legal-hold-membership
--profile
--totp
-d
-f
USERNAME
users-update command line option
--archive-size-quota
--debug
--email
--first-name
--last-name
--notes
--password
--profile
--totp
--user-id
--username
-d
users-update-departure-date command line option
--clear
--debug
--profile
--totp
-d
DATE
USERNAME
users-update-risk-profile-notes command line option
--append
--clear
--debug
--profile
--totp
-d
NOTE
USERNAME
users-update-start-date command line option
--clear
--debug
--profile
--totp
-d
DATE
USERNAME
V
VALUE
trusted-activities-create command line option
W
watchlists-add command line option
--debug
--profile
--totp
--watchlist-id
--watchlist-type
-d
[USER_ID|USERNAME]
watchlists-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
watchlists-bulk-generate-template command line option
--path
-p
CMD
watchlists-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
watchlists-list command line option
--debug
--format
--profile
--totp
-d
-f
watchlists-list-members command line option
--debug
--format
--only-included-users
--profile
--totp
--watchlist-id
--watchlist-type
-d
-f
watchlists-remove command line option
--debug
--profile
--totp
--watchlist-id
--watchlist-type
-d
[USER_ID|USERNAME]
Read the Docs
v: v1.14.4
Versions
latest
stable
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.13.0
v1.12.1
v1.12.0
v1.11.1
v1.11.0
v1.10.0
v1.9.0
v1.8.1
v1.8.0
v1.7.0
v1.6.1
v1.6.0
v1.5.1
v1.5.0
v1.4.2
v1.4.1
v1.4.0
v1.3.1
v1.3.0
v1.2.0
v1.1.0
v1.0.0
feature-extension_scripts
Downloads
On Read the Docs
Project Home
Builds