/usr/share/gtk-doc/html/libsignon-glib/gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html is in libsignon-glib-doc 1.13+16.04.20151209.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>com.google.code.AccountsSSO.SingleSignOn.Identity: libsignon-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libsignon-glib Reference Manual">
<link rel="up" href="signond-dbus-api.html" title="Part III. signond D-Bus API">
<link rel="prev" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html" title="com.google.code.AccountsSSO.SingleSignOn.AuthSession">
<link rel="next" href="appendices.html" title="Part IV. Appendices">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.description" class="shortcut">Description</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="signond-dbus-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appendices.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-com-google-code-AccountsSSO-SingleSignOn-Identity.top_of_page"></a>com.google.code.AccountsSSO.SingleSignOn.Identity</span></h2>
<p>com.google.code.AccountsSSO.SingleSignOn.Identity — Representation of a single identity.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.requestCredentialsUpdate" title="The requestCredentialsUpdate() method">requestCredentialsUpdate</a> (IN s message,
OUT u id);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.getInfo" title="The getInfo() method">getInfo</a> (OUT a{sv} info);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.verifyUser" title="The verifyUser() method">verifyUser</a> (IN a{sv} params,
OUT b valid);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.verifySecret" title="The verifySecret() method">verifySecret</a> (IN s secret,
OUT b valid);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.remove" title="The remove() method">remove</a> ();
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.signOut" title="The signOut() method">signOut</a> (OUT b unnamed_arg0);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.store" title="The store() method">store</a> (IN a{sv} info,
OUT u id);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.addReference" title="The addReference() method">addReference</a> (IN s reference,
OUT i id);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.removeReference" title="The removeReference() method">removeReference</a> (IN s reference,
OUT i id);
</pre>
</div>
<div class="refsect1">
<a name="id-1.4.5.4"></a><h2>Signals</h2>
<pre class="synopsis">
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-Identity.unregistered" title='The "unregistered" signal'>unregistered</a> ();
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.Identity.html#gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-Identity.infoUpdated" title='The "infoUpdated" signal'>infoUpdated</a> (i type);
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-com-google-code-AccountsSSO-SingleSignOn-Identity"></a><h2>Description</h2>
<p> The signond D-Bus APIs are unstable, subject to change and should not be
used by client applications, which should use libsignon-glib or
libsignon-qt instead.
</p>
<p> A single credential stored in the Signon database.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-com.google.code.AccountsSSO.SingleSignOn.Identity"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.requestCredentialsUpdate"></a><h3>The requestCredentialsUpdate() method</h3>
<pre class="programlisting">
requestCredentialsUpdate (IN s message,
OUT u id);
</pre>
<p> Request that the user enters a new secret, which is then stored in the
Signon database.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>message</code></em></code>:</span></p></td>
<td><p>message to be shown to the user</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT u <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>the ID of the Identity</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.getInfo"></a><h3>The getInfo() method</h3>
<pre class="programlisting">
getInfo (OUT a{sv} info);
</pre>
<p> Fetch a large amount of additional information on the Identity, such as
the username, type, method and so on.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>info</code></em></code>:</span></p></td>
<td><p>a dictionary of additional information</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.verifyUser"></a><h3>The verifyUser() method</h3>
<pre class="programlisting">
verifyUser (IN a{sv} params,
OUT b valid);
</pre>
<p> Request that the user enters a secret, and verify that against the secret
stored in the Signon database.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>params</code></em></code>:</span></p></td>
<td><p>parameters to pass to the authentication plugin</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT b <em class="parameter"><code>valid</code></em></code>:</span></p></td>
<td><p>whether the supplied secret is valid</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.verifySecret"></a><h3>The verifySecret() method</h3>
<pre class="programlisting">
verifySecret (IN s secret,
OUT b valid);
</pre>
<p> Verifies that the supplied secret is valid by comparing it to the secret
stored in the Signon database.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>secret</code></em></code>:</span></p></td>
<td><p>the secret to verify</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT b <em class="parameter"><code>valid</code></em></code>:</span></p></td>
<td><p>whether the secret is valid</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.remove"></a><h3>The remove() method</h3>
<pre class="programlisting">
remove ();
</pre>
<p> Remove the identity from the Signon database.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.signOut"></a><h3>The signOut() method</h3>
<pre class="programlisting">
signOut (OUT b unnamed_arg0);
</pre>
<p> Close all authentication sessions for the identity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">OUT b <em class="parameter"><code>unnamed_arg0</code></em></code>:</span></p></td>
<td><p></p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.store"></a><h3>The store() method</h3>
<pre class="programlisting">
store (IN a{sv} info,
OUT u id);
</pre>
<p> Store the given credentials information in the identity, returning a
numeric ID for the identity in the Signon database.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>info</code></em></code>:</span></p></td>
<td><p>information to store in the Identity</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT u <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>a numeric ID for the identity in the database</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.addReference"></a><h3>The addReference() method</h3>
<pre class="programlisting">
addReference (IN s reference,
OUT i id);
</pre>
<p> Add a named reference to the Identity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>reference</code></em></code>:</span></p></td>
<td><p>a named reference to add</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>the ID of the reference in the database</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-Identity.removeReference"></a><h3>The removeReference() method</h3>
<pre class="programlisting">
removeReference (IN s reference,
OUT i id);
</pre>
<p> Remove a named reference from the Identity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>reference</code></em></code>:</span></p></td>
<td><p>a named reference to removed</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>the ID of the reference in the database</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-signals-com.google.code.AccountsSSO.SingleSignOn.Identity"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-Identity.unregistered"></a><h3>The "unregistered" signal</h3>
<pre class="programlisting">
unregistered ();
</pre>
<p> Emitted when the Identity is removed from the Signon database.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-signal-com-google-code-AccountsSSO-SingleSignOn-Identity.infoUpdated"></a><h3>The "infoUpdated" signal</h3>
<pre class="programlisting">
infoUpdated (i type);
</pre>
<p> updated.
<em class="parameter"><code>type</code></em>: the type of update that occurred
</p>
<p> Emitted when credentials information has been updated is the Signon
database, such as when the credentials were updated or removed, or when
the identity was signed out.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">i <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p></p></td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|