Aplicando requisitos de segurança a uma operação

Editar online

Para impor os requisitos de segurança em uma operação API, você aplica componentes de esquema de segurança criados anteriormente que definem vários aspectos da configuração de segurança da API.

Sobre essa tarefa

Nota:
  • Esta tarefa está relacionada com a configuração de uma definição de API OpenAPI 3.0. Para obter detalhes sobre como configurar uma definição de API OpenAPI 2.0 , consulte Editando uma definição de API OpenAPI 2.0.
  • OpenAPI 3.0 APIs são suportadas apenas com o DataPower® API Gateway, não com o DataPower Gateway (v5 compatible).
  • Para obter detalhes das limitações de suporte atuais do OpenAPI 3.0 , consulte OpenAPI 3.0 suporte no IBM® API Connect.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

Para obter detalhes sobre como criar e configurar componentes do esquema de segurança, consulte Definindo componentes do esquema de segurança.

Um requisito de segurança especifica um ou mais componentes de esquema de segurança cujas condições devem estar todas atendidas para que a operação de API seja chamada com sucesso. É possível definir vários requisitos de segurança; neste caso, um aplicativo poderá chamar sua operação de API se ela atender a qualquer um dos requisitos de segurança que você definiu.

Quaisquer requisitos de segurança que você definir para uma operação substituirão completamente quaisquer requisitos de segurança definidos na API pai. Se você não definir nenhum requisito de segurança para uma operação ou excluir todos os requisitos de segurança de uma operação, a operação herdará os requisitos de segurança definidos na API pai. Para obter mais informações, consulte Aplicação de requisitos de segurança em uma API.

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI". Para voltar ao formulário de criação, clique no ícone Ícone de formulárioFormulário.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
  2. Expandir Caminhos, em seguida, expandir o Caminho necessário.
  3. Expandir Operaçõese, em seguida, expandir a operação necessária.
  4. Para criar um novo requisito de segurança para a operação, conclua as etapas a seguir:
    1. Clique no ícone de Ícone de inclusão da API OpenAPI 3.0 adição ao lado da entrada “Requisitos de segurança” da operação no painel de navegação.
    2. Selecione os esquemas de segurança que deseja incluir nesse requisito de segurança. Os esquemas de segurança listados são aqueles que foram definidos nos componentes de esquema de segurança; consulte Definição de componentes de esquema de segurança.

      Se o esquema de segurança selecionado for do tipo “ OAuth2 ”, selecione os escopos necessários; os escopos disponíveis para seleção são aqueles especificados no componente do esquema de segurança; para obter mais informações, consulte “Definindo componentes de um esquema de segurança do tipo ‘ OAuth2 ’ ”.

      Se você estiver aplicando o esquema de segurança OAuth2 a uma API que é imposta pelo DataPower API Gateway, você só precisa selecionar quaisquer escopos se a verificação avançada de escopo após a geração do token não estiver habilitada no provedor nativo OAuth associado ao esquema de segurança. Se um escopo padrão tiver sido definido no provedor nativo OAuth e a solicitação da API não contiver nenhum escopo, o escopo padrão será usado; para obter mais informações, consulte Configurando escopos para um provedor nativo OAuth.

      Observação: O seguinte requisito adicional se aplica a esquemas de segurança que serão usados com um provedor terceirizado OAuth. Se um esquema de segurança OAuth for selecionado para proteger uma API do consumidor, também deve-se incluir um esquema de segurança de chave de API, já que X-IBM-Client-Id ou client_id devem ser incluídos nas credenciais de segurança para que as definições de configuração do Plano correto possam ser impostas.
    3. Clique em Criar. As seleções de esquema de segurança são mostradas; é possível mudá-las novamente antes de salvar.
    4. Clique em Enviar quando estiver pronto.
  5. Para modificar um requisito de segurança existente, conclua as etapas a seguir:
    1. Clique na entrada Segurança da operação na área de janela de navegação. Todos os requisitos de segurança definidos anteriormente são listados; os esquemas de segurança incluídos em cada requisito de segurança são mostrados.
    2. Para alterar os esquemas de segurança de um requisito de segurança, clique no ícone de edição ícone de edição do requisito de segurança ao lado do requisito em questão e, em seguida, altere as seleções de segurança conforme necessário.
    3. Clique em Enviar quando concluir, em seguida, clique em Salvar.
    4. Para excluir um requisito de segurança, clique no ícone de exclusão Ícone Excluir requisito de segurançacorrespondente, clique em Excluir para confirmar e, em seguida, clique em Salvar.
    5. Para desativar a segurança para a operação, desmarque a caixa de seleção Requerer um dos Requisitos de Segurança a seguir e clique em Salvar.
    Observação: essas configurações substituem completamente quaisquer requisitos de segurança definidos na API pai; consulte Aplicação de requisitos de segurança em uma API.