使用 REST API 自訂 Oracle Universal Authenticator 從屬端應用程式

簡介

本教學課程示範如何使用 REST API 和 Postman 自訂 Oracle Universal Authenticator 從屬端應用程式。

必要條件

開始此自學課程之前，您必須具有：

  1. 閱讀並瞭解自訂 Oracle Universal Authenticator 從屬端應用程式。
  2. 使用 Oracle Universal Authenticator 部署的執行中 Oracle Advanced Authentication 安裝。
  3. 根據安裝 Oracle Universal Authenticator 從屬端應用程式，在裝置上安裝 Oracle Universal Authenticator 從屬端應用程式。
  4. 熟悉 REST 架構樣式。
  5. 已安裝 Native Postman client 應用程式。
  6. 已下載 json 檔案 Oracle_Universal_Authenticator_REST_API.postman_collection.json 、Oracle_Universal_Authenticator_Example_Environment.postman_environment.json 。

注意：使用 REST API 更新特性時，管理員應注意下列事項：

安裝 Oracle Advanced Authentication Postman Collection

在 Postman 中設定環境參數

注意：下列步驟可能會因您的 Postman 版本而有所不同。

  1. 開啟 Postman，然後在工作區中選取環境。

  2. 按一下匯入。

  3. 在匯入對話方塊中，選取或刪除 Oracle_Universal_Authenticator_Example_Environment.postman_environment.json ，然後按一下開啟。

  4. 在顯示的環境清單中，按一下 Oracle Universal Authenticator Example Environment 右邊的省略符號，然後按一下複製。

  5. 在原始環境上方顯示的 Oracle Universal Authenticator Example Environment Copy 上，按一下省略符號，然後重新命名為 Oracle Universal Authenticator Environment for REST APIs。

  6. 在初始值和目前值中輸入下列值，以更新新環境的環境變數。完成後，按一下儲存：

    • RELEASENAME ：指派給 Oracle Advanced Authentication 設定的 RELEASENAME，例如 oaainstall。
    • DRSS_URL ：Oracle Advanced Authentication 中 DRSS 端點的 URL，例如 https://oaa.example.com/oaa-drss。
    • DRSS_USERNAME ：DRSS API 的使用者名稱，格式為 RELEASENAME-oaa-drss，例如 oaainstall-oaa-drss。
    • DRSS_PASSWORD ：Oracle Advanced Authentication 設定的 drssapikey。

    注意：如果您不知道 RELEASENAME、DRSS_URL、DRSS_USERNAME 和 DRSS_PASSWORD，請參閱列印建置詳細資訊。

    環境看起來將類似下列項目：

  7. 按一下環境下拉式清單，然後從清單中選取更新的環境：

匯入 Postman Collection

  1. 若要匯入 Oracle Advanced Authentication REST API Postman 集合，請選取集合 > 匯入。

  2. 在匯入對話方塊中，選取或刪除 Oracle_Universal_Authenticator_REST_API.postman_collection.json 。

    此集合應顯示如下：

測試佈景主題 API

建立語言主題

注意：若要避免 SSL 憑證驗證錯誤，請在導覽漢堡功能表中瀏覽至檔案 > 設定值，然後在「一般」頁籤中關閉 SSL 憑證驗證。

在這個區段中，您可以為要自訂的項目建立語言主題。

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API 。

  2. 選取 PUT updateLocale 。此要求會對 oaa-drss/v1/themes/<locale> 端點提出 PUT 要求，並根據「主體」中的資訊，為您所需的地區設定建立主題。

    視需要變更或移除欄位與值。

    在此範例中，會建立 en_US 語言的主題 oaa-drss/v1/themes/en_US，並更新所有可自訂特性。

    對於標誌值，您必須使用您選擇的公用程式將 bmp 檔案轉換為 BASE64，然後將該值貼入 logo 項目。

  3. 按一下傳送。

  4. 在回應中，確認顯示 204 No Content。

  5. 為您需要的其他語言建立更多佈景主題。在此範例中，會建立法文 fr 語言的主題 oaa-drss/v1/themes/fr，並更新所有可自訂特性。

    注意：所有自訂的文字都必須使用您所建立主題的語言。

  6. 按一下傳送。

  7. 在回應中，確認顯示 204 No Content。

  8. 針對您所需的任何其他語言主題重複上述步驟，例如西班牙文等等。

取得語言佈景主題

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API

  2. 選取 GET getLocale 。此要求會對 oaa-drss/v1/themes/locales 端點提出 GET 要求，並傳回所有已建立的主題。

  3. 按一下傳送。

  4. 在回應中，確認顯示 Status: 200 OK。會傳回主題清單。

取得主題的自訂特性

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API 。

  2. 選取 GET getLocale 。此要求會對 oaa-drss/v1/themes/<locale> 端點提出 GET 要求，並傳回主題的所有自訂特性。

  3. 按一下傳送。

  4. 在回應中，確認顯示 Status: 200 OK。會傳回自訂的特性清單。

    注意：除了您自訂的參數之外，您也會看到尚未自訂之參數的預設值，以及其他無法自訂的參數。

啟用主題

若要開始使用 Oracle Universal Authenticator 從屬端應用程式中的主題，您必須將 oua.themes.custom.distribution 特性設為 "1"。

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API 。

  2. 選取 PUT oua.themes.custom.distribution 。此要求會透過在主體中設定 oua.themes.custom.distribution 特性，對 oaa-drss/oua/property/v1 端點提出 PUT 要求。值若為 1，則會啟用主題，而值若為 0，則會停用主題。預設值是 0。

  3. 按一下傳送。

  4. 在回應中，確認顯示 Status: 200 OK，且回應包含設為 1 的 oua.themes.custom.distribution。

更新佈景主題

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API 。

  2. 選取 PUT updateLocale 。此要求會對 oaa-drss/v1/themes/<locale> 端點提出 PUT 要求，並根據本文中的資訊，為您所需的地區設定建立或更新主題。

    視需要更新或移除欄位與值。

    注意：除了要更新的欄位之外，您還必須包含先前自訂的所有欄位。如果您未新增先前自訂的特性，這些特性將會被預設值覆寫。

    在此範例中，CPFT_TILE_IMAGE 會更新為 Enter your Example Company Username"。

  3. 按一下傳送。

  4. 在回應中，確認顯示 204 No Content。

刪除主題

刪除佈景主題會移除整個佈景主題。管理員在刪除主題時應注意下列事項：

  1. 在「集合」頁籤中，瀏覽至 Oracle Universal Authenticator REST API > 主題管理 API 。

  2. 選取 DEL deleteLocale 。此要求會對 oaa-drss/v1/themes/<locale> 端點提出 DELETE 要求，並刪除指定地區設定的主題。

    在此範例中，會刪除西班牙文地區設定 (es)。

  3. 按一下傳送。

  4. 在回應中，確認顯示 204 No Content。

  5. 如果您需要以虛擬值更新主題，請使用 PUT updateLocale 來更新主題，然後按一下傳送。204 No Content 訊息隨即顯示：

深入瞭解

意見

若要提供本教學課程的意見，請聯絡 idm_user_assistance_ww_grp@oracle.com

致謝

其他學習資源

探索 docs.oracle.com/learn 上的其他實驗室，或存取 Oracle Learning YouTube 頻道上的更多免費學習內容。此外，請造訪 education.oracle.com/learning-explorer 以成為 Oracle Learning Explorer。

如需產品文件，請造訪 Oracle Help Center 。