前のトピック: ユーザのすべてのアカウントの取得次のトピック: アカウントを使用したユーザの詳細の取得

CA Strong Authentication Web Services Guide › ユーザおよびアカウントの管理 › ユーザ アカウント操作の実行 › ユーザ アカウントの詳細の取得

ユーザ アカウントの詳細の取得

特定のユーザ アカウントの詳細を取得するには、retrieveUserAccount 操作を使用する必要があります。

このセクションでは、ユーザの単一アカウントの取得に関する以下のトピックについて説明します。

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

以下の表に、retrieveUserAccountRequest メッセージの要素のリストを示します。

要素

必須

説明

userId/orgName

いいえ

ユーザが属する組織の名前です。

注： 組織名が渡されない場合、その操作ではデフォルトの組織が使用されます。

userId/userName

はい

システムでユーザを識別するための一意の識別子。

userId/userRefId

いいえ

1 人のユーザが実行したさまざまな操作を追跡するために参照用として使用される識別子。

account/accountType

はい

アカウント ID を修飾し、アカウント ID の使用に関する追加コンテキストを指定する属性。

account/accountID

いいえ

ユーザ名に追加してユーザを識別するために使用される代替識別子。 アカウント ID はアカウントとも呼ばれます。

account/accountStatus

いいえ

アカウントのステータス。 サポートされている値は以下のとおりです。

  • 0-9： アカウントが INITIAL 状態であることを示します。
  • 10-19： アカウントが ACTIVE 状態であることを示します。
  • 20-29： アカウントが INACTIVE 状態であることを示します。
  • 30-39： アカウントが DELETED 状態であることを示します。
  • >39：アカウントの状態が不明（UNKNOWN）であることを示します。

account/accountIDAttribute

いいえ

システムでユーザを識別するために使用される代替識別子。

注： 1 人のユーザに対して渡すことができるアカウント ID は 3 つまでです。

account/dateCreated

いいえ

アカウント ID が作成された日時のタイムスタンプ。

account/dateModified

いいえ

アカウント ID が最後に変更された日時のタイムスタンプ。

account/accountCustomAttribute

いいえ

名前と値のペアで渡す追加のアカウント情報。

  • attributeName
    作成する属性の名前を示します。
  • attributeValue
    名前に対応する値を示します。

clientTxId

いいえ

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

Web サービスの起動

ユーザ アカウントの詳細を取得する方法

  1. （オプション） retrieveUserAccount 操作のヘッダに認証および許可の詳細を含めます。 ヘッダ要素の詳細については、「Web サービス セキュリティの管理」の章を参照してください。
  2. retrieveUserAccountRequest 要素を使用して、上記の表に記載されているユーザおよびアカウントの詳細を収集します。
  3. retrieveUserAccountRequest メッセージを使用して、前の手順で取得した詳細に従って入力メッセージを作成します。
  4. ArcotUserRegistrySvc サービスの retrieveUserAccount 操作を呼び出して、アカウント情報に基づいたユーザの詳細を取得します。

    この操作では、トランザクション識別子、認証トークン、およびユーザ アカウントの詳細が含まれる retrieveUserAccountResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。

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

retrieveUserAccountResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションではユーザ アカウントの詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。

成功したトランザクションで返される要素の詳細については、以下の表を参照してください。 エラーがある場合は、付録「エラー コード」を参照してください。

要素

説明

ヘッダ要素

udsTransactionID

UDS を使用して実行されたトランザクションの一意の識別子。

authToken

Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。

デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。

本文要素

account/accountType

アカウント ID を修飾し、アカウント ID の使用に関する追加コンテキストを指定する属性。

account/accountID

ユーザ名に追加してユーザを識別するために使用される代替識別子。 アカウント ID はアカウントとも呼ばれます。

account/accountStatus

アカウントのステータス。 サポートされている値は以下のとおりです。

  • 0-9： アカウントが INITIAL 状態であることを示します。
  • 10-19： アカウントが ACTIVE 状態であることを示します。
  • 20-29： アカウントが INACTIVE 状態であることを示します。
  • 30-39： アカウントが DELETED 状態であることを示します。
  • >39：アカウントの状態が不明（UNKNOWN）であることを示します。

account/accountIDAttribute

システムでユーザを識別するために使用される代替識別子。

account/dateCreated

アカウント ID が作成された日時のタイムスタンプ。

account/dateModified

アカウント ID が最後に変更された日時のタイムスタンプ。

account/accountCustomAttribute

名前と値のペアで渡す追加のアカウント情報。

  • attributeName
    作成する属性の名前を示します。
  • attributeValue
    名前に対応する値を示します。