Definindo esquemas de segurança OAuth2

Editar online

Um esquema de segurança da API ( OAuth2 ) define as configurações para controlar o acesso às operações da API por meio do padrão de autorização OAuth.

Antes de Iniciar

Antes de poder criar um esquema de segurança OAuth2 , deve-se:

Criar um provedor OAuth.
- Para usar o API Manager, consulte Configurando um provedor nativo OAuth ou Configurando um provedor de terceiros OAuth.
Incluir o provedor OAuth em um catálogo. Caso não tenha criado catálogos, use o Catálogo de ambiente de simulação. Consulte as instruções do OAuth na etapa Criando e configurando catálogos.

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 fazer uso de um esquema de segurança OAuth2 , deve-se fazer referência a ele de outro lugar em sua definição de API. Para obter mais informações, consulte “Aplicando requisitos de segurança a uma API” e “Aplicando requisitos de segurança a uma operação ”.

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ário Formulário.

Procedimento

Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
Se já houver um ou mais esquemas de segurança definidos, expanda Esquemas de segurança.
Para criar um esquema de segurança do tipo “ OAuth2 ”, clique no ícone de adição ao lado de “Esquemas de segurança ” e, em seguida, selecione “ oauth2 ”. Para editar um esquema de segurança OAuth2 existente, clique no nome do esquema de segurança na área de janela de navegação.
Insira um nome de identificação de sua escolha no campo Nome do esquema de segurança .
Forneça as informações a seguir:
- Nome do esquema de segurança: um nome de identificação de sua escolha.
- OAuth Provedor : Selecione o provedor OAuth a ser usado.
- Fluxo: Selecione uma das opções a seguir:
  - Implícito
  - Proprietário do recurso - Senha
  - Aplicativo
  - Código de acesso
  Observação: as opções de fluxo disponíveis para seleção dependem das opções suportadas pelo provedor de OAuth selecionado.
  Se você selecionou Proprietário do recurso - JWT como o tipo de concessão compatível ao criar o provedor OAuth, você deve selecionar Proprietário do recurso - Senha como o Fluxo para este esquema de segurança.
- Descrição: uma descrição opcional do esquema de segurança OAuth2. Você pode usar a sintaxe CommonMark para representação em rich text.
- Os terminais de URL (os terminais aplicáveis dependem do tipo de fluxo):
  - URL de autorização
  - URL de token
  Observação: os valores do endpoint URL fornecidos aqui são mantidos apenas para fins informativos; nenhuma validação ou outra ação é aplicada a eles por API Connect. A segurança OAuth que é aplicada depende do provedor OAuth especificado.
- Escopos (disponível se você estiver editando um esquema de segurança OAuth2 existente):
  - Para incluir um novo escopo, clique em Incluir Para editar um escopo existente, clique no ícone de opções ao lado do escopo desejado e, em seguida, clique em Editar.
  - Forneça as informações a seguir:
    
    Escopo: o identificador do escopo.
    
    Descrição: uma descrição opcional do escopo. Você pode usar a sintaxe CommonMark para representação em rich text.
    
    Se você estiver criando um novo escopo, clique em Criar.
Se você estiver criando um novo esquema de segurança OAuth2 , clique em Criar.
Os detalhes do esquema de segurança são exibidos para edição adicional.
Clique em Salvar quando concluído.

O quê fazer em seguida

Aplique o esquema de segurança a uma API ou operação. Para obter mais informações, consulte “Aplicando requisitos de segurança a uma API” e “Aplicando requisitos de segurança a uma operação ”.