前のトピック: ユーザ アカウントの詳細の取得次のトピック: ユーザ アカウントの削除

CA Risk Authentication Web サービス開発者ガイド › ユーザおよびアカウントの管理 › ユーザ アカウント操作の実行 › アカウントを使用したユーザの詳細の取得

アカウントを使用したユーザの詳細の取得

ユーザのアカウント情報を使用してユーザの詳細を取得するには、listUsersForAccount 操作を使用する必要があります。 このセクションでは、ユーザ アカウントに基づいてユーザ情報を取得するための以下の手順について説明します。

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

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

要素

必須

説明

orgName

いいえ

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

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

accountType

いいえ

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

注： accountID および accountIDAttribute 要素はオプションですが、少なくとも 1 つの要素を渡す必要があります。

accountID

いいえ

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

accountIDAttribute

いいえ

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

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

filter/includeImage

いいえ

ユーザの画像を取得する必要があるかどうかを示します。 サポートされている値は以下のとおりです。

  • 0： 画像を取得する必要がないことを示します。
  • 1： 画像を取得する必要があることを示します。

filter/includeAccounts

いいえ

ユーザ アカウントを取得する必要があるかどうかを示すフラグ。 サポートされている値は以下のとおりです。

  • 0： ユーザ アカウントを取得する必要がないことを示します。
  • 1： ユーザ アカウントを取得する必要があることを示します。

clientTxId

いいえ

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

Web サービスの起動

アカウント情報を使用してユーザの詳細を取得する方法

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

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

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

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

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

要素

説明

ヘッダ要素

udsTransactionID

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

authToken

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

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

本文要素

userId/orgName

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

userId/userName

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

userId/userRefId

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

dateCreated

システムでユーザが作成された日時のタイムスタンプ。

dateModified

ユーザの詳細が最後に変更された日時のタイムスタンプ。

emailId

登録されているユーザの電子メール ID。 ユーザに複数の電子メール ID が設定されている場合、すべての電子メール ID が取得されます。

telephoneNumber

登録されているユーザの電話番号。 ユーザに複数の電話番号が設定されている場合、すべての電話番号が取得されます。

firstName

ユーザの名。

middleName

ユーザのミドル ネーム。

lastName

ユーザの姓。

pam

RiskMinder で保護されているリソースにユーザがアクセスしようとした場合に、ユーザに表示される個人保証メッセージ（PAM）。

pamImageURL

RiskMinder で保護されているリソースにユーザがアクセスしようとした場合に、ユーザに表示される 画像が含まれる URL。

image

ユーザ自身を識別するためにユーザがアップロードする画像。

status

ユーザのステータスです。以下の値になります。

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

customAttribute

名前と値のペアで渡す追加のユーザ情報。

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

startLockTime

ユーザを非アクティブにする日時のタイムスタンプ。

endLockTime

非アクティブ ユーザをアクティブにする日時のタイムスタンプ。

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
    名前に対応する値を示します。