vividime Community

title: Add user [Print this page]

author: vividime-Club time: 2024-12-18 13:18
title: Add user
How to add ueser?

author: vividime-Club time: 2024-12-18 13:18

Request URL

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

Request Message

Request Parameter

Request parameter: xmlData (required)

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

<info>

<user>

<pass></pass

<parent></parent

<roles></roles

</user

</info

<?xml version="1.0" encoding="UTF-8"? </type> </user> </info>

<info>

<areaCode>+86</areaCode

<mobileNumber>13987876565</mobileNumber

<parent>testgroup,g1</parent

<roles>role1,role2</roles

<name>param1</name>

<value>ok</value

</extendAttr

</extendAttrs

</user

</info

Request Parameter Description

The request parameters are user information:

•name (required): user name, user name cannot be special character "\ /:*?" <>|;,." The user name cannot be special characters "\ /:*?

•pass (optional): password, if you do not fill in the password that is <pass></pass>, pass is the default password. If you set a password, the length of the password cannot be less than 8, and must contain both numbers, uppercase letters and lowercase letters. In the request parameter password set special characters <, &, you need to use the entity reference < and & instead.

•email (required): email address.

•areaCode (optional): area code of the cell phone, default is empty, default is +86 when the cell phone number is filled.

•mobileNumber (optional): cell phone number.

•alias (optional): nickname.

•parent (optional when adding users in the root directory, required when adding users in a group): the folder (user group) where the user is located, it must be a group that exists in the system, multiple groups are separated by commas.

•roles (optional): roles included, must be system roles, multiple roles separated by commas.

•Example: role1,role2,role3

•extendAttrs-extendAttr (optional): customize user attributes, can only set customized attributes that have already been created.

•extendAttrs-extendAttr-name (optional): the name of the customized attribute parameter.

•extendAttrs-extendAttr-value (optional): value of the customized attribute.

•type (optional): user's operation type, 1 for editor, 2 for viewer, 3 for explorer; defaults to editor when not filled or assigned.

•When isOverWrite is configured as true, user can be updated; when isOverWrite is not configured as true, user is not updated. When user.edit.strict=true in bi.properties, the user's mailbox and password properties cannot be updated.

Request Example

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

•Operation successful

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

<results

<message>Operation successful. </message>

</result>

</results>

•Operation failed

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

<results

<message>Id already exists. </message>

</result>

</results>

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

<message>Folder "g3" could not be found. </message>

</results> <results

</results

Result Description

Response result information is xml, can parse direcly.

•level return type, different values represent different return status, see Appendix.

•message is the result of api operation.

Welcome vividime Community (https://club.vividime.com/)