ADManager Plus ユーザー検索のAPI

Active Directory ID管理ソフト

このAPIを使用すると、Active Directory内の任意のユーザーを見つけることができます。

リクエストURL(JSON)形式:

http://:/RestAPI/SearchUser

リクエストパラメータ:

パラメータ名必須概要
PRODUCT_NAMEはいリクエストの送信元である製品名やモジュール名が監査に必要となります
AuthTokenはい「Generate AuthToken API」を使用して取得された認証トークン
domainNameはい検索を実行する必要があるドメイン
rangeはいリクエストの応答で返されるユーザーの詳細の数
startIndexはいユーザーの詳細結果の開始インデックス
searchTextオプション検索に使用するテキスト
refreshオプションブール型。「True」の場合、サーバーはAD Manager PlusでADの変更事項を更新およびアップデートし、更新された結果を送信します
sortColumnオプション検索結果の列のいずれかを使用して結果を並べ替えることができます
ascendingオプションデフォルトでは、結果は「昇順」で表示されます。「降順」が指定されている場合、結果は降順で表示されます

応答:

応答はJSON形式のキーと値のペアになります。応答には次のキーが含まれます。

パラメータ名概要
status検索操作のステータス。リクエストの正常終了時には「SUCCESS」
statusMessageリクエストの処理中に問題またはエラーが発生した場合、適切なメッセージが含まれます
Count指定された検索条件に一致するユーザーの総数
UsersListユーザーの詳細のJSONArray。配列内の各JSONObjectは、検索結果のユーザーを表します。JSONObjectには、ユーザーの属性のキー・値ペア、およびその対応する値が含まれています

サンプルリクエスト/応答

リクエスト:

http://Byron:8080/RestAPI/SearchUser?domainName=admanagerplus.com&AuthToken=a70d 9e6c-4167-4de4-a6a1-3b3aff50c82e&range=2&startIndex=1

応答:

{"count":1139,"status":"SUCCESS","statusMessage":"","UsersList":[{"DISPLAY_NAME":"john mat","FIRST_NAME":"john","MOBILE":"-","COUNTRY":"-","OBJECT_GUID":"{25AB1089-C67 3-4CC1-AF04-D3D8C8B3D39D}","LOGON_NAME":"john-3786@csez.admanagerplusin.com" ,"CITY":"-","INITIAL":"-","EMAIL_ADDRESS":"john.a@admanagerplus.com","LAST_NAME":" mat"},{"DISPLAY_NAME":"charlie M","FIRST_NAME":"charlie M","MOBILE":"-","COUNTRY":"-","OBJECT_GUID":"{3B030A75-2F7C-4400-82E5-B738D352 970A}","LOGON_NAME":"charlie-pt1394@csez.admanagerplusin.com","CITY":"-","INITIAL":"- ","EMAIL_ADDRESS":"charlie.m@admanagerplus.com","LAST_NAME":"-"}]}