Updating User Account Details
Use the set operation to update user account details.
Request Packet Structure
A request XML packet that changes user account settings should include the set operation node:
<packet> <user> <set> ... </set> </user> </packet>
The set node is nested within type UserSetInput (
user.xsd). This node has the following graphics representation:
Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/220.127.116.11/agent_input.svg.
It indicates users to be updated with the specified information. Data type: UserSelectionFilter (
user.xsd). To see the structure of this node, proceed to section Available Filters.
It contains a collection of settings that will be set for the filtered user accounts. Data type: UserSetValuesInput (
user.xsd). See the definition of this node below.
The values node is structured as follows:
It specifies a collection of general settings that will be set for the filtered accounts. Data type: UserSetGenInfo (
It specifies the password of a user account. Data type: string.
It specifies a user name. Data type: string.
It specifies contact information for this user account. Data type: ContactInfoAdd (
user.xsd). To see the node definition, refer to section User Contact Information.
It specifies the account status. Data type: string. Allowed values:
Value 0 is equal to disabled, 1 is equal to enabled.
It specifies the ID of the user account in the Plesk components. Data type: string.
It specifies an account username (can be an e-mail address or word containing alphanumeric, dash, dot and underscore symbols). Data type: string.
It specifies the subscription id to which the user will have access. If not specified or is set to 0, it grants the user access to all subscriptions within your hosting account. Data type: string.
It specifies the email address of the user account. Data type: string.
It specifies the user account role settings. Data type: UserAddRoles (
It specifies the name of a role assigned to the account. Data type: string.
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
Response Packet Structure
The set node of the response packet is structured as follows:
Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/18.104.22.168/agent_output.svg.
It wraps the result of the requested operation. Data type: extension of resultType (
It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
Is used to return the error code when the operation fails. Data type: unsignedInt.
It returns an error message if the operation fails. Data type: string.
It returns a filtering rule specified in the request packet. Data type: anySimple.
It is required if the operation succeeds. Returns the unique identifier of a user account whose data is updated. Data type: integer.
A request packet can look as follows:
<packet version="22.214.171.124"> <user> <set> <filter> <owner-guid>58bb9092-4c8b-4110-ba3d-c40bdad3b178</owner-guid> </filter> <values> <roles> <name>WebMaster</name> </roles> </values> </set> </user> </packet>
<packet version="126.96.36.199"> <user> <set> <result> <status>ok</status> <filter-id>58bb9092-4c8b-4110-ba3d-c40bdad3b178</filter-id> <id>20</id> </result> <result> <status>ok</status> <filter-id>58bb9092-4c8b-4110-ba3d-c40bdad3b178</filter-id> <id>21</id> </result> </set> </user> </packet>
Leave your feedback on this topic here
If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.