How to build Okta enterprise SSO with Python

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 Python 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 Python.
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 Aplicativo web tradicional, 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 "Aplicativo web tradicional" ou filtre todos os frameworks "Aplicativo web tradicional" disponíveis usando as caixas de seleção de filtro rápido à esquerda. Clique no cartão do framework "Flask" 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 Flask SDK

dica:

O exemplo usa Flask, mas os conceitos são os mesmos para outros frameworks.
O projeto de exemplo em Python está disponível em nosso repositório do Python SDK.
O Logto SDK utiliza corrotinas, lembre-se de usar await ao chamar funções assíncronas.

Instalação

Execute no diretório raiz do projeto:

pip install logto # ou `poetry add logto` ou qualquer outro que você use

Inicializar LogtoClient

Primeiro, crie uma configuração Logto:

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # Substitua pelo seu endpoint Logto
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

dica:

Você pode encontrar e copiar o "App Secret" na página de detalhes do aplicativo no Admin Console:

Também substitua o armazenamento de memória padrão por um armazenamento persistente, por exemplo:

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

Veja Storage para mais detalhes.

No seu aplicativo web, adicione uma rota para lidar adequadamente com a solicitação de login dos usuários. Vamos usar /sign-in como exemplo:

flask.py
@app.route("/sign-in")
async def sign_in():
  # Obtenha a URL de login e redirecione o usuário para ela
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

Substitua http://localhost:3000/callback pela URL de callback que você configurou no seu Logto Console para este aplicativo.

Se você quiser mostrar a página de cadastro na primeira tela, pode definir interactionMode como signUp:

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # Mostrar a página de cadastro na primeira tela
  ))

Agora, sempre que seus usuários visitarem http://localhost:3000/sign-in, isso iniciará uma nova tentativa de login e redirecionará o usuário para a página de login do Logto.

Nota Criar uma rota de login não é a única maneira de iniciar uma tentativa de login. Você sempre pode usar o método signIn para obter a URL de login e redirecionar o usuário para ela.

Após o usuário fazer uma solicitação de logout, o Logto limpará todas as informações de autenticação do usuário na sessão.

Para limpar a sessão do Python e a sessão do Logto, uma rota de logout pode ser implementada da seguinte forma:

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # Redirecionar o usuário para a página inicial após um logout bem-sucedido
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

Lidar com o status de autenticação

No Logto SDK, podemos usar client.isAuthenticated() para verificar o status de autenticação. Se o usuário estiver autenticado, o valor será verdadeiro; caso contrário, o valor será falso.

Aqui também implementamos uma página inicial simples para demonstração:

Se o usuário não estiver autenticado, mostrar um botão de login;
Se o usuário estiver autenticado, mostrar um botão de logout.

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "Não autenticado <a href='/sign-in'>Entrar</a>"
    return "Autenticado <a href='/sign-out'>Sair</a>"

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 Flask 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 Python. Agora você deve conseguir fazer login com Okta enterprise SSO. Aproveite!

Create an application in Logto​

Integrate Flask SDK​

Instalação​

Inicializar LogtoClient​

Implementar login e logout​

Lidar com o status de autenticação​

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​