Add user

<< Click to Display Table of Contents >>

Add user

Previous pageReturn to chapter overviewNext page

Request address

http://ip:port/bi/api?action=saveNode&type=user&token=xxxx

Request message

 

Request parameter

 

required parameter :xmlData(required)

<?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>

 </user>

</info>

or

<?xml version="1.0" encoding="UTF-8"?>

<info>

 <user isOverWrite="true">

         <name>hunk1</name>

         <pass></pass>

         <email>test1@qq.com</email>

                    <alias>hunk</alias>

         <parent>testgroup,g1</parent>

         <roles>role1,role2</roles>

 </user>

</info>

parametric description

 

The request parameter is user information:

1)name(required):User name, user name cannot be a special character”\ /:*?"<>|;,.“。

2)pass(optional):Password, password length must not be less than 8, and must contain both numeric, uppercase and lowercase letters. When the password sets the special character < & in the request parameter, the entity reference &lt; and &amp;is used instead.

3)email(required):email

4)alias(optional): nickname

5)parent(Not fill in the root directory, add users under the group required):The folder where the user resides (user's group) must be a system-existing group separated by commas.

6)roles(optional):Contains roles that must be system-existing, separated by commas, such as:role1,role2,role3。

7) When configuring isOverWrite= "true", you can update the user;When isOverWrite = " true " is not configured , the user is not updated .

Sample

 

function addUser() {

  var xml = getXml();

    $.post("http://ip:port/bi/api?action=saveNode&type=user&token=xxxx",

    {xmlData : xml},

    function(result) {

       console.log(result);

    });

  }

Response message

 

Response result

 

1) Successful operation

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

         <level>1</level>

         <message>Operates successfully.</message>

  </result>

</results>

2) Operation failure

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

         <level>6</level>

         <message>Id already exists.</message>

  </result>

</results>

or

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

         <level>6</level>

         <message>Folder not found: g3.</message>

  </result>

</results>

Result description

 

The response result information is xml. direct parse.

1)  level return type , different values represent different return states , see Appendix .

2) message is the interface operation result information.