18.6 Web資格証明の管理

外部RESTサービスまたはREST対応SQLサービスの認証資格証明を格納します。

18.6.1 資格証明について

Web資格証明を使用して、外部RESTサービスまたはREST対応SQLサービスに接続します。

Web資格証明を作成すると、Application ExpressコンポーネントおよびAPIで使用する認証資格証明が安全に格納および暗号化されます。資格証明は、クリア・テキストで取得できません。資格証明はワークスペースレベルで格納されるため、すべてのアプリケーションに表示されます。

有効なURLの定義によるWeb資格証明の保護

「URLに対して有効」属性に有効なURLを追加して、Web資格証明を保護できます。「URLに対して有効」属性にURLを追加すると、Application Expressが機密性の高い資格証明を別のサーバーに誤って送信するのを防ぐことができます。Web資格証明が使用されるたびに、Application ExpressはURLが「URLに対して有効」属性で定義されているものと一致するかどうかを確認します。

この属性にURLを追加する場合は、各URLを新しい行に配置します。使用するURLエンドポイントは、ここで指定するURLのいずれかで始まる必要があります。例は、フィールドレベル・ヘルプを参照してください。

資格証明のエクスポートおよびインポート

アプリケーションをエクスポートすると、使用されている資格証明がエクスポート・ファイルに追加されます。アプリケーションを別のワークスペースにインポートすると、Application Expressによって、ターゲット・ワークスペースにすでに同じ静的IDの資格証明が含まれているかどうかが確認されます。資格証明がすでに存在する場合、アプリケーションでそれが使用されます。そうでない場合は、インポート・ファイルからの資格証明が、ターゲット・ワークスペースに作成されます。

サポートされている認証タイプについて

Web資格証明では、次の認証タイプがサポートされます。

  • 基本認証: 認可リクエスト・ヘッダーとしてBase64エンコード形式のユーザー名とパスワードを送信します。

  • OAuth2クライアント資格証明フロー: Application Expressは、トークン・サーバーURLを使用して、クライアントIDとクライアント・シークレットをアクセス・トークンと交換します。その後、アクセス・トークンを使用して実際のリクエストが実行されます。アクセス・トークンの有効期限が切れると、Application Expressは新しいトークンを透過的にリクエストします。

  • HTTPヘッダー: 資格証明はHTTPヘッダーとしてRESTリクエストに追加されます。資格証明の名前はHTTPヘッダー名で、資格証明のシークレットはHTTPヘッダー値です。Application Expressでは、これらのシークレットはデバッグ・ログまたはその他のログに追加されません。

  • URL問合せ文字列: 資格証明は、問合せ文字列パラメータとしてRESTリクエストのURLに追加されます(例: ?name=value)。このオプションは、APIキーで役に立つ場合があります。Application Expressでは、これらのシークレットはデバッグ・ログまたはその他のログに追加されません。ただし、プロキシ・サーバーまたはその他の中間サーバーは、これらの資格証明をログ・ファイルに記録します。

18.6.2 Web資格証明の作成

ワークスペース・ユーティリティまたは共有コンポーネントからWeb資格証明を作成します。

