このセクションでは、組織に対してアップロードされる OATH トークンの取得に関する以下のトピックについて説明します。
AuthMinder データベースから OATH トークンを取得するには、FetchOATHTokensRequestMessage を使用します。以下の表に、このリクエスト メッセージの要素のリストを示します。
|
要素 |
必須 |
説明 |
|
|---|---|---|---|
|
共通の要素 |
|||
|
clientTxId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
|
|
additionalInput/pairs |
いいえ |
AuthMinder の additionalInput 要素を使用すると、追加情報を指定して AuthMinder の認証機能を拡張したい場合に、追加入力を設定できます。 その場合、名前と値のペアで追加情報を設定する必要があります。
事前定義済みの追加入力パラメータの一部を以下に示します。
|
|
|
組織詳細（orgDetails）要素 |
|||
|
fetchGlobal |
いいえ |
グローバル レベルで割り当てられている OATH トークンを取得するかどうかを示します。 サポートされている値は以下のとおりです。
|
|
|
または |
|||
|
orgList |
いいえ |
OATH トークンをアップロードする組織の名前を示します。 |
|
|
トークン要素 |
|||
|
tokenID |
いいえ |
OATH トークンの一意の識別子。 |
|
|
batchID |
いいえ |
OATH トークンが作成されたバッチを示す識別子です。 |
|
|
検索フィルタ（tokenStatus）要素 |
|||
|
tokenStatusFilter/free |
いいえ |
未使用で、まだユーザに割り当てられていないトークンを取得するフィルタ。 |
|
|
tokenStatusFilter/assigned |
いいえ |
ユーザに割り当てられているトークンを取得するフィルタ。 |
|
|
tokenStatusFilter/abandoned |
いいえ |
使用されなくなったトークンを取得するフィルタ。 |
|
|
tokenStatusFilter/failed |
いいえ |
アップロード時に失敗したトークンを取得するために使用されるフィルタ。 トークンのアップロードは以下の場合に失敗することがあります。
|
|
組織のユーザに対して割り当てられている OATH トークンを取得する方法
このタイプでは、追加情報を名前と値のペアとして設定します。
この操作では、認証情報およびトランザクションの詳細を含む FetchOATHTokensResponseMessage のインスタンスが返されます。
成功したトランザクションでは、FetchOATHTokenResponse レスポンス メッセージに、以下の表で説明されている要素およびアップロードされたトークン情報が返されます。 これらの要素は SOAP本文に含まれます。 エラーがある場合、エラー レスポンスは SOAP 本文に含まれます。 SOAP エラー メッセージの詳細については、付録「エラー コード」を参照してください。
|
要素 |
説明 |
|---|---|
|
message |
操作のステータスを定義する文字列。 |
|
reasonCode |
操作の失敗時に AuthMinder サーバが送信する一意のコード。 |
|
responseCode |
操作の失敗時に AuthMinder サーバが送信する一意のコード。 |
|
transactionID |
トランザクションの一意の識別子。 |
|
additionalOutput |
AuthMinder サーバに渡された additionalInput に対する出力。 |
|
batchID |
アップロードされたトークンのバッチの識別に役立つ一意の識別子。 |
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|