Package Documentation
Storm Package: synapse-doppel
The following Commands are available from this package. This documentation is generated for version 0.1.0 of the package.
Storm Commands
This package implements the following Storm Commands.
doppel.alert.get
Retrieve a Doppel alert by ID.
Doppel alerts can be retrieved by using --id <DOPPEL ID> or by an inbound
risk:alert node with the :ext:id property set to the Doppel ID to be
retrieved.
Examples:
// Retrieve the specified Doppel alert and yield the risk:alert node
doppel.alert.get --id VEX-10 --yield
// Retrieve an alert with an inbound risk:alert node
[ risk:alert=({"ext:id": "VEX-10"}) ] | doppel.alert.get
// Override the default config
doppel.alert.get --id VEX-10 --config myconfig
Endpoints:
/v1/alert : Retrieves an alert by ID or entity (phone number or URL). These alerts can be generated
from both Brand Protection and Email Resilience.
Usage: doppel.alert.get [options]
Options:
--help : Display the command usage.
--id <id> : The Doppel alert ID to retrieve. (default: None)
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
--config <config> : Override the default config with the provided name.
Inputs:
risk:alert : Update the inbound risk:alert node
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.alerts
Retrieve Doppel alerts as a feed.
The --since-last option can be used to retrieve new results since the last run of
the command. When using --since-last, the time of the query execution will be
stored in the :latest property of an associated meta:feed node. This means
the last time will be tracked per-view and may be overwritten if the same query is
run in multiple forks and subsequently merged.
When using --since-last, the --min-activity-time, --min-created-time, and
--max-created-time options are ignored.
If an inbound inet:url node is provided, this command will only query for alerts
regarding the specified URL.
Examples:
// Retrieve all Doppel alerts
doppel.alerts
// Use the per-view stored value to retrieve new results
doppel.alerts --since-last
// Override the default config
doppel.alerts --config myconfig
// Create a cron job to ingest new results every day
cron.add --name doppel.alerts --hour 3 { doppel.alerts --since-last }
Endpoints:
/v1/alerts : Retrieves a list of alerts across all Doppel products (Brand Protection and Email
Resilience), with support for filtering and sorting by key attributes.
Usage: doppel.alerts [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--size <size> : Limit the number of results ingested to the given size.
--yield : Yield the newly created nodes.
--product <product> : Only retrieve alerts for the specified product. (default: None)
--min-activity-time <min_activity_time>: Specify the minimum time to limit feed results.
--min-created-time <min_created_time>: Specify the minimum time to limit feed results.
--max-created-time <max_created_time>: Specify the maximum time to limit feed results.
--since-last : Retrieve results since the last run of the command with --since-last specified.
--config <config> : Override the default config with the provided name.
Inputs:
inet:url : Only retrieve alerts about the specified URL
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.config.add
Add a Synapse-Doppel configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global configuration
doppel.config.add global_config apikey1234 userapikey5678
// Add a configuration for the current user
doppel.config.add --scope self my_config apikey5678 userapikey5678
Usage: doppel.config.add [options] <name> <apikey> <user-apikey>
Options:
--help : Display the command usage.
--organization-code <organization_code>: The organization to act on behalf of.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Doppel. (default: rep.doppel)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
<apikey> : The API key string.
<user_apikey> : The User API key string.
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.config.del
Delete a Synapse-Doppel configuration.
Examples:
// Delete the "fooconfig" configuration
doppel.config.del fooconfig
Usage: doppel.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.config.list
Display the list of Synapse-Doppel configurations you have access to.
Usage: doppel.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.config.migrate
Migrate options for all Synapse-Doppel configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Migrate the tag prefix for all configurations
doppel.config.migrate --tag-prefix my.tagpref
Usage: doppel.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Doppel. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.admin
doppel.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
doppel.config.show
// Show a configuration by name
doppel.config.show myconfig
Usage: doppel.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
doppel.config.update
Update the configuration of a defined Synapse-Doppel configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "fooconfig"
// configuration
doppel.config.update fooconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "fooconfig" configuration
doppel.config.update fooconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "fooconfig"
doppel.config.update fooconfig --ssl-verify (false)
// Change the name of the "fooconfig" configuration to "barconfig"
doppel.config.update fooconfig --name barconfig
Usage: doppel.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The API key string. (default: None)
--user-apikey <user_apikey> : The User API key string. (default: None)
--organization-code <organization_code>: The organization code to act on behalf of. (default: None)
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Doppel. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.doppel.adminpower-ups.doppel.user
Storm Modules
This package does not export any Storm APIs.