Web資格証明を作成するには:

  1. Web資格証明ページにナビゲートします。
    • 「ワークスペース・ユーティリティ」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. 「ワークスペース・ユーティリティ」をクリックします。

      3. 「Web資格証明」をクリックします。

    • 「共有コンポーネント」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. アプリケーションを選択します。

      3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。

      4. 「セキュリティ」で、「Web資格証明」を選択します。

  2. Web資格証明ページで、「作成」をクリックします。
  3. Web資格証明ページで属性を構成します。
  4. 名前: わかりやすい名前を入力します。
  5. 認証タイプ: 次のいずれかを選択します。
    • 基本認証
    • OAuth2クライアント資格証明フロー
    • HTTPヘッダー
    • URL問合せ文字列

    この属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

    次に表示されるオプションは、選択した認証タイプによって異なります。

  6. 認証タイプが「基本認証」の場合:
    1. クライアントIDまたはユーザー名: ユーザー名を入力します。Application Expressでは、この情報は暗号化されて格納されません。
    2. クライアント・シークレットまたはパスワード: パスワードを入力します。
    3. クライアント・シークレットまたはパスワードの確認: パスワードを再度入力して、入力内容を確認します。
    4. URLに対して有効: Application Expressは、Web資格証明が使用するURLがこの属性のURLと一致するかどうかを確認します。この属性にURLを追加する場合は、次のようにします。
      • 各URLを新しい行に配置します。

      • 使用するURLエンドポイントは、ここで指定するURLのいずれかで始まる必要があります。

      例は、フィールドレベル・ヘルプを参照してください。

    5. インストール時にプロンプトを表示: アプリケーションを別のOracle Application Expressインスタンスにインポートするときに、この資格証明に対するプロンプトを表示するかどうかを選択します。
    6. コメント: ここにコメントまたはノートを入力します。これらのコメントは、アプリケーションの実行時には表示されません。
  7. 認証タイプが「OAuth2クライアント資格証明フロー」の場合:
    1. OAuthスコープ: OAuth 2.0用語のアクセス・トークンで表される権限は、スコープと呼ばれます。スコープ・パラメータを使用すると、アプリケーションはアクセス・リクエストの目的のスコープを表現できます。

      認証サーバーでアクセス・トークン・リクエストにスコープを指定する必要がある場合は、ここで指定します。OAuth2アクセス・トークンは、次のリクエスト本文でリクエストされます。

      grant_type=client_credentials&scope={scope}
    2. クライアントIDまたはユーザー名: クライアントIDを入力します。Application Expressでは、この情報は暗号化されて格納されません。
    3. クライアント・シークレットまたはパスワード: シークレットを再度入力して、入力内容を確認します。
    4. URLに対して有効: Application Expressは、Web資格証明が使用するURLがこの属性のURLと一致するかどうかを確認します。この属性にURLを追加する場合は、次のようにします。
      • 各URLを新しい行に配置します。

      • 使用するURLエンドポイントは、ここで指定するURLのいずれかで始まる必要があります。

      例は、フィールドレベル・ヘルプを参照してください。

    5. インストール時にプロンプトを表示: アプリケーションを別のOracle Application Expressインスタンスにインポートするときに、この資格証明に対するプロンプトを表示するかどうかを選択します。
    6. コメント: ここにコメントまたはノートを入力します。これらのコメントは、アプリケーションの実行時には表示されません。
  8. 認証タイプが「HTTPヘッダー」の場合:
    1. 資格証明名: この資格証明に使用するHTTPヘッダーの名前を入力します。
    2. 資格証明シークレット: 資格証明の値(シークレット)を入力します。
    3. URLに対して有効: Application Expressは、Web資格証明が使用するURLがこの属性のURLと一致するかどうかを確認します。この属性にURLを追加する場合は、次のようにします。
      • 各URLを新しい行に配置します。

      • 使用するURLエンドポイントは、ここで指定するURLのいずれかで始まる必要があります。

      例は、フィールドレベル・ヘルプを参照してください。

    4. インストール時にプロンプトを表示: アプリケーションを別のOracle Application Expressインスタンスにインポートするときに、この資格証明に対するプロンプトを表示するかどうかを選択します。
    5. コメント: ここにコメントまたはノートを入力します。これらのコメントは、アプリケーションの実行時には表示されません。
  9. 認証タイプが「URL問合せ文字列」の場合:
    1. 資格証明名: この資格証明に使用するURL問合せ文字列パラメータの名前を入力します。
    2. 資格証明シークレット: 資格証明の値(シークレット)を入力します。
    3. URLに対して有効: Application Expressは、Web資格証明が使用するURLがこの属性のURLと一致するかどうかを確認します。この属性にURLを追加する場合は、次のようにします。
      • 各URLを新しい行に配置します。

      • 使用するURLエンドポイントは、ここで指定するURLのいずれかで始まる必要があります。

      例は、フィールドレベル・ヘルプを参照してください。

    4. インストール時にプロンプトを表示: アプリケーションを別のOracle Application Expressインスタンスにインポートするときに、この資格証明に対するプロンプトを表示するかどうかを選択します。
    5. コメント: ここにコメントまたはノートを入力します。これらのコメントは、アプリケーションの実行時には表示されません。
  10. 「変更の適用」をクリックします。

18.6.3 資格証明の編集または削除

ワークスペース・ユーティリティまたは共有コンポーネントからWeb資格証明を編集または削除します。

Web資格証明を編集または削除するには:

  1. Web資格証明ページにナビゲートします。
    • 「ワークスペース・ユーティリティ」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. 「ワークスペース・ユーティリティ」をクリックします。

      3. 「Web資格証明」をクリックします。

    • 「共有コンポーネント」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. アプリケーションを選択します。

      3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。

      4. 「セキュリティ」で、「Web資格証明」を選択します。

  2. Web資格証明ページで、資格証明名を選択します。
    作成/編集ページが表示されます。
  3. 資格証明を編集するには:
    1. 対象となる属性を編集します。属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。
    2. 変更を保存するには、「変更の適用」をクリックします。
  4. 資格証明を削除するには:
    1. 資格証明を削除するには、「削除」をクリックします。
    2. プロンプトが表示されたら、「OK」をクリックします。

      ヒント:

      資格証明は、ワークスペース内のいずれかの場所で参照されている場合は削除できません。

18.6.4 資格証明の使用状況の表示

Web資格証明の使用状況レポートを表示します。

Web資格証明の使用状況レポートを表示するには:

  1. Web資格証明ページにナビゲートします。
    • 「ワークスペース・ユーティリティ」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. 「ワークスペース・ユーティリティ」をクリックします。

      3. 「Web資格証明」をクリックします。

    • 「共有コンポーネント」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. アプリケーションを選択します。

      3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。

      4. 「セキュリティ」で、「Web資格証明」を選択します。

  2. Web資格証明ページで、「使用状況」をクリックします。
    使用状況ページの上部には、使用されている資格証明、関連付けられたコンポーネント・タイプおよびコンポーネントの名前が表示されます。未使用の資格証明がページの下部に表示されます。
  3. 未使用の資格証明を削除するには、「未使用の削除」をクリックします。

18.6.5 資格証明の履歴の表示

Web資格証明の履歴レポートを表示します。

Web資格証明の履歴レポートを表示するには:

  1. Web資格証明ページにナビゲートします。
    • 「ワークスペース・ユーティリティ」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. 「ワークスペース・ユーティリティ」をクリックします。

      3. 「Web資格証明」をクリックします。

    • 「共有コンポーネント」からの場合:
      1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。

      2. アプリケーションを選択します。

      3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。

      4. 「セキュリティ」で、「Web資格証明」を選択します。

  2. Web資格証明ページで、「履歴」をクリックします。
    履歴ページに、現在のワークスペースの資格証明への最近の変更が表示されます。