NAME

createsharedaccount - creates a shared account.

SYNOPSIS

createsharedaccount [OPTION]...

DESCRIPTION

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

OPTIONS

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

--extendedoptions : Prints all options, use this instead of help option.

-A, --adminuser admin : The context admin username for authentication.

-P, --adminpass adminPassword : The context admin password for authentication.

-c, --contextid contextId : The context identifier. Mandatory.

-u, --username sharedAccountName : Username of the shared account

-d, --displayname displayName : Display name of the shared account

-g, --givenname givenName : Given name for the shared account

-s, --surname surname : Surname of the shared account

-p, --password password : Password for the shared account

-e, --email email : Primary mail address

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

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

-x, --department department : Department of the shared account

-z, --company company : Company of the shared account

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

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

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

--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

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

--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 shared account and cannot be adjusted afterward. However, it is possible to remove previously set 'default' characteristics again through updatesharedaccount(1) parameter '--convert-drive-user-folders'.

Importing CSV Files

With the --csv-import <CSV file> option a full path to a CSV file with shared account 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 column names 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 createsharedaccount 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

Shared accounts have a fixed module access that cannot be changed per account: mail, calendar and contacts, with the global address book disabled and the portal denied. The --access-* options and --access-combination-name of the user tools are therefore not available for shared accounts. The meaning of the individual rights is explained in Module Access.

EXAMPLES

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

Creates a sharedaccount.

createsharedaccount -A masterAdmin -P masterPassword -c 123 -z CompanyA -u "appointments" -d "Appointments of CompanyA" -p newpw -e appointments@example.com

Creates a sharedaccount without given and sur name.

deletesharedaccount(1), listsharedaccount(1), updatesharedaccount(1)