前のトピック: ユーザへの認証情報の割り当て次のトピック: OATH トークンの取得

CA Strong Authentication Web Services Guide › バルク操作の実行 › OATH トークンのアップロード

OATH トークンのアップロード

このセクションでは、一括での OATH トークンのアップロードに関する以下のトピックについて説明します。

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

AuthMinder データベースに OATH トークンを一括でアップロードするには、UplodaOATHTokensRequestMessage を使用します。以下の表に、このリクエスト メッセージの要素のリストを示します。

要素

必須

説明

共通の要素

clientTxId

いいえ

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

additionalInput/pairs

いいえ

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

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

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

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

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

共通のキー要素

orgDetails/orgName

いいえ

OATH トークンをアップロードする組織の名前を示します。

orgDetails/isGlobal

いいえ

OATH トークンをグローバル レベルで適用するかどうかを示します。 このオプションを選択すると、OATH トークンはシステム内のすべての組織で利用可能になります。

remark

いいえ

OATH トークンを識別するテキスト メッセージ。

key

はい

OTP の生成に使用されるキー。

OATH トークン（keyContainer）要素

注： OATH トークン情報は、以下の要素を使用して渡すか、またはその情報を XML ファイルに入れ、inputXml 要素を使用してそのファイルをアップロードすることができます。

バージョン

はい

OATH トークン情報を定義するスキーマのバージョン。 この要素でサポートされている値は「1.0」です。

EncryptionMethod/ algorithm

はい

機密情報の暗号化に使用される暗号化方式。

たとえば、Secret 要素などです。

EncryptionMethod/IV

はい

暗号化スキームで使用される初期化ベクトルの base64 エンコード形式の値。 これは、サポートされているほかのアルゴリズムの中で「AES128-CBC」に対してのみ必要です。

TokenInfo/Manufacturer

いいえ

OATH トークンの製造者情報。

TokenInfo/SerialNo

いいえ

OATH トークンの一意のシリアル番号。

TokenInfo/Model

いいえ

OATH トークンの作成に関する情報を示す一意のモデル番号。

TokenInfo/AdditionalInfo

いいえ

OATH トークンに設定する追加情報。 この情報は名前と値のペアで設定します。

  • Name
    作成するキー ペアの名前を示します。
  • Value
    名前に対応する値を示します。

Key/KeyAlgorithm

はい

OTP の生成に使用されるアルゴリズム。 サポートされている値は以下のとおりです。

  • HOTP： イベント ベースの OTP がサポートされていることを示します。
  • TOTP： 時間ベースの OTP がサポートされていることを示します。

Key/KeyId

はい

トークンの一意の識別子。

Key/OTPFormat/Length

はい

OATH トークンを使用して生成される OTP の文字長を示します。

Key/Secret

はい

OTP の生成に使用される共有秘密キー。

Key/Counter

いいえ

HOTP の場合に、OTP の生成に使用されるカウンタ。 このカウンタによって、ユーザが OTP を使用できる回数が決定されます。

Key/Time

いいえ

TOTP の場合に、タイム ステップのカウントを開始する時刻（秒単位）。

Key/TimeInterval

いいえ

TOTP の生成に使用されるタイム ステップ ウィンドウ。 同じウィンドウ内で生成される OTP は同一です。

この値の単位は秒です。

XML 情報

inputXml

いいえ

AuthMinder サーバによって発行されるワンタイム パスワードのキー コンテナを定義する XML ファイル。

Web サービスの起動

ユーザの OATH トークンを一括でアップロードする方法

  1. （オプション） SOAP ヘッダまたは UploadOATHTokens 操作の additionalInput 要素に認証および許可の詳細を含めます。 ヘッダ要素の詳細については、「Web サービス セキュリティの管理」の章を参照してください。
  2. （オプション）プラグインを実装する場合は、additionalInput 要素タイプを呼び出して追加入力を指定します。

    このタイプでは、追加情報を名前と値のペアとして設定します。

  3. UploadOATHTokensRequestMessage を使用して、前の手順で取得した詳細に従って入力メッセージを作成します。
  4. ArcotWebFortBulkOperationsSvc サービスの UploadOATHTokens 操作を呼び出して、OATH トークンをアップロードします。

    この操作では、トランザクションの詳細およびバッチ識別子を含む UploadOATHTokensResponseMessage のインスタンスが返されます。

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

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

要素

説明

message

操作のステータスを定義する文字列。

reasonCode

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

responseCode

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

transactionID

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

additionalOutput

AuthMinder サーバに渡された additionalInput に対する出力。

batchID

アップロードされたトークンのバッチの識別に役立つ一意の識別子。