Admin Guide¶
Synapse-Apollo Admin Guide¶
Configuration¶
Synapse-Apollo requires an Apollo API key. For information on how to sign up, please visit the Apollo website.
Setting API key for global use¶
To set-up a global API key:
> apollo.setup.apikey myapikey
Setting Synapse-Apollo API key for all users.
Using per-user API keys¶
A user may set-up their own API key:
> apollo.setup.apikey --self myapikey
Setting Synapse-Apollo API key for the current user.
Permissions¶
Package (synapse-apollo) defines the following permissions:
power-ups.apollo.user : Controls user access to Synapse-Apollo.
power-ups.apollo.spend : Controls access to Apollo APIs that incur a query cost.
You may add rules to users/roles directly from storm:
> auth.user.addrule visi power-ups.apollo.user
User (visi) added rule: power-ups.apollo.user
or:
> auth.role.addrule ninjas power-ups.apollo.user
Role (ninjas) added rule: power-ups.apollo.user
Exported APIs¶
Synapse-Apollo does not currently export any APIs.
Node Actions¶
Synapse-Apollo provides the following node actions in Optic:
Name : generate an org
Desc : Generate an ou:org node from the inet:fqdn
Forms: inet:fqdn
Name : search for people (by org fqdn)
Desc : Populate ps:contacts for the orgs inet:fqdn
Forms: inet:fqdn
Name : search for people
Desc : Populate ps:contacts for the given ou:org
Forms: ou:org
Onload Events¶
Synapse-Apollo uses an onload
to initialize 2 extended model properties:
inet:fqdn:_apollo:id¶
The extended property _apollo:id
property added to the inet:fqdn
form is used to record
Apollo API organization ID associated with that inet:fqdn
as the primary domain.
ps:contact:_apollo:id¶
The extended property _apollo:id
property added to the ps:contact
form is used to record
Apollo API person ID used as the basis to construct the ps:contact
node.