<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Auth::Identity Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Auth.html">Auth</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Auth_1_1Identity.html">Identity</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::Identity Class Reference<div class="ingroups"><a class="el" href="group__auth.html">Authentication module (Wt::Auth)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::Identity" -->
<p>A class that represents a user identity.
<a href="classWt_1_1Auth_1_1Identity.html#details">More...</a></p>
<p><code>#include <Auth/Identity></code></p>
<p><a href="classWt_1_1Auth_1_1Identity-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a449befb50421eca487fb921a86624881">Identity</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a449befb50421eca487fb921a86624881"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d222837201d09347fc411cc2ddaf92b"></a><!-- doxytag: member="Wt::Auth::Identity::Identity" ref="a4d222837201d09347fc411cc2ddaf92b" args="(const std::string &provider, const std::string &id, const WString &name, const std::string &email, bool emailVerified)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a4d222837201d09347fc411cc2ddaf92b">Identity</a> (const std::string &provider, const std::string &id, const <a class="el" href="classWt_1_1WString.html">WString</a> &name, const std::string &email, bool emailVerified)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#ad9741bdd1c5175d496fe71e8f036f335">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the identity is valid. <a href="#ad9741bdd1c5175d496fe71e8f036f335"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a74533c2fae182d36efd768a269735ed6">provider</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the provider name. <a href="#a74533c2fae182d36efd768a269735ed6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#ace4617c79e00bd91c0d7722fc82b27be">id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the id. <a href="#ace4617c79e00bd91c0d7722fc82b27be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a2e339b1fe3f10ae41ae1f4128803d5a9">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name. <a href="#a2e339b1fe3f10ae41ae1f4128803d5a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a646616c683c7289d91f1c7dff65ad687">email</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an email address. <a href="#a646616c683c7289d91f1c7dff65ad687"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a19e269fc71eac86cca3fd45785d669d1">emailVerified</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the email address has been verified. <a href="#a19e269fc71eac86cca3fd45785d669d1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classWt_1_1Auth_1_1Identity.html">Identity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#aca9a52ebe8245174cff6452c833ce31e">Invalid</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An invalid identity constant. <a href="#aca9a52ebe8245174cff6452c833ce31e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Identity.html#a1d680fd0dbf7a12684a511d74081eb06">LoginName</a> = "loginname"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The login name identity. <a href="#a1d680fd0dbf7a12684a511d74081eb06"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class that represents a user identity. </p>
<p>The identity is the result of an authentication process. Although the most common authentication method (password authentication) only returns a user name, other methods (such as OAuth, client SSL certificates, or an authentication reverse proxy server) may return more information.</p>
<p>At the very least, the user is identified using a unique ID, and it optionally also contains name and email address information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>OAuthService::getIdentity(), RegistrationWidget::registerIdentified() </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a449befb50421eca487fb921a86624881"></a><!-- doxytag: member="Wt::Auth::Identity::Identity" ref="a449befb50421eca487fb921a86624881" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Auth::Identity::Identity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Creates an invalid identity. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a646616c683c7289d91f1c7dff65ad687"></a><!-- doxytag: member="Wt::Auth::Identity::email" ref="a646616c683c7289d91f1c7dff65ad687" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::Auth::Identity::email </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an email address. </p>
<p>Returns the user's email address, or an empty string if not provided.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Identity.html#a19e269fc71eac86cca3fd45785d669d1" title="Returns whether the email address has been verified.">emailVerified()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a19e269fc71eac86cca3fd45785d669d1"></a><!-- doxytag: member="Wt::Auth::Identity::emailVerified" ref="a19e269fc71eac86cca3fd45785d669d1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Auth::Identity::emailVerified </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the email address has been verified. </p>
<p>The third party provider may be able to guarantee that the user indeed also control's the given email address (e.g. because the third party hosts that email account for the user).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Identity.html#a646616c683c7289d91f1c7dff65ad687" title="Returns an email address.">email()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ace4617c79e00bd91c0d7722fc82b27be"></a><!-- doxytag: member="Wt::Auth::Identity::id" ref="ace4617c79e00bd91c0d7722fc82b27be" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::Auth::Identity::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the id. </p>
<p>Returns a unique identifier for the user within the scope of this provider. </p>
</div>
</div>
<a class="anchor" id="ad9741bdd1c5175d496fe71e8f036f335"></a><!-- doxytag: member="Wt::Auth::Identity::isValid" ref="ad9741bdd1c5175d496fe71e8f036f335" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Auth::Identity::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the identity is valid. </p>
<p>An invalid identity is used to indicate for example that no identity information could be obtained. </p>
</div>
</div>
<a class="anchor" id="a2e339b1fe3f10ae41ae1f4128803d5a9"></a><!-- doxytag: member="Wt::Auth::Identity::name" ref="a2e339b1fe3f10ae41ae1f4128803d5a9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a>& Wt::Auth::Identity::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name. </p>
<p>Returns the user's name, or an empty string if not provided. </p>
</div>
</div>
<a class="anchor" id="a74533c2fae182d36efd768a269735ed6"></a><!-- doxytag: member="Wt::Auth::Identity::provider" ref="a74533c2fae182d36efd768a269735ed6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::Auth::Identity::provider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the provider name. </p>
<p>This is a unique id that names the source for this identity (e.g. "google-oauth", or "LDAP", or "user" (for a user-chosen identity). </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aca9a52ebe8245174cff6452c833ce31e"></a><!-- doxytag: member="Wt::Auth::Identity::Invalid" ref="aca9a52ebe8245174cff6452c833ce31e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1Identity.html">Identity</a> <a class="el" href="classWt_1_1Auth_1_1Identity.html#aca9a52ebe8245174cff6452c833ce31e">Wt::Auth::Identity::Invalid</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An invalid identity constant. </p>
<p>This is an identity that is not <a class="el" href="classWt_1_1Auth_1_1Identity.html#ad9741bdd1c5175d496fe71e8f036f335" title="Returns whether the identity is valid.">isValid()</a>. </p>
</div>
</div>
<a class="anchor" id="a1d680fd0dbf7a12684a511d74081eb06"></a><!-- doxytag: member="Wt::Auth::Identity::LoginName" ref="a1d680fd0dbf7a12684a511d74081eb06" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="classWt_1_1Auth_1_1Identity.html#a1d680fd0dbf7a12684a511d74081eb06">Wt::Auth::Identity::LoginName</a> = "loginname"<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The login name identity. </p>
<p>This is a provider name for the (usually user-controlled) identity, used for example for password-based authentication. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
