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

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

Subject Item

n2:webid

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n3:isWebServiceOf

n4:this_ODSUserModuleAPI

n3:endPointURL

n6:webid

schema:shortDescription

<p>Authenticate with, register with, or connect a WebID. </p>

n3:hasParameter

n7:_confirm n7:_action

schema:name

EntryPoint - user_authenticate_webid

schema:description

<p>This method represents the ODS support for WebID authentiction. It can be used to connect an ODS account to a WebID, to register a new ODS account using a WebID, or to authenticate a user via their WebID. In addition ODS supports X.509 certificates without an embedded WebID.</p><p>Clients need to call this method through an SSL connection providing the X.509 client certifcate which should be used for authentication, registration, or to connect to an account. In the case of account connection the user need to authenticate themselves in addition to providing the certificate. Any of the supported ways can be used except for the certificate itself. Typically clients will use a session ID. See <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref> for details.</p><p>VSP or PHP clients that do not have access to the client certifcate's private key can use <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> with a <computeroutput>service</computeroutput> values of <computeroutput>webid</computeroutput>.</p><sect1 id="group__ods__module__user_1ods_user_authenticate_web_storage"> <title>WebID Storage</title> <p>WedIDs will be stored like other 3rd party online accounts as handled by <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref>. As such they are listed via <ref kindref="member" refid="group__ods__module__user_1ga74edeb21c990ffa4d8e554fd8dd13eff">user.onlineAccounts.list()</ref> with service type <computeroutput>"webid"</computeroutput> and a <computeroutput>uri</computeroutput> that is the actual WebID.</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>action</parametername> </parameternamelist> <parameterdescription> <p>The action to perform. See <ref kindref="member" refid="group__ods__module__user_1ods_authentication_url_action">Authentication Action Types</ref> for details on the supported actions. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>confirm</parametername> </parameternamelist> <parameterdescription> <p>The confirmation mode. See <ref kindref="member" refid="group__ods__module__user_1ods_authentication_url_confirm">Authentication Confirmation Mode</ref> for details on the supported modes.</p></parameterdescription> </li> </ul> <simplesect kind="return"><p>A valid ODS session or the confirmation session encoded as an XML stream. In case the client authenticated with a session ID for the <computeroutput>connect</computeroutput> action this session ID will be returned.</p></simplesect> <simplesect kind="see"><p><ref kindref="member" refid="group__ods__module__user_1ga6238a5b780bc6a2811d977bfdc2a9f96">user.authenticate()</ref>, <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref></p></simplesect> </p></sect1> <sect1 id="group__ods__module__user_1ods_user_session_example"> <title>Example User Session:</title> <p>The user session object contains:<itemizedlist> <listitem><p>The session ID <computeroutput>sid</computeroutput> </p></listitem><listitem><p>The user with username <computeroutput>uname</computeroutput>, the internal numerical <computeroutput>uid</computeroutput>, and two flags:<itemizedlist> <listitem><p><computeroutput>dba</computeroutput> indicates if the user is the dba user, ie. has administrator privileges.</p></listitem><listitem><p><computeroutput>new</computeroutput> indicates if this user has been newly registered. This is useful for client to show some welcome message or the like.</p></listitem></itemizedlist> </p></listitem></itemizedlist> </p><p><pre> &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></sect1> <sect1 id="group__ods__module__user_1ods_auth_confirmation_session_example"> <title>Example Confirmation Session:</title> <p><pre> &lt;confirmSession&gt; &lt;cid&gt;&lt;/cid&gt; &lt;user&gt; &lt;name&gt;&lt;/name&gt; &lt;email&gt;&lt;/email&gt; &lt;/user&gt; &lt;onlineAccount&gt; &lt;service&gt;webid&lt;/service&gt; &lt;uid&gt;&lt;/uid&gt; &lt;/onlineAccount&gt; &lt;reason&gt; &lt;code&gt;invalid_username&lt;/code&gt; &lt;msg&gt;The login name contains invalid characters&lt;/msg&gt; &lt;/reason&gt; &lt;/confirmSession&gt; </pre></p><p><simplesect kind="par"><title>Authentication</title><p>This function will provide additional information if authentication via one of the supported methods as described in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref> is used. </p></simplesect> </p></sect1>

schema:url

n6:webid