<< Click to Display Table of Contents >> 1.3添加用户复制链接 |
请求地址 |
http://ip:port/bi/api?action=saveNode&type=user&token=xxxx |
|
请求消息 |
请求参数 |
请求参数:xmlData(必填) <?xml version="1.0" encoding="UTF-8"?> <info> <user> <name>hunk1</name> <pass></pass> <email>test@qq.com</email> <alias>hunk</alias> <parent></parent> <roles></roles> <type></type> </user> </info> 或者 <?xml version="1.0" encoding="UTF-8"?> <info> <user isOverWrite="true"> <name>hunk1</name> <pass></pass> <email>test1@qq.com</email> <areaCode>+86</areaCode> <mobileNumber>13987876565</mobileNumber> <alias>hunk</alias> <parent>testgroup,g1</parent> <roles>role1,role2</roles> <extendAttrs> <extendAttr> <name>param1</name> <value>ok</value> </extendAttr> </extendAttrs> <type>1</type> </user> </info> |
参数描述 |
请求参数为用户信息: •name(必填):用户名,用户名不能为特殊字符“\ /:*?"<>|;,.”。 •pass(选填):密码,如果不填密码即<pass></pass>,pass就是默认密码。如果设置密码,密码长度不能小于8,并且必须同时包含数字、大写字母和小写字母。在请求参数中密码设置特殊字符<、&时,需要用实体引用<和&代替。 •email(必填):邮箱。 •areaCode(选填):手机区号,默认为空,当填写了手机号时默认为+86。 •mobileNumber(选填):手机号。 •alias(选填): 昵称。 •parent(添加根目录下的用户时不填,添加组下的用户时必填):用户所在的文件夹(用户组),必须是系统存在的组,多个以逗号分隔。 •roles(选填):包含的角色,必须是系统存在的角色,多个以逗号分隔。 ➢例如:role1,role2,role3 •extendAttrs-extendAttr(选填):定制用户属性,只能设置已经创建的定制属性。 •extendAttrs-extendAttr-name(选填):定制属性参数名。 •extendAttrs-extendAttr-value(选填):定制属性值。 •type(选填):用户的操作类型,1为可编辑,2为仅查看,默认值为1。 •当配置isOverWrite为true时,可以更新用户;不配置isOverWrite为true时,不更新用户。当bi.properties中的user.edit.strict=true时,无法更新用户的邮箱和密码属性。 |
|
示例 |
function addUser() { var xml = getXml(); $.post("http://ip:port/bi/api?action=saveNode&type=user&token=xxxx", {xmlData : xml}, function(result) { console.log(result); }); } |
|
响应消息 |
响应结果 |
•操作成功 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <level>1</level> <message>操作成功。</message> </result> </results> •操作失败 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <level>6</level> <message>Id已存在。</message> </result> </results> 或者 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <level>6</level> <message>文件夹“g3"找不到。</message> </result> </results> |
结果描述 |
响应结果信息为xml,直接parse即可。 •level 返回类型,不同数值代表不同返回状态,见附录。 •message为接口操作结果信息。 |