This HTML5 document contains 14 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:register

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n4:isWebServiceOf

n7:this_ODSUserModuleAPI

n4:endPointURL

n6:register

schema:shortDescription

<p>Register a new user account. </p>

n4:hasParameter

n5:_mode n5:_data n5:_password n5:_email n5:_name

schema:name

EntryPoint - user_register

schema:description

<p>ODS allows to register new accounts in several ways, ranging from simple a username/password combination to registration through an existing Twitter account. Some registration methods such as the registration via OAuth or OpenID requires more than one step. This function is used for classicaly username/password registration. Other registration methods like WebID, OpenID, or any OAuth-based service are supported through the <computeroutput>register</computeroutput> action in <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> and <ref kindref="member" refid="group__ods__module__user_1ga974f604be99696e368122af579e4a670">user.authenticate.webid()</ref>.</p><p>For security reasons it is highly recommended to perform any registration calls through a secure connection.</p><p>Registration via username and password is as easy as calling <ref kindref="member" refid="group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825">user.register()</ref> with the <computeroutput>name</computeroutput>, <computeroutput>password</computeroutput>, and <computeroutput>email</computeroutput> parameters filled. If the <computeroutput>name</computeroutput> is not in use yet and the <computeroutput>email</computeroutput> address is either unique or ODS has been configured to allow non-unique email addresses, then a new user account will be created which can immediately be used for <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref>.</p><p><simplesect kind="par"><title>Post Registration</title><p>ODS accounts which have not beed created with a classical password have a random password which can be changed later on via <ref kindref="member" refid="group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965">user.password.change()</ref> to enable classical <ref kindref="member" refid="ods_authentication_1ods_authentication_password_hash">Password Hash Authentication</ref>. In addition any of the supported registration and authentication methods can be added to an existing account at any time through the <ref kindref="member" refid="group__ods__module__user_1ga0ee8a3214520a223cd188b1ed0b65784">user.update()</ref> or <ref kindref="member" refid="group__ods__module__user_1ga777818aa3df3994ecb3fc581e691c18a">user.update.fields()</ref> functions.</p></simplesect> <parameterlist kind="param"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The user name for the new account. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> <p>The password for the new account. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> <p>The email address for the new account. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>mode</parametername> </parameternamelist> <parameterdescription> <p><emphasis>deprecated</emphasis> </p></parameterdescription> </li> <li> <parameternamelist> <parametername>data</parametername> </parameternamelist> <parameterdescription> <p><emphasis>deprecated</emphasis> </p></parameterdescription> </li> </ul> <simplesect kind="return"><p>On success a new user session as detailed in <ref kindref="member" refid="group__ods__module__user_1ods_user_session_example">Example User Session:</ref> is returned which can be used as described in <ref kindref="member" refid="ods_authentication_1ods_authentication_session_id">Authentication via Session Id</ref>. On error an appropriate HTTP status code is set and an error message as detailed in <ref kindref="member" refid="ods_response_format_1ods_response_format_result_code">ODS Error Result Codes</ref> is returned.</p></simplesect> <simplesect kind="see"><p><ref kindref="member" refid="ods_authentication_1ods_authentication_oauth">Authentication via OAuth</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i "http://www.iodbc.org/ods/api/user.register?name=test123&amp;password=1&amp;email=test@yahoo.com" HTTP/1.1 200 OK Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64 VDB Connection: Keep-Alive Date: Mon, 28 Dec 2009 22:18:59 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="ISO-8859-1" Content-Length: 59 &lt;userSession&gt; &lt;sid&gt;1de236f5da2f32d92e8c0cce5053a96e&lt;/sid&gt; &lt;user&gt; &lt;uname&gt;test123&lt;/uname&gt; &lt;uid&gt;132&lt;/uid&gt; &lt;new&gt;1&lt;/new&gt; &lt;dba&gt;0&lt;/dba&gt; &lt;/user&gt; &lt;/userSession&gt; </pre></p><p><simplesect kind="par"><title>Authentication</title><p>This function does not require any authentication. </p></simplesect> </p>

schema:url

n6:register