usergrid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From timangl...@apache.org
Subject svn commit: r1550369 [2/2] - in /incubator/usergrid/site/publish/docs: collections/index.html organizations-admins/index.html users-and-devices/ users-and-devices/index.html
Date Thu, 12 Dec 2013 08:12:44 GMT
Added: incubator/usergrid/site/publish/docs/users-and-devices/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/users-and-devices/index.html?rev=1550369&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/users-and-devices/index.html (added)
+++ incubator/usergrid/site/publish/docs/users-and-devices/index.html Thu Dec 12 08:12:43
2013
@@ -0,0 +1,467 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <title>Apache Usergrid (incubating) — Users & Devices</title>
+    <meta http-equiv="x-ua-compatible" content="ie=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1,
maximum-scale=1" />
+    <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+    <meta name="description" content="An open-source Backend-as-a-Service stack for web
& mobile applications, based on RESTful APIs." />
+    <meta property="og:title" content="Apache Usergrid" />
+    <meta property="og:description" content="An open-source Backend-as-a-Service stack
for web & mobile applications, based on RESTful APIs." />
+    <!-- Loading Typekit -->
+    <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+    <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+    <!-- Loading Bootstrap -->
+    <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+    <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+    <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"
rel="stylesheet" type="text/css">
+    <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+    
+
+    <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file.
-->
+    <!--[if lt IE 9]>
+      <script src="js/html5shiv.js"></script>
+      <script src="js/respond.min.js"></script>
+    <![endif]-->
+</head>
+<body>
+
+    <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+    <div class="container">
+        <div class="navbar-header">
+            <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+            </button>
+            <a href="/" class="navbar-brand">
+                <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+            </a>
+        </div>
+        <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+            <ul class="nav navbar-nav navbar-right">
+                <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+                <li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>
+                <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span
class="icns icon-github-sign"></span></a></li>
+                <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span
class="icns icon-trello"></span></a></li>-->
+                <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span
class="icns icon-bug"></span></a></li>
+                <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span
class="icns icon-stackexchange"></span></a></li>
+                <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4"
target="_blank"><span class="icns icon-comments"></span></a></li>
+                <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"
target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+                <li><a href="https://twitter.com/usergrid" target="_blank"><span
class="icns icon-twitter"></span></a></li>
+            </ul>
+        </nav>
+    </div>
+    </header>
+
+
+<div class="container bf-docs-container">    
+    <div class="row">
+        <div class="col-md-3">
+            <div class="bf-sidebar hidden-print" role="complementary">
+                <ul class="nav nav-list">
+                    <li><a href="/docs/getting-up-and-running-locally/">Getting
Up & Running Locally</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/ugc#usergrid-command-line-ugc"><code>ugc</code>
— the Command-line Client</a></li>
+
+                    <li class="nav-header"><span>Concepts</span></li>
+                    <li>
+                        <a href="/docs/organizations-admins/">Organizations & Admins</a>
+                        <ul>
+                            <li>
+                                <a href="/docs/applications/">Applications</a>
+                                <ul>
+                                    <li><a href="/docs/roles-and-permissions/">Roles
& Permissions</a></li>
+                                    <!--<li><a href="#">Queues</a></li>-->
+                                    <li><a href="/docs/events-and-counters/">Events
& Counters</a></li>
+                                    <li><a href="/docs/relationships/">Relationships
(Joins)</a></li>
+                                    <li>
+                                        <a href="/docs/collections">Collections</a>
+                                        <ul>
+                                            <li><a href="/docs/query-language/">Query
Language</a></li>
+                                            <li><a href="/docs/users-and-devices/">Users
& Devices</a></li>
+                                            <li><a href="/docs/groups/">Groups</a></li>
+                                            <li><a href="/docs/activities/">Activities</a></li>
+                                            <li><a href="/docs/assets/">Assets</a></li>
+                                        </ul>
+                                    </li>
+                                </ul>
+                            </li>
+                        </ul>
+                    </li>
+
+
+                    <li class="nav-header"><span>Usage</span></li>
+                    <li>REST API — Coming Soon</li>
+                    <li><a class="icns-apple" href="https://github.com/usergrid/usergrid/tree/master/sdks/ios">iOS
SDK</a></li>
+                    <li><a class="icns-android" href="https://github.com/usergrid/usergrid/tree/master/sdks/android">Android
SDK</a></li>
+                    <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li>
+                    <li><a class="icns-windows" href="https://github.com/usergrid/usergrid/tree/master/sdks/dotnet">Windows
8 / Windows Phone / .net SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/nodejs">Node.js
module</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby">Ruby
gem</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby-on-rails">Ruby
on Rails gem</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/php">PHP
library</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/java">Java
library</a></li>
+
+                    <li class="nav-header"><span>Internals</span></li>
+                    <li>Design & Goals — Coming Soon</li>
+                    <li>Java Architecture — Coming Soon</li>
+                    <li>Cassandra Schema — Coming Soon</li>
+                    <li><a href="/docs/contributing/">Contributing</a></li>
+
+                    <li class="nav-header"><span>Operations</span></li>
+                    <li>Deploying — Coming Soon</li>
+                    <li>Monitoring — Coming Soon</li>
+                    <li><a href="/docs/upgrading/">Upgrading</a></li>
+                    <li>Security — Coming Soon</li>
+                </ul>
+            </div>
+        </div>
+
+        <div class="col-md-9 main-article" role="main">
+            <div class="page-article">
+                <div class="page-header">
+                    <h1>Users & Devices</h1>
+                  <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/users-and-devices.md">contribute
to this article on github</a></small>
+                </div>
+                <div class="toc">
+	<ul>
+<li>
+<a href="#users">Users</a><ul>
+<li><a href="#properties">Properties</a></li>
+<li><a href="#sets">Sets</a></li>
+<li><a href="#relationshops">Relationshops</a></li>
+<li><a href="#facebook-sign-in">Facebook Sign-in</a></li>
+</ul>
+</li>
+<li>
+<a href="#devices">Devices</a><ul>
+<li><a href="#properties-1">Properties</a></li>
+<li><a href="#relationships">Relationships</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<p>Users and Devices are the primary ways to identify access to the system. Devices
are great to track anonymous access, while Users allow you to model signing up, signing in,
etc.</p>
+<h2 id="users"><a href="#users">Users</a></h2>
+<h3 id="properties"><a href="#properties">Properties</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Property</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">uuid</td>
+<td align="left">UUID</td>
+<td align="left">User’s unique entity ID</td>
+</tr>
+<tr class="even">
+<td align="left">type</td>
+<td align="left">string</td>
+<td align="left">Type of entity, in this case “user”</td>
+</tr>
+<tr class="odd">
+<td align="left">created</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
creation</td>
+</tr>
+<tr class="even">
+<td align="left">modified</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
modification</td>
+</tr>
+<tr class="odd">
+<td align="left">username</td>
+<td align="left">string</td>
+<td align="left">Valid and unique string username (mandatory)</td>
+</tr>
+<tr class="even">
+<td align="left">password</td>
+<td align="left">string</td>
+<td align="left">User password</td>
+</tr>
+<tr class="odd">
+<td align="left">email</td>
+<td align="left">string</td>
+<td align="left">Valid and unique email address</td>
+</tr>
+<tr class="even">
+<td align="left">name</td>
+<td align="left">string</td>
+<td align="left">User display name</td>
+</tr>
+<tr class="odd">
+<td align="left">activated</td>
+<td align="left">boolean</td>
+<td align="left">Whether the user account is activated</td>
+</tr>
+<tr class="even">
+<td align="left">disabled</td>
+<td align="left">boolean</td>
+<td align="left">Whether the user account is administratively disabled</td>
+</tr>
+<tr class="odd">
+<td align="left">firstname</td>
+<td align="left">string</td>
+<td align="left">User first name</td>
+</tr>
+<tr class="even">
+<td align="left">middlename</td>
+<td align="left">string</td>
+<td align="left">User middle name</td>
+</tr>
+<tr class="odd">
+<td align="left">lastname</td>
+<td align="left">string</td>
+<td align="left">User last name</td>
+</tr>
+<tr class="even">
+<td align="left">picture</td>
+<td align="left">string</td>
+<td align="left">User picture</td>
+</tr>
+</tbody>
+</table><h3 id="sets"><a href="#sets">Sets</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Set</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">connections</td>
+<td align="left">string</td>
+<td align="left">Set of connection types (e.g., likes)</td>
+</tr>
+<tr class="even">
+<td align="left">rolenames</td>
+<td align="left">string</td>
+<td align="left">Set of roles assigned to a user</td>
+</tr>
+<tr class="odd">
+<td align="left">permissions</td>
+<td align="left">string</td>
+<td align="left">Set of user permissions</td>
+</tr>
+<tr class="even">
+<td align="left">credentials</td>
+<td align="left">string</td>
+<td align="left">Set of user credentials</td>
+</tr>
+</tbody>
+</table><h3 id="relationshops"><a href="#relationshops">Relationshops</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Collection</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">groups</td>
+<td align="left">group</td>
+<td align="left">Collection of groups to which a user belongs</td>
+</tr>
+<tr class="even">
+<td align="left">devices</td>
+<td align="left">device</td>
+<td align="left">Collection of devices in the service</td>
+</tr>
+<tr class="odd">
+<td align="left">activities</td>
+<td align="left">activity</td>
+<td align="left">Collection of activities a user has performed</td>
+</tr>
+<tr class="even">
+<td align="left">feed</td>
+<td align="left">activity</td>
+<td align="left">Inbox of activity notifications a user has received</td>
+</tr>
+<tr class="odd">
+<td align="left">roles</td>
+<td align="left">role</td>
+<td align="left">Set of roles assigned to a user</td>
+</tr>
+</tbody>
+</table><h3 id="facebook-sign-in"><a href="#facebook-sign-in">Facebook
Sign-in</a></h3>
+<p>You can authenticate your Apache Usergrid requests by logging into Facebook. To
access Apache Usergrid resources, you need to provide an access token with each request (unless
you use the sandbox app). You can get an access token by connecting to an appropriate web
service endpoint and providing the correct client credentials — this is further described
in <a href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a>. However, you can also obtain an access token by logging into
Facebook.</p>
+<p>To enable authentication to Apache Usergrid through Facebook, do the following in
your app:</p>
+<ol style="list-style-type: decimal">
+<li>Make a login call to the Facebook API (do this using the <a href="https://developers.facebook.com/docs/sdks/">Facebook
SDK</a> or <a href="https://developers.facebook.com/docs/facebook-login/">API</a>).
If the login succeeds, a Facebook access token is returned.</li>
+<li>
+<p>Send the Facebook access token to Apache Usergrid. If the Facebook access token
is valid and the user does not already exist in App Services, Apache Usergrid provisions a
new Apache Usergrid user. It also returns an Apache Usergrid access token, which you can use
for subsequent Apache Usergrid API calls. Behind the scenes, Apache Usergrid uses the Facebook
access token to retrieve the user’s profile information from Facebook.</p>
+<p>If the Facebook access token is invalid, Facebook returns an OAuth authentication
error, and the login does not succeed.</p>
+</li>
+</ol><p>The request to authenticate to Apache Usergrid using a Facebook access
token is:</p>
+<pre><code>GET https://api.usergrid.com/{my_org}/{my_app}/auth/facebook?fb_access_token={fb_access_token}</code></pre>
+<p>where:</p>
+<ul>
+<li>{my_org} is the organization UUID or organization name.<br>
+</li>
+<li>{my_app} is the application UUID or application name.<br>
+</li>
+<li>{fb_access_token} is the Facebook access token.</li>
+</ul><h2 id="devices"><a href="#devices">Devices</a></h2>
+<h3 id="properties-1"><a href="#properties-1">Properties</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Property</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">uuid</td>
+<td align="left">UUID</td>
+<td align="left">Entity unique ID</td>
+</tr>
+<tr class="even">
+<td align="left">type</td>
+<td align="left">string</td>
+<td align="left">Entity type (e.g., device)</td>
+</tr>
+<tr class="odd">
+<td align="left">created</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
creation</td>
+</tr>
+<tr class="even">
+<td align="left">modified</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
modification</td>
+</tr>
+<tr class="odd">
+<td align="left">name</td>
+<td align="left">string</td>
+<td align="left">Device name (mandatory)</td>
+</tr>
+</tbody>
+</table><h3 id="relationships"><a href="#relationships">Relationships</a></h3>
+<p>Devices have the following associated collection.</p>
+<table>
+<thead><tr class="header">
+<th align="left">Collection</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody><tr class="odd">
+<td align="left">users</td>
+<td align="left">user</td>
+<td align="left">Collection of users to which a device belongs</td>
+</tr></tbody>
+</table>
+            </div>
+        </div>
+    </div>
+    <div class="row">
+        <div class="col-md-3"></div>
+        <div class="col-md-9">
+            <div class="github-callout">
+                <strong>Questions?</strong> Please do <a href="/community">ask
on the mailing-lists</a>!<br/>
+                <strong>Found an error?</strong> We’d greatly appreciate
a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/users-and-devices.md">this
article on github</a>.</div>
+        </div>
+    </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+    <div class="container">
+        <div class="row">
+            <div class="col-md-2">
+                <ul class="nav nav-list">
+                    <li class="nav-header"><a href="/">Home</a></li>
+                    <li class="nav-header"><a href="/community/">Community</a></li>
+                        <li><a href="/community/#events">Events</a></li>
+                        <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+                        <li><a href="/community/#deployments">Deployments</a></li>
+                        <li><a href="/community/#committers">Commiters</a></li>
+                    <!-- <li class="nav-header"><a href="#">Docs</a></li>
-->
+                </ul>
+            </div>
+            <div class="col-md-2">
+                <ul class="nav nav-list">
+                    <li class="nav-header"><a href="https://github.com/usergrid/usergrid/"
target="_blank">Code</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/stack"
target="_blank">Server Stack</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/portal"
target="_blank">Admin Portal</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc"
target="_blank">ugc command line</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios"
target="_blank">iOS SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android"
target="_blank">Android SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript"
target="_blank">HTML5/JS SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs"
target="_blank">node.js module</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails"
target="_blank">Ruby on Rails gem</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby"
target="_blank">Ruby gem</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php"
target="_blank">PHP SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java"
target="_blank">Java SDK</a></li>
+                    <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet"
target="_blank">.NET / Windows SDK</a></li>
+                </ul>
+            </div>
+            <div class="col-md-2">
+                <ul class="nav nav-list">
+                    <li class="nav-header">Resources</li>
+                        <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub
Code</a></li>
+                        <li><a href="https://issues.apache.org/jira/browse/USERGRID"
target="_blank">JIRA Bug Tracker</a></li>
+                        <li><a href="http://stackoverflow.com/search?q=usergrid"
target="_blank">StackOverflow</a></li>
+                        <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+                        <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+                        <li><a href="http://incubator.apache.org/projects/usergrid.html"
target="_blank">Podling Listing</a></li>
+                        <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE"
target="_blank">License</a></li>
+                        <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements"
target="_blank">Getting Started</a></li>
+                        <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing"
target="_blank">Contribution Guidelines</a></li>
+                </ul>
+            </div>
+            <div class="col-md-2"></div>
+            <div class="col-md-4">
+                <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"
data-widget-id="401499136807038976"  data-related="usergrid" height="400px" style="overflow:hidden">Tweets
about "usergrid"</a>
+                <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+            </div> 
+        <!--
+            <div class="col-md-4">
+                <div class="input-group form-search">
+                    <input type="text" class="form-control search-query">
+                    <span class="input-group-btn">
+                        <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+                    </span>
+                </div>
+            </div> -->
+        </div> 
+        <div class="row">
+            <div id="copyright">
+                <img src="/img/egg-logo.png" /><br/><br/>
+                <p>Apache Usergrid is an effort undergoing incubation at The Apache
Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of
all newly accepted projects until a further review indicates that the infrastructure, communications,
and decision making process have stabilized in a manner consistent with other successful ASF
projects. While incubation status is not necessarily a reflection of the completeness or stability
of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+                <p>Copyright © 2013 The Apache Software Foundation, Licensed under
the Apache License, Version 2.0.<br>
+                Apache and the Apache feather logos are trademarks of The Apache Software
Foundation.</p>
+                <p class="credits">Site designed & assembled with love by <a
href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a>
+ <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+            </div>
+        </div>
+    </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+    head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-45815079-1', 'apache.org');
+  ga('send', 'pageview');
+
+</script>
+
+
+</body>
+</html>
\ No newline at end of file



Mime
View raw message