跳至主要內容

首頁參數(First screen parameters)

一組自訂驗證 (Authentication) 參數,讓你能根據需求調整終端使用者的首頁體驗。

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

first_screen

first_screen 參數是決定使用者導向 Logto 登入頁時所見首頁的關鍵參數。預設會顯示通用登入表單。你可以根據應用程式需求,利用此參數自訂首頁。支援的值如下:

  • sign_in:顯示登入表單。(預設值)
  • register:顯示註冊表單。
  • reset_password:顯示重設密碼表單。
  • single_sign_on:顯示企業級單一登入 (SSO, Single Sign-On) 登入表單。(會要求輸入電子郵件地址以判斷啟用的 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 其他登入畫面參數,可提升使用者體驗。此參數特別適合你有自訂前置驗證 (Authentication) 表單,預先收集使用者識別碼時,讓使用者在登入時免於重複輸入。

例如,將已收集的電子郵件地址預填入登入表單:

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]',
});
備註:

我們正逐步將 first_screenidentifierlogin_hint 參數支援加入所有 Logto SDK。如你的 SDK 尚未支援,歡迎提交 issue 或聯絡我們。

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