You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/05 16:55:58 UTC
[12/51] [abbrv] [partial] incubator-usergrid git commit: Switch over
to new docs for the website.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/index.html
----------------------------------------------------------------------
diff --git a/content/docs/index.html b/content/docs/index.html
index 0783526..81812d4 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -1,275 +1,732 @@
-<!DOCTYPE html>
-<html lang="en">
+
+<!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">
- <title>Apache Usergrid (incubating) — Overview</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'>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Apache Usergrid Documentation — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
- <!-- 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]-->
+
+
+
+
+ <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="#"/>
+ <link rel="next" title="Usergrid Features" href="introduction/usergrid-features.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
</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 & Running Locally</a></li>
- <li><a href="/docs/deploy-local/">Deploying to local Tomcat & 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>
+
+<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="#" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
</div>
- </div>
+
+
- <div class="col-md-9 main-article" role="main">
- <div class="page-article">
- <div class="page-header">
- <h1>Overview</h1>
- <!-- TODO: reenable this when we sync SVN to GitHub
- <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs.md">contribute to this article on github</a></small>
- -->
- </div>
- <div class="toc">
-
+
+<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>
-<p>
-Usergrid is an open-source Backend-as-a-Service (“BaaS” or “mBaaS”) composed of an integrated distributed NoSQL database, application layer and client tier with SDKs for developers looking to rapidly build web and/or mobile applications. It provides elementary services (user registration & management, data storage, file storage, queues) and retrieval features (full text search, geolocation search, joins) to power common app features.
-</p>
-<p>
-It is a multi-tenant system designed for deployment to public cloud environments (such as Amazon Web Services, Rackspace, etc.) or to run on traditional server infrastructures so that anyone can run their own private BaaS deployment.
-</p>
+
+ </div>
-<p>
-For architects and back-end teams, it aims to provide a distributed, easily extendable, operationally predictable and highly scalable solution. For front-end developers, it aims to simplify the development process by enabling them to rapidly build and operate mobile and web applications without requiring backend expertise.
-</p>
- </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.md">this article on github</a>.</div>
- -->
- </div>
- </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>
+<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/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 & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators & 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 & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & 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 & 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 & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management & 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 & 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 & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating & 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 & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & 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 & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </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="#">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="#">Docs</a> »</li>
+
+ <li>Apache Usergrid Documentation</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="_sources/index.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="apache-usergrid-documentation">
+<h1>Apache Usergrid Documentation<a class="headerlink" href="#apache-usergrid-documentation" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound" id="introduction">
+<p class="caption"><span class="caption-text">Introduction</span><a class="headerlink" href="#introduction" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#data-storage-management">Data storage & management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#flexible-data-querying">Flexible data querying</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#social">Social</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#user-management">User management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#geolocation">Geolocation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#push-notifications">Push notifications</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#organizations">Organizations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#applications">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#entities">Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#default-entities">Default entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#properties">Properties</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#default-properties">Default properties</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/async-vs-sync.html#synchronous">Synchronous</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/async-vs-sync.html#asynchronous">Asynchronous</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id1">
+<span id="getting-started"></span><p class="caption"><span class="caption-text">Getting Started</span><a class="headerlink" href="#id1" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#creating-an-application">Creating an application</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#securing-an-application">Securing an application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-account.html#next-steps">Next steps</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#what-is-the-sandbox-application">What is the sandbox application?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#is-the-sandbox-secure">Is the sandbox secure?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#creating-a-new-sandbox-application">Creating a New Sandbox Application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#supported-http-methods">Supported HTTP methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#base-url">Base URL</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#request-construction">Request construction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#accessing-collections">Accessing collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#accessing-entities">Accessing entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#issuing-queries">Issuing queries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#authentication-oauth">Authentication (OAuth)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#response-format">Response format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#sdks">SDKs</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id2">
+<span id="data-storage"></span><p class="caption"><span class="caption-text">Data Storage</span><a class="headerlink" href="#id2" title="Permalink to this toctree">¶</a></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><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/optimizing-access.html#put-your-data-in-as-you-ll-want-to-get-it-out">Put your data in as you’ll want to get it out</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/optimizing-access.html#best-practice-denormalize-for-pre-computed-query-results">Best practice: Denormalize for pre-computed query results</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/collections.html">Collections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#creating-collections">Creating Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#retrieving-collections">Retrieving Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#updating-collections">Updating Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#deleting-collections">Deleting Collections</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/entities.html">Entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#creating-custom-data-entities">Creating Custom Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#creating-multiple-custom-entities">Creating multiple custom entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#retrieving-data-entities">Retrieving Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#updating-data-entities">Updating Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#deleting-data-entities">Deleting Data Entities</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id3">
+<span id="data-queries"></span><p class="caption"><span class="caption-text">Data Queries</span><a class="headerlink" href="#id3" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/querying-your-data.html">Querying your data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/querying-your-data.html#basic-query-usage">Basic query usage</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/query-parameters.html">Query parameters & clauses</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#contains">Contains</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#location">Location</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#order-by">Order by</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#limit">Limit</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#cursor">Cursor</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators & data types</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/operators-and-types.html#operators">Operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/operators-and-types.html#data-types">Data types</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/advanced-query-usage.html">Advanced query usage</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/advanced-query-usage.html#attaching-a-query-to-all-api-calls">Attaching a query to all API calls</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id4">
+<span id="entity-connections"></span><p class="caption"><span class="caption-text">Entity Connections</span><a class="headerlink" href="#id4" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/connecting-entities.html">Connecting entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/connecting-entities.html#request-syntax">Request syntax</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/retrieving-entities.html">Retrieving connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connected-entities">Retrieve all connected entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connecting-entities-by-type">Retrieve all connecting entities by type</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connecting-entities">Retrieve all connecting entities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/disconnecting-entities.html">Disconnecting entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/disconnecting-entities.html#request-syntax">Request syntax</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="security-authentication">
+<span id="security-and-authentication"></span><p class="caption"><span class="caption-text">Security & Authentication</span><a class="headerlink" href="#security-authentication" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#permissions-syntax">Permissions syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#complex-paths">Complex paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#assigning-permissions">Assigning permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#removing-permissions">Removing permissions</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#authentication-levels">Authentication levels</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#application-user-authentication-user-login">Application user authentication (user login)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#application-client-authentication">Application client authentication</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#admin-user-authentication">Admin user authentication</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#organization-client-authentication">Organization client authentication</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#configuring-authentication-levels">Configuring authentication levels</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#user-authentication-level">User authentication level</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#admin-authentication-levels">Admin authentication levels</a></li>
+</ul>
+</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><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#default-ttl">Default ttl</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#changing-the-default-ttl">Changing the default ttl</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#changing-ttl-when-a-token-is-created">Changing ttl when a token is created</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html">Authenticating API requests</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html#authenticating-with-access-tokens">Authenticating with access tokens</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html#authenticating-with-client-id-and-client-secret">Authenticating with client ID and client secret</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html#revoking-tokens-user-logout">Revoking tokens (user logout)</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/facebook-sign.html">Facebook sign in</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/facebook-sign.html#facebook-login-example">Facebook login example</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/securing-your-app.html">Security best practices</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#never-use-the-sandbox-for-a-production-app">Never use the ‘sandbox’ for a production app</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#review-permissions-in-your-apps">Review permissions in your apps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#edit-the-default-role">Edit the ‘default’ role</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#use-https">Use https</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#acquire-access-tokens-in-a-secure-way">Acquire access tokens in a secure way</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#treat-mobile-clients-as-untrustworthy">Treat mobile clients as untrustworthy</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="user-management-social-graph">
+<span id="user-management-and-social-graph"></span><p class="caption"><span class="caption-text">User Management & Social Graph</span><a class="headerlink" href="#user-management-social-graph" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management & social graph</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#user-management">User management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#group-management">Group management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#social-connections">Social connections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#activity-feeds">Activity feeds</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/working-user-data.html">Working with User Data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#creating-users">Creating users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#retrieving-user-data">Retrieving user data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#updating-deleting-user-data">Updating & deleting user data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#changing-a-user-password">Changing a user password</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#resetting-a-user-password">Resetting a user password</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/group.html">Working with group data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#creating-groups">Creating groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#retrieving-groups">Retrieving groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#parameter-description">Parameter Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#retrieving-a-group-s-users">Retrieving a group’s users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#deleting-a-group">Deleting a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#adding-a-user-to-a-group">Adding a user to a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#removing-a-user-from-a-group">Removing a user from a group</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/activity.html">Activity</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#posting-activities">Posting activities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#posting-an-activity-to-a-group">Posting an activity to a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#creating-an-activity-for-a-user-s-followers-in-a-group">Creating an activity for a user’s followers in a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#retrieving-activity-feeds">Retrieving activity feeds</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#retrieving-a-group-s-activity-feed">Retrieving a group’s activity feed</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html">Social Graph Connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-connections.html#following-followers">Following/followers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-connections.html#creating-a-following-followers-connection">Creating a following/followers connection</a></li>
+</ul>
+</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><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#creating-a-user-account-in-usergrid">Creating a user account in Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#creating-an-app-and-users">Creating an app and users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#ios-client">iOS client</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#ios-sdk">iOS SDK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#android-client-and-sdk">Android client and SDK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#javascript-html5-client-and-sdk">Javascript/HTML5 client and SDK</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="geo-location">
+<span id="geolocation"></span><p class="caption"><span class="caption-text">Geo-location</span><a class="headerlink" href="#geo-location" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="geolocation/geolocation.html">Geolocating your Entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#saving-location-data-in-an-entity">Saving location data in an entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#querying-location-data">Querying location data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#enrich-your-app-with-location-data">Enrich your app with location data</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="assets-files">
+<span id="asset-and-file-management"></span><p class="caption"><span class="caption-text">Assets & Files</span><a class="headerlink" href="#assets-files" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#id1">Uploading assets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#updating-assets">Updating assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-asset-data">Retrieving asset data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-an-asset-entity">Retrieving an asset entity</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="counters-events">
+<span id="counters-and-events"></span><p class="caption"><span class="caption-text">Counters & Events</span><a class="headerlink" href="#counters-events" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#example-request">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#example-response">Example response</a></li>
+</ul>
+</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><ul>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#example-request">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#example-response">Example response</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#retrieving-counters-by-time-interval">Retrieving counters by time interval</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id1">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id2">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id3">Example response</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="organizations-applications">
+<p class="caption"><span class="caption-text">Organizations & Applications</span><a class="headerlink" href="#organizations-applications" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#creating-an-organization">Creating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-an-organization">Getting an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#activating-an-organization">Activating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#reactivating-an-organization">Reactivating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#generating-organization-client-credentials">Generating organization client credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#retrieving-organization-client-credentials">Retrieving organization client credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-an-organization-s-activity-feed">Getting an organization’s activity feed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-the-applications-in-an-organization">Getting the applications in an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#adding-an-admin-user-to-an-organization">Adding an admin user to an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-the-admin-users-in-an-organization">Getting the admin users in an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#removing-an-admin-user-from-an-organization">Removing an admin user from an organization</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#creating-an-application">Creating an application</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#generating-application-credentials">Generating application credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#getting-application-credentials">Getting application credentials</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="api-reference">
+<span id="rest-endpoints"></span><p class="caption"><span class="caption-text">API Reference</span><a class="headerlink" href="#api-reference" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action-methods">Action Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed-methods">ActivityFeed Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#appdata-methods">AppData Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#credential-methods">Credential Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#devices-methods">Devices Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entity-methods">Entity Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event-methods">Event Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group-methods">Group Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification-methods">Notification Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organization-methods">Organization Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permission-methods">Permission Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#receipt-methods">Receipt Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#role-methods">Role Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#user-methods">User Methods</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action">Action</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed">ActivityFeed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#actor">Actor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#addpermission">AddPermission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#addrole">AddRole</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#adminuserupdate">AdminUserUpdate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#appdata">AppData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#cancelmsg">CancelMSG</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createactivity">CreateActivity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createadminuser">CreateAdminUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createapp">CreateApp</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createentities">CreateEntities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createentity">CreateEntity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createevent">CreateEvent</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#creategroup">CreateGroup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createnotification">CreateNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createnotifications">CreateNotifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createorg">CreateOrg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createuser">CreateUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#credential">Credential</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#device">Device</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entity">Entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#error">Error</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event">Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group">Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#imagemodel">ImageModel</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#metadata">Metadata</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification">Notification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notifier">Notifier</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#object">Object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organization">Organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permission">Permission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#receipt">Receipt</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#resetpw">ResetPW</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#resetpwmsg">ResetPWMsg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#role">Role</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#schedulenotification">ScheduleNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#setexpiration">SetExpiration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#sets">Sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#user">User</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="client-sdks">
+<span id="sdks"></span><p class="caption"><span class="caption-text">Client SDKs</span><a class="headerlink" href="#client-sdks" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="installing-the-stack">
+<span id="installation"></span><p class="caption"><span class="caption-text">Installing the Stack</span><a class="headerlink" href="#installing-the-stack" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#build-the-usergrid-console">Build the Usergrid Console</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#example-usergrid-custom-properties-file">Example <strong>usergrid-custom.properties</strong> file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#example-usergrid-deployment-properties-file">Example <strong>usergrid-deployment.properties</strong> file</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="more-about-usergrid">
+<span id="about"></span><p class="caption"><span class="caption-text">More about Usergrid</span><a class="headerlink" href="#more-about-usergrid" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="reference/presos-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#building-mobile-apps-with-apache-usergrid">Building Mobile Apps with Apache Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#how-to-contribute-to-apache-usergrid">How to Contribute to Apache Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#apache-usergrid-internals">Apache Usergrid Internals</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#open-source-mobile-backend-on-cassandra">Open Source Mobile Backend on Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#usergrid-overview">Usergrid Overview</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+</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>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="introduction/usergrid-features.html" class="btn btn-neutral float-right" title="Usergrid Features" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
</div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © 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>
-<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');
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
- ga('create', 'UA-45815079-1', 'apache.org');
- ga('send', 'pageview');
+ <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>
+
+
+
+ <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
</body>
-</html>
+</html>
\ No newline at end of file