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/12 19:14:00 UTC
[05/60] [abbrv] incubator-usergrid git commit: cherry picking docs
from master
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/user-management/group.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/group.html b/content/docs/user-management/group.html
new file mode 100644
index 0000000..0f2a33d
--- /dev/null
+++ b/content/docs/user-management/group.html
@@ -0,0 +1,824 @@
+
+
+<!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>Working with group data — 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="Activity" href="activity.html"/>
+ <link rel="prev" title="Working with User Data" href="working-user-data.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>
+<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 class="current">
+<li class="toctree-l1"><a class="reference internal" href="user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Working with group data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#creating-groups">Creating groups</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#request-syntax">Request Syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#request-uri">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#request">Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#response">Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#retrieving-groups">Retrieving groups</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id1">Request Syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id2">Request URI</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#parameter-description">Parameter Description</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id3">Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id4">Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#retrieving-a-group-s-users">Retrieving a group’s users</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id5">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-request">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-response">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#deleting-a-group">Deleting a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#adding-a-user-to-a-group">Adding a user to a group</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id6">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id7">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id8">Example</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id9">Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id10">Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#removing-a-user-from-a-group">Removing a user from a group</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id11">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id12">Example request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id13">Example response</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="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="../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> »</li>
+
+ <li>Working with group data</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/user-management/group.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="working-with-group-data">
+<h1>Working with group data<a class="headerlink" href="#working-with-group-data" title="Permalink to this headline">¶</a></h1>
+<p>You can organize app users into groups. Groups have their own Activity
+Feed, their own permissions and be a useful alternative to Roles,
+depending on how you model your data. Groups were originally designed to
+emulate Facebook Groups, so they will tend to function about the same
+way Facebook Groups would.</p>
+<p>Groups are hierarchical. Every member of the group
+<code class="docutils literal"><span class="pre">/groups/california/san-francisco</span></code> is also a member of the group
+<code class="docutils literal"><span class="pre">/groups/california</span></code>.</p>
+<p>Groups are also a great way to model things such a topic subscriptions.
+For example, you could allow people to subscribe (i.e. become a member
+of the group and be alerted via Activities) to
+<code class="docutils literal"><span class="pre">/groups/memes/dogs/doge</span></code> or subscribe to all <code class="docutils literal"><span class="pre">/groups/memes/dogs</span></code>.</p>
+<p>See the <a class="reference external" href="../rest-endpoints/api-docs.html#group">Group Model section of the API
+Reference</a> for a list of the
+system-defined properties for group entities. In addition, you can
+create group properties specific to your application.</p>
+<div class="section" id="creating-groups">
+<h2>Creating groups<a class="headerlink" href="#creating-groups" title="Permalink to this headline">¶</a></h2>
+<p>A group entity represents an application group of users. You can create,
+retrieve, update, delete, and query group entities. See User entity
+properties for a list of the system-defined properties for group
+entities. In addition, you can create group properties specific to your
+application.</p>
+<div class="section" id="request-syntax">
+<h3>Request Syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/your-org/your-app/groups" '{ request body }'
+</pre></div>
+</div>
+<p>Use the POST method to create a new group. Groups use paths to indicate
+their unique names. This allows you to create group hierarchies by using
+slashes. For this reason, you need to specify a path property for a new
+group.</p>
+</div>
+<div class="section" id="request-uri">
+<h3>Request URI<a class="headerlink" href="#request-uri" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">POST</span> <span class="o">/</span><span class="p">{</span><span class="n">org_id</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app_id</span><span class="p">}</span><span class="o">/</span><span class="n">groups</span>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid | org_id</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>uuid | app_id</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>request body</td>
+<td>One or more sets of group properties of which path is mandatory.</td>
+</tr>
+</tbody>
+</table>
+<p>The <code class="docutils literal"><span class="pre">path</span></code> property is required and must be unique, it may include
+forward slashes to denote hierarchical relationships.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"somegroup/somesubgroup"</span><span class="p">,</span>
+ <span class="s">"title"</span> <span class="p">:</span> <span class="s">"Some SubGroup"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="example">
+<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
+<p><strong>Note</strong>: Although not shown in the API examples below, you need to
+provide a valid access token with each API call. See Authenticating
+users and application clients for details.</p>
+</div>
+<div class="section" id="request">
+<h3>Request<a class="headerlink" href="#request" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/my-org/my-app/groups" -d '{"path":"mynewgroup"}'
+</pre></div>
+</div>
+</div>
+<div class="section" id="response">
+<h3>Response<a class="headerlink" href="#response" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span><span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span><span class="p">:</span> <span class="s">"7fb8d891-477d-11e1-b2bd-22000a1c4e22"</span><span class="p">,</span>
+ <span class="s">"params"</span><span class="p">:</span> <span class="p">{},</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/groups"</span><span class="p">,</span>
+ <span class="s">"uri"</span><span class="p">:</span> <span class="s">"https://api.usergrid.com/22000a1c4e22-7fb8d891-477d-11e1-b2bd/7fb8d891-477d-11e1-b2bd-22000a1c4e22/groups"</span><span class="p">,</span>
+ <span class="s">"entities"</span><span class="p">:</span> <span class="p">[{</span>
+ <span class="s">"uuid"</span><span class="p">:</span> <span class="s">"a668717b-67cb-11e1-8223-12313d14bde7"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"group"</span><span class="p">,</span>
+ <span class="s">"created"</span><span class="p">:</span> <span class="mi">1331066016571</span><span class="p">,</span>
+ <span class="s">"modified"</span><span class="p">:</span> <span class="mi">1331066016571</span><span class="p">,</span>
+ <span class="s">"metadata"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7"</span><span class="p">,</span>
+ <span class="s">"sets"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/rolenames"</span><span class="p">,</span>
+ <span class="s">"permissions"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/activities"</span><span class="p">,</span>
+ <span class="s">"feed"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/feed"</span><span class="p">,</span>
+ <span class="s">"roles"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/roles"</span><span class="p">,</span>
+ <span class="s">"users"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"mynewgroup"</span>
+ <span class="p">}],</span>
+ <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1331066016563</span><span class="p">,</span>
+ <span class="s">"duration"</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"my-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span><span class="p">:</span> <span class="s">"my-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="retrieving-groups">
+<h2>Retrieving groups<a class="headerlink" href="#retrieving-groups" title="Permalink to this headline">¶</a></h2>
+<p>Retrieving group data</p>
+<p>You can retrieve data about groups through cURL or one of the SDKs. Each
+provides a way to filter the list of groups by data associated with the
+group, such as title or path, or other properties in the group entity.</p>
+<p>See the <a class="reference external" href="../rest-endpoints/api-docs.html#group">Group Model section of the API
+Reference</a> for a list of the
+system-defined properties for group entities. In addition, you can
+create group properties specific to your application.</p>
+<div class="section" id="id1">
+<h3>Request Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/my-org/my-app/groups/mynewgroup"
+</pre></div>
+</div>
+<p>Use the GET method to retrieve group data.</p>
+</div>
+<div class="section" id="id2">
+<h3>Request URI<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>GET /<org_id | uuid>/<app_id | uuid>/groups</groupPath | uuid> | <?ql=query_string>
+</pre></div>
+</div>
+<p>Parameters</p>
+</div>
+</div>
+<div class="section" id="parameter-description">
+<h2>Parameter Description<a class="headerlink" href="#parameter-description" title="Permalink to this headline">¶</a></h2>
+<p>org_id | uuid Organization UUID or organization name app_id | uuid
+Application UUID or application name groupPath | uuid Group UUID or
+group path, which must be unique. query_string A data store query. For
+more on queries, see Data queries.</p>
+<div class="section" id="id3">
+<h3>Request<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre># Get a group by the group path, "employees/managers".
+curl -X GET "https://api.usergrid.com/my-org/my-app/groups/employees/managers"
+
+# Get a group by UUID.
+curl -X GET "https://api.usergrid.com/my-org/my-app/groups/a407b1e7-58e8-11e1-ac46-22000a1c5a67e"
+
+# Get group data filtering by their title.
+curl -X GET "https://api.usergrid.com/my-org/my-app/groups?ql=select%20*%20where%20title%3D'Management%20Employees'"
+</pre></div>
+</div>
+</div>
+<div class="section" id="id4">
+<h3>Response<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
+<p>The following is an example of JSON returned by a query for a single
+group.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"db1e60a0-417f-11e3-9586-0f1ff3650d20"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/steventraut/mynewapp/groups"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5005a0fa-6916-11e3-9c1b-b77ec8addc0d"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"group"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1387503030399</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1387503030399</span><span class="p">,</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"managers"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/roles"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/activities"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/feed"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/roles"</span><span class="p">,</span>
+ <span class="s">"users"</span> <span class="p">:</span> <span class="s">"/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/users"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s">"title"</span> <span class="p">:</span> <span class="s">"Management Employees"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1391020491701</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">15</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"my-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"my-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="retrieving-a-group-s-users">
+<h2>Retrieving a group’s users<a class="headerlink" href="#retrieving-a-group-s-users" title="Permalink to this headline">¶</a></h2>
+<p>Use the GET method to retrieve all the users in a group.</p>
+<div class="section" id="id5">
+<h3>Request URI<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="p">{</span><span class="n">org_id</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app_id</span><span class="p">}</span><span class="o">/</span><span class="n">groups</span><span class="o">/</span><span class="p">{</span><span class="n">uuid</span><span class="o">|</span><span class="n">groupname</span><span class="p">}</span><span class="o">/</span><span class="n">users</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="parameters">
+<h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="42%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>arg uuid|string org_id</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>arg uuid|string app_id</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>arg uuid|string groupname</td>
+<td>UUID or name of the group</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="example-request">
+<h3>Example - Request<a class="headerlink" href="#example-request" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/my-org/my-app/groups/mygroup/users"
+</pre></div>
+</div>
+</div>
+<div class="section" id="example-response">
+<h3>Example - Response<a class="headerlink" href="#example-response" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"e7127751-6985-11e2-8078-02e81aeb2129"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/myorg/sandbox/groups/d20976ff-802f-11e2-b690-02e81ae61238/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"cd789b00-698b-11e2-a6e3-02e81ae236e9"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"barney"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1359405994314</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1361894320470</span><span class="p">,</span>
+ <span class="s">"activated"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"email"</span> <span class="p">:</span> <span class="s">"barney@apigee.com"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/rolenames"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/followers"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"barney"</span><span class="p">,</span>
+ <span class="s">"picture"</span> <span class="p">:</span> <span class="s">"http://www.gravatar.com/avatar/00767101f6b4f2cf5d02ed510dbcf0b4"</span><span class="p">,</span>
+ <span class="s">"test"</span> <span class="p">:</span> <span class="s">"fred"</span><span class="p">,</span>
+ <span class="s">"username"</span> <span class="p">:</span> <span class="s">"barney"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1361903248398</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"myorg"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"sandbox"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="deleting-a-group">
+<h2>Deleting a group<a class="headerlink" href="#deleting-a-group" title="Permalink to this headline">¶</a></h2>
+<p>To delete a group, delete the associated group entity as you would any
+other entity. Note that this will only delete the group. Any entities in
+the group will be preserved.</p>
+<p>For more information and code samples, see <a class="reference external" href="../data-storage/entities.html#deleting-data-entities">Deleting Data
+Entities</a>.</p>
+</div>
+<div class="section" id="adding-a-user-to-a-group">
+<h2>Adding a user to a group<a class="headerlink" href="#adding-a-user-to-a-group" title="Permalink to this headline">¶</a></h2>
+<p>See all application entities</p>
+<p>You can add users to groups from client code using cURL commands or one
+of the SDKs, as described here.</p>
+<p>When setting up your application on the server, you might find it easier
+and more convenient to create and populate groups with the admin portal.
+There, you can create groups, create roles, and define permission rules
+that govern user access to data and services in your application. For
+more information, see Security & token authentication.</p>
+<p>Use the POST method to add a user to a group. If the named group does
+not yet exist, an error message is returned.</p>
+<div class="section" id="id6">
+<h3>Request syntax<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST https://api.usergrid.com/<org_id>/<app_id>/groups/<uuid | groupname>/users/<uuid | username>
+</pre></div>
+</div>
+</div>
+<div class="section" id="id7">
+<h3>Request URI<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>POST /<org_id>/<app_id>/groups/<uuid | groupname>/users/<uuid | username>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="43%" />
+<col width="57%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>arg uuid | string org_id</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>arg uuid | string app_id</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>arg uuid | string groupname</td>
+<td>UUID or name of the group</td>
+</tr>
+<tr class="row-odd"><td>arg uuid | string username</td>
+<td>UUID or username of user</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="id8">
+<h3>Example<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
+<p><strong>Note</strong>: Although not shown in the API examples below, you need to
+provide a valid access token with each API call. See Authenticating
+users and application clients for details.</p>
+</div>
+<div class="section" id="id9">
+<h3>Request<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/my-org/my-app/groups/mynewgroup/users/john.doe"
+</pre></div>
+</div>
+</div>
+<div class="section" id="id10">
+<h3>Response<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span><span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span><span class="p">:</span> <span class="s">"7fb8d891-477d-11e1-b2bd-22000a1c4e22"</span><span class="p">,</span>
+ <span class="s">"params"</span><span class="p">:</span> <span class="p">{},</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span><span class="p">:</span> <span class="s">"https://api.usergrid.com/22000a1c4e22-7fb8d891-477d-11e1-b2bd/7fb8d891-477d-11e1-b2bd-22000a1c4e22/groups/a668717b-67cb-11e1-8223-12313d14bde7/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span><span class="p">:</span> <span class="p">[{</span>
+ <span class="s">"uuid"</span><span class="p">:</span> <span class="s">"6fbc8157-4786-11e1-b2bd-22000a1c4e22"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
+ <span class="s">"created"</span><span class="p">:</span> <span class="mi">1327517852364015</span><span class="p">,</span>
+ <span class="s">"modified"</span><span class="p">:</span> <span class="mi">1327517852364015</span><span class="p">,</span>
+ <span class="s">"activated"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@mail.com"</span><span class="p">,</span>
+ <span class="s">"metadata"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"connecting"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"owners"</span><span class="p">:</span><span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/connecting/owners"</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22"</span><span class="p">,</span>
+ <span class="s">"sets"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/rolenames"</span><span class="p">,</span>
+ <span class="s">"permissions"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span><span class="p">:{</span>
+ <span class="s">"activities"</span><span class="p">:</span><span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span><span class="p">:</span><span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span><span class="p">:</span><span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span><span class="p">:</span> <span class="s">"/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/followers"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s">"picture"</span><span class="p">:</span> <span class="s">"https://www.gravatar.com/avatar/90f823ba15655b8cc8e3b4d63377576f"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"john.doe"</span>
+ <span class="p">}],</span>
+ <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1331066031380</span><span class="p">,</span>
+ <span class="s">"duration"</span><span class="p">:</span> <span class="mi">64</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"my-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span><span class="p">:</span> <span class="s">"my-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="removing-a-user-from-a-group">
+<h2>Removing a user from a group<a class="headerlink" href="#removing-a-user-from-a-group" title="Permalink to this headline">¶</a></h2>
+<p>Use the DELETE method to remove a user from the specified group.</p>
+<div class="section" id="id11">
+<h3>Request syntax<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/<org>/<app>/groups/<group>/users/<user>"
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>org</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>app</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>group</td>
+<td>UUID or name of the group</td>
+</tr>
+<tr class="row-odd"><td>user</td>
+<td>UUID, username or email of user to be deleted</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="id12">
+<h3>Example request<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/your-org/your-app/groups/someGroup/users/someUser
+</pre></div>
+</div>
+</div>
+<div class="section" id="id13">
+<h3>Example response<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"delete"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/your-org/your-app/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"74d2d7da-e694-11e3-b0c6-4d2664c8e0c3"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1401301104077</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1401301104077</span><span class="p">,</span>
+ <span class="s">"username"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"email"</span> <span class="p">:</span> <span class="s">"your-org@apigee.com"</span><span class="p">,</span>
+ <span class="s">"activated"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"picture"</span> <span class="p">:</span> <span class="s">"http://www.gravatar.com/avatar/0455fc92de2636fc7a176cc5d298bb78"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/roles"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/followers"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1401751485776</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">220</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="activity.html" class="btn btn-neutral float-right" title="Activity" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="working-user-data.html" class="btn btn-neutral" title="Working with User Data" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</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>
+
+ </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/4a92ab09/content/docs/user-management/groups.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/groups.html b/content/docs/user-management/groups.html
new file mode 100644
index 0000000..6fd0a61
--- /dev/null
+++ b/content/docs/user-management/groups.html
@@ -0,0 +1,398 @@
+
+
+<!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>Groups — 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"/>
+
+
+ <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>
+<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.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="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="../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> »</li>
+
+ <li>Groups</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/user-management/groups.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="groups">
+<h1>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h1>
+<p>You can organize app users into groups. Groups have their own Activity
+Feed, their own permissions and be a useful alternative to Roles,
+depending on how you model your data. Groups were originaly designed to
+emulate Facebook Groups, so they will tend to function about the same
+way Facebook Groups would.</p>
+<p>Groups are hierarchical. Every member of the group
+/groups/california/san-francisco is also a member of the group
+/groups/california.</p>
+<p>Groups are also a great way to model things such a topic subscriptions.
+For example, you could allow people to subscribe (i.e. become a member
+of the group and be alerted via Activities) to /groups/memes/dogs/doge
+or subscribe to all /groups/memes/dogs</p>
+<div class="section" id="general-properties">
+<h2>General properties<a class="headerlink" href="#general-properties" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="9%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Group’s unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>Type of entity, in this case “user”</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>path</td>
+<td>string</td>
+<td>Valid slash-delimited group path (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>title</td>
+<td>string</td>
+<td>Display name</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="set-properties">
+<h2>Set properties<a class="headerlink" href="#set-properties" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Set</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>connections</td>
+<td>string</td>
+<td>Set of connection types (e.g., likes)</td>
+</tr>
+<tr class="row-odd"><td>rolenames</td>
+<td>string</td>
+<td>Set of roles assigned to a group</td>
+</tr>
+<tr class="row-even"><td>credentials</td>
+<td>string</td>
+<td>Set of group credentials</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="collections">
+<h2>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Collection</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>users</td>
+<td>user</td>
+<td>Collection of users in the group</td>
+</tr>
+<tr class="row-odd"><td>activities</td>
+<td>activity</td>
+<td>Collection of activities a user has performed</td>
+</tr>
+<tr class="row-even"><td>feed</td>
+<td>activity</td>
+<td>Inbox of activity notifications a group has received</td>
+</tr>
+<tr class="row-odd"><td>roles</td>
+<td>role</td>
+<td>Set of roles to which a group belongs</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <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>
+
+ </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