前のトピック: ユーザ ステータスの更新次のトピック: すべてのユーザの検索

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

ユーザの詳細の取得

特定のユーザの詳細を検索するには、retrieveUser 操作を使用します。

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

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

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

要素

必須

説明

userIdentifier

はい

システムでユーザを識別する一意の識別子（ユーザ名）。

orgName

いいえ

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

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

accountType

いいえ

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

filter/includeImage

いいえ

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

  • 0： 画像を取得する必要がないことを示します。 デフォルト値です。
  • 1： 画像を取得する必要があることを示します。

filter/includeAccounts

いいえ

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

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

filter/deepSearch

いいえ

複数のパラメータに基づいてユーザを検索する必要があるかどうかを示すフラグ。 サポートされている値は以下のとおりです。

  • 0： ユーザ名のみに基づいてユーザを検索することを示します。
  • 1： 以下の詳細を使用してユーザを検索することを示します。
    最初の検索属性： ユーザ名
    2 番目の検索属性： アカウント ID
    3 番目の検索属性： アカウント ID の属性

    最初の検索属性を使用してユーザの詳細が見つからない場合、2 番目の属性が使用されます。 最初および 2 番目の両方の属性でユーザの詳細を取得できない場合、3 番目の属性を使用してユーザの詳細が検索されます。

clientTxId

いいえ

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

Web サービスの起動

ユーザの詳細を取得する方法

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

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

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

retrieveUserResponse レスポンス メッセージでは、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

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

pamImageURL

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

image

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

status

ユーザのステータス。 サポートされている値は以下のとおりです。

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

    注： 値を渡さない場合、デフォルトではステータスは ACTIVE に設定されます。

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