How to build Okta enterprise SSO with Next.js (Pages Router)

Para nossos novos amigos:

Logto é uma alternativa ao Auth0 projetada para aplicativos modernos e produtos SaaS. Ele oferece serviços tanto Cloud quanto Open-source para ajudá-lo a lançar rapidamente seu sistema de identidade e gerenciamento (IAM). Desfrute de autenticação, autorização e gerenciamento multi-inquilino tudo em um.

Recomendamos começar com um tenant de desenvolvimento gratuito no Logto Cloud. Isso permite que você explore todos os recursos facilmente.

Neste artigo, vamos percorrer os passos para construir rapidamente a experiência de login Okta enterprise SSO (autenticação de usuário) com Next.js (Pages Router) e Logto.

Pré-requisitos

Uma instância Logto em execução. Confira a página de introdução para começar.
Conhecimento básico de Next.js (Pages Router).
Uma conta Okta enterprise SSO utilizável.

Create an application in Logto

Logto é baseado na autenticação OpenID Connect (OIDC) e na autorização OAuth 2.0. Ele suporta o gerenciamento de identidade federada em vários aplicativos, comumente chamado de Autenticação Única (SSO).

Para criar seu aplicativo Traditional web, basta seguir estas etapas:

Abra o Logto Console. Na seção "Get started", clique no link "View all" para abrir a lista de frameworks de aplicativos. Alternativamente, você pode navegar para Logto Console > Applications e clicar no botão "Create application".
No modal que se abre, clique na seção "Traditional web" ou filtre todos os frameworks "Traditional web" disponíveis usando as caixas de seleção de filtro rápido à esquerda. Clique no cartão do framework "Next.js" para começar a criar seu aplicativo.
Insira o nome do aplicativo, por exemplo, "Bookstore", e clique em "Create application".

🎉 Ta-da! Você acabou de criar seu primeiro aplicativo no Logto. Você verá uma página de parabéns que inclui um guia de integração detalhado. Siga o guia para ver como será a experiência em seu aplicativo.

Integrate Next.js SDK

dica:

O projeto de exemplo está disponível em nosso repositório SDK.
O exemplo é baseado no Pages Router do Next.js.

Instalação

Importe o Logto SDK através do seu gerenciador de pacotes favorito:

npm
pnpm
yarn

npm i @logto/next

pnpm add @logto/next

yarn add @logto/next

Integração

Iniciar LogtoClient

Importe e inicialize LogtoClient:

libraries/logto.ts
import LogtoClient from '@logto/next';

export const logtoClient = new LogtoClient({
  appId: '<your-application-id>',
  appSecret: '<your-app-secret-copied-from-console>',
  endpoint: '<your-logto-endpoint>', // Ex.: http://localhost:3001
  baseUrl: 'http://localhost:3000',
  cookieSecret: 'complex_password_at_least_32_characters_long',
  cookieSecure: process.env.NODE_ENV === 'production',
});

Configurar URIs de Redirecionamento

Antes de mergulharmos nos detalhes, aqui está uma visão geral rápida da experiência do usuário final. O processo de login pode ser simplificado da seguinte forma:

Seu aplicativo invoca o método de login.
O usuário é redirecionado para a página de login do Logto. Para aplicativos nativos, o navegador do sistema é aberto.
O usuário faz login e é redirecionado de volta para o seu aplicativo (configurado como o URI de redirecionamento).

Este processo de autenticação segue o protocolo OpenID Connect (OIDC), e o Logto aplica medidas de segurança rigorosas para proteger o login do usuário.
Se você tiver vários aplicativos, pode usar o mesmo provedor de identidade (Logto). Uma vez que o usuário faz login em um aplicativo, o Logto completará automaticamente o processo de login quando o usuário acessar outro aplicativo.

Para saber mais sobre a lógica e os benefícios do login baseado em redirecionamento, veja Experiência de login do Logto explicada.

nota:

Nos trechos de código a seguir, assumimos que seu aplicativo está sendo executado em http://localhost:3000/.

Configurar URIs de redirecionamento

