Restrict Access Interceptor Addition (ssd api-management add (plan | api)-interceptor restrict)

The ssd api-management add (plan | api)-interceptor restrict command allows you to add a "Restrict Access" interceptor to an API or plan flow on Sensedia API Platform.

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

Usage

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

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

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

Below you will find usage examples in the direct mode:

# Blocks access to the "Production" and "Testing" environments
$ ssd (api-management | apim) add api-interceptor restrict --api-name "Open Banking" --api-version "1.0.0" --revision 1 --position 1 --flow "INBOUND" --environment "Production" --environment "Testing" --restriction-type BLOCK
$ ssd (api-management | apim) add plan-interceptor restrict --plan-name "Plan Name" --position 1 --flow "INBOUND" --environment "Production" --environment "Testing" --restriction-type BLOCK

# Allows access to the "Production" environment
$ ssd (api-management | apim) add api-interceptor restrict --api-name "Open Banking" --api-version "1.0.0" --revision 1 --position 1 --flow "INBOUND" --environment "Production" --restriction-type ALLOW
$ ssd (api-management | apim) add plan-interceptor restrict --plan-name "Plan Name" --position 1 --flow "INBOUND" --environment "Production" --restriction-type ALLOW

# Adds a "Restrict" interceptor interactively
$ ssd (api-management | apim) add plan-interceptor restrict
$ ssd (api-management | apim) add api-interceptor restrict

Available Flags

The following flags can be used with the ssd (api-management | apim) add (plan | api)-interceptor restrict 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

--environment

string

Adds an environment to which the access restriction policy will apply. Repeat the flag to add more environments

-f, --flow

string

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

-h, --help

Displays help for the command

--restriction-type

string

Selects the type of access policy (BLOCK or ALLOW)

-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]