Share via

Configurar o logon único usando o Microsoft Entra ID para o Spring Cloud Gateway e o API Portal

  • Artigo

Este artigo se aplica a(o):❌ Básico/Standard ✔️ Enterprise

Este artigo mostra como configurar o logon único (SSO) para o Spring Cloud Gateway ou Portal de API usando a ID do Microsoft Entra como um provedor de identificação OpenID.

Pré-requisitos

Para habilitar o SSO do Spring Cloud Gateway ou o Portal de API, as quatro propriedades a seguir devem estar configuradas:

Propriedade de SSO Configuração do Microsoft Entra
clientId Consulte Registrar aplicativo
clientSecret Consulte Criar o segredo do cliente
scope Consulte Configurar o escopo
issuerUri Consulte Gerar URI do emissor

Você configurará as propriedades no Microsoft Entra ID nas etapas a seguir.

Atribuir um ponto de extremidade para o Spring Cloud Gateway ou portal de API

Primeiro, você deve obter o ponto de extremidade público atribuído para o Spring Cloud Gateway e o portal de API seguindo estas etapas:

  1. Abra sua instância de serviço do plano Enterprise no portal do Azure.
  2. Selecione o Gateway do Spring Cloud ou o portal de API nos componentes do VMware Tanzu no menu à esquerda.
  3. Selecione Sim ao lado de Atribuir ponto de extremidade.
  4. Copie a URL para uso na próxima seção deste artigo.

Criar um registro de aplicativo do Microsoft Entra

Registre seu aplicativo para estabelecer uma relação de confiança entre o aplicativo e a plataforma de identidade da Microsoft usando as seguintes etapas:

  1. Na tela inicial , selecione Microsoft Entra ID no menu esquerdo.
  2. Selecione Registros de aplicativo em Gerenciar e, em seguida, selecione Novo registro.
  3. Insira um nome de exibição para seu aplicativo em Nome e selecione um tipo de conta a ser registrada em Tipos de conta com suporte.
  4. No URI de Redirecionamento (opcional), selecione Web e, em seguida, insira a URL da seção acima na caixa de texto. O URI de redirecionamento é o local onde o Microsoft Entra ID redireciona seu cliente e envia tokens de segurança após a autenticação.
  5. Selecione Registrar para concluir o registro do aplicativo.

Screenshot of how to fill out the Add App Registration screen.

Quando o registro for concluído, você verá a ID do aplicativo (cliente) na tela Visão geral da página Registros de aplicativo*.

Adicionar um URI de redirecionamento após o registro do aplicativo

Você também pode adicionar URIs de redirecionamento após o registro do aplicativo seguindo estas etapas:

  1. Na visão geral do aplicativo, em Gerenciar no menu à esquerda, selecione Autenticação.
  2. Selecione Web e, em seguida, selecione Adicionar URI em URIs de redirecionamento.
  3. Adicione um novo URI de redirecionamento e selecione Salvar.

Screenshot of adding a redirect URI to the authentication screen.

Para obter mais informações sobre o registro de aplicativo, consulte Guia de início rápido: registrar um aplicativo com a plataforma de identidade da Microsoft.

Adicionar um segredo do cliente

O aplicativo usa um segredo do cliente para se autenticar no fluxo de trabalho do SSO. Você pode adicionar um segredo do cliente usando as seguintes etapas:

  1. Na visão geral do aplicativo, em Gerenciar no menu esquerdo, selecione Certificados e segredos.
  2. Selecione Segredos do cliente e, em seguida, Novo segredo do cliente.
  3. Insira uma descrição do segredo do cliente e defina uma data de validade.
  4. Selecione Adicionar.

Aviso

Lembre-se de salvar o segredo do cliente em uma localização segura. Não é possível recuperá-lo depois de sair da página. O segredo do cliente deve ser fornecido com a ID do cliente ao entrar como o aplicativo.

Configurar o escopo

A propriedade scope do SSO é uma lista de escopos a serem incluídos nos tokens de identidade JWT. Eles são muitas vezes referidos como permissões. A plataforma de identidade oferece suporte a vários escopos do OpenID Connect, como openid, emaile profile. Para obter mais informações, consulte a seção Escopos do OpenID Connect de Escopos e permissões na plataforma de identidade da Microsoft.

Configurar o URI do emissor

O URI do emissor é o URI declarado como o Identificador do Emissor. Por exemplo, se o issuer-uri fornecido for https://example.com, uma solicitação de configuração do Provedor OpenID será feita para https://example.com/.well-known/openid-configuration.

O URI do emissor do Microsoft Entra ID é como <authentication-endpoint>/<Your-TenantID>/v2.0. Substitua <authentication-endpoint> pelo ponto de extremidade de autenticação do seu ambiente de nuvem (por exemplo, https://login.microsoftonline.com para o Azure global) e substitua <Your-TenantID> pela ID do Diretório (locatário) em que o aplicativo foi registrado.

Configure o SSO

Depois de configurar seu aplicativo Microsoft Entra, você pode configurar as propriedades SSO do Spring Cloud Gateway ou do API Portal seguindo estas etapas:

  1. Selecione o Gateway do Spring Cloud ou o portal de API nos componentes do VMware Tanzu no menu à esquerda e, em seguida, Configuração.
  2. Insira Scope, Client Id, Client Secret e Issuer URI nos campos apropriados. Separe vários escopos com uma vírgula.
  3. Selecione Salvar para habilitar a configuração de SSO.

Observação

Após configurar as propriedades do SSO, lembre-se de habilitar o SSO para as rotas do Spring Cloud Gateway definindo ssoEnabled=true. Para obter mais informações, confira Configuração de rota.

Próximas etapas