Definindo componentes do esquema de segurança do OIDC

Um esquema de segurança OIDC (OpenID Connect) define as configurações para usar seu provedor OIDC para controlar o acesso à API.

Antes de iniciar

Antes de poder criar um componente de esquema de segurança OIDC, deve-se criar um provedor OAuth nativo e definir as configurações OIDC para ele.
  1. Crie um provedor OIDC.
  2. Configure os parâmetros OIDC para seu provedor OAuth nativo.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
  2. Expandir Componentes > Esquemas de Segurança e, em seguida, clique em Ícone de inclusão da API OpenAPI 3.0 para incluir um novo esquema de segurança.
  3. Na caixa de diálogo Incluir esquema , forneça as seguintes configurações antes de clicar em Incluir:
    • Nome do esquema de segurança (Chave): forneça um nome para o novo esquema.
    • Tipo de esquema de segurança: selecione openIdConnect
    • OpenID Connect URL : digite o endpoint de autorização URL para o provedor OIDC.
  4. Na página OpenId Connect Security Scheme , inclua informações sobre o provedor OIDC:
    • Tipo: selecione seu provedor OIDC na lista.

      A lista exibe apenas os provedores OAuth nativos que estão configurados para o OIDC com uma descoberta URL fornecida no campo OpenIDConnect Discovery path e que estão ativados para o catálogo que a API está configurada para usar.

    • OpenID Connect URL : Quando você seleciona seu provedor, o URL é preenchido para você com a descoberta URL que foi configurada para o provedor OAuth nativo.
  5. Clique em Salvar.