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

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

Subject Item

n2:authenticate

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n3:isWebServiceOf

n7:this_ODSUserModuleAPI

n3:endPointURL

n6:authenticate

schema:shortDescription

<p>Start a new user session via user digest information. </p>

n3:hasParameter

n4:_openIdIdentity n4:_oauthMode n4:_facebookUID n4:_openIdUrl n4:_oauthToken n4:_oauthSid n4:_oauthVerifier n4:_user_name n4:_password_hash

schema:name

EntryPoint - user_authenticate

schema:description

<p>ODS supports a variety of authentication methods. The most common way of operation for a client is to obtain a session ID and use it in subsequent calls to the API as described in <ref kindref="member" refid="ods_authentication_1ods_authentication_session_id">Authentication via Session Id</ref>. Session IDs are obtained in one of the following ways. This method allows to authenticate via classical user digest information (user name and password). Authentication through third-party services is handled by <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref>. <ref kindref="member" refid="group__ods__module__user_1ga974f604be99696e368122af579e4a670">user.authenticate.webid()</ref> handles WebiD (X.509 client SSL certificate authentication). In contrast to the other methods <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> will return a URL the client needs to navigate the user to in order to complete the authentication. The other methods will return a session ID.</p><p>A session will timeout after being unused for half an hour.</p><sect1 id="group__ods__module__user_1ods_user_authenticate_password"> <title>Authentication via Password Hash</title> <p>When authenticating via password hashes parameters <computeroutput>user_name</computeroutput> and <computeroutput>password_hash</computeroutput> need to be specified. The password hash uses the <emphasis>sha1</emphasis> digest algorithm and includes both the user name and the password.</p><p>This can be created via openssl or any sha1 tool available in the environment of the client: <programlisting><codeline><highlight class="preprocessor"><sp />#<sp />echo<sp />-n<sp />"demofoobar"<sp />|<sp />openssl<sp />dgst<sp />-sha1</highlight></codeline> <codeline><highlight class="preprocessor"><sp />#<sp />echo<sp />-n<sp />"demofoobar"<sp />|<sp />sha1sum</highlight></codeline> </programlisting></p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>user_name</parametername> </parameternamelist> <parameterdescription> <p>The user name of the account created via <ref kindref="member" refid="group__ods__module__user_1gabff5adf64d0a8d144eea3bf00c186825">user.register()</ref>. If specified <computeroutput>password_hash</computeroutput> also needs to be provided. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>password_hash</parametername> </parameternamelist> <parameterdescription> <p>The password hash as explained in <ref kindref="member" refid="ods_authentication_1ods_authentication_password_hash">Password Hash Authentication</ref>. Mandatory if <computeroutput>user_name</computeroutput> is specified. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>facebookUID</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for Facebook login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>openIdUrl</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OpenID login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>openIdIdentity</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OpenID login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>oauthMode</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OAuth login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>oauthSid</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OAuth login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>oauthVerifier</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OAuth login. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>oauthToken</parametername> </parameternamelist> <parameterdescription> <p>Deprecated Use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> for OAuth login.</p></parameterdescription> </li> </ul> <simplesect kind="return"><p>An XML stream containing the session id of the newly created session. This session id can then be used to authenticate other method calls as explained in <ref kindref="member" refid="ods_authentication_1ods_authentication_session_id">Authentication via Session Id</ref>. For an example of a user session object see <ref kindref="member" refid="group__ods__module__user_1ods_user_session_example">Example User Session:</ref>.</p></simplesect> <simplesect kind="see"><p><ref kindref="member" refid="ods_authentication_1ods_authentication_oauth">Authentication via OAuth</ref>, <ref kindref="member" refid="group__ods__module__user_1ga974f604be99696e368122af579e4a670">user.authenticate.webid()</ref>, <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i "http://www.iodbc.org/ods/api/user.authenticate?user_name=demo&amp;password_hash=49e473da03fbc286f06b5f0bf1f3301b5e4a67fd" HTTP/1.1 200 OK Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu Connection: Keep-Alive Date: Tue, 17 Apr 2012 09:31:34 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 114 &lt;userSession&gt; &lt;sid&gt;1de236f5da2f32d92e8c0cce5053a96e&lt;/sid&gt; &lt;user&gt; &lt;uname&gt;demo&lt;/uname&gt; &lt;uid&gt;127&lt;/uid&gt; &lt;new&gt;0&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 requries authentication via one of the supported authentication methods as described in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref>. </p></simplesect> </p></sect1>

schema:url

n6:authenticate