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

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

Subject Item

n2:confirm

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n4:isWebServiceOf

n5:this_ODSUserModuleAPI

n4:endPointURL

n6:confirm

schema:shortDescription

<p>Confirm an authentication confirmation request. </p>

n4:hasParameter

n7:_cid n7:_username n7:_email

schema:name

EntryPoint - user_authenticate_confirm

schema:description

<p>Whenever ODS creates an authentication confirmation request as a result to a call to <ref kindref="member" refid="group__ods__module__user_1gad6f02a38ce0b890ad56c35888e33eed8">user.authenticate.authenticationUrl()</ref> or <ref kindref="member" refid="group__ods__module__user_1ga974f604be99696e368122af579e4a670">user.authenticate.webid()</ref> this method can be used to complete the authentication and create the final account with the verified profile details.</p><p>If this method is called with authentication credentials as detailed in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref> it will not create a new user account. Instead it will connect the 3rd-party serivce id from the confirmation session to the authenticated account.</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>cid</parametername> </parameternamelist> <parameterdescription> <p>The confirmation session ID. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> <p>The username as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> <p>The email as verified and optionally changed by the user. Will only be used in confirmation mode, when called without user authentication.</p></parameterdescription> </li> </ul> <simplesect kind="return"><p>A user session object as details in <ref kindref="member" refid="group__ods__module__user_1ga974f604be99696e368122af579e4a670">user.authenticate.webid()</ref> in the case of success. In the case of an error a code 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="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>

schema:url

n6:confirm