http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/orgs-and-apps/organization.html ---------------------------------------------------------------------- diff --git a/content/docs/orgs-and-apps/organization.html b/content/docs/orgs-and-apps/organization.html new file mode 100644 index 0000000..47f0c4f --- /dev/null +++ b/content/docs/orgs-and-apps/organization.html @@ -0,0 +1,1017 @@ + + +<!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>Organization — 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="Application" href="application.html"/> + <link rel="prev" title="Organization & application management" href="managing.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/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 class="current"> +<li class="toctree-l1"><a class="reference internal" href="managing.html">Organization & application management</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="">Organization</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#creating-an-organization">Creating an organization</a><ul> +<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-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="#getting-an-organization">Getting an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id1">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id2">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id3">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#activating-an-organization">Activating an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#request-url">Request URL</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id4">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id5">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#reactivating-an-organization">Reactivating an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id6">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id7">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id8">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#generating-organization-client-credentials">Generating organization client credentials</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id9">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id10">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id11">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#retrieving-organization-client-credentials">Retrieving organization client credentials</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id12">Request URL</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id13">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id14">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#getting-an-organization-s-activity-feed">Getting an organization’s activity feed</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id15">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id16">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id17">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#getting-the-applications-in-an-organization">Getting the applications in an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id18">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id19">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id20">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#adding-an-admin-user-to-an-organization">Adding an admin user to an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id21">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id22">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id23">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#getting-the-admin-users-in-an-organization">Getting the admin users in an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id24">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id25">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id26">Example - Response</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#removing-an-admin-user-from-an-organization">Removing an admin user from an organization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id27">Request URI</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id28">Example - Request</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id29">Example - Response</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="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>Organization</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/orgs-and-apps/organization.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="organization"> +<h1>Organization<a class="headerlink" href="#organization" title="Permalink to this headline">¶</a></h1> +<p>An organization represents the highest level of the API Services BaaS +data hierarchy. It contains applications (and the entities and +collections they contain) and is associated with one or more +administrators. An organization can be representative of a company, +team, or project. It allows multiple applications to be shared within +the organization with other administrators.</p> +<div class="section" id="creating-an-organization"> +<h2>Creating an organization<a class="headerlink" href="#creating-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the POST method to create an organization through a form post.</p> +<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>POST /organizations|orgs {request body} +</pre></div> +</div> +<p>Parameters</p> +<p>Expected to be sent form data in the body of the request.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="37%" /> +<col width="63%" /> +</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>organization (string)</td> +<td>The name of the organization.</td> +</tr> +<tr class="row-odd"><td>username (string)</td> +<td>The username of the administrator.</td> +</tr> +<tr class="row-even"><td>name (string)</td> +<td>The name of the administrator.</td> +</tr> +<tr class="row-odd"><td>email (string)</td> +<td>The email address of the administrator.</td> +</tr> +<tr class="row-even"><td>password (string)</td> +<td>The password of the administrator.</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 -i POST "https://api.usergrid.com/management/orgs" -d '{"password":"test12345","email":"[email protected]","name":"test","username":"test123","organization":"testorg"}' +</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>{ + "action": "new organization", + "status": "ok", + "data": { + "owner": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "tester123", + "name": "test", + "email": "[email protected]", + "activated": false, + "disabled": false, + "uuid": "48c92c73-0d7e-11e2-98b9-12313d288ee0", + "adminUser": true, + "displayEmailAddress": "tester123 <[email protected]>", + "htmldisplayEmailAddress": "tester123 <<a href="mailto:[email protected]">[email protected]</a>>" + }, + "organization": { + "name": "testorg", + "uuid": "5de0bb69-0d7f-11e2-87b9-12313d288ff0" + } + }, + "timestamp": 1349284674173, + "duration": 21376 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-an-organization"> +<h2>Getting an organization<a class="headerlink" href="#getting-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve an organization given a specified UUID or +username.</p> +<div class="section" id="id1"> +<h3>Request URI<a class="headerlink" href="#id1" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="35%" /> +<col width="65%" /> +</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_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +<p>Note: You also need to provide a valid access token with the API call. +See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users and application +clients</a> +for details.</p> +</div> +<div class="section" id="id2"> +<h3>Example - Request<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg" +</pre></div> +</div> +</div> +<div class="section" id="id3"> +<h3>Example - Response<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "timestamp": 1349286861746, + "duration": 18, + "organization": { + "users": { + "tester123": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "tester123", + "name": "test", + "email": "[email protected]", + "activated": true, + "disabled": false, + "uuid": "327b527f-cd0c-11e1-bcf7-12313d1c4491", + "adminUser": true, + "displayEmailAddress": "tester123 <[email protected]>", + "htmldisplayEmailAddress": "tester123 <<a href="mailto:[email protected]">[email protected]</a>>" + } + }, + "name": "testorg", + "applications": { + "tester123/sandbox": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", + "tester123/testapp1": "be08a5f9-fdd3-11e1-beca-12313d027471", + "tester123/testapp2": "cede5b7e-fe90-11e1-95c8-12313b122c56" + }, + "uuid": "33dd0563-cd0c-11e1-bcf7-12313d1c4491" +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="activating-an-organization"> +<h2>Activating an organization<a class="headerlink" href="#activating-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to activate an organization from a link provided in +an email notification.</p> +<div class="section" id="request-url"> +<h3>Request URL<a class="headerlink" href="#request-url" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>GET /organizations|orgs/{org_name}|{uuid}/activate?token={token}&confirm={confirm_email} +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="27%" /> +<col width="73%" /> +</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_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +<tr class="row-odd"><td>token</td> +<td>Activation token (supplied via email).</td> +</tr> +<tr class="row-even"><td>confirm_email</td> +<td>(boolean) Send confirmation email (false is the default).</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id4"> +<h3>Example - Request<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/activate?token=33dd0563-cd0c-11e1-bcf7-12313d1c4491" +</pre></div> +</div> +</div> +<div class="section" id="id5"> +<h3>Example - Response<a class="headerlink" href="#id5" 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">"activate organization"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1337928462810</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">3342</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="reactivating-an-organization"> +<h2>Reactivating an organization<a class="headerlink" href="#reactivating-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to reactivate an organization.</p> +<div class="section" id="id6"> +<h3>Request URI<a class="headerlink" href="#id6" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">reactivate</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</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>string org_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id7"> +<h3>Example - Request<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/reactivate" +</pre></div> +</div> +</div> +<div class="section" id="id8"> +<h3>Example - Response<a class="headerlink" href="#id8" 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">"reactivate organization"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349385280891</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">3612</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="generating-organization-client-credentials"> +<h2>Generating organization client credentials<a class="headerlink" href="#generating-organization-client-credentials" title="Permalink to this headline">¶</a></h2> +<p>Use the POST method to generate new credentials for an organization +client.</p> +<div class="section" id="id9"> +<h3>Request URI<a class="headerlink" href="#id9" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">credentials</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</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>string org_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +<p><strong>Note</strong>: You also need to provide a valid access token with the API +call. <a class="reference external" href="../security_and_auth/authenticating-users-and-application-clients.html">Authenticating users and application +clients</a> +for details.</p> +</div> +<div class="section" id="id10"> +<h3>Example - Request<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/management/orgs/credentials" +</pre></div> +</div> +</div> +<div class="section" id="id11"> +<h3>Example - Response<a class="headerlink" href="#id11" 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">"generate organization client credentials"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349385795647</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span> + <span class="s">"credentials"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"client_id"</span><span class="p">:</span> <span class="s">"c2V7N61DY90MCdG78xIxPRxFdQ"</span><span class="p">,</span> + <span class="s">"client_secret"</span><span class="p">:</span> <span class="s">"c2V7WEdXIutZWEkWdySLCt_lYDFVMMN"</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="retrieving-organization-client-credentials"> +<h2>Retrieving organization client credentials<a class="headerlink" href="#retrieving-organization-client-credentials" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve the credentials for an organization +client.</p> +<div class="section" id="id12"> +<h3>Request URL<a class="headerlink" href="#id12" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">credentials</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</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>string org_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +<p><strong>Note</strong>: You also need to provide a valid access token with the API +call. See <a class="reference external" href="../security_and_auth/authenticating-users-and-application-clients.html">Authenticating users and application +clients</a> +for details.</p> +</div> +<div class="section" id="id13"> +<h3>Example - Request<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/credentials" +</pre></div> +</div> +</div> +<div class="section" id="id14"> +<h3>Example - Response<a class="headerlink" href="#id14" 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 organization client credentials"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349386672984</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">690</span><span class="p">,</span> + <span class="s">"credentials"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"client_id"</span><span class="p">:</span> <span class="s">"c2V7N61DY90MCdG78xIxPRxFdQ"</span><span class="p">,</span> + <span class="s">"client_secret"</span><span class="p">:</span> <span class="s">"c2V7WEdXIutZWEkWdySLCt_lYDFVMMN"</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-an-organization-s-activity-feed"> +<h2>Getting an organization’s activity feed<a class="headerlink" href="#getting-an-organization-s-activity-feed" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to get an organization’s activity feed.</p> +<div class="section" id="id15"> +<h3>Request URI<a class="headerlink" href="#id15" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">feed</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</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>string org_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +<p><strong>Note</strong>: You also need to provide a valid access token with the API +call. See <a class="reference external" href="../security_and_auth/authenticating-users-and-application-clients.html">Authenticating users and application +clients</a> +for details.</p> +</div> +<div class="section" id="id16"> +<h3>Example - Request<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/feed" +</pre></div> +</div> +</div> +<div class="section" id="id17"> +<h3>Example - Response<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + { + "action": "get organization feed", + "status": "ok", + "entities": [ + { + "uuid": "cf4d981c-fe90-11e1-95c8-12313b122c56", + "type": "activity", + "created": 1347643370454, + "modified": 1347643370454, + "actor": { + "displayName": "tester123", + "objectType": "person", + "uuid": "327b527f-cd0c-11e1-bcf7-12313d1c4491", + "entityType": "user" + }, + "category": "admin", + "metadata": { + "cursor": "gGkAAQMAgGkABgE5xc3r1gCAdQAQz02YHP6QEeGVyBIxOxIsVgCAdQAQz3SoH_6QEeGVyBIxOxIsVgA", + "path": "/groups/33dd0563-cd0c-11e1-bcf7-12313d1c4491/feed/cf4d981c-fe90-11e1-95c8-12313b122c56" + }, +"object": { + "displayName": "testapp2", + "objectType": "Application", + "uuid": "cede5b7e-fe90-11e1-95c8-12313b122c56", + "entityType": "application_info" + }, + "published": 1347643370454, + "title": "<a mailto="mailto:[email protected]">tester123 ([email protected])</a> created a new application named testapp2", + "verb": "create" + },... +, + "timestamp": 1349387253811 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-the-applications-in-an-organization"> +<h2>Getting the applications in an organization<a class="headerlink" href="#getting-the-applications-in-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve the applications in an organization.</p> +<div class="section" id="id18"> +<h3>Request URI<a class="headerlink" href="#id18" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">applications</span><span class="o">|</span><span class="n">apps</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</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>string org_name|arg uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +<p><strong>Note</strong>: You also need to provide a valid access token with the API +call. See <a class="reference external" href="../security_and_auth/authenticating-users-and-application-clients.html">Authenticating users and application +clients</a> +for details.</p> +</div> +<div class="section" id="id19"> +<h3>Example - Request<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/apps" +</pre></div> +</div> +</div> +<div class="section" id="id20"> +<h3>Example - Response<a class="headerlink" href="#id20" 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 organization application"</span><span class="p">,</span> + <span class="s">"data"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"testorg/sandbox"</span><span class="p">:</span> <span class="s">"3500ba10-cd0c-11e1-bcf8-12313d1c5591"</span><span class="p">,</span> + <span class="s">"testorg/testapp1"</span><span class="p">:</span> <span class="s">"be09a5f9-fdd3-11e1-beca-12313d027361"</span><span class="p">,</span> + <span class="s">"testorg/testapp2"</span><span class="p">:</span> <span class="s">"cede5b8e-fe90-11e1-65c8-12313b111c56"</span> + <span class="p">},</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349815338635</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">22</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="adding-an-admin-user-to-an-organization"> +<h2>Adding an admin user to an organization<a class="headerlink" href="#adding-an-admin-user-to-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the PUT method to add an existing admin user to an organization.</p> +<div class="section" id="id21"> +<h3>Request URI<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre><span class="n">PUT</span> <span class="o">/</span><span class="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">org_uuid</span><span class="p">}</span><span class="o">/</span><span class="n">users</span><span class="o">/</span><span class="p">{</span><span class="n">username</span><span class="o">|</span><span class="n">email</span><span class="o">|</span><span class="n">uuid</span><span class="p">}</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="47%" /> +<col width="53%" /> +</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>string org_name|arg org_uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +<tr class="row-odd"><td>string username|string email|arg uuid</td> +<td>User name, user email address, or user UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id22"> +<h3>Example - Request<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X PUT "https://api.usergrid.com/management/orgs/testorg/users/test123" +</pre></div> +</div> +</div> +<div class="section" id="id23"> +<h3>Example - Response<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "action": "add user to organization", + "status": "ok", + "data": { + "user": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "tester123", + "name": "test", + "email": "[email protected]", + "activated": true, + "disabled": false, + "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591", + "adminUser": true, + "displayEmailAddress": "tester123 <[email protected]>", + "htmldisplayEmailAddress": "tester123 <<a href="mailto:[email protected]">[email protected]</a>>" + } + }, + "timestamp": 1349390189106, + "duration": 11808 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-the-admin-users-in-an-organization"> +<h2>Getting the admin users in an organization<a class="headerlink" href="#getting-the-admin-users-in-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve details about the admin users in an +organization.</p> +<div class="section" id="id24"> +<h3>Request URI<a class="headerlink" href="#id24" 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="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">org_uuid</span><span class="p">}</span><span class="o">/</span><span class="n">users</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="39%" /> +<col width="61%" /> +</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_name|arg org_uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id25"> +<h3>Example - Request<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/orgs/testorg/users" +</pre></div> +</div> +</div> +<div class="section" id="id26"> +<h3>Example - Response<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "action": "get organization users", + "data": { + "user": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "tester123", + "name": "test", + "email": "[email protected]", + "activated": true, + "disabled": false, + "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591", + "adminUser": true, + "displayEmailAddress": "tester123 <[email protected]>", + "htmldisplayEmailAddress": "tester123 <<a href="mailto:[email protected]">[email protected]</a>>" + } + }, + "timestamp": 13494542201685, + "duration": 10 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="removing-an-admin-user-from-an-organization"> +<h2>Removing an admin user from an organization<a class="headerlink" href="#removing-an-admin-user-from-an-organization" title="Permalink to this headline">¶</a></h2> +<p>Use the DELETE method to remove an admin user from an organization. All +organizations must have a minimum of one user with org admin privileges. +If you attempt to delete the last org admin in an organization, the API +will return a 400 Bad Request error.</p> +<div class="section" id="id27"> +<h3>Request URI<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre><span class="n">DELETE</span> <span class="o">/</span><span class="n">organizations</span><span class="o">|</span><span class="n">orgs</span><span class="o">/</span><span class="p">{</span><span class="n">org_name</span><span class="p">}</span><span class="o">|</span><span class="p">{</span><span class="n">org_uuid</span><span class="p">}</span><span class="o">/</span><span class="n">users</span><span class="o">/</span><span class="p">{</span><span class="n">username</span><span class="o">|</span><span class="n">email</span><span class="o">|</span><span class="n">uuid</span><span class="p">}</span> +</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>org_name|arg org_uuid</td> +<td>Organization name or organization UUID.</td> +</tr> +<tr class="row-odd"><td>username|string email|arg uuid</td> +<td>User name, user email address, or user UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id28"> +<h3>Example - Request<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE "https://api.usergrid.com/management/orgs/testorg/users/test123" +</pre></div> +</div> +</div> +<div class="section" id="id29"> +<h3>Example - Response<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "action": "remove user from organization", + "status": "ok", + "data": { + "user": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "tester123", + "name": "test", + "email": "[email protected]", + "activated": true, + "disabled": false, + "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591", + "adminUser": true, + "displayEmailAddress": "tester123 <[email protected]>", + "htmldisplayEmailAddress": "tester123 <<a href="mailto:[email protected]">[email protected]</a>>" + } + }, + "timestamp": 1349453590005, + "duration": 727 +} +</pre></div> +</div> +</div> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="application.html" class="btn btn-neutral float-right" title="Application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="managing.html" class="btn btn-neutral" title="Organization & application management" 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/push-notifications/tbd.html ---------------------------------------------------------------------- diff --git a/content/docs/push-notifications/tbd.html b/content/docs/push-notifications/tbd.html new file mode 100644 index 0000000..a5e2846 --- /dev/null +++ b/content/docs/push-notifications/tbd.html @@ -0,0 +1,280 @@ + + +<!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>COMING IN USERGRID 2 — 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/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="../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>COMING IN USERGRID 2</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/push-notifications/tbd.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="coming-in-usergrid-2"> +<h1>COMING IN USERGRID 2<a class="headerlink" href="#coming-in-usergrid-2" title="Permalink to this headline">¶</a></h1> +</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 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/push-notifications/users-devices.html ---------------------------------------------------------------------- diff --git a/content/docs/push-notifications/users-devices.html b/content/docs/push-notifications/users-devices.html new file mode 100644 index 0000000..618e5f3 --- /dev/null +++ b/content/docs/push-notifications/users-devices.html @@ -0,0 +1,537 @@ + + +<!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>Users & Devices — 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/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="../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>Users & Devices</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/push-notifications/users-devices.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="users-devices"> +<h1>Users & Devices<a class="headerlink" href="#users-devices" title="Permalink to this headline">¶</a></h1> +<p>Users and Devices are the primary ways to identify access to the system. +Devices are great to track anonymous access, while Users allow you to +model signing up, signing in, etc.</p> +<div class="section" id="users"> +<h2>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="properties"> +<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="10%" /> +<col width="77%" /> +</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>Userâ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>username</td> +<td>string</td> +<td>Valid and unique string username (mandatory)</td> +</tr> +<tr class="row-odd"><td>password</td> +<td>string</td> +<td>User password</td> +</tr> +<tr class="row-even"><td>email</td> +<td>string</td> +<td>Valid and unique email address</td> +</tr> +<tr class="row-odd"><td>name</td> +<td>string</td> +<td>User display name</td> +</tr> +<tr class="row-even"><td>activated</td> +<td>boolean</td> +<td>Whether the user account is activated</td> +</tr> +<tr class="row-odd"><td>disabled</td> +<td>boolean</td> +<td>Whether the user account is administratively disabled</td> +</tr> +<tr class="row-even"><td>firstname</td> +<td>string</td> +<td>User first name</td> +</tr> +<tr class="row-odd"><td>middlename</td> +<td>string</td> +<td>User middle name</td> +</tr> +<tr class="row-even"><td>lastname</td> +<td>string</td> +<td>User last name</td> +</tr> +<tr class="row-odd"><td>picture</td> +<td>string</td> +<td>User picture</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="sets"> +<h2>Sets<a class="headerlink" href="#sets" 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 user</td> +</tr> +<tr class="row-even"><td>permissions</td> +<td>string</td> +<td>Set of user permissions</td> +</tr> +<tr class="row-odd"><td>credentials</td> +<td>string</td> +<td>Set of user credentials</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="relationshops"> +<h2>Relationshops<a class="headerlink" href="#relationshops" 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>groups</td> +<td>group</td> +<td>Collection of groups to which a user belongs</td> +</tr> +<tr class="row-odd"><td>devices</td> +<td>device</td> +<td>Collection of devices in the service</td> +</tr> +<tr class="row-even"><td>activities</td> +<td>activity</td> +<td>Collection of activities a user has performed</td> +</tr> +<tr class="row-odd"><td>feed</td> +<td>activity</td> +<td>Inbox of activity notifications a user has received</td> +</tr> +<tr class="row-even"><td>roles</td> +<td>role</td> +<td>Set of roles assigned to a user</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="facebook-sign-in"> +<h2>Facebook Sign-in<a class="headerlink" href="#facebook-sign-in" title="Permalink to this headline">¶</a></h2> +<p>You can authenticate your Apache Usergrid requests by logging into +Facebook. To access Apache Usergrid resources, you need to provide an +access token with each request (unless you use the sandbox app). You can +get an access token by connecting to an appropriate web service endpoint +and providing the correct client credentials â this is further described +in <a class="reference external" href="/authenticating-users-and-application-clients">Authenticating users and application +clients</a>. However, you +can also obtain an access token by logging into Facebook.</p> +<p>To enable authentication to Apache Usergrid through Facebook, do the +following in your app:</p> +<ol class="arabic"> +<li><p class="first">Make a login call to the Facebook API (do this using the <a class="reference external" href="https://developers.facebook.com/docs/sdks/";>Facebook +SDK</a> or +<a class="reference external" href="https://developers.facebook.com/docs/facebook-login/";>API</a>). If +the login succeeds, a Facebook access token is returned.</p> +</li> +<li><p class="first">Send the Facebook access token to Apache Usergrid. If the Facebook +access token is valid and the user does not already exist in App +Services, Apache Usergrid provisions a new Apache Usergrid user. It +also returns an Apache Usergrid access token, which you can use for +subsequent Apache Usergrid API calls. Behind the scenes, Apache +Usergrid uses the Facebook access token to retrieve the user’s +profile information from Facebook.</p> +<p>If the Facebook access token is invalid, Facebook returns an OAuth +authentication error, and the login does not succeed.</p> +</li> +</ol> +<p>The request to authenticate to Apache Usergrid using a Facebook access +token is:</p> +<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/{my_org}/{my_app}/auth/facebook?fb_access_token={fb_access_token} +</pre></div> +</div> +<p>where:</p> +<ul class="simple"> +<li>{my_org} is the organization UUID or organization name.</li> +<li>{my_app} is the application UUID or application name.</li> +<li>{fb_access_token} is the Facebook access token.</li> +</ul> +</div> +<div class="section" id="devices"> +<h2>Devices<a class="headerlink" href="#devices" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="id1"> +<h2>Properties<a class="headerlink" href="#id1" 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>Entity unique ID</td> +</tr> +<tr class="row-odd"><td>type</td> +<td>string</td> +<td>Entity type (e.g., device)</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>name</td> +<td>string</td> +<td>Device name (mandatory)</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="relationships"> +<h2>Relationships<a class="headerlink" href="#relationships" title="Permalink to this headline">¶</a></h2> +<p>Devices have the following associated collection.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="11%" /> +<col width="69%" /> +</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 to which a device 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