Vá para a página de detalhes do aplicativo no Logto Console. Adicione um URI de redirecionamento http://localhost:3000/api/logto/sign-in-callback.

URI de redirecionamento no Logto Console

Assim como no login, os usuários devem ser redirecionados para o Logto para sair da sessão compartilhada. Uma vez concluído, seria ótimo redirecionar o usuário de volta para o seu site. Por exemplo, adicione http://localhost:3000/ como a seção de URI de redirecionamento pós logout.

Em seguida, clique em "Salvar" para salvar as alterações.

Preparar rotas de API

Prepare rotas de API para conectar com Logto.

Volte para o seu IDE/editor, use o seguinte código para implementar as rotas de API primeiro:

pages/api/logto/[action].ts
import { logtoClient } from '../../../libraries/logto';

export default logtoClient.handleAuthRoutes();

Isso criará 4 rotas automaticamente:

/api/logto/sign-in: Fazer login com Logto.
/api/logto/sign-in-callback: Lidar com o callback de login.
/api/logto/sign-out: Fazer logout com Logto.
/api/logto/user: Verificar se o usuário está autenticado com Logto, se sim, retornar informações do usuário.

Preparamos as rotas de API, agora vamos implementar os botões de login e logout na sua página inicial. Precisamos redirecionar o usuário para a rota de login ou logout quando necessário. Para ajudar com isso, use useSWR para buscar o status de autenticação de /api/logto/user.

Confira este guia para saber mais sobre useSWR.

/pages/index.tsx
import { type LogtoContext } from '@logto/next';
import useSWR from 'swr';

const Home = () => {
  const { data } = useSWR<LogtoContext>('/api/logto/user');

  return (
    <nav>
      {data?.isAuthenticated ? (
        <p>
          Olá, {data.claims?.sub},
          <button
            onClick={() => {
              window.location.assign('/api/logto/sign-out');
            }}
          >
            Sair
          </button>
        </p>
      ) : (
        <p>
          <button
            onClick={() => {
              window.location.assign('/api/logto/sign-in');
            }}
          >
            Entrar
          </button>
        </p>
      )}
    </nav>
  );
};

export default Home;

Ponto de verificação: Teste seu aplicativo

Agora, você pode testar seu aplicativo:

Execute seu aplicativo, você verá o botão de login.
Clique no botão de login, o SDK iniciará o processo de login e redirecionará você para a página de login do Logto.
Após fazer login, você será redirecionado de volta para seu aplicativo e verá o botão de logout.
Clique no botão de logout para limpar o armazenamento de tokens e sair.

Add Okta enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Next.js as a federated identity provider. The Logto enterprise SSO connector helps you establish this connection in minutes by allowing several parameter inputs.

To add an enterprise SSO connector, simply follow these steps:

Navigate to Logto console > Enterprise SSO.

SSO page

Click "Add enterprise connector" button and choose your SSO provider type. Choose from prebuilt connectors for Microsoft Entra ID (Azure AD), Google Workspace, and Okta, or create a custom SSO connection using the standard OpenID Connect (OIDC) or SAML protocol.
Provide a unique name (e.g., SSO sign-in for Acme Company).

Select your SSO provider

Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

SSO connection

Customize the SSO experience and enterprise’s email domain in the "Experience" tab. Users sign in with the SSO-enabled email domain will be redirected to SSO authentication.

SSO experience

Save changes.

Set up Aplicativo OIDC no portal de administração Okta

