Adição de Interceptor de OAuth (ssd api-management add (plan | api)-interceptor oauth)

O comando ssd api-management add (plan | api)-interceptor oauth permite adicionar um interceptor de "OAuth" ao fluxo de uma API ou um plano na Sensedia API Platform.

É possível utilizar o comando ssd api-management add (plan | api)-interceptor oauth ou a sua versão abreviada ssd apim add (plan | api)-interceptor oauth.

Uso

O comando ssd api-management add (plan | api)-interceptor oauth pode ser seguido de flags com seus respectivos argumentos:

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

Caso nenhuma flag seja especificada, o modo interativo será ativado.

Veja abaixo exemplos de uso no modo direto:

# Adiciona um interceptor de "OAuth" ao fluxo Inbound da API ou do plano para todos seus recursos e métodos
$ ssd (api-management | apim) add api-interceptor oauth --api-name "Open Banking" --api-version "1.0.0" --revision 1 --flow INBOUND
$ ssd (api-management | apim) add plan-interceptor oauth --plan-name "Plan Name" --flow INBOUND

# Seleciona os grant types por meio de flags
$ ssd (api-management | apim) add api-interceptor oauth --api-name "Open Banking" --api-version "1.0.0" --revision 1 --flow INBOUND --password --authorization-code --client-credentials --implicit
$ ssd (api-management | apim) add plan-interceptor oauth --plan-name "Plan Name" --flow INBOUND --password --authorization-code --client-credentials --implicit

# Adiciona um interceptor "Oauth" de forma interativa
$ ssd (api-management | apim) add plan-interceptor oauth
$ ssd (api-management | apim) add api-interceptor oauth

Flags disponíveis

As flags que podem ser usadas com o comando ssd (api-management | apim) add (plan | api)-interceptor oauth são as seguintes:

Flag

Tipo

Descrição

Flags para as APIs

-n, --api-name

string

Nome da API à qual o interceptor será adicionado

-s, --revision

string

Revisão da API à qual o interceptor será adicionado

-v, --api-version

string

Versão da API à qual o interceptor será adicionado

Flags para os planos

-n, --plan-name

string

Nome do plano ao qual o interceptor será adicionado

Outras flags

--authorization-code

Seleciona o grant type "Authorization Code"

-c, --config

string

Arquivo de configuração (predefinido: $HOME/.sensedia.yaml)

--client-credentials

Seleciona o grant type "Client Credentials"

-f, --flow

string

Fluxo da API ou do plano ao qual o interceptor será adicionado (INBOUND ou OUTBOUND)

-h, --help

Exibe a ajuda para o comando

--implicit

Seleciona o grant type "Implicit"

--password

Seleciona o grant type "Password"

-m, --method

string

Método (operação) ao qual o interceptor será adicionado (Opcional). Ex.: POST

-a, --path

string

Caminho da operação à qual o interceptor será adicionado (Opcional). Ex.: /users

-p, --position

int

Posição do interceptor no fluxo da API ou do plano

--profile

string

Perfil de configuração que deseja utilizar (predefinido: "default")

-r, --resource

string

Nome do recurso ao qual o interceptor será adicionado (Opcional)

--verbose

Lista todas as requisições feitas pelo comando. É possível armazenar essas informações em um arquivo TXT em vez de exibi-las no terminal. Ex.: $ ssd api-management list apis --verbose 2> log.txt

Flags globais

Flag

Tipo

Descrição

-c, --config

string

Arquivo de configuração (predefinido: $HOME/.sensedia/config.json)

--profile

string

Perfil de configuração que deseja utilizar (predefinido: "default")

--verbose

Lista todas as requisições feitas pelo comando. É possível armazenar essas informações em um arquivo TXT em vez de exibi-las no terminal. Ex.: $ 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]