Type domainUserSet

The user node is used in the add and set request packets. It is specified by complex type domainUserSet (plesk_domain.xsd). This node is structured as follows (pared-down variant):

• The enabled node is optional. It is used to enable/disable the domain account. Data type: Boolean.
• The password node is optional. It specifies the password of the domain administrator. Data type: string (5 to 14 characters long).
• The global-login and the uid nodes are deprecated.
• The cname node is optional. It specifies the company where the domain administrator works. Data type: string (0 to 255 characters long).
• The pname node is optional. It specifies the name of the domain administrator. Data type: string (0 to 255 characters long).
• The phone node is optional. It specifies the phone number of the domain administrator. Data type: string (0 to 255 characters long).
• The fax node is optional. It specifies the fax number of the domain administrator. Data type: string (0 to 255 characters long).
• The email node is optional. It specifies the email address of the domain administrator. Data type: string (0 to 255 characters long).
• The address node is optional. It specifies the postal address of the domain administrator. Data type: string (0 to 255 characters long).
• The city node is optional. It specifies the city of the domain administrator. Data type: string (0 to 255 characters long).
• The state node is optional. It specifies the state of the domain administrator. Is required for US only. Data type: string (0 to 255 characters long).
• The pcode node is optional. It specifies the zip code of the domain administrator. Is required for US only. Data type: string (0 to 10 characters long).
• The country node is optional. It specifies the country code of the domain administrator. Data type: string (0 to 2 characters long).
• The multiply_login node is optional. It indicates whether multiple logins with the same domain administrator credentials are allowed. Data type: Boolean.
• The perms node is optional. It specifies a collection of permissions set for the domain administrator. Data type: domainPerms (plesk_domain.xsd). See the structure of this node in the Domain Administrator Permissions topic.

The following sample packet creates a domain account and sets Domain Administrator information:

<packet version="1.4.2.0">

<domain>

<add>

   <gen_setup>

      <name>newdomain.com</name>

      <client_id>1234</client_id>

      <ip_address>192.0.2.123</ip_address>

   </gen_setup>

   <user>

      <enabled>false</enabled>

      <password>123456</password>

      <cname>technolux</cname>

      <pname>Stephen Holmes</pname>

      <phone>2121342526</phone>

      <fax>2121342527</fax>

      <email>sholmes@technolux.ca</email>

      <address>Gray Lake Road, 12</address>

      <city>Totonto</city>

      <state/>

      <pcode/>

      <country>CA</country>

      <multiply_login>false</multiply_login>

      <perms/>

   </user>

</add>

</domain>

</packet>