Admin Guide
Synapse-Proofpoint Admin Guide
Configuration
Synapse-Proofpoint requires a Proofpoint API key. For information on how to sign up, please visit the Proofpoint API documentation.
Setting the configuration for global use
To set-up a global configuration:
> proofpoint.config.add global_config global_apikey
Synapse-Proofpoint config "global_config" added
Creating a configuration for role-based use
Add an unscoped configuration:
> proofpoint.config.add myunscoped myapikey --scope unscoped
Synapse-Proofpoint config "myunscoped" added
Grant another user admin permissions to the new configuration:
> proofpoint.config.update myunscoped --perm user visi admin
Updated Synapse-Proofpoint config "myunscoped"
Grant a role read permissions to the new configuration:
> proofpoint.config.update myunscoped --perm role ninjas read
Updated Synapse-Proofpoint config "myunscoped"
Overriding the proxy configuration
In order to override the default proxy configuration in the Cortex the user must have the
power-ups.proofpoint.admin
or storm.lib.inet.http.proxy
permission.
When the proxy configuration is set to (false)
or a URL the permission will be checked
when a configuration is created/updated, and when it is used to make an HTTP request.
Dependencies
Synapse-Proofpoint does not have any dependencies.
Permissions
Package (synapse-proofpoint) defines the following permissions:
power-ups.proofpoint.user : Controls user access to Synapse-Proofpoint. ( default: false )
power-ups.proofpoint.admin : Controls access to Synapse-Proofpoint admin options. ( default: false )
You may add rules to users/roles directly from Storm:
> auth.user.addrule visi power-ups.proofpoint.user
Added rule power-ups.proofpoint.user to user visi.
or:
> auth.role.addrule ninjas power-ups.proofpoint.user
Added rule power-ups.proofpoint.user to role ninjas.
Workflows
Synapse-Proofpoint provides the following workflows in Optic:
Title: Configuration
Node Actions
Synapse-Proofpoint does not provide any node actions in Optic.