NAME

createuser - creates a user.

SYNOPSIS

createuser [OPTION]...

DESCRIPTION

This command line tool creates new users in a given context. The displayname must be unique in one context.

OPTIONS

-c, --contextid contextId : The id of the context

-u, --username username : Username of the user

-d, --displayname displayName : Display name of the user

-g, --givenname givenName : Given name for the user

-s, --surname surname : Surname of the user

-p, --password password : Password for the user

-e, --email email : Primary mail address

-l, --language language : Language for the user (de_DE,en_US,fr_FR)

-t, --timezone timezone : Timezone of the user (Europe/Berlin)

-x, --department department : Department of the user

-z, --company company : Company of the user

-a, --aliases aliases : E-Mail aliases of the user, separated by ","

--access-combination-name access-combination-name : Access combination name

--addguipreferences addguipreferences : Add a GUI setting (key=value)

--csv-import CSV file : Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed).

-A, --adminuser masterAdmin : Master admin user name for authentication. Optional, depending on your configuration.

-P, --adminpass masterAdminPassword : Master admin password for authentication. Optional, depending on your configuration.

-h, --help : Prints a help text.

--environment : Show info about commandline environment.

--nonl : Remove all newlines (\n) from output.

--responsetimeout : The optional response timeout in seconds when reading data from server (default: 0s; infinite).

EXTENDED OPTIONS

--email1 string : Email1

--birthday datevalue : Birthday

--anniversary datevalue : Anniversary

--branches string : Branches

--business_category string : Business_category

--postal_code_business string : Postal_code_business

--state_business string : State_business

--street_business string : Street_business

--telephone_callback string : Telephone_callback

--city_home string : City_home

--commercial_register string : Commercial_register

--country_home string : Country_home

--email2 string : Email2

--email3 string : Email3

--employeetype string : EmployeeType

--fax_business string : Fax_business

--fax_home string : Fax_home

--fax_other string : Fax_other

--imapserver string : ImapServer

--imaplogin string : ImapLogin

--smtpserver string : SmtpServer

--instant_messenger1 string : Instant_messenger1

--instant_messenger2 string : Instant_messenger2

--telephone_ip string : Telephone_ip

--telephone_isdn string : Telephone_isdn

--mail_folder_drafts_name string : Mail_folder_drafts_name

--mail_folder_sent_name string : Mail_folder_sent_name

--mail_folder_spam_name string : Mail_folder_spam_name

--mail_folder_trash_name string : Mail_folder_trash_name

--mail_folder_archive_full_name string : Mail_folder_archive_full_name

--mail_folder_scheduled_full_name string : Mail_folder_scheduled_full_name

--manager_name string : Manager_name

--marital_status string : Marital_status

--cellular_telephone1 string : Cellular_telephone1

--cellular_telephone2 string : Cellular_telephone2

--info string : Info

--nickname string : Nickname

--number_of_children string : Number_of_children

--note string : Note

--number_of_employee string : Number_of_employee

--telephone_pager string : Telephone_pager

--password_expired booleanvalue : Password_expired

--telephone_assistant string : Telephone_assistant

--telephone_business1 string : Telephone_business1

--telephone_business2 string : Telephone_business2

--telephone_car string : Telephone_car

--telephone_company string : Telephone_company

--telephone_home1 string : Telephone_home1

--telephone_home2 string : Telephone_home2

--telephone_other string : Telephone_other

--postal_code_home string : Postal_code_home

--profession string : Profession

--telephone_radio string : Telephone_radio

--room_number string : Room_number

--sales_volume string : Sales_volume

--city_other string : City_other

--country_other string : Country_other

--middle_name string : Middle_name

--postal_code_other string : Postal_code_other

--state_other string : State_other

--street_other string : Street_other

--spouse_name string : Spouse_name

--state_home string : State_home

--street_home string : Street_home

--suffix string : Suffix

--tax_id string : Tax_id

--telephone_telex string : Telephone_telex

--telephone_ttytdd string : Telephone_ttytdd

--uploadfilesizelimitperfile string : Upload file size limit per file for mail attachments

--uploadfilesizelimit string : Total upload file size limit for mail attachments

--image1 string : The contact picture as base64 encoded string or file:// URI

--image1_content_type string : The content type of the contact picture

--url string : Url

--userfield01 string : Userfield01

--userfield02 string : Userfield02

--userfield03 string : Userfield03

--userfield04 string : Userfield04

--userfield05 string : Userfield05

--userfield06 string : Userfield06

--userfield07 string : Userfield07

--userfield08 string : Userfield08

--userfield09 string : Userfield09

--userfield10 string : Userfield10

--userfield11 string : Userfield11

--userfield12 string : Userfield12

--userfield13 string : Userfield13

--userfield14 string : Userfield14

--userfield15 string : Userfield15

--userfield16 string : Userfield16

--userfield17 string : Userfield17

--userfield18 string : Userfield18

--userfield19 string : Userfield19

--userfield20 string : Userfield20

--city_business string : City_business

--country_business string : Country_business

--assistant_name string : Assistant_name

--telephone_primary string : Telephone_primary

--categories string : Categories

--mail_folder_confirmed_ham_name string : Mail_folder_confirmed_ham_name

