Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameanalysis
nopaneltrue


Fiona-todo: update http collector to add a link to this page

This page is for ...

Overview

DEV-10937:

  • HTTP Datasources → Properties →  Secret Key Details
  • Datasource instances → Username/Password or Username Key/Password Key
  • HTTP Headers Properties → Basic Settings → Value (question)
  • HTTP collectors → URL expression or Statement Expression

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. In order to provide a username and/or password securely,

Configure 

  - a secret key, which defines the public name and points to

  - a local secret. This is a PhixFlow item that stores encrypted data in the PhixFlow database.

In order to provide a password securely:

  • Create a local secret that contains the password
  • Create a secret key that "points to" the local secret
  • In the HTTP collector expression, specify the secret key name.                                                     

    Configure a key/value pair using the PhixFlow items:  

    1.   In a HTTP Datasource properties → Secret Key Details, create a secret key.
    2.   Add the value to the local secret. PhixFlow encrypts the local secret.

    You can use the secret key name to refer to the encrypted value in the following places:

    • HTTP Datasources → Properties →  Secret Key Details
    • Datasource instances → Username/Password or Username Key/Password Key
    • HTTP Headers Properties → Basic Settings → Value (question)
    • HTTP collectors → URL expression or Statement Expression                                                                                                                                                              

    When you run analysis

    PhixFlow then finds the secure credentials in the keystore and provides them to authenticate to the external site.

    Insert excerpt
    _property_toolbar
    _property_toolbar
    nopaneltrue

    Insert excerpt
    _property_tabs
    _property_tabs
    namebasic-h
    nopaneltrue

    Insert excerpt
    _parent
    _parent
    nopaneltrue

    Local Secret

    FieldDescription
    KeyRead only. This key will match the key of the Secret Key.
    SecretThe secret value that will be available in expressions where the Secret Key name is used.

    Basic Settings

    FieldDescription
    NameEnter a name. You will use this name in expressions to refer to this key.
    KeyRead only. PhixFlow generates a unique key value used to refer to the secret.
    Enabled

     

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to indicate you have completed the properties and the secret key is ready to use.

    If ticked there will be a secret value corresponding to this key, which may be null.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     means a reference to this secret key in an expression will fail.

    SecretRead only. When the secret key has been saved, the secret can be edited.


    Live Search
    spaceKey@self
    additionalnone
    placeholderSearch all help pages
    typepage

    Panel
    borderColor#00374F
    titleColorwhite
    titleBGColor#00374F
    borderStylesolid
    titleSections on this page

    Table of Contents
    maxLevel3
    indent12px
    stylenone

    Learn More

    For links to all pages in this topic, see Analysis Models for Batch Processing Data.

    Insert excerpt
    _terms_changing
    _terms_changing
    nopaneltrue