express-gateway-plugin-skyflow-api v0.0.1-beta.1

express-gateway-plugin-skyflowapi

Introduction

The Skyflow plugin for Express Gateway helps you to quickly integrate with Skyflow Vault APIs. You can use the plugin policies within Express Gateway Pipelines to perform the actions on the request payload to the inbound routes.

Installation

To add express-gateway-plugin-skyflowapi to your dependencies, run the following command:

    "express-gateway-plugin-skyflow-api": "git+ssh://github.com/skyflowtech/express-gateway-plugin-skyflowapi.git"

Example

A sample gateway with Skyflow API policy is available in the examples folder. Create a Vault in Skyflow and replace the parameters listed in the gateway.config.yml file.

Quick start

1. Create a Vault in Skyflow Studio.

2. Create a Service Account for the vault. Download the Service Account credentials.

3. Add the plugin to the system config file as follows:

plugins:
  skyflow-api: {}

4. Add the configuration keys to the gateway.config.yml file.

policies:
  - skyflow-api:
      - action:
          search: 
            searchField : <field in the skyflow vault> #Ex primary_email
            searchKey : <field in the request body> #key in your request body
            dlp: <dlp filter level you want to query the data.> #Currently accepts Plain_Text,TOKEN
            tableName: customers
            workspaceUrl: <your skyflow workspace url> 
            vaultId: <vault id>
            serviceAccountFile: <path to service account file>

Documentation

You can find the complete documentation in the Documentation page.