Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
This page is for data modellers who need to provide securely-stored credentials to access data via HTTP.
Overview
When importing data via HTTP, you sometimes need to provide authentication to an external site. There are several options for how to store and then reference the username and password; see Authenticating for an API. One option is to use the HTTP datasource properties → the Secret Key section to create a key associated with the username or password, which is encrypted and stored in the PhixFlow database.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Secret Key
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Name | Enter a name.
${_datasource.key} . | ||||||||
| Key | Read-only. When you save the secret key, PhixFlow automatically generates a unique key in this field. The key is a combination of the Name and the internal ID of the HTTP datasource.
| ||||||||
| Enabled | |
to indicate you have completed configuring the secret key and associated local secret value, and it is ready to use. The local secret value may be null.
| |||||||||||||||||||||||||
| Secret | Click
When you save the local secret, PhixFlow displays asterisks here to show that the secret value has been encrypted. To edit a secret value, click
To delete a secret value, click
You can save the secret key without adding a secret. In this case, you must add the secret key and a value to the keystore; see Authenticating for an API and Adding Data to a Keystore. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Local Secret
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Key | Read-only. The same automatically-generated key in the secret key is paired with this local secret. | ||||||||
| Secret | Enter the value that you want to encrypt, such as a password. To switch between displaying or hiding the value, click
PhixFlow encrypts the value when storing it in the database, but when it is required to authenticate to an external site, PhixFlow supplies the unencrypted string. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
External Secret (Keystore)
Secret values such as passwords can be held in the Java Keystore used as part of your PhixFlow installation. This enables a single instance of the secret to exist outside off PhixFlow.
Setup
- In PhixFlow, open the Properties of the HTTP of Database Datasource where the secret value will be used.
- In the Advanced section, record the 32 character Internal ID.
- Create an entry on the server Keystore with the naming convention
datasourceInternalID.KeyName.Where the KeyName should be unique from any other secret name used in PhixFlow.Info title Example b813b1bc5554e1259cc8cbd1087ca4ab.password
- The Datasource can now reference the secret using the syntax, _datasource.KeyName
Info _datasource.
- PhixFlow will now use the Keystore value secret.
- Note, PhixFlow checks for a local secret with the KeyName first and if one exists it will be used. If one is not found PhixFlow checks the keystore for the value and uses it where found. All names are case-sensitive.
Using a Secret
For HTTP objects connected to the HTTP datasource, and HTTP Action nodes you can reference a secret key in:
- HTTP collectors Collectors and HTTP exporters → Exporters → URL Expression or or Statement Expression
- HTTP Headers Properties → → Basic Settings → → Value.
- HTTP Action → Headers
| Insert excerpt |
|---|
|
|
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Learn More
For links to all pages in this topic, see Analysis Models for Batch Processing Data.