免费下载 此API允许您定位Active Directory中的任何用户。
请求URL (JSON)格式: http://<hostname>:<port>/RestAPI/SearchUser
请求参数:
| 参数名 | 强制性 | 描述 |
| PRODUCT_NAME | 是 | 发送请求的产品名称/模块名称;用于审计。 |
| AuthToken | 是 | 使用生成AuthToken API获得的身份验证令牌。 |
| domainName | 是 | 在其中执行搜索的域。 |
| range | 是 | 要在请求响应中返回的用户详细信息数量。 |
| startIndex | 是 | 用户详细信息结果的起始索引。 |
| searchText | 可选 | 在搜索中使用的文本。 |
| refresh | 可选 | 布尔型。为'true'时，服务器将刷新并更新ADManager Plus中AD中的更改，然后发送更新的结果。 |
| sortColumn | 可选 | 搜索结果中的任何一列都可以用于对结果进行排序。 |
| ascending | 可选 | 默认情况下，结果为'ascending'，升序显示。如果为'descending'，结果将按降序显示。 |
响应:
响应将是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":"-"}]}
注意:
保留字符包括 ; / ? : @ = &
不安全的字符包括 < > # % { } | \ ^ ~ [ ] ` "'
