Retrieving Web Users Settings

Use the get operation to retrieve settings of web users on a specified site. A web user settings have less priority than web user preferences. If you cannot update web user settings - check web users preferences of the site. For more information on the preferences, refer to the Retrieving Web Users Preferences section.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving settings of web users includes the get operation node:

<packet version="1.6.7.0">
<webuser >
   <get>
   ...
   </get>
</webuser>
</packet>

 

The get node is presented by type WebUserSetInputType (webuser.xsd), and its graphical representation is as follows:

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

  • The filter node is required. It specifies the filtering rule. For more information, refer to the Available Filters section. Data type: WebUserFilter (webuser.xsd).

 

Remarks

You can retrieve settings of multiple web users using different filtering rules in a single packet. Add as many get operations as the number of different filtering rules to be used.

<packet version="1.6.7.0">
<get>
...
</get>
...
<get>
...
</get>
</packet>
 

Response Packet Structure

The get node of the output XML packet is presented by type WebUserGetOutputType (webuser.xsd) and structured as follows:

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

  • The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).
  • The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. It returns the error code when the get operation fails. Data type: unsignedInt.
  • The errtext node is optional. It returns the error message if the get operation fails. Data type: string.
  • The filter-id node is required. It returns the filtering rule parameter. For more information, refer to the Available Filters section. Data type:anySimpleType.
  • The id node is optional. If the get operation succeeds it holds the id of the web user. Data type: integer.

    The following nodes are required only if the get operation succeeds:

    • The login node is optional. Returns the login name of a web user. Data type: string.
    • The ftp-quota node is optional. It specifies the limit of disk space (in bytes) provided for a web user on the server. Data type: integer.
    • The asp node is optional. It specifies if the ASP support for Apache is provided. Data type: boolean.
    • The asp-dot-net is optional. It specifies if the ASP.NET support is provided. This feature is supported only by Plesk for Windows. Data type: boolean.
    • The ssi node is optional. It specifies if the SSI support is provided. Data type: boolean.
    • The php node is optional. It specifies if the PHP support is provided. Data type: boolean.
    • The cgi node is optional. It specifies if the CGI support is provided. Data type: boolean.
    • The mod-perl node is optional. It specifies if the mod_perl Apache module is supported. data type: boolean.
    • The mod-python node is optional. It specifies if the mod_python Apache module is supported. Data type: boolean.
    • The fastcgi node is optional. It specifies if the fastcgi extension is supported. Data type: boolean.

Note: If a value for a node is "false", it is not nested in the packet.

 

Samples

Retrieving a web user settings

The following request retrieves settings of the web user with login name abcdef.

<packet>
<webuser>

<get>
   <filter>
      <login>abcdef</login>
   </filter>
</get>

</webuser>
</packet>

Response:

<packet>
<webuser>
<get>

   <result>
      <status>ok</status>
      <filter-id>abcdef</filter-id>
      <id>17</id>
      <login>abcdef</login>
      <ftp-quota>-1</ftp-quota>
   </result>

</get>
</webuser>
</packet>
Retrieving multiple web users settings

The following request retrieves settings of all web users from example.com, and example2.com sites.

<packet>
<webuser>
<get>
   <filter>
      <site-name>example.com</site-name>
      <site-name>example2.com</site-name>
   </filter>
</get>
</webuser>
</packet>

Response:

<packet>
<webuser>
<get>

   <result>
      <status>ok</status>
      <filter-id>example.com</filter-id>

      <id>17</id>
      <login>FirstUser</login>
      <ftp-quota>-1</ftp-quota>
      <php>true</php>
      <cgi>true</cgi>
   </result>

   <result>
      <status>ok</status>
      <filter-id>example.com</filter-id>

      <id>18</id>
      <login>SecondUser</login>
      <ftp-quota>100</ftp-quota>
      <php>true</php>
   </result>

   <result>
      <status>ok</status>
      <filter-id>example2.com</filter-id>

      <id>11</id>
      <login>FirstUser</login>
      <ftp-quota>100</ftp-quota>
      <php>true</php>
   </result>

</get>
</webuser>
</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.