/usr/share/gtk-doc/html/libsignon-glib/gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.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 321 | <!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.AuthService: 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="signond-dbus-api.html" title="Part III. signond D-Bus API">
<link rel="next" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.html" title="com.google.code.AccountsSSO.SingleSignOn.AuthSession">
<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.AuthService.description" class="shortcut">Description</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="signond-dbus-api.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthSession.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.AuthService"></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-AuthService.top_of_page"></a>com.google.code.AccountsSSO.SingleSignOn.AuthService</span></h2>
<p>com.google.code.AccountsSSO.SingleSignOn.AuthService — Manages Signon identities.</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.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.registerNewIdentity" title="The registerNewIdentity() method">registerNewIdentity</a> (OUT o objectPath);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.getIdentity" title="The getIdentity() method">getIdentity</a> (IN u id,
OUT o objectPath,
OUT a{sv} identityData);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.getAuthSessionObjectPath" title="The getAuthSessionObjectPath() method">getAuthSessionObjectPath</a> (IN u id,
IN s type,
OUT s path);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.queryMethods" title="The queryMethods() method">queryMethods</a> (OUT as methods);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.queryMechanisms" title="The queryMechanisms() method">queryMechanisms</a> (IN s method,
OUT as mechanisms);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.queryIdentities" title="The queryIdentities() method">queryIdentities</a> (IN a{sv} filter,
OUT aa{sv} identities);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.clear" title="The clear() method">clear</a> (OUT b success);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.backupStarts" title="The backupStarts() method">backupStarts</a> (OUT y unnamed_arg0);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.backupFinished" title="The backupFinished() method">backupFinished</a> (OUT y unnamed_arg0);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.restoreStarts" title="The restoreStarts() method">restoreStarts</a> (OUT y unnamed_arg0);
<a class="link" href="gdbus-com.google.code.AccountsSSO.SingleSignOn.AuthService.html#gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.restoreFinished" title="The restoreFinished() method">restoreFinished</a> (OUT y unnamed_arg0);
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-com-google-code-AccountsSSO-SingleSignOn-AuthService"></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> Query information on available authentication methods and mechanisms, as
well as create identities and authentication sessions.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-com.google.code.AccountsSSO.SingleSignOn.AuthService"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.registerNewIdentity"></a><h3>The registerNewIdentity() method</h3>
<pre class="programlisting">
registerNewIdentity (OUT o objectPath);
</pre>
<p> Create a new (empty) 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">OUT o <em class="parameter"><code>objectPath</code></em></code>:</span></p></td>
<td><p>the D-Bus object path of the new Identity</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.getIdentity"></a><h3>The getIdentity() method</h3>
<pre class="programlisting">
getIdentity (IN u id,
OUT o objectPath,
OUT a{sv} identityData);
</pre>
<p> Get an Identity from the Signon database, creating it if it does not
exist.
</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 u <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p>the ID of the Identity in the Signon database</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>objectPath</code></em></code>:</span></p></td>
<td><p>the D-Bus object path for the Identity</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>identityData</code></em></code>:</span></p></td>
<td><p>the information associated with the Identity</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.getAuthSessionObjectPath"></a><h3>The getAuthSessionObjectPath() method</h3>
<pre class="programlisting">
getAuthSessionObjectPath (IN u id,
IN s type,
OUT s path);
</pre>
<p> Return a D-Bus object path for a newly-created AuthSession.
</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 u <em class="parameter"><code>id</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT s <em class="parameter"><code>path</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-AuthService.queryMethods"></a><h3>The queryMethods() method</h3>
<pre class="programlisting">
queryMethods (OUT as methods);
</pre>
<p> Query the list of all available authentication methods.
</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 as <em class="parameter"><code>methods</code></em></code>:</span></p></td>
<td><p>an array of the available authentication methods</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.queryMechanisms"></a><h3>The queryMechanisms() method</h3>
<pre class="programlisting">
queryMechanisms (IN s method,
OUT as mechanisms);
</pre>
<p> Query the list of available authentication mechanisms for a given
authentication method.
</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>method</code></em></code>:</span></p></td>
<td><p>the authentication method for which to query the available mechanisms</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT as <em class="parameter"><code>mechanisms</code></em></code>:</span></p></td>
<td><p>an array of the available authentication mechanisms</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.queryIdentities"></a><h3>The queryIdentities() method</h3>
<pre class="programlisting">
queryIdentities (IN a{sv} filter,
OUT aa{sv} identities);
</pre>
<p> Request an array of identities which are 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>filter</code></em></code>:</span></p></td>
<td><p>the filter to apply to the returned identities</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT aa{sv} <em class="parameter"><code>identities</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-AuthService.clear"></a><h3>The clear() method</h3>
<pre class="programlisting">
clear (OUT b success);
</pre>
<p> Clear the Signon database by removing all stored identities.
</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>success</code></em></code>:</span></p></td>
<td><p>whether the clear succeeded</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-com-google-code-AccountsSSO-SingleSignOn-AuthService.backupStarts"></a><h3>The backupStarts() method</h3>
<pre class="programlisting">
backupStarts (OUT y unnamed_arg0);
</pre>
<p> TODO
</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 y <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-AuthService.backupFinished"></a><h3>The backupFinished() method</h3>
<pre class="programlisting">
backupFinished (OUT y unnamed_arg0);
</pre>
<p> TODO
</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 y <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-AuthService.restoreStarts"></a><h3>The restoreStarts() method</h3>
<pre class="programlisting">
restoreStarts (OUT y unnamed_arg0);
</pre>
<p> TODO
</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 y <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-AuthService.restoreFinished"></a><h3>The restoreFinished() method</h3>
<pre class="programlisting">
restoreFinished (OUT y unnamed_arg0);
</pre>
<p> TODO
</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 y <em class="parameter"><code>unnamed_arg0</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>
|