使用登入小組件

使用 IBM Cloud® App ID,您可以使用預設使用者介面(稱為「登入小組件」),讓應用程式使用者能夠選擇想要用來登入的身分提供者。 如果您使用雲端目錄,登入 Widget 也會提供額外的使用者介面功能,例如註冊、忘記密碼、多因素驗證等。

瞭解登入小組件

「登入小組件」最好的其中一部分,是您可以在自行實作任何鑑別使用者介面之前開始使用 App ID,這讓開發人員的加入體驗更容易。

預設的「登入小組件」行為是什麼?

依預設,會啟用「登入小組件」來使用 Facebook、Google 及 Cloud Directory。 您可以隨時藉由選擇要配置為選項的身分提供者來變更行為。 啟用多個身分提供者時,「登入小組件」會呈現一個畫面,使用者可以在其中進行身分提供者選擇。 但是,如果您啟用了單一供應商,使用者就看不到之前提到的選擇畫面。 他們會被直接帶到身份提供者處,開始登入程序。

例如,如果您正在使用預設值 - Facebook、Google 及 Cloud Directory,使用者會看到該畫面。 如果僅啟用 Facebook,使用者會直接連到 Facebook 進行鑑別。

可對每一個提供者顯示哪些畫面?

當您使用 Cloud Directory 時,App ID 可以為您提供使用者管理的延伸功能。 擴充的功能也適用於登入 Widget 的功能。 儲存在 Cloud Directory 中的使用者,可以直接在「登入小組件」中,利用例如註冊或重設密碼之類的功能。 請參閱下表,以查看您可以對每一種類型的身分提供者顯示的畫面。

每個身份提供者可以顯示的登入小組件螢幕
登入小組件畫面 社交身分提供者 企業身分提供者 雲端目錄
登入 勾號圖示 勾號圖示 勾號圖示
註冊 勾號圖示
忘記密碼 勾號圖示
變更密碼 勾號圖示
帳戶詳細資料 勾號圖示

自訂 SSO 登入流程

成功鑑別後,App ID 會使用應用程式可用於鑑別的加密存取記號和身分記號來建立階段作業 Cookie。 自訂流程的另一種方法是將存取記號傳送至瀏覽器,讓任何瀏覽器應用程式都可以在其 AJAX 要求中使用該記號。

自訂登入小組件

登入小組件是動態的。 您可以自訂外觀或身分提供者組態,而且變更會立即套用。 不需要更新應用程式碼或以任何方式重新部署應用程式!

您需要比登入小組件所提供更多的自訂作業嗎? 您可以實作自己的完全自訂使用者介面,來進行使用者登入、註冊、重設密碼及其他流程,以建立您應用程式的獨特體驗。 若要開始,請參閱將您的應用程式加上品牌

若要自訂畫面,請執行下列動作:

  1. 開啟 App ID 服務儀表板。
  2. 選取登入自訂作業區段。 您可以修改「登入小組件」的外觀,以符合公司品牌。
  3. 選取本端系統中的 PNG 或 JPG 檔案,以上傳公司的標誌。 建議的影像大小是 320 x 320 像素。 檔案大小上限是 100 KB。
  4. 從顏色選取器中選取小組件的標頭顏色,或輸入另一個顏色的十六進位碼。
  5. 檢查預覽窗格,然後在滿意自訂時按一下儲存變更。 即會顯示一則確認訊息。
  6. 在瀏覽器中,重新整理登入頁面,以驗證您的變更。

使用 Android SDK 顯示登入小組件

您可以使用 Android 客戶端 SDK 來呼叫預先設定的畫面。

在您的程式碼中放置下列指令。

LoginWidget loginWidget = AppID.getInstance().getLoginWidget();
loginWidget.launch(this, new AuthorizationListener() {
      @Override
      public void onAuthorizationFailure (AuthorizationException exception) {
      //Exception occurred
      }

      @Override
      public void onAuthorizationCanceled () {
      //Authentication canceled by the user
      }

      @Override
      public void onAuthorizationSuccess (AccessToken accessToken, IdentityToken identityToken, refreshToken: RefreshToken) {
      //User authenticated
      }
   });

註冊

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 將下列程式碼新增至您的應用程式。 當使用者從自訂畫面註冊您的應用程式時,註冊流程便會啟動。 下列呼叫不僅會登錄使用者,還可以傳送驗證電子郵件來完成登錄,視您的「雲端目錄」配置而定。

    LoginWidget loginWidget = AppID.getInstance().getLoginWidget();
    loginWidget.launchSignUp(this, new AuthorizationListener() {
       @Override
       public void onAuthorizationFailure (AuthorizationException exception) {
             //Exception occurred
       }
    
       @Override
       public void onAuthorizationCanceled () {
             //Sign up canceled by the user
       }
    
       @Override
       public void onAuthorizationSuccess (AccessToken accessToken, IdentityToken identityToken, RefreshToken refreshToken) {
             if (accessToken != null && identityToken != null) {
                //User authenticated
             } else {
                //email verification is required
             }
       }
    });
    

