此API可用于将用户帐户从您的应用程序添加到Active Directory组。
请求URL (JSON)格式: http:// <hostname> : <port> /RestAPI/AddUsersToGroup
请求参数:
参数名 | 强制性 | 描述 |
AuthToken | 是 | 使用生成AuthToken API获得的身份验证令牌。 |
domainName | 是 | 在其中修改用户对象的域 |
inputFormat | 是 | 要修改的用户帐户属性的详细信息。此属性应为JSONArray字符串,并且格式如下: [>,<JSONObject>,<JSONObject>]; JSONObject - LDAP属性及其相应值的键/值对 java示例代码: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("sAMAccountName", "John"); userDetails.put(json); json = new JSONObject(); json.put("sAMAccountName", "Damien");userDetails.put(json); |
PRODUCT_NAME | 是 | 发送请求的产品名称/模块名称;用于审计。 |
响应:
响应将是一个包含JSONObjects列表的JSON数组字符串。列表中的每个JSONObject表示在请求的inputFormat属性中发送的一个用户。每个对象将包含有关状态的以下属性:
参数 | 描述 |
status | 用户修改操作的状态: '1' 为修改成功,'0'即为出现错误。 |
statusMessage | 包含有关执行指定操作时发生的问题或错误的消息。 |
SAM ACCOUNT NAME | 添加到组的用户的sAMAccountName。 |
userPrincipalName | 添加到组的用户的userPrincipalName。 |
示例请求
请求:
http://admanager:8080/RestAPI/AddUsersToGroup?PRODUCT_NAME=MODULE&AuthToken=75adb327-91a0-4384-98b6-6c42332f8263&domainName=admp.local&inputFormat=[{"sAMAccountName":"John"}, {"sAMAccountName":"Damien"}]&addGroup=[Account Operators, Administrators]
http://admanager:8080/RestAPI/AddUsersToGroup?PRODUCT_NAME=MODULE&AuthToken=75adb327-91a0-4384-98b6-6c42332f8263&domainName=admp.local&inputFormat=[{"sAMAccountName":"John"}, {"sAMAccountName":"Damien"}]&addGroup=[Account Operators, Administrators]&primaryGroup=Administrators
示例响应:
[{"sAMAccountName":"John","objectSID":"S-1-5-21-2664452653-2810534411-3271467435-4097","userPrincipalName":"John@admp.local","statusMessage":"Successfully modified.","status":"1"}, {"statusMessage":"sAMAccountName: Damien - No such user matched. Verify the LDAP attribute in search query or could be a privilege issue.","status":"0"}]
基于技术员的将用户添加到组限制
使用此API在一天内可以将用户添加到组总数取决于许可中帮助台技术员(HDTs)的数量。
HDT可以进行的API调用的最大数量为50次/天,与HDT执行的任务无关。如果您有两个 HDT许可,则您可以进行的API调用总数为100次/天(100个AD对象)即2*50。
由于每天的API调用限制不是针对特定任务的,您可以执行任何操作,但API调用总数不应超过100。也就是说,一个HDT可以执行多种操作,如用户创建、OU创建、密码重置等等,但所有任务的API调用次数放在一起不应超过100。