Aplicando requisitos de segurança em uma API

Editar online

Para impor requisitos de segurança em uma API, você aplica esquemas de segurança criados anteriormente que especificam vários aspectos da configuração de segurança da API.

Sobre essa tarefa

Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

É 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 definições de esquemas de segurança, consulte Definindo esquemas de segurança.

As restrições a seguir existem ao aplicar esquemas de segurança a uma API:
  • Não é possível aplicar mais de dois esquemas de segurança de chaves de API a uma API.
  • Se você aplicar um esquema de segurança de chaves de API ao segredo do cliente, um esquema de segurança de chave de API também deverá ser aplicado ao ID do cliente.
  • Se for necessário que o desenvolvedor de aplicativos forneça o ID do cliente e o segredo do cliente, dois esquemas de segurança de chaves de API separados deverão ser aplicados.
  • É possível ter no máximo um esquema de chave de API do tipo ID do cliente, independentemente de o ID do cliente ser enviado no cabeçalho da solicitação ou como um parâmetro de consulta.
  • É possível ter no máximo um esquema de chave de API do tipo segredo do cliente, independentemente de o segredo do cliente ser enviado no cabeçalho da solicitação ou como um parâmetro de consulta.
  • Não é possível aplicar mais de um esquema de segurança básico a uma API. Se você aplicar um esquema de segurança básico, não será possível também aplicar um esquema de segurança OAuth.
  • É possível aplicar no máximo um esquema de segurança OAuth a uma API.

Um requisito de segurança especifica um ou mais esquemas de segurança cujas condições devem ser todas satisfeitas para que a API seja chamada com êxito É possível definir vários requisitos de segurança; neste caso, um aplicativo pode chamar sua API se ela atender a qualquer um dos requisitos de segurança que você definiu.

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 2.0 ..
  2. Expanda Geral..
  3. Para criar um requisito de segurança para a API, conclua as etapas a seguir:
    1. Clique no ícone de adição Ícone de inclusão da API OpenAPI 2.0 ao lado de "Segurança" 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; consulte Definição de esquemas 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 esquema de segurança; para obter mais informações, consulte “Defining OAuth2 security schemes ”.

      Se você estiver aplicando o esquema de segurança “ OAuth2 ” a uma API que é gerenciada pelo DataPower® API Gateway, só será necessário selecionar os escopos se a opção “Verificação avançada de escopos após a geração do token” não estiver ativada 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á utilizado; para obter mais informações, consulte Configurando escopos para um provedor nativo OAuth.

      Observação: O requisito adicional a seguir aplica-se aos esquemas de segurança que serão utilizados com um provedor terceirizado do tipo “ 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.
  4. Para modificar um requisito de segurança existente, conclua as etapas a seguir:
    1. Clique em Segurança 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 API, desmarque a caixa de seleção Requerer um dos Requisitos de Segurança a seguir e, em seguida, clique em Salvar