--mail_folder_confirmed_spam_name string : Mail_folder_confirmed_spam_name

--gui_spam_filter_capabilities_enabled booleanvalue : GUI_spam_filter_capabilities_enabled

--mailenabled true/false : Mailenabled

--defaultsenderaddress stringvalue : DefaultSenderAddress

--title string : Title

--position string : Position

The --access-* options below set the module access of the new user. Without any of them the user inherits the module access of the context administrator (minus publicfoldereditable). Options that are given are applied on top of that inherited set, so an option that is not given keeps the administrator's value; the defaults quoted below only apply to the CSV import, where every right that is not listed starts as "off". All rights, their names in the different layers and the named combinations are explained in Module Access.

--access-calendar on/off : Calendar module (Default is off)

--access-contacts on/off : Contact module access (Default is on)

--access-delegate-tasks on/off : Create tasks with other participants. Evaluated by the App Suite UI, not checked by the middleware.

--access-edit-public-folder on/off : Edit public folder access (Default is off)

--access-ical on/off : Former read-only iCal interface, removed with 7.10.0. Accepted for compatibility, has no effect.

--access-infostore on/off : Infostore module access (Default is off)

--access-read-create-shared-Folders on/off : Read create shared folder access (Default is off)

--access-syncml on/off : SyncML access. Only evaluated by the SyncML bundle of the USM/EAS extension, which is not part of the current USM image.

--access-active-sync on/off : Exchange ActiveSync access through the USM/EAS extension. Requires --access-usm on as well.

--access-usm on/off : Universal Sync Module access, the base of Exchange ActiveSync (USM/EAS extension).

--access-tasks on/off : Tasks access (Default is off)

--access-vcard on/off : Former read-only vCard interface, removed with 7.10.0. Accepted for compatibility, has no effect.

--access-webdav on/off : WebDAV access to Drive files.

--access-webdav-xml on/off : [DEPRECATED] WebDAV/XML interface of the first Outlook OXtender. Accepted for compatibility, has no effect.

--access-webmail on/off : Webmail access (Default is on)

--access-denied-portal on/off : Denies portal access. Negative right: clients see the portal capability only while it is off.

--access-publication on/off : [DEPRECATED] Publications were removed with 7.10.2. Accepted for compatibility, has no effect.

--access-subscription on/off : Subscriptions of external address books (Google, Microsoft, Yahoo, CardDAV). Calendar subscriptions do not depend on it.

--access-edit-group on/off : Edit group access (Default is off)

--access-edit-resource on/off : Edit resource access (Default is off)

--access-edit-password on/off : Edit password access (Default is off)

--access-collect-email-addresses on/off : Edit collect email addresses (Default is off)

--access-multiple-mail-accounts on/off : Use multiple mail account feature (Default is off)

--access-global-address-book-disabled on/off : Disables the global address book for the user by removing the folder permission. Rejected together with --access-edit-public-folder, --access-read-create-shared-Folders, --access-delegate-tasks or --access-webdav-xml unless com.openexchange.admin.bypassAccessCombinationChecks is set.

--access-public-folder-editable on/off : Grants folder administrator permission on the public root folders. Only honored for the context administrator, silently dropped for other users.

--foldertree 0/1 : 0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.

--access-olox20 on/off : [DEPRECATED] OLOX 2.0 Outlook connector. Accepted for compatibility, has no effect.

--default-folder-mode default/default-deletable/no-default-folders : The mode how the default infostore folders "Documents", "Documents/Templates", "Pictures", "Music" and "Videos" should be created. If not selected, 'default' is applied. Note: This parameter is only evaluated when initially creating the folders for the user and cannot be adjusted afterwards. However, it is possible to remove previously set 'default' characteristics again through changeuser(1) parameter '--convert-drive-user-folders'.

--convert-guest booleanvalue : The flag whether it desired to convert an existent guest user to a regular user in case there is already a guest user associated with given primary E-Mail address

Importing CSV Files

With the --csv-import <CSV file> option a full path to a CSV file with user data to import can be specified. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.

With this option you can specify a csv file (a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix "--".

This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to be created, containing the whole data.

Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin are always the same.

MODULE ACCESS

Module access limits which modules, interfaces and features a user may use. It can be set right by right with the --access-* options or as a whole with --access-combination-name, which refers to a named set of rights defined through com.openexchange.moduleaccessdefinitions.<name> properties (traditionally in ModuleAccessDefinitions.properties). The shipped names are webmail, pim, pim_infostore, pim_mobility, groupware_standard, groupware_premium, drive and all, plus the legacy names webmail_plus, pim_plus, groupware_plus, premium and groupware, which are kept for existing installations. A name always replaces the complete set of rights; nothing is inherited.

A complete reference of all rights, their names in the different layers, their current status, the shipped combinations, the defaults and the validation rules is given in Module Access.

EXAMPLES

createuser -A masterAdmin -P masterPassword -c 123 -q 1000 -z CompanyA -u "admin" -d "Admin of CompanyA" -g John -s Example -p newpw -e john@example.com

Creates a user.

SEE ALSO

deleteuser(1), listuser(1), changeuser(1), getusercapabilities(1)