# user: Users

The `user` utility is used for managing additional Control Panel users.

## Usage

    user <command> [<login_name>] [
    <option_1> [<param>]
    [<option_2> [<param>]]
    ... [<option_N> [<param>]]

## Example

The following command creates an additional user account Mary with the username mary@example.com. The user account will be created based on the role called webmaster, and the user will be able to access Control Panel and manage websites of a customer with username JDoe.

    plesk bin user --create mary@example.com -owner JDoe -passwd sample -cname Mary -role webmaster

## Commands

Command | Parameter | Description | Example
--- | --- | --- | ---
`--create` or `-c` | `<login_name>` | Creates a user account. Requires the options `-cname, -passwd, -owner, -role`. Login can be an e-mail address or a word containing alphanumeric, dash, dot and underscore symbols. | To create a user account for webmaster Mary, who will manage websites of JDoe:
    plesk bin user --create mary@example.com -owner JDoe -passwd sample -cname Mary -role webmaster
`--update` or `-u` | `<login_name>` | Updates user account settings. | To change the password for the user mary@example.com to 12345:
    plesk bin user --update mary@example.com -passwd 12345
`--delete` or `-d` | `<login_name>` | Removes a user account. | To remove the user account with the username mary@example.com:
    plesk bin user --delete mary@example.com
`--info` or `-i` | `<login_name>` | Displays user account information. | To retrieve the info on the account with the username mary@example.com:
    plesk bin user --info mary@example.com
`--help` or `-h` |  | Displays help on the utility use. | To view help on the use of this utility:
    plesk bin user --help

## Options

Option | Parameter | Description | Example
--- | --- | --- | ---
`-cname` | `<string>` | Specifies the user’s contact name. Required with the `--create` command. | To change a name for the user mary@example.com to Jane:
    plesk bin user --update mary@example.com -cname Jane
`-role` | `<existing role name>` | Specifies the user role assigned to the user account. Roles define what Control Panel users can do in the Panel. | To create a user account for webmaster Mary, who will manage websites of JDoe:
    plesk bin user --create mary@example.com -owner JDoe -passwd sample -cname Mary -role webmaster
`-passwd` | `<password>` | Specifies a user’s password Required with the `--create` command. | To change the password for the user mary@example.com to 12345:
    plesk bin user --update mary@example.com -passwd 12345
`-status` | `enabled|disabled` | Activates or suspends a user account. Suspended user accounts cannot log in to Control Panel. | To suspend the user account mary@example.com:
    plesk bin user --update mary@example.com -status disabled
`-phone` | `<number>` | Specifies user’s phone number. | To set phone number in the personal info of the user with the login name mary@example.com to 1234567:
    plesk bin user --update mary@example.com -phone 1234567
`-owner` | `<username>` | Specifies the username of a Panel user for which an additional user account is created. | To create a user account for webmaster Mary, who will manage websites of JDoe:
    plesk bin user --create mary@example.com -owner JDoe -passwd sample -cname Mary -role webmaster
`-company` | `<string>` | Specifies a user’s company name. | To set company name in the personal info of the mary@example.com account to MegaCompany Inc.:
    plesk bin user --update mary@example.com -company "MegaCompany Inc."
`-fax` | `<number>` | Specifies a user’s fax number. | To set fax number in the personal info of the account mary@example.com to 5556676677:
    plesk bin user --update mary@example.com -fax 5556676677
`-address` | `<string>` | Specifies a user’s postal address. | To set postal address in the personal info of the account mary@example.com to Elm str. 17:
    plesk bin user --update mary@example.com -address "Elm str. 17"
`-city` | `<string>` | Specifies a user’s city. | To set city in the personal info of the account mary@example.com to New York:
    plesk bin user --update mary@example.com -city "New York"
`-state` | `<string>` | Specifies a user’s state/province. | To set state in the personal info of the account mary@example.com to NY:
    plesk bin user --update mary@example.com -state NY
`-zip` | `<string>` | Specifies a user’s ZIP or postal code. | To set the postal code in the personal info of the account mary@example.com to 123123:
    plesk bin user --update mary@example.com -zip 123123
`-country` | `<string>` | Specifies a user’s country: a two-letters upper-case code in compliance with ISO 3166. | To set country in the personal info of the account mary@example.com to United States:
    plesk bin user --update mary@example.com -country US
`-im-type` | `<integer>` | Specifies a user’s instant messenger type. 1 - ICQ. 2 - Jabber. 3 - AIM. 4 - Skype. 0 - Other. | To set an instant messenger for the user account mary:
    plesk bin user --update mary -im-type 1 -im 123456789
`-im` | `<string>` | Specifies a user’s instant messenger number. |
`-external-email` | `<string>` | Specifies an external email address for an additional user. | To set an external email address for the user account mary:
    plesk bin user --update mary -external-email usermary@example.com
`-comment` | `<string>` | Specifies additional information about the user. | To add a comment for the user account mary:
    plesk bin user -u mary -comment "This is a comment"
`-email` | `<string>` | Specifies an email address for the additional user within the subscription to which the user belongs. If you specify a non-existing email account within the subscription, it will be created. | To set an email account under the subscription example.com for the user account mary:
    plesk bin user --update mary -email usermary@example.com
`-subscription-name` | `<subscription_name>` | Allows a user to access only a specified subscription within a hosting account. | To allow the user with the account mary@example.com access only the example.com subscription:
    plesk bin user --update mary@example.com -subscription-name example.com
`-for-all-subscriptons` |  | Allows a user to access all subscriptions within a hosting account | To allow the user with the account mary@example.com access all subscriptions:
    plesk bin user --update mary@example.com -for-all-subscriptions
`-locale` | `<locale_code>` | Sets the locale for the user. | To set the locale for the user account mary to en-US:
    plesk bin user -u mary -locale en-US