忘記密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者從您的應用程式管理其帳戶必須設為開啟

  2. 在服務儀表板的重設密碼標籤中,請確定忘記密碼電子郵件已設為開啟

  3. 將下列程式碼新增至您的應用程式。 當使用者在您的應用程式中按一下「忘記密碼」時,SDK 會呼叫 forgot_password API,以將電子郵件傳送給使用者,容許他們重設其密碼。

    LoginWidget loginWidget = AppID.getInstance().getLoginWidget();
    loginWidget.launchForgotPassword(this, new AuthorizationListener() {
       @Override
       public void onAuthorizationFailure (AuthorizationException exception) {
             //Exception occurred
       }
    
       @Override
       public void onAuthorizationCanceled () {
             // Forogt password canceled by the user
       }
    
       @Override
       public void onAuthorizationSuccess (AccessToken accessToken, IdentityToken identityToken, RefreshToken refreshToken) {
             // Forgot password finished, in this case accessToken and identityToken will be null.
       }
    });
    

變更詳細資料

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 在服務儀表板的密碼變更標籤中,將密碼變更電子郵件設為「開啟」。

  3. 呼叫登入小組件來啟動變更詳細資料流程。

    LoginWidget loginWidget = AppID.getInstance().getLoginWidget();
    loginWidget.launchChangeDetails(this, new AuthorizationListener() {
       @Override
       public void onAuthorizationFailure (AuthorizationException exception) {
             // Exception occurred
       }
    
       @Override
       public void onAuthorizationCanceled () {
             // Changed details canceled by the user
       }
    
       @Override
       public void onAuthorizationSuccess (AccessToken accessToken, IdentityToken identityToken, RefreshToken refreshToken) {
             // User authenticated, and fresh tokens received
       }
    });
    

變更密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 將下列程式碼放在您的應用程式中,以啟動變更密碼流程。

    LoginWidget loginWidget = AppID.getInstance().getLoginWidget();
    loginWidget.launchChangePassword(this, new AuthorizationListener() {
       @Override
       public void onAuthorizationFailure (AuthorizationException exception) {
             // Exception occurred
       }
    
       @Override
       public void onAuthorizationCanceled () {
             // Change password canceled by the user
       }
    
       @Override
       public void onAuthorizationSuccess (AccessToken accessToken, IdentityToken identityToken, RefreshToken refreshToken) {
             // User authenticated, and fresh tokens received
       }
    });
    

使用 iOS Swift SDK 顯示登入小組件

您可以使用 iOS Swift 客戶端 SDK 來呼叫預先設定的畫面。

在您的程式碼中放置下列指令。

import IBMCloudAppID
class delegate : AuthorizationDelegate {
   public func onAuthorizationSuccess(accessToken: AccessToken, identityToken: IdentityToken, refreshToken: RefreshToken?) {
         //User authenticated
   }

   public func onAuthorizationCanceled() {
         //Authentication canceled by the user
   }

   public func onAuthorizationFailure(error: AuthorizationError) {
         //Exception occurred
   }
}

AppID.sharedInstance.loginWidget?.launch(delegate: delegate())

註冊

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 將下列程式碼放在您的應用程式中。 當使用者嘗試註冊您的應用程式時,登入 Widget 會被呼叫並顯示自訂的註冊頁面。

    class delegate : AuthorizationDelegate {
       public func onAuthorizationSuccess(accessToken: AccessToken?, identityToken: IdentityToken?, refreshToken: RefreshToken?, response:Response?) {
          if accessToken == nil && identityToken == nil {
          //email verification is required
          return
          }
       //User authenticated
       }
    
       public func onAuthorizationCanceled() {
          //Sign up canceled by the user
       }
    
       public func onAuthorizationFailure(error: AuthorizationError) {
          //Exception occurred
       }
    }
    
    AppID.sharedInstance.loginWidget?.launchSignUp(delegate: delegate())
    

忘記密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者從您的應用程式管理其帳戶必須設為開啟

  2. 在服務儀表板的重設密碼標籤中,請確定忘記密碼電子郵件已設為開啟

  3. 將下列程式碼放在您的應用程式中。 當您的其中一個應用程式使用者要求更新其密碼時,就會呼叫登入小組件,並啟動處理程序。

    class delegate : AuthorizationDelegate {
       public func onAuthorizationSuccess(accessToken: AccessToken?, identityToken: IdentityToken?, refreshToken: RefreshToken?, response:Response?) {
          //forgot password finished, in this case accessToken and identityToken will be null.
       }
    
       public func onAuthorizationCanceled() {
          //forgot password canceled by the user
       }
    
       public func onAuthorizationFailure(error: AuthorizationError) {
          //Exception occurred
       }
    }
    
    AppID.sharedInstance.loginWidget?.launchForgotPassword(delegate: delegate())
    

