Admin Guide

Synapse-DomainIQ Admin Guide

Configuration

Synapse-DomainIQ requires a DomainIQ API key. For information on how to sign up, please visit the DomainIQ API documentation.

Setting API key for global use

To set-up a global API key:

> domainiq.setup.apikey myapikey
Setting DomainIQ API key for all users.

Using per-user API keys

A user may set-up their own API key:

> domainiq.setup.apikey --self myapikey
Setting DomainIQ API key for the current user.

Permissions

Package (synapse-domainiq) defines the following permissions:
power-ups.domainiq.user          : Controls user access to Synapse-DomainIQ. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.domainiq.user
Added rule power-ups.domainiq.user to user visi.

or:

> auth.role.addrule ninjas power-ups.domainiq.user
Added rule power-ups.domainiq.user to role ninjas.

Exported APIs

Synapse-DomainIQ does not currently export any APIs.

Workflows

Synapse-DomainIQ provides the following workflows in Optic:

Title: Configuration

Node Actions

Synapse-DomainIQ provides the following node actions in Optic:

Name : whois
Desc : Enrich nodes with WHOIS data using Synapse-DomainIQ
Forms: inet:fqdn

Name : whois history
Desc : Enrich nodes with WHOIS history data using Synapse-DomainIQ
Forms: inet:fqdn

Name : reverse lookup
Desc : Enrich nodes with reverse lookup data using Synapse-DomainIQ
Forms: inet:dns:mx, inet:dns:ns, inet:email, inet:fqdn, inet:ipv4, inet:whois:email, inet:whois:recns