前のトピック: ユーザの詳細の取得次のトピック: すべてのユーザの検索

CA Risk Authentication Web サービス開発者ガイド › ユーザおよびアカウントの管理 › ユーザ操作の実行 › ページネーションを使用したユーザの検索

ページネーションを使用したユーザの検索

RiskMinder データベース内またはディレクトリ サービス内のユーザを検索すると、その情報はユーザ名のアルファベット順で取得および表示されます。 多数のユーザで大規模なセットアップを行っている場合、検索結果内を移動して特定のユーザを見つける必要があります。 そのような場合に検索効率を向上させるために、開始および終了のインデックス範囲を指定してユーザを検索できます。

注： LDAP 組織内のユーザを検索する場合は、LDAP でページネーション検索がサポートされていることを確認してください。

このセクションでは、検索インデックスに基づいてアクティブなユーザを検索するための以下の手順について説明します。

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

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

要素

必須

説明

orgName

いいえ

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

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

startIndex

はい

取得する必要があるユーザ情報の開始インデックス エントリ。

たとえば、完全な検索で 60 個の結果が取得される場合に、startIndex を 45 に設定すると、検索結果のエントリ 45 以降のユーザ情報が返されます。

endIndex

はい

取得する必要があるユーザ情報の終了インデックス エントリ。

たとえば、完全な検索で 60 個の結果が取得される場合に、startIndex を 45 に設定し、endIndex を 55 に設定すると、検索結果のエントリ 45 ～ 55 のユーザ情報が返されます。

clientTxId

いいえ

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

Web サービスの起動

ページネーションに基づいてユーザを検索する方法

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

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

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

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

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

要素

説明

ヘッダ要素

udsTransactionID

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

authToken

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

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

本文要素

count

検索結果で返されるユーザの総数。

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

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