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. インストールされたネイティブPostmanクライアント・アプリケーション。
  6. jsonファイルOracle_Universal_Authenticator_REST_API.postman_collection.json、Oracle_Universal_Authenticator_Example_Environment.postman_environment.jsonをダウンロードしました。

ノート: 管理者は、REST APIを使用してプロパティを更新するときに、次の点に注意してください:

Oracle Advanced Authentication Postmanコレクションのインストール

Postmanでの環境パラメータの設定

ノート: 次のステップは、使用しているPostmanのバージョンによって異なる場合があります。

  1. Postmanを開き、ワークスペースで「環境」を選択します。

  2. 「インポート」をクリックします。

  3. 「インポート」ダイアログ・ボックスで、Oracle_Universal_Authenticator_Example_Environment.postman_environment.jsonを選択またはドロップし、「開く」をクリックします。

  4. 表示される環境リストで、「Oracle Universal Authenticatorサンプル環境」の右側にある省略記号をクリックし、「複製」をクリックします。

  5. 元の環境の上に表示されるOracle Universal Authenticator環境コピーの例で、省略記号をクリックし、名前を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: RELEASENAME-oaa-drssの形式のDRSS APIのユーザー名(oaainstall-oaa-drssなど)。
    • DRSS_PASSWORD: Oracle Advanced Authentication設定のdrssapikey。

    ノート: RELEASENAME、DRSS_URL、DRSS_USERNAMEおよびDRSS_PASSWORDがわからない場合は、デプロイメントの詳細の印刷を参照してください。

    環境は次のようになります。

  7. 「環境」ドロップダウン・リストをクリックし、リストから更新された環境を選択します。

Postmanコレクションのインポート

  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を参照してください。