此API有助于从您的应用程序修改Active Directory中的用户帐户。
请求URL (JSON)格式: http:// <hostname> : <port> /RestAPI/ModifyUser
Request Parameters:
参数名 | 强制性 | 描述 |
AuthToken | 是 | 使用生成AuthToken API获得的身份验证令牌。 |
domainName | 是 | 在其中修改用户对象的域 |
inputFormat | 是 | 要修改的用户帐户属性的详细信息。此属性应为JSONArray字符串,并且格式如下: [>,<JSONObject>,<JSONObject>];JSONObject - LDAP属性及其相应值的键/值对 java示例代码: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("sAMAccountName", "John"); json.put("manager", "Scott"); json.put("department", "Designers"); userDetails.put(json); json = new JSONObject(); json.put("sAMAccountName", "Damien"); json.put("manager", "Scott"); json.put("department", "Designers");userDetails.put(json); |
PRODUCT_NAME | 是 | 发送请求的产品名称/模块名称;用于审计。 |
响应:
响应将是一个包含JSONObjects列表的JSON数组字符串。列表中的每个JSONObject表示在请求的inputFormat属性中发送的一个用户。每个对象将包含有关状态的以下属性:
参数 | 描述 |
status | 用户修改操作的状态:修改成功时为'SUCCESS'。如果出现错误,则为'SEVERE'。 |
statusMessage | 包含有关执行指定操作时发生的问题或错误的消息。 |
SAM ACCOUNT NAME | 修改的用户帐户的SAMAccountName。 |
USER_NAME | 修改的用户帐户的用户名。 |
示例输入/输出
请求:
http://admanager:8080/RestAPI/ModifyUser?domainName=admp.local&AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&inputFormat=[{"sAMAccountName":"John", "manager":"Scott", "department":"Designers"}, {"sAMAccountName":"Damien", "manager":"Scott", "department":"Designers"}]&PRODUCT_NAME=RESTAPI
示例响应:
[{"USER_NAME":"John","LOG_ON_NAME":"John","statusMessage":"Successfully updated the user.","status":"SUCCESS"},{"USER_NAME":"Damien","LOG_ON_NAME":"Damien","statusMessage":"Successfully updated the user.","status":"SUCCESS"}]
授权:
当技术员发送API请求时,他们的授权将应用于这些请求。也就是说,如果技术员未被授权修改用户,则该技术员也不能使用API修改用户帐户。
基于技术员的修改用户属性限制
使用此API在一天内可以修改用户总数取决于许可中帮助台技术员(HDTs)的数量。
HDT 可以进行的 API 调用的最大数量为 50 次/天,与 HDT 执行的任务无关。 如果您有两个 HDT 许可证,则您可以进行的 API 调用总数为 100/天,即 2*50。
由于每天的 API 调用限制不是针对特定任务的,您可以执行任何操作,但 API 调用的总数不应超过 100。 也就是说,一个 HDT 可以执行多种操作,如用户创建、OU 创建、密码重置、 等等,但所有任务的 API 调用次数放在一起不应超过 100。