Pular para o conteúdo principal

Parâmetros da primeira tela

Um conjunto de parâmetros de autenticação personalizados que permitem adaptar a experiência desejada da primeira tela para os usuários finais.

  • first_screen: Especifica a primeira tela que o usuário verá.
  • identifier: Especifica os tipos de identificador que o formulário de login ou cadastro aceitará.
  • login_hint: Preenche o campo de identificador com o endereço de email ou nome de usuário do usuário. (Este é um parâmetro padrão do OIDC)

first_screen​

O parâmetro first_screen é o parâmetro chave que determina a primeira tela que os usuários verão quando forem redirecionados para a página de login do Logto. Por padrão, o formulário de login universal será exibido. Use este parâmetro para personalizar a primeira tela com base nos requisitos do seu aplicativo. Os valores suportados são:

  • sign_in: Exibe o formulário de login. (Padrão)
  • register: Exibe o formulário de cadastro.
  • reset_password: Exibe o formulário de redefinição de senha.
  • single_sign_on: Exibe o formulário de login do SSO corporativo. (Um endereço de email será solicitado para determinar os provedores de SSO habilitados)
  • identifier:sign-in: Exibe um formulário de login específico para identificador. O tipo de identificador pode ser especificado usando o parâmetro identifier. Isso é útil quando você tem múltiplos métodos de login por identificador habilitados.
  • identifier:register: Exibe um formulário de cadastro específico para identificador. O tipo de identificador pode ser especificado usando o parâmetro identifier. Isso é útil quando você tem múltiplos métodos de cadastro por identificador habilitados.
Parâmetro da primeira tela

Por exemplo, enviando usuários diretamente para o formulário de login do SSO corporativo:

curl --location \
--request GET 'https://<your-tenant>.logto.app/oidc/auth?client_id=<client_id>&...&first_screen=single_sign_on'

identifier​

O parâmetro identifier é usado para especificar os tipos de identificador que o formulário de login ou cadastro aceitará. Este parâmetro é aplicável apenas quando o parâmetro first_screen está definido como identifier:sign-in, identifier:register ou reset_password. Os valores suportados são: username, email e phone. Separe múltiplos valores com um espaço vazio para permitir múltiplos tipos de identificador.

Por exemplo, enviando usuários diretamente para a página de cadastro por email ou número de telefone:

curl --location \
--request GET 'https://<your-tenant>.logto.app/oidc/auth?client_id=<client_id>&...&first_screen=identifier:register&identifier=email phone'

Todos os tipos de identificador especificados neste parâmetro devem estar habilitados nas suas configurações de login ou cadastro no Logto Console.

Qualquer tipo de identificador não suportado ou desabilitado será ignorado. Se todos os identificadores especificados não forem suportados, a configuração padrão de experiência de login será usada.

login_hint​

O parâmetro login_hint, definido na especificação padrão OpenID Connect, é usado para pré-preencher o formulário de login com o identificador do usuário (como um email, número de telefone ou nome de usuário). Com o Logto, ele pode ser combinado com outros parâmetros de tela de login para melhorar a experiência do usuário. Este parâmetro é especialmente útil se você tiver um formulário de pré-autenticação personalizado que coleta o identificador do usuário com antecedência, permitindo que ele pule a reentrada durante o login.

Por exemplo, pré-preenchendo o endereço de email coletado no formulário de login:

curl --location \
--request GET 'https://<your-tenant>.logto.app/oidc/auth?client_id=<client_id>&...&first_screen=identifier:sign_in&identifier=email&login_hint=[email protected]

Suporte do SDK​

Nos SDKs do Logto suportados, você pode definir os parâmetros ao chamar o método signIn:

logtoClient.signIn({
  redirectUri: 'https://your-app.com/callback',
  firstScreen: 'identifier:register',
  identifier: ['email', 'phone'],
  loginHint: '[email protected]',
});
nota:

Estamos gradualmente adicionando suporte para os parâmetros first_screen, identifier e login_hint a todos os SDKs do Logto. Se você não os vir no seu SDK, por favor, abra um problema ou entre em contato conosco.

Para usuários do Logto OSS, esses parâmetros são suportados desde a versão 1.15.0. Se você estiver usando uma versão mais antiga, por favor, atualize para a versão mais recente.