設定を取得するには、fetch 操作を使用します。
このセクションでは、設定の詳細の取得に関する以下のトピックについて説明します。
設定の詳細を取得するには、fetchRequest メッセージを使用します。 以下の表に、すべての認証情報に適用可能な、このリクエスト メッセージの共通の要素のリストを示します。
|
要素 |
必須 |
説明 |
|---|---|---|
|
clientTxnId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
|
追加入力（AdditionalInput）要素 |
||
|
pairs |
いいえ |
AuthMinder の additionalInput 要素を使用すると、追加情報を指定して AuthMinder の認証機能を拡張したい場合に、追加入力を設定できます。 その場合、名前と値のペアで追加情報を設定する必要があります。
事前定義済みの追加入力パラメータの一部を以下に示します。
|
|
組織詳細（configurationNames/orgDetails）要素 |
||
|
orgName |
はい |
指定した組織で使用されている設定を取得します。 |
|
または |
||
|
isGlobal |
はい |
グローバル レベルで適用されている設定を取得するかどうかを示します。 |
|
設定要素 以下の 2 つの要素はすべての設定（configurationNames/configurationname<Names>）に適用できます。 |
||
|
configNames |
いいえ |
特定の組織の設定名を取得します。 |
|
isAllConfigs |
いいえ |
すべての設定を取得する必要があるかどうかを示します。 |
|
isFetchOnlyNames |
いいえ |
取得する必要があるのは設定名のみかどうかを示します。 |
設定の詳細を取得する方法
成功したトランザクションでは、fetchResponse レスポンス メッセージに、以下の表で説明されている要素が返されます。 これらの要素は SOAP本文に含まれます。 エラーがある場合、エラー レスポンスは SOAP 本文に含まれます。 SOAP エラー メッセージの詳細については、付録「エラー コード」を参照してください。
|
要素 |
説明 |
|---|---|
|
message |
トランザクションのステータスを示します。 |
|
reasonCode |
操作の失敗時に AuthMinder サーバが送信する一意のコード。 |
|
responseCode |
エラーの場合に SDK が返すコード。 |
|
transactionID |
トランザクションの一意の識別子。 |
|
additionalOutput |
追加入力の戻り値。 |
|
設定 |
以下が返されます。
|
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|