前のトピック: サーバ イベントの取得次のトピック: 設定の削除

CA Strong Authentication Web Services Guide › AuthMinder 設定の管理 › HSM で使用可能なキーの確認

HSM で使用可能なキーの確認

HSM にキーが存在するかどうかを確認するには、isKeyAvailableInHSM 操作を使用します。 このセクションでは、HSM キーの確認に関する以下のトピックについて説明します。

注： 設定を削除した後、変更を有効にするにはシステム キャッシュをリフレッシュする必要があります。 システム キャッシュをリフレッシュする方法の詳細については、「組織キャッシュのリフレッシュ」を参照してください。

リクエスト メッセージの準備

HSM 内のキーを確認するには、isKeyAvailableInHSMRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。

要素

必須

説明

clientTxId

いいえ

呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。

追加入力（AdditionalInput）要素

pairs

いいえ

AuthMinder の additionalInput 要素を使用すると、追加情報を指定して AuthMinder の認証機能を拡張したい場合に、追加入力を設定できます。 その場合、名前と値のペアで追加情報を設定する必要があります。

  • name （作成するキー ペアの名前）
  • value （名前に対応する値）

    注： これらの要素は複数追加できます。

事前定義済みの追加入力パラメータの一部を以下に示します。

  • AR_WF_LOCALE_ID
    呼び出し元アプリケーションにメッセージを返す際に AuthMinder で使用するロケールを指定します。
  • AR_WF_CALLER_ID
    トランザクションの追跡に役立ちます。 この情報は、セッション ID またはクライアント トランザクション ID （clientTxnId）を使用して指定できます。

キーの詳細

keyLabel

はい

HSM で使用可能なキーを参照するキーのラベル。

Web サービスの起動

設定の詳細を削除する方法

  1. （オプション） SOAP ヘッダまたは isKeyAvailableInHSM 操作の additionalInput 要素に認証および許可の詳細を含めます。 これらの詳細については、「Web サービス セキュリティの管理」の章を参照してください。
  2. isKeyAvailableInHSMRequest 要素を使用して、上記の表に記載されているキーの詳細を確認します。
  3. isKeyAvailableInHSMRequest メッセージを使用して、前の手順で取得した詳細に従って入力メッセージを作成します。
  4. ArcotWebFortAdminSvc サービスの isKeyAvailableInHSM 操作を呼び出して、設定の詳細を削除します。

レスポンス メッセージの解釈

成功したトランザクションでは、isKeyAvailableInHSMResponse レスポンス メッセージに、上記の表で説明されている要素が返されます。 これらの要素は SOAP本文に含まれます。 エラーがある場合、エラー レスポンスは SOAP 本文に含まれます。 SOAP エラー メッセージの詳細については、付録「エラー コード」を参照してください。

要素

説明

message

トランザクションのステータスを示します。

reasonCode

操作の失敗時に AuthMinder サーバが送信する一意のコード。

responseCode

エラーの場合に SDK が返すコード。

transactionID

トランザクションの一意の識別子。

additionalOutput

追加入力に対応する戻り値。