Etapa 1: Criar um aplicativo OIDC no portal de administração do Okta {#step-1-create-an-oidc-application-on-okta-admin-portal}

Visite o portal de administração do Okta e faça login como administrador.
Navegue até a página Applications / Applications usando o menu lateral.
Clique no botão Create App Integration para criar um novo aplicativo OIDC.
Selecione a opção OIDC - OpenID Connect como o Sign-in method.
Selecione a opção Web Application como o Application type.

Okta create application.webp

Clique no botão Next para continuar.

Etapa 2: Configurar as configurações do aplicativo

Forneça um App integration name. Ele será usado como o identificador do seu aplicativo OIDC.
Adicione um novo Sign-in redirect URIs usando a URL de callback do conector SSO do Logto.

Este é o URI para o qual o Okta redirecionará o navegador do usuário após a autenticação bem-sucedida. Após um usuário autenticar-se com sucesso com o IdP, o IdP redireciona o navegador do usuário de volta para este URI designado junto com um código de autorização. O Logto completará o processo de autenticação com base no código de autorização recebido deste URI.

Configurações do aplicativo Okta.webp

Atribua usuários ao aplicativo.

Com base nas configurações de Assignments, você pode escolher atribuir o aplicativo a todos os usuários ou a usuários/grupos específicos.

Atribuir usuários no Okta.webp

Clique no botão Save para salvar as configurações do aplicativo.

Etapa 3: Configurar o conector Logto com as credenciais do cliente

Após criar com sucesso o aplicativo OIDC, você será redirecionado para a página de detalhes do aplicativo.

Okta client credentials.webp

Copie o client ID e o client secret e preencha os campos correspondentes na aba Connection do conector Logto SSO.

Use seu domínio Okta como o emissor (issuer). Exemplo: https://dev-12345678.okta.com. Depois de preencher todos os campos, clique no botão Save para salvar as configurações do conector.

Se o link do emissor (issuer) que você forneceu for válido, você verá uma lista completa analisada das configurações do IdP Okta mostrada abaixo do campo emissor (issuer).

Etapa 4: Escopos adicionais (Opcional)

Use o campo Scope para adicionar escopos adicionais à sua solicitação OAuth. Isso permitirá que você solicite mais informações do servidor OAuth da Okta. Consulte a documentação da Okta para mais detalhes sobre os escopos disponíveis.

Independentemente das configurações de escopo personalizadas, o Logto sempre enviará os escopos openid, profile e email para o IdP. Isso é para garantir que o Logto possa recuperar corretamente as informações de identidade e o endereço de email do usuário.

Etapa 5: Definir domínios de email e habilitar o conector SSO

Forneça os domínios de email da sua organização na aba SSO experience do conector do Logto. Isso habilitará o conector SSO como um método de autenticação para esses usuários.

Usuários com endereços de email nos domínios especificados serão redirecionados para usar seu conector SSO como seu único método de autenticação.

Para mais detalhes sobre a criação de integração OIDC com Okta, por favor, confira Create OIDC App Integrations.

Save your configuration

Verifique se você preencheu os valores necessários na área de configuração do conector Logto. Clique em "Salvar e Concluído" (ou "Salvar alterações") e o conector Okta enterprise SSO deve estar disponível agora.

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

Navigate to: Console > Sign-in experience > Sign-up and sign-in.
Enable the "Enterprise SSO" toggle.
Save changes.

Once enabled, a "Single Sign-On" button will appear on your sign-in page. Enterprise users with SSO-enabled email domains can access your services using their enterprise identity providers (IdPs).

Auto detect SSO sign-in via email domain

To learn more about the SSO user experience, including SP-initiated SSO and IdP-initiated SSO, refer to User flows: Enterprise SSO.

Testing and Validation

Retorne ao seu aplicativo Next.js (Pages Router). Agora você deve conseguir fazer login com Okta enterprise SSO. Aproveite!

Create an application in Logto​

Integrate Next.js SDK​

Instalação​

Integração​

Iniciar LogtoClient​

Configurar URIs de Redirecionamento​

Sobre o login baseado em redirecionamento​

Configurar URIs de redirecionamento​

Preparar rotas de API​

Implementar login e logout​

Ponto de verificação: Teste seu aplicativo​

Add Okta enterprise SSO connector​

Set up Aplicativo OIDC no portal de administração Okta​

Etapa 2: Configurar as configurações do aplicativo​

Etapa 3: Configurar o conector Logto com as credenciais do cliente​

Etapa 4: Escopos adicionais (Opcional)​

Etapa 5: Definir domínios de email e habilitar o conector SSO​

Save your configuration​

Enable Okta enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​