usergrid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From snoopd...@apache.org
Subject [10/51] [abbrv] [partial] incubator-usergrid git commit: Switch over to new docs for the website.
Date Wed, 05 Aug 2015 14:58:29 GMT
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/introduction/data-model.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/data-model.html b/content/docs/introduction/data-model.html
new file mode 100644
index 0000000..e8aba1e
--- /dev/null
+++ b/content/docs/introduction/data-model.html
@@ -0,0 +1,449 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>Usergrid Data model &mdash; Apache Usergrid 1.0 documentation</title>
+  
+
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  
+  
+    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  
+
+  
+
+  
+    <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+        <link rel="next" title="Async vs. sync calls" href="async-vs-sync.html"/>
+        <link rel="prev" title="Usergrid Features" href="usergrid-features.html"/> 
+
+  
+  <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-nav-search">
+        
+
+        
+          <a href="../index.html" class="icon icon-home"> Apache Usergrid
+        
+
+        
+        </a>
+
+        
+          
+          
+            <div class="version">
+              1.0
+            </div>
+          
+        
+
+        
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+        
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        
+          
+          
+              <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid Data model</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#organizations">Organizations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#applications">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#entities">Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#default-entities">Default entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#properties">Properties</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#default-properties">Default properties</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
+</ul>
+
+          
+        
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+        <a href="../index.html">Apache Usergrid</a>
+      </nav>
+
+
+      
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="../index.html">Docs</a> &raquo;</li>
+      
+    <li>Usergrid Data model</li>
+      <li class="wy-breadcrumbs-aside">
+        
+          
+            <a href="../_sources/introduction/data-model.txt" rel="nofollow"> View page source</a>
+          
+        
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="usergrid-data-model">
+<h1>Usergrid Data model<a class="headerlink" href="#usergrid-data-model" title="Permalink to this headline">¶</a></h1>
+<p>Usergrid models the data for your apps as application-specific
+collections of data entities managed within an organization. The
+following is an overview of the component hierarchy that makes up the
+data model, and is intended to help you understand how data is stored,
+managed and accessed.</p>
+<div class="section" id="organizations">
+<h2>Organizations<a class="headerlink" href="#organizations" title="Permalink to this headline">¶</a></h2>
+<p>An organization contains one or more applications, and represents
+administrator-level access. Multiple accounts may be given administrator
+access to an organization. Accounts can also be members of multiple
+organizations.</p>
+<p>An organization with the same name as your username is automatically
+created for you when you sign up. By default, you are assigned as the
+administrator of this organization.</p>
+</div>
+<div class="section" id="applications">
+<h2>Applications<a class="headerlink" href="#applications" title="Permalink to this headline">¶</a></h2>
+<p>In Usergrid, you can create one or more applications within an
+organization. Applications represent an instance of application data
+associated with an app, and you may create as many applications as you
+wish. This allows you to utilize the backend in a way that corresponds
+to your development process. For example, you might create separate
+applications for development and production instances of your app. By
+default, all organization have a sandbox application (see Using a
+Sandbox Application for important information regarding the default
+sandbox application).</p>
+<p>Each application provides the infrastructure for storing, retrieving,
+updating and deleting the entities and collections associated with a
+specific app instance.</p>
+</div>
+<div class="section" id="collections">
+<h2>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h2>
+<p>Usergrid stores all data entities in uniquely-named collections.
+Collections are created automatically for every entity type, including
+custom entities, and are named using the plural form of the entity type
+they store. For example, all user entities are stored in the /users
+collection, and all device entities in the /devices collection. An
+entity can belong to only one collection.</p>
+<p>Currently, collections cannot be renamed or deleted; however, all of the
+data entities in a collection can be updated or deleted.</p>
+</div>
+<div class="section" id="entities">
+<h2>Entities<a class="headerlink" href="#entities" title="Permalink to this headline">¶</a></h2>
+<p>An entity represents a basic, JSON-formatted data object that is used by
+your app, such as a user, device, event or asset. Unlike records in
+conventional database tables, which have a rigid schema that defines
+what they can store and how they can be related to each other, Usergrid
+entities are very flexible. This makes Usergrid a powerful solution for
+managing data for modern applications, where people, places, and content
+often need to be associated in a way that is most appropriate from a
+user perspective.</p>
+<p>Here is a simple example of an entity:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;5c0c1789-d503-11e1-b36a-12313b01d5c1&quot;</span><span class="p">,</span>
+  <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
+  <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1343074620374</span><span class="p">,</span>
+  <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1355442681264</span><span class="p">,</span>
+  <span class="s">&quot;username&quot;</span> <span class="p">:</span> <span class="s">&quot;john.doe&quot;</span><span class="p">,</span>
+  <span class="s">&quot;email&quot;</span> <span class="p">:</span> <span class="s">&quot;jdoe57@mail.com&quot;</span><span class="p">,</span>
+  <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;John Doe&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="default-entities">
+<h2>Default entities<a class="headerlink" href="#default-entities" title="Permalink to this headline">¶</a></h2>
+<p>The following entity types are predefined in Usergrid. For more details,
+see Default Data Entity Types.</p>
+<ul class="simple">
+<li>user</li>
+<li>group</li>
+<li>role</li>
+<li>application</li>
+<li>activity</li>
+<li>device</li>
+<li>asset</li>
+<li>folder</li>
+<li>event</li>
+<li>notifier</li>
+<li>notification</li>
+<li>receipt</li>
+</ul>
+</div>
+<div class="section" id="properties">
+<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
+<p>A data entity is a set of properties, which can each contain any
+JSON-representable value, including a nested JSON document. All entities
+have predefined properties, but you are free to define any number of
+custom properties for any entity. Default properties require specific
+data types for validation purposes, while custom properties can be any
+JSON data type. Most predefined and all application-defined entity
+properties are indexed, allowing you to query collections quickly and
+easily.</p>
+<p>Individual or multiple properties can be updated in a single operation;
+however, partial updating of nested JSON documents is not supported.
+This means that all properties of a nested document must be provided in
+a PUT request for the update of the nested document to be processed,
+even if the some of the values have not changed.</p>
+</div>
+<div class="section" id="default-properties">
+<h2>Default properties<a class="headerlink" href="#default-properties" title="Permalink to this headline">¶</a></h2>
+<p>At a minimum, each entity is defined by two properties, both of which
+are strings: type and UUID. The entity &#8216;type&#8217; is the singular form of
+the collection the entity is stored in. For example, an entity in the
+&#8216;users&#8217; collection has an entity type of &#8216;user&#8217;. The entity &#8216;UUID&#8217; is an
+immutable universally unique identifier, which can be used to reference
+the entity. A UUID is automatically generated for every entity when it
+is created. You can also create custom entities and entity properties;
+however, Usergrid reserves certain entity types with pre-defined
+properties by default. For a complete list of reserved entities and
+properties, see Default Data Entity Types.</p>
+<p>When you access the system via the API, you’ll always provide your
+organization UUID or name, application UUID or name, and typically the
+UUID or name of the entity you’re modifying or retrieving.</p>
+<p>All entities have the following default properties:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="12%" />
+<col width="73%" />
+</colgroup>
+<tbody valign="top">
+<tr class="row-odd"><td>Property</td>
+<td>Type</td>
+<td>Description</td>
+</tr>
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Entity unique id</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>entity type (for example, user)</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td>UTC timestamp in milliseconds of when the entity was
+created</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td>UTC timestamp in milliseconds of when the entity was
+last modified</td>
+</tr>
+</tbody>
+</table>
+<p>Custom entities also have an optional name property that is a string
+identifier.</p>
+</div>
+</div>
+
+
+           </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="async-vs-sync.html" class="btn btn-neutral float-right" title="Async vs. sync calls" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="usergrid-features.html" class="btn btn-neutral" title="Usergrid Features" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2013-2015, Apache Usergrid.
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  
+
+    <script type="text/javascript">
+        var DOCUMENTATION_OPTIONS = {
+            URL_ROOT:'../',
+            VERSION:'1.0',
+            COLLAPSE_INDEX:false,
+            FILE_SUFFIX:'.html',
+            HAS_SOURCE:  true
+        };
+    </script>
+      <script type="text/javascript" src="../_static/jquery.js"></script>
+      <script type="text/javascript" src="../_static/underscore.js"></script>
+      <script type="text/javascript" src="../_static/doctools.js"></script>
+
+  
+
+  
+  
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+  
+
+  
+  
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.StickyNav.enable();
+      });
+  </script>
+   
+
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/introduction/usergrid-features.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/usergrid-features.html b/content/docs/introduction/usergrid-features.html
new file mode 100644
index 0000000..496a33d
--- /dev/null
+++ b/content/docs/introduction/usergrid-features.html
@@ -0,0 +1,449 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>Usergrid Features &mdash; Apache Usergrid 1.0 documentation</title>
+  
+
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  
+  
+    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  
+
+  
+
+  
+    <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+        <link rel="next" title="Usergrid Data model" href="data-model.html"/>
+        <link rel="prev" title="Apache Usergrid Documentation" href="../index.html"/> 
+
+  
+  <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-nav-search">
+        
+
+        
+          <a href="../index.html" class="icon icon-home"> Apache Usergrid
+        
+
+        
+        </a>
+
+        
+          
+          
+            <div class="version">
+              1.0
+            </div>
+          
+        
+
+        
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+        
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        
+          
+          
+              <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid Features</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#data-storage-management">Data storage &amp; management</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#application-data">Application data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#files-assets">Files &amp; assets</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#flexible-data-querying">Flexible data querying</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#social">Social</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#entity-relationships">Entity relationships</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#activity-streams">Activity streams</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#user-management">User management</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#registration-and-login">Registration and login</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#roles-permissions">Roles &amp; permissions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#groups">Groups</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#third-party-authentication">Third-party authentication</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#geolocation">Geolocation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#push-notifications">Push notifications</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
+</ul>
+
+          
+        
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+        <a href="../index.html">Apache Usergrid</a>
+      </nav>
+
+
+      
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="../index.html">Docs</a> &raquo;</li>
+      
+    <li>Usergrid Features</li>
+      <li class="wy-breadcrumbs-aside">
+        
+          
+            <a href="../_sources/introduction/usergrid-features.txt" rel="nofollow"> View page source</a>
+          
+        
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="usergrid-features">
+<h1>Usergrid Features<a class="headerlink" href="#usergrid-features" title="Permalink to this headline">¶</a></h1>
+<p>Usergrid provides developers with access to a flexible data store and
+enables you to quickly integrate valuable features into your app,
+including social graphs, user management, data storage, push
+notifications, performance monitoring, and more.</p>
+<p>With Usergrid, developers can set up their own cloud-based data platform
+in minutes instead of months – no server-side coding or back-end
+development needed. This allows your developers to focus on developing
+the rich features and user experience that truly differentiate your app,
+rather than on the time-consuming details of implementing core back-end
+services and infrastructure.</p>
+<div class="section" id="data-storage-management">
+<h2>Data storage &amp; management<a class="headerlink" href="#data-storage-management" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="application-data">
+<h3>Application data<a class="headerlink" href="#application-data" title="Permalink to this headline">¶</a></h3>
+<p>At the core of Usergrid is a flexible platform that can store any type
+of application data, from simple records like a catalog of books to
+complex associations like user relationships. No matter what type of
+data drives your app, you can store it as collections of data entities
+and immediately perform complex queries or full-text searches on any
+field. You can also create custom entities with custom properties,
+giving you the ability to store data and context in a way that makes
+sense for your app.</p>
+<p>To learn more about entities and collections, see Usergrid Data model.</p>
+<p>For a complete list of the default data entities available, see Default
+Data Entity Types.</p>
+</div>
+<div class="section" id="files-assets">
+<h3>Files &amp; assets<a class="headerlink" href="#files-assets" title="Permalink to this headline">¶</a></h3>
+<p>Images, video, and audio are key components of a great app experience.
+With Usergrid, you can upload and retrieve binary objects from the same
+data store as the rest of your application data, eliminating the need to
+set up content delivery networks (CDNs) and easing implementation. We
+handle all the back-end details that keep your content quickly
+accessible.</p>
+<p>To learn more about files and asset storage, see Uploading files and
+assets .</p>
+</div>
+</div>
+<div class="section" id="flexible-data-querying">
+<h2>Flexible data querying<a class="headerlink" href="#flexible-data-querying" title="Permalink to this headline">¶</a></h2>
+<p>One of Usergrid&#8217; most powerful features is the ability to perform
+SQL-style queries and full-text searches on data entities, as well as
+their properties. This lets you quickly retrieve specific data entities
+based on multiple criteria, then utilize that data to power social
+features, target push notifications, perform user analysis, and more.</p>
+<p>Learn more about querying app data, see Data query overview.</p>
+</div>
+<div class="section" id="social">
+<h2>Social<a class="headerlink" href="#social" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="entity-relationships">
+<h3>Entity relationships<a class="headerlink" href="#entity-relationships" title="Permalink to this headline">¶</a></h3>
+<p>You can create relationships between data entities to help build
+features, improve user experience, and contextualize data. For example,
+you might associate a user with their devices to capture valuable
+geolocation data, create relationships between users to build social
+graphs, or implement popular features such as activity streams.</p>
+<p>To learn more about entity relationships, see Entity connections.</p>
+</div>
+<div class="section" id="activity-streams">
+<h3>Activity streams<a class="headerlink" href="#activity-streams" title="Permalink to this headline">¶</a></h3>
+<p>A key aspect of social networking apps is the ability to provide and
+publish data streams of user actions, such as ongoing lists of comments,
+activities, and tweets. Usergrid simplifies management and routing of
+these data streams by providing an activity entity that is specifically
+designed to automatically create a relationship between activities and
+the user who created them.</p>
+<p>To learn more about activities and activity feeds, see Activity feeds.</p>
+</div>
+</div>
+<div class="section" id="user-management">
+<h2>User management<a class="headerlink" href="#user-management" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="registration-and-login">
+<h3>Registration and login<a class="headerlink" href="#registration-and-login" title="Permalink to this headline">¶</a></h3>
+<p>You can easily add and manage users by providing the core services
+necessary to handle secure registration and log in, including OAuth
+2.0-compliant client authentication. In addition, any number of default
+or custom data entities and properties can be associated with a user
+entity to create complete user profiles.</p>
+<p>To learn more about user management, see User.</p>
+<p>To learn more about authentication, see Authenticating users and
+application clients.</p>
+</div>
+<div class="section" id="roles-permissions">
+<h3>Roles &amp; permissions<a class="headerlink" href="#roles-permissions" title="Permalink to this headline">¶</a></h3>
+<p>Applications often require the ability to configure fine-grain control
+of user access to data, features and functionality. Usergrid solves the
+implementation details of user access with roles and permissions. Simply
+create roles that represent user types or access levels, such as
+Administrator, then assign the necessary permissions to that role. With
+a single API call, you can then associate your roles with any user or
+group of users.</p>
+<p>To learn more about user roles and permissions, see Managing access by
+defining permission rules.</p>
+</div>
+<div class="section" id="groups">
+<h3>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h3>
+<p>Groups are a flexible way to organize your users based on any number of
+criteria. For example, you might group users based on interests or
+location to more effectively deliver relevant content, target offers, or
+customize campaigns. You can also take advantage of the groups entity to
+enable group-based social networking activities, such as allowing your
+users to create private information feeds or circles of friends.</p>
+<p>To learn more about groups, see Working with group data.</p>
+</div>
+<div class="section" id="third-party-authentication">
+<h3>Third-party authentication<a class="headerlink" href="#third-party-authentication" title="Permalink to this headline">¶</a></h3>
+<p>In addition to supporting user management and OAuth-based login for your
+app, Usergrid also makes it easy to integrate third-party authentication
+through such popular services as Facebook, Twitter and other
+OAuth-enabled accounts. Providing third-party sign-in can improve user
+experience, while increasing adoption, giving you access to valuable
+information from social networks and services.</p>
+<p>To learn more about using third-party sign-in, see Facebook sign in.</p>
+</div>
+</div>
+<div class="section" id="geolocation">
+<h2>Geolocation<a class="headerlink" href="#geolocation" title="Permalink to this headline">¶</a></h2>
+<p>The device entity allows you to capture geolocation data from your
+users&#8217; GPS-enabled devices to more effectively target campaigns, push
+notifications, offers and more. Geolocation also gives you an important
+data point for contextualizing and analyzing trends and user behavior.</p>
+<p>To learn more about geolocation, see Geolocation.</p>
+</div>
+<div class="section" id="push-notifications">
+<h2>Push notifications<a class="headerlink" href="#push-notifications" title="Permalink to this headline">¶</a></h2>
+<p>Push notifications are the most effective way to engage your users with
+relevant content, and thanks to Usergrid, implementing them can be done
+in minutes. Simply register your app and your user&#8217;s devices with a
+notification provider, such as Apple Push Notification Service or Google
+Cloud Messaging, then use the Usergrid notification entity to send
+millions of push notifications a month at no cost. When used in
+conjunction with queries of user and application data, push
+notifications become a powerful tool for leveraging user data, ensuring
+relevancy and driving engagement.</p>
+<p>To learn more about push notifications, see Push notifications overview.</p>
+</div>
+</div>
+
+
+           </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="data-model.html" class="btn btn-neutral float-right" title="Usergrid Data model" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="../index.html" class="btn btn-neutral" title="Apache Usergrid Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2013-2015, Apache Usergrid.
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  
+
+    <script type="text/javascript">
+        var DOCUMENTATION_OPTIONS = {
+            URL_ROOT:'../',
+            VERSION:'1.0',
+            COLLAPSE_INDEX:false,
+            FILE_SUFFIX:'.html',
+            HAS_SOURCE:  true
+        };
+    </script>
+      <script type="text/javascript" src="../_static/jquery.js"></script>
+      <script type="text/javascript" src="../_static/underscore.js"></script>
+      <script type="text/javascript" src="../_static/doctools.js"></script>
+
+  
+
+  
+  
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+  
+
+  
+  
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.StickyNav.enable();
+      });
+  </script>
+   
+
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/managing-access-defining-permission-rules/index.html
----------------------------------------------------------------------
diff --git a/content/docs/managing-access-defining-permission-rules/index.html b/content/docs/managing-access-defining-permission-rules/index.html
deleted file mode 100644
index 40659ec..0000000
--- a/content/docs/managing-access-defining-permission-rules/index.html
+++ /dev/null
@@ -1,357 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <meta charset="utf-8">
-    <title>Apache Usergrid (incubating) — Managing access by defining permission rules</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>
-        </div>
-        <a href="/" class="navbar-brand">
-                <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
-            </a>
-        <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><a href="http://usergrid.readthedocs.org/" target="_blank"><span class="icns icon-book"></span></a></li>
-                <li><a href="http://github.com/apache/incubator-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/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" 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="/community/#live"><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>
-                <li><a href="https://cwiki.apache.org/confluence/display/usergrid/" target="_blank"><span class="icns icon-wiki"></span></a></li>
-                <li><a href="/releases/"><span class="icns icon-releases"></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 &amp; Running Locally</a></li>
-                    <li><a href="/docs/deploy-local/">Deploying to local Tomcat &amp; Cassandra</a></li>
-                    <li><a href="https://github.com/apache/incubator-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-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/apache/incubator-usergrid/tree/master/sdks/ios">iOS SDK</a></li>
-                    <li><a class="icns-android" href="https://github.com/apache/incubator-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/apache/incubator-usergrid/tree/master/sdks/dotnet">Windows 8 / Windows Phone / .net SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs">Node.js module</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby">Ruby gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails">Ruby on Rails gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php">PHP library</a></li>
-                    <li><a href="https://github.com/apache/incubator-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 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> -->
-
-                    <li class="nav-header"><span>Presentations & Videos</span></li>
-                    <li><a href="/docs/presentations/">Presentations</a></li>
-                    <li><a href="/docs/videos/">Videos</a></li>
-
-                    <li class="nav-header"><span>We need your help!</span></li>
-                    <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li>
-                    <!--
-                    <li><a href="/docs/contribute-docs">How to contribute docs</a></li>
-                    -->
-                </ul>
-            </div>
-        </div>
-
-        <div class="col-md-9 main-article" role="main">
-            <div class="page-article">
-                <div class="page-header">
-                    <h1>Managing access by defining permission rules</h1>
-                    <!-- TODO: reenable this when we sync SVN to GitHub
-                  <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/managing-access-defining-permission-rules.md">contribute to this article on github</a></small>
-                    -->
-                </div>
-                <div class="toc">
-	<ul>
-<li>
-<a href="#managing-access-by-defining-permission-rules">Managing access by defining permission rules</a><ul>
-<li><a href="#roles-included-by-default">Roles included by default</a></li>
-<li><a href="#defining-your-own-roles-andpermissions">Defining your own roles and permissions</a></li>
-<li><a href="#permission-rule-examples">Permission rule examples</a></li>
-</ul>
-</li>
-</ul>
-</div>
-<h1 id="managing-access-by-defining-permission-rules">Managing access by defining permission rules</h1>
-<p>You control your app users’ access to application resources by defining roles and permission rules. In your Apache Usergrid application, you assign application users a <em>role</em> that represents a set of permissions. Through these permissions, you allow users to perform certain operations (GET, POST, PUT, or DELETE) on specific resources. When the user submits a request via your app code to the Apache Usergrid API, the user’s permissions are checked against the resource paths that the user is trying to access. The request succeeds only if access to the resource is allowed by the permission rules you specify.</p>
-<p>You specify roles for unauthenticated users and those who authenticate as an Application User, as defined in <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a>. Roles are not applied for the other authentication levels: Application, Admin User, and Organization. Access at these levels can’t be restricted by roles and permission rules. You should allow clients to authenticate at these levels sparingly and carefully.</p>
-<h2 id="roles-included-by-default">Roles included by default</h2>
-<p>When defining user access to your application’s data, you create roles, specify permission rules for them, then associate users with the roles. Apache Usergrid includes three predefined roles when you create an application.</p>
-<p>The following table lists the three roles included by default. Note that two of these are in effect and applied from the time your application is created (until you change them). Apache Usergrid applies the following default behavior:</p>
-<ol style="list-style-type: decimal">
-<li>An unauthenticated user is automatically added to the Guest role so that they can register for a user account.</li>
-<li>A user who has a user account and authenticates with it is automatically added to the Default role. <strong>Note that by default, this role is very permissive.</strong> Be sure to restrict it with specific permission rules before deploying to production.</li>
-</ol>
-<table>
-<col width="33%">
-<col width="33%">
-<col width="33%">
-<thead>
-<tr class="header">
-<th align="left">Role</th>
-<th align="left">Description</th>
-<th align="left">Notes</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>Guest</p></td>
-<td align="left"><p>Default for unauthenticated users. Includes a basic set of permissions for unregistered or unauthenticated users. Users are automatically added to the Guest role before they’re authenticated. After they’re authenticated, users are automatically added to the Default role.</p></td>
-<td align="left"><p>Grants permission for a user to create a user account and for their device to be registered. You can change permission rules based on your goals for unregistered user access. This role is designed to provide access for people who haven’t yet registered, and allow them to register.</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>Default</p></td>
-<td align="left"><p>Default for authenticated users. Includes permissions for the set of operations you want an authenticated user to be able to perform. Users are added to this role after they’re authenticated.</p></td>
-<td align="left"><p>By default, <strong>grants full access for all resources in your application</strong>. A first task in securing your application should be to restrict access by redefining this role to narrow the access it provides. Remove the default full permission rule and add restrictive permission rules for a production deployment.</p></td>
-</tr>
-<tr class="odd">
-<td align="left"><p>Administrator</p></td>
-<td align="left"><p>Unused until you associate it with users or groups. By default, includes no permissions that provide access.</p></td>
-<td align="left">
-<p>Grants no access. Consider this a blank slate. Add permission rules and associate this role with users and groups as needed.</p>
-<p><strong>Note</strong>: The Administrator role is <em>not the same</em> as an organization administrator – that is, someone who authenticates as an Admin User. The Admin User is an implicit user created when you create an organization. After authenticating, the Admin User has full access to all of the administration features of the Apache Usergrid API. By comparison, the Administrator role is simply a role (initially without permissions) that can be assigned to any user.</p>
-</td>
-</tr>
-</tbody>
-</table>
-<h2 id="defining-your-own-roles-andpermissions">Defining your own roles and permissions</h2>
-<p>When preparing an application for production use, a good first step is to edit permission rules for the Default role. This role will be applied for every user who authenticates as an Application User.</p>
-<p>The admin portal is the best place to manage roles. While you can manage roles and permissions programmatically (see <a href="/role">Role</a>), security-related calls from a mobile app will pose a security risk. Consider doing so only from a server-side web application.</p>
-<p>For easy-to-read examples, this section expresses permission rules in this way:</p>
-<pre><code>&lt;operations&gt;:&lt;entity path pattern&gt;</code></pre>
-<ul>
-<li>&lt;operations&gt; is a comma-delimited set of REST operations (GET, PUT, POST, DELETE) that are allowed for the specified entity path.</li>
-<li>&lt;entity path pattern&gt; is a parameter evaluated using Apache Ant pattern matching (see <a href="http://ant.apache.org/manual/dirtasks.html#patterns">http://ant.apache.org/manual/dirtasks.html#patterns</a>).</li>
-</ul>
-<p>For example, in the Default role, first remove the permission rule that grants full access to all authenticated users. You could then begin by creating a rule that grants access for the authenticated user to makes changes only to data associated with their account. </p>
-<pre><code>GET,PUT,POST,DELETE:/users/me/**</code></pre>
-<p>Use the Admin Portal to make role and permission rule changes. On the left sidebar of the portal, click Users, then click Roles. This displays the roles defined for the application. To create a role, click the Add button (it looks like a person’s silhouette). To delete a role, select the role you want to delete and click the Remove button (it looks like a trash can). To view the privileges in a role, click the role.</p>
-<p>Suppose you created a role named “customer”. Here’s what the privileges for the role might look like:</p>
-<div class="figure">
-<img src="/docs/sites/docs/files/worker_permissions.png">
-</div>
-<p>Notice that specific privileges for operations are represented using checkboxes in the Permission Rules section. The path indicates the resource path for which the permissions apply. The permissions apply to all resources in the specified path directory and its subdirectories. As currently specified, the worker role has GET permission on the base directory path (/) and all resource paths below it (in other words, all resource paths).</p>
-<p>You can add a permission, by entering the entity path pattern in the Path field of the Add Permission Rule section, and checking the operation checkboxes (get, post, put, and delete) as appropriate. For example, the following adds permission to create a user:</p>
-<div class="figure">
-<img src="/docs/sites/docs/files/add_permission.png">
-</div>
-<p>Click Add, and the permission is added to the role.</p>
-<div class="figure">
-<img src="/docs/sites/docs/files/pemission_list.png">
-</div>
-<h2 id="permission-rule-examples">Permission rule examples</h2>
-<p>Here are some examples to illustrate how permissions are specified:</p>
-<ul>
-<li><p>Authenticated user can change any data related to the:<br> POST:/users/*</p></li>
-<li><p>A permission the permits the current user to make any changes to resources associated with them:<br> GET,PUT,POST,DELETE:/users/me/**</p></li>
-<li><p>A permission that allows someone to look at a specific user:<br> GET:/users/john.doe</p></li>
-<li>
-<p>A permission that allows the current user to see his activity feed:<br> GET:/users/${user}/feed/*</p>
-<p>The ${user} in the entity path refers to a variable that represents the current user’s UUID.</p>
-</li>
-<li>
-<p>A permission allowing linked entities to be read:<br> GET:/users/${user}/**</p>
-<p>The /** in the entity path is a wildcard that matches everything under that path. This means that the full specification matches multiple resource paths, including, but not limited to, the following:</p>
-<pre><code>/users/${user}/feed
-/users/${user}/feed/item1/a/b/c</code></pre>
-</li>
-<li><p>A permission that allows the current user to add himself or another user to a group:<br> POST:/groups/${user}/users/**</p></li>
-</ul>
-            </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/managing-access-defining-permission-rules.md">this article on github</a>.</div> 
-                -->
-            </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>
-                </ul>
-            </div>
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/" target="_blank">Code</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-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/apache/incubator-usergrid" target="_blank">GitHub Code</a></li>
-                    <li><a href="http://usergrid.readthedocs.org/" target="_blank">Docs</a></li>
-                    <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" target="_blank">JIRA Bug Tracker</a></li>
-                    <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
-                    <li><a href="/community/#live">Live Chat</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/apache/incubator-usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
-                    <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow" target="_blank">Contribution Guidelines</a></li>
-                </ul>
-            </div>
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header">Apache</li>
-                    <li><a href="http://www.apache.org/licenses/" target="_blank">License</a></li>
-                    <li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a></li>
-                    <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
-                    <li><a href="http://www.apache.org/security/">Security</a></li>
-                    <li><a href="http://www.apache.org/" target="_blank">Apache Foundation</a></li>
-                </ul>
-            </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>


Mime
View raw message