禁用用户API

此API允许您禁用Active Directory中的任何用户帐户。

请求URL (JSON)格式: http://<hostname>:<port>/RestAPI/DisableUser

请求参数:

参数名 强制性 描述
PRODUCT_NAME 发送请求的产品名称/模块名称;用于审计。
AuthToken 使用生成AuthToken API获得的身份验证令牌。
domainName 用户账户的域名。
inputFormat 要禁用的每个用户帐户的详细信息。该属性应该是一个JSONArray字符串,格式如下:
[<JSONObject>, <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", "Mat");
userDetails.put(json);

注意:

您可以指定以下任何属性作为搜索条件,以使用REST API请求查找用户对象:

  1. sAMAccountName
  2. UserPrincipalName
  3. distinguishedName
  4. mail
  5. employeeID
  6. objectGUID
  7. objectSid

响应:

响应将是一个包含JSONObjects列表的JSONArray字符串。列表中的每个JSONObject表示在请求的inputFormat参数中发送的一个用户帐户。每个对象将包含以下属性:

参数名 描述
userPrincipalName 用户账户的userPrincipalName。
sAMAccountName 用户账户的sAMAccountName。
objectSID 用户账户的objectSID。
statusMessage 如果在处理请求时发生问题/错误,则包含适当的消息。

示例输入/输出

请求

http://Byron:8080/RestAPI/DisableUser?AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e &PRODUCT_NAME=MODULE_NAME&domainName=admanagerplus.com&inputFormat=[{" sAMAccountName":"colin.altonen"}]

响应:

[{"userPrincipalName":"colin.altonen@admanagerplus.com","sAMAccountName":"colin.altone n","objectSID":"S-1-5-21-2996321955-1937665885-1535019402-3881","statusMessage":"Successfully modified."}]

基于技术员的禁用用户限制

使用此API在一天内可以禁用用户总数取决于许可中帮助台技术员(HDTs)的数量。

HDT可以进行的API调用的最大数量为50次/天,与HDT执行的任务无关。如果您有两个 HDT许可,则您可以进行的API调用总数为100次/天(100个AD对象)即2*50。

由于每天的API调用限制不是针对特定任务的,您可以执行任何操作,但API调用总数不应超过100。也就是说,一个HDT可以执行多种操作,如用户创建、OU创建、密码重置等等,但所有任务的API调用次数放在一起不应超过100。

注意:

  • 默认的管理帐户将不会被视为帮助台技术员。
  • 确保URL对REST API请求中使用的所有特殊和保留字符进行编码。由于发送请求的客户端(浏览器、postman或TP工具)不属于ADManager Plus,因此为特殊、保留和不安全字符编码URL完全由用户负责。

    保留字符包括 ; / ? : @ = &
    不安全的字符包括 < > # % { } | \ ^ ~ [ ] ` "'

他们正在使用ADManager Plus简化Windows AD域管理