Log Obfuscation Interceptor Addition (ssd api-management add (plan | api)-interceptor log-obfuscation)

The ssd api-management add (plan | api)-interceptor log-obfuscation command allows you to add a "Log Obfuscation" interceptor to an API or plan flow on Sensedia API Platform.

You can use the ssd api-management add (plan | api)-interceptor log-obfuscation command or its shortened version ssd apim add (plan | api)-interceptor log-obfuscation.

Usage

The ssd api-management add (plan | api)-interceptor log-obfuscation command can be followed by flags with their corresponding arguments:

ssd api-management add (plan | api)-interceptor log-obfuscation [flags]

If no flag is specified, the interactive mode will be activated.

Below you will find usage examples in the direct mode:

# Adds a "Log Obfuscation" interceptor to the API or plan Inbound flow for all of its resources and methods
$ ssd (api-management | apim) add api-interceptor log-obfuscation --api-name "Open Banking" --api-version "1.0.0" --revision 1 --flow INBOUND --location BODY --custom-regex "[\+\-\w.]+" --replace-to "#####"
$ ssd (api-management | apim) add plan-interceptor log-obfuscation --plan-name "Plan Name" --flow INBOUND --location BODY --custom-regex "[\+\-\w.]+" --replace-to "#####"

# Adds a "Log Obfuscation" interceptor in the API or plan Outbound flow to obfuscate an attribute in the header
$ ssd (api-management | apim) add api-interceptor log-obfuscation --api-name "Open Banking" --api-version "1.0.0" --revision 1 --flow OUTBOUND --location HEADER --attribute "password" --replace-to "******"
$ ssd (api-management | apim) add plan-interceptor log-obfuscation --plan-name "Plan Name" --flow OUTBOUND --location HEADER --attribute "password" --replace-to "******"

Available Flags

The following flags can be used with the ssd (api-management | apim) add (plan | api)-interceptor log-obfuscation command:

Flag

Type

Description

Flags for APIs

-n, --api-name

string

API name to which the interceptor will be added

-s, --revision

string

API revision to which the interceptor will be added

-v, --api-version

string

API version to which the interceptor will be added

Flags for plans

-n, --plan-name

string

Plan name to which the interceptor will be added

Other flags

--attribute

string

Attribute to be obfuscated

--custom-regex

string

Custom regular expression (regex) to identify the information to be obfuscated

-f, --flow

string

API or plan flow to which the interceptor will be added (INBOUND or OUTBOUND)

-h, --help

Displays help for the command

--location

string

Specifies the location of the information to be obfuscated. Available options: "BODY", "HEADER"

--replace-to

string

Defines the symbols into which the information will be converted

-m, --method

string

Method (operation) to which the interceptor will be added (Optional). E.g.: POST

-a, --path

string

Operation path to which the interceptor will be added (Optional). E.g.: /users

-p, --position

int

Position of the interceptor in the API or plan flow

-r, --resource

string

Resource name to which the interceptor will be added (Optional)

Global Flags

Flag

Type

Description

-c, --config

string

Configuration file (default: $HOME/.sensedia/config.json)

--profile

string

The configuration profile you want to use (default: "default")

--verbose

Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]