Connectors FAQs

How does a Lucidum connector access the various data sources and consume the data? #

Answer: Lucidum uses the data source’s API library or REST API requests to get the data.

How does a connector authenticate itself to consume the data from the API? #

Answer:  some data sources use username + password; some use API key + API secret; some use client id + client secret + scopes. The 3rd way is usually OAuth-based and it may have different versions but the general process is the resource owner uses the client id and secret to get the authorization code and then sends an HTTP request to exchange the authorization code for an access token and refresh token. The resource owner then sends the tokens to the Lucidum connector which uses the tokens to consume the data from the API.

What does the Lucidum connector do to the customer data set via the API? #

Answer: connectors only read from data sources and don’t modify the customer data set.

How frequently do the Lucidum connectors run? #

Answer: each connector runs once a day.

What are Lucidum’s Connector Parameter Requirements? #

Connectors usually require a common set of parameters:

  • Host Name/IP Address/Domain. The hostname or IP address of the data source server. It is where the connectors fetch the data.

  • Port. Connection port.

  • Scope. Defines the boundary in which the above credentials apply.

  • Verify SSL. For future use.

  • One of the following type of authentication information:

    • User Name and Password. The credentials for a user account that has the permissions to fetch assets.

    • API Key. An API key associated with a user account that has permissions to fetch assets.

    • Client ID and Client Secret. Usually the customer needs to register an App client.

    • AWS Access Key ID and AWS Access Key Secret

    • User Name and API Key. The credentials for a user account that has the required permissions to fetch assets. Examples include Auvik and Jira assets platform and the Jira software platform. You need not just the API key but also the user name for this category.

    • JSON Key pair for the service account. A JSON document containing service-account credentials.

    • Email of an admin account and JSON Key pair for the service account.

Please also be aware that each data custodian might have different products or platforms which might have different authentication methods.