Request address

http://ip:port/bi/api?action=getNode&token=xxxx

Request message

Request parameter

required parameter:xmlData (required)

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

<ref>

  <type>user</type>

</ref>

or

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

<ref>

  <type>group</type>

</ref>

or

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

<ref>

  <type>role</type>

</ref>

or

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

<ref>

  <type>user</type>

  <path>g1/u1</path>

</ref>

or

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

<ref>

  <type>group</type>

  <path>g1/g1-1</path>

</ref>

or

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

<ref>

  <type>role</type>

  <path>admin_role</path>

</ref>

or

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

<ref>

  <type>user</type>

  <name>u1</name>

</ref>

or

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

<ref>

  <type>group</type>

  <name>g1</name>

</ref>

or

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

<ref>

  <type>role</type>

  <name>admin_role</name>

</ref>

parametric description

Node parameter information:

1)type：type (required): Node type, including three types: user, group, and role.

2)path(optional): node full path

3)name(optional): node name

4)There can only be name or path. When name and path exist at the same time, the name will prevail.

5)If neither name nor path exists or is empty, all objects of that type are returned.

Sample

function getNode() {

  var xml = getXml();

  $.post("http://" + ip + ":" + port + "/" + project + "/api?action=getNode&token=xxxx",

     {xmlData : xml},

     function(result) {

     writeXml(result);

  });

}

Response message

Response result

1) Get user response:

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

<results>

   <result>

       <asset>

           <user>

               <name>u1</name>

               <alias></alias>

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

               <parent>g1</parent>

               <roles>r1</roles>

               <priority>5</priority>

               <createUser>admin</createUser>

               <createTime>2020-10-23 13:46:41</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:19</updateTime>

               <areaCode></areaCode>

               <mobileNumber></mobileNumber>

               <extendAttrs><定制属性1>1

               </定制属性1>

           </extendAttrs>

       </user>

   </asset>

</result>

</results>

2) Get group response:

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

<results>

   <result>

       <asset>

           <group>

               <name>g1</name>

               <parent>root</parent>

               <roles>r1</roles>

               <createUser>admin</createUser>

               <createTime>2020-10-23 14:30:58</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:29</updateTime>

           </group>

       </asset>

   </result>

</results>

3) Get role response:

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

<results>

   <result>

       <asset>

           <role>

               <name>r1</name>

               <createUser>admin</createUser>

               <createTime>2020-10-23 14:31:06</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:06</updateTime>

           </role>

       </asset>

   </result>

</results>

4) Operation failed

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

<results>

  <result>

     <level>6</level>

     <message>Role “role1” is not exist.</message>

  </result>

</results>

Result description

The response result information is xml, which can be directly parse.

1)Asset is the returned node information.

2)User, group, role: corresponding user, group, role information.

3)The user information that can be returned are:

name: the name of the user;

alisa: the user's nickname;

email: user's email address;

parent: group of users;

roles: the roles of the user;

priority: the priority of the user;

createUser: the person who created this user;

createTime: creation time;

updateUser: the person who updated this user recently;

updateTime: last update time;

areaCode: area code;

mobileNumber: mobile phone number;

extendAttrs: user's custom attributes;

4)  The grouping information that can be returned are:

name: the name of the group;

parent: the parent of the group;

roles: grouped roles;

createUser: the person who created this group;

createTime: creation time;

updateUser: the person who recently updated this group;

updateTime: last update time;

5) The role information that can be returned is:

name: the name of the role;

createUser: the person who created this role;

createTime: creation time;

updateUser: the person who updated this role recently;

updateTime: last update time;

6) Level return type, different values represent different return status, see appendix.

7) Message is the interface operation result information.