此API有助于从应用程序创建Active Directory用户帐户。
请求URL (JSON)格式: http://<hostname>:<port>/RestAPI/CreateUser
请求参数
参数名称 | 强制性 | 描述 |
AuthToken | 是 | 使用生成AuthToken API获得的身份验证令牌。 |
domainName | 是 | 创建用户对象的域名称 |
inputFormat | 是 | 要创建的用户帐户属性的详细信息。这个属性应该是一个JSONArray字符串,格式如下所示。 [>, <JSONObject>, <JSONObject>]; JSONObject - LDAP属性及其相应值的键/值对 java示例代码: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("givenName", "John"); json.put("initials", "mat"); json.put("sn", "Martin"); json.put("password", "Martin@12"); json.put("templateName", "User Creation Template"); userDetails.put(json); json = new JSONObject(); json.put("givenName", "Damien"); json.put("initials", "S"); json.put("sn", "David"); json.put("password", "Test@123"); json.put("templateName", "User Creation Template"); userDetails.put(json); 注意:如果其中不包含"templateName"属性键/值对,将使用为技术人员分配的默认用户创建模板。 |
PRODUCT_NAME | 是 | 发送请求的产品名称/模块名称;用于审计。 |
响应:
响应将是一个JSON数组字符串,其中包含JSONObject的列表。列表中的每个JSONObject表示在请求中以inputFormat属性发送的用户。每个对象将包含以下有关状态的属性。
参数名 | 描述 |
status | 用户创建操作的状态:在成功创建时显示'SUCCESS';错误时显示'SEVERE'。 |
statusMessage | 包含有关执行指定操作时发生的问题或错误的消息。 |
LOG_ON_NAME | 创建的用户帐户的登录名。只有在用户创建操作成功时才会出现。 |
USER_NAME | 创建的用户帐户的用户名。只有在用户创建操作成功时才会出现。 |
USER_PASSWORD | 创建的用户帐户的密码,以纯文本形式。只有在用户创建操作成功时才会出现。 |
示例输入/输出
请求:
http://Byron:8080/RestAPI/CreateUser?domainName=admanagerplus.com&AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&inputFormat=[{"givenName":"ByronTest", "password":"Test@123", "templateName":"User Creation Template"}]
响应:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
身份验证:
当技术人员发送API请求时,他们的授权将应用于这些请求。也就是说,如果没有授权技术人员创建用户,技术人员也不能使用API创建用户帐户。
基于技术员的用户创建限制
使用CreateUser API可以在一天内创建的用户总数取决于许可的帮助台技术人员(HDTs)的数量。
HDT可以进行的API调用的最大数量为50次/天,与HDT执行的任务无关。如果您有两个 HDT许可,则您可以进行的API调用总数为100次/天(100个AD对象)即2*50。
由于每天的API调用限制不是针对特定任务的,您可以执行任何操作,但API调用总数不应超过100。也就是说,一个HDT可以执行多种操作,如用户创建、OU创建、密码重置等等,但所有任务的API调用次数放在一起不应超过100。
注意:
保留字符包括 ; / ? : @ = &
不安全的字符包括 < > # % { } | \ ^ ~ [ ] ` "'