Files
deployd/docs/usercollection.html
Dallon Feldner 79aa222886 Added docs
2012-03-31 14:54:48 -07:00

41 lines
1.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<span class="brand">
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
</ul>
</div>
</div>
</div>
<div class="container"><h1>User Collection Resource</h1>
<p>A User Collection resource behaves much like the standard Collection resource, but adds the ability to authenticate with a username and password.</p>
<h2>Special properties</h2>
<p>The User Collection contains two special properties:</p>
<ul>
<li><strong>email</strong> - For security, hidden by default on all users except the current user.</li>
<li><strong>password</strong> - Never readable under any circumstances. Can only be set when the user is logged in, when creating a new user, or from the Dashboard.</li>
</ul>
<h2>Authenticating a user</h2>
</div>
</body>
</html>