# 22. Virtuoso Functions Guide - xmlStorageSystem.registerUser

Chapter Contents | Prev | Next
Keyword Search:
www.openlinksw.com
docs.openlinksw.com
Book Home
Contents
Preface
Virtuoso Functions Guide
Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Remote SQL Data Source
Replication
SOAP
SQL
String
Transaction
Type Mapping
UDDI
User Defined Types & The CLR
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web Server & Internet
XML
XPATH & XQUERY
Functions Index

## xmlStorageSystem.registerUser

Register a user with the XML Storage System
structure xmlStorageSystem.registerUser (in email string, in name string, in password string, in clientPort integer, in userAgent string, in serialNumber string);
Description

This method allows users to register within XML Storage System. The actions performed on the server are:

- make a new Web account named <email> with the password specified.
- make a home-folder in WebDAV repository as /DAV/<email>.
- make a sub-folder called "blog".

Parameters
email – For user identification, this should be a valid email account.
name – A human readable name for the user account.
password – The password for authentication. Note that this is the only call that sends the password in clear-text. All other functions send the password as a MD5 hash.
clientPort – Currently ignored and reserved for future use.
userAgent – Currently ignored and reserved for future use.
serialNumber – Currently ignored and reserved for future use.
Return Types

This method returns a structure as follows:

        'usernum' string 	account id
        'flError' boolean   0 success, 1 fault
        'message' string    fault message (can be used to handle error cases)

Examples
Registering a new user

    SQL> SOAP_CLIENT (url=>'http://localhost:6666/xmlStorageSystem',
    	 	 operation=>'registerUser', parameters=>vector
    		('email','user@example.domain', 'name', 'Somebody Name',
    		 'password', 'xxx', 'clientPort', 0, 'userAgent', '' , 'serialNumber', ''));

        - SOAP response
        <registerUserResponse>
          <Result>
    	<usernum>user@example.domain</usernum>
    	<flError>0</flError>
    	<message>Welcome, Somebody Name</message>
          </Result>
        </registerUserResponse>

See Also

xmlStorageSystem.mailPasswordToUser()

xmlStorageSystem.getServerCapabilities()

xmlStorageSystem.deleteMultipleFiles()

xmlStorageSystem.saveMultipleFiles()