變更詳細資料

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 在服務儀表板的密碼變更標籤中,將密碼變更電子郵件設為「開啟」。

  3. 呼叫登入小組件來啟動變更詳細資料流程。

    class delegate : AuthorizationDelegate {
       public func onAuthorizationSuccess(accessToken: AccessToken?, identityToken: IdentityToken?, refreshToken: RefreshToken?, response:Response?) {
          //User authenticated, and fresh tokens received
       }
    
       public func onAuthorizationCanceled() {
             //changed details canceled by the user
       }
    
       public func onAuthorizationFailure(error: AuthorizationError) {
             //Exception occurred
       }
    }
    
    AppID.sharedInstance.loginWidget?.launchChangeDetails(delegate: delegate())
    

變更密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 將下列程式碼放在您的應用程式中,以啟動變更密碼流程。

    class delegate : AuthorizationDelegate {
       public func onAuthorizationSuccess(accessToken: AccessToken?, identityToken: IdentityToken?, refreshToken: RefreshToken?, response:Response?) {
             //User authenticated, and fresh tokens received
       }
    
       public func onAuthorizationCanceled() {
             //change password canceled by the user
       }
    
       public func onAuthorizationFailure(error: AuthorizationError) {
             //Exception occurred
       }
    }
    
    AppID.sharedInstance.loginWidget?.launchChangePassword(delegate: delegate())
    

使用 Node.js SDK 顯示登入小組件

您可以使用 Node.js 伺服器 SDK 來呼叫預先設定的畫面。

將張貼路徑新增至可利用使用者名稱及密碼參數所呼叫的應用程式,並使用資源擁有者密碼登入。

app.post("/form/submit", bodyParser.urlencoded({extended: false}), passport.authenticate(WebAppStrategy.STRATEGY_NAME, {
successRedirect: LANDING_PAGE_URL,
failureRedirect: ROP_LOGIN_PAGE_URL,
failureFlash : true // allow flash messages
}));

WebAppStrategy 可讓使用者利用使用者名稱和密碼登入您的 Web 應用程式。 登入成功之後,使用者的存取記號會儲存在 HTTP 階段作業中,並且可在階段作業期間使用。 在 HTTP 階段作業損毀或過期之後,記號即無效。

註冊

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 將下列程式碼放在您的應用程式中。 當使用者嘗試註冊您的應用程式時,登入 Widget 會被呼叫並顯示自訂的註冊頁面。

    app.get("/sign_up", passport.authenticate(WebAppStrategy.STRATEGY_NAME, {
    successRedirect: LANDING_PAGE_URL,
    show: WebAppStrategy.SIGN_UP
    }));
    

忘記密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者從您的應用程式管理其帳戶必須設為開啟

  2. 在服務儀表板的重設密碼標籤中,請確定忘記密碼電子郵件已設為開啟

  3. 將下列程式碼放在您的應用程式中,以將 show 內容傳遞至 WebAppStrategy.FORGOT_PASSWORD。 當使用者要求更新其登入您應用程式的密碼時,就會呼叫登入小組件,並啟動處理程序。

    app.get("/forgot_password", passport.authenticate(WebAppStrategy.STRATEGY_NAME, {
    successRedirect: LANDING_PAGE_URL,
    show: WebAppStrategy.FORGOT_PASSWORD
    }));
    

變更詳細資料

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 在服務儀表板的密碼變更標籤中,將密碼變更電子郵件設為「開啟」。

  3. 將下列程式碼放在您的應用程式中,以將 show 內容傳遞至 WebAppStrategy.FORGOT_PASSWORD,來啟動變更詳細資料表單。

    app.get("/change_details", passport.authenticate(WebAppStrategy.STRATEGY_NAME, {
    successRedirect: LANDING_PAGE_URL,
    show: WebAppStrategy.CHANGE_DETAILS
    }));
    

變更密碼

  1. 在主控台中設定 Cloud Directory 設定容許使用者註冊至您的應用程式容許使用者從您的應用程式管理其帳戶兩者必須都設為開啟

  2. 在服務儀表板的密碼變更標籤中,將密碼變更電子郵件設為「開啟」。

  3. 將下列程式碼放在您的應用程式中,以將 show 內容傳遞至 WebAppStrategy.FORGOT_PASSWORD,來啟動變更詳細資料表單。

    app.get("/change_password", passport.authenticate(WebAppStrategy.STRATEGY_NAME, {
    successRedirect: LANDING_PAGE_URL,
    show: WebAppStrategy.CHANGE_PASSWORD
    }));