前のトピック: ユーザの詳細の取得次のトピック: ユーザ ステータスの取得

CA Strong Authentication Web Services Guide › ユーザおよびアカウントの管理 › ユーザ操作の実行 › すべてのユーザの検索

すべてのユーザの検索

システムのすべてのユーザを検索するには、searchUsers 操作を使用する必要があります。

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

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

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

要素

必須

説明

orgPattern

いいえ

組織の検索に使用するパターン。 たとえば、「*ac」のパターンでは以下の組織のユーザが検索されます。

  • Acme
  • Acro

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

orgName

いいえ

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

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

searchExpression

はい

ユーザの検索に使用される表現。 たとえば、「*m」で検索すると、以下のユーザの詳細が取得されます。

  • John Smith
  • Mathew

count

いいえ

検索結果の数がこの値を超えている場合、この値と同じ数の検索結果のみが取得されます。

filter/includeImage

いいえ

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

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

filter/includeAccounts

いいえ

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

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

filter/deepSearch

いいえ

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

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

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

status

いいえ

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

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

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

account/accountType

はい

 

account 要素が定義されている場合のみ。

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

RepositoryUserAttributes/attributeName

いいえ

ユーザ情報を格納するために使用されるユーザ属性の名前。 たとえば、「First Name」や「Email Address」などです。

clientTxId

いいえ

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

Web サービスの起動

ユーザを検索する方法

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

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

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

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

searchUsersResponse で返される要素は retrieveUserResponse で返される要素と同じです。 成功したトランザクションで返されるユーザ詳細の詳細については、retrieveUserResponse の要素に関する情報が記載されている表を参照してください。 エラーがある場合は、付録「エラー コード」を参照してください。