跳至主要內容

首屏參數

一組自訂驗證參數,允許你為終端使用者量身打造所需的首屏體驗。

  • first_screen:指定使用者將看到的首屏。
  • identifier:指定登入或註冊表單將接受的識別符類型。
  • login_hint:填入使用者的電子郵件地址或使用者名稱到識別符欄位。(這是 OIDC 標準參數)

first_screen

first_screen 參數是決定使用者重定向到 Logto 登入頁面時所見首屏的關鍵參數。預設情況下,將顯示通用登入表單。使用此參數可根據應用程式需求自訂首屏。支援的值有:

  • sign_in:顯示登入表單。(預設)
  • register:顯示註冊表單。
  • reset_password:顯示密碼重設表單。
  • single_sign_on:顯示企業級單一登入 (SSO) 表單。(將要求輸入電子郵件地址以確定啟用的 SSO 提供者)
  • identifier:sign-in:顯示特定識別符的登入表單。可使用 identifier 參數指定識別符類型。當你啟用了多種識別符登入方法時,此功能非常有用。
  • identifier:register:顯示特定識別符的註冊表單。可使用 identifier 參數指定識別符類型。當你啟用了多種識別符註冊方法時,此功能非常有用。
First screen parameter

例如,直接將使用者導向企業級單一登入 (SSO) 表單:

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

identifier

identifier 參數用於指定登入或註冊表單將接受的識別符類型。此參數僅在 first_screen 參數設為 identifier:sign-inidentifier:registerreset_password 時適用。支援的值有:usernameemailphone。用空格分隔多個值以允許多種識別符類型。

例如,直接將使用者導向電子郵件或電話號碼註冊頁面:

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

此參數中指定的所有識別符類型必須在 Logto Console 的登入或註冊設定中啟用。

任何不支援或未啟用的識別符類型將被忽略。如果所有指定的識別符均不支援,將使用預設的登入體驗配置。

login_hint

login_hint 參數在標準 OpenID Connect 規範 中定義,用於預先填入使用者的識別符(如電子郵件、電話號碼或使用者名稱)到登入表單中。在 Logto 中,它可以與其他登入屏幕參數結合使用,以提升使用者體驗。此參數特別有用於自訂的預驗證表單中,該表單提前收集使用者的識別符,讓他們在登入時可跳過重新輸入。

例如,在登入表單中預先填入收集的電子郵件地址:

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]

SDK 支援

在支援的 Logto SDK 中,你可以在呼叫 signIn 方法時設置參數:

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

我們正在逐步為所有 Logto SDK 添加對 first_screenidentifierlogin_hint 參數的支援。如果在你的 SDK 中未看到這些參數,請開啟問題或聯繫我們。

對於 Logto OSS 使用者,這些參數自版本 1.15.0 起支援。如果你使用的是舊版本,請 升級 至最新版本。