http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/asset-and-files/uploading-assets.html ---------------------------------------------------------------------- diff --git a/content/docs/asset-and-files/uploading-assets.html b/content/docs/asset-and-files/uploading-assets.html new file mode 100644 index 0000000..8143f88 --- /dev/null +++ b/content/docs/asset-and-files/uploading-assets.html @@ -0,0 +1,416 @@ + + +<!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>Uploading assets — 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="Retrieving assets" href="retrieving-assets.html"/> + <link rel="prev" title="Geolocating your Entities" href="../geolocation/geolocation.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 class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="">Uploading assets</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#id1">Uploading assets</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="#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="#updating-assets">Updating assets</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="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>Uploading assets</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/asset-and-files/uploading-assets.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="uploading-assets"> +<h1>Uploading assets<a class="headerlink" href="#uploading-assets" title="Permalink to this headline">¶</a></h1> +<p>With Usergrid, you can store and retrieve files and assets that hold +data objects such as images, video, and audio content.</p> +<p>Usergrid manages these objects as Asset entities. Optionally, you can +use Folder entities to organize related assets.</p> +<div class="section" id="id1"> +<h2>Uploading assets<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> +<p>Assets can be any file type and can be attached to any entity. When an +asset is uploaded, Usergrid will automatically detect the file metadata +for the asset and save it in the associated entity as a +<code class="docutils literal"><span class="pre">file-metadata</span></code> property. Only 1 asset can be attached to an entity.</p> +<p>To attach an asset to an entity, do the following:</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 -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</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>filename</td> +<td>A filename to associate with the asset.</td> +</tr> +<tr class="row-odd"><td>file_location</td> +<td>The location of the asset to be uploaded.</td> +</tr> +<tr class="row-even"><td>org Organization</td> +<td>UUID or organization name</td> +</tr> +<tr class="row-odd"><td>app Application</td> +<td>UUID or application name</td> +</tr> +<tr class="row-even"><td>collection</td> +<td>Name or UUID of the collection of the entity you want to attach the asset to.</td> +</tr> +<tr class="row-odd"><td>entity</td> +<td>Name or UUID of an existing entity you want to attach the asset to.</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 POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/' +</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> +<p>Notice the <code class="docutils literal"><span class="pre">file-metadata</span></code> property in the response.</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">"post"</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">"/users"</span><span class="p">,</span> + <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/amuramoto/sandbox/pictures"</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">"410b213a-b379-11e3-a0e5-9953085ea376"</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">"test"</span><span class="p">,</span> + <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1395681911491</span><span class="p">,</span> + <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1399069838919</span><span class="p">,</span> + <span class="s">"name"</span> <span class="p">:</span> <span class="s">"clouds"</span><span class="p">,</span> + <span class="s">"file"</span> <span class="p">:</span> <span class="s">"fobnszewobnioerabnoiawegbrn</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> + <span class="s">"file-metadata"</span> <span class="p">:</span> <span class="p">{</span> + <span class="s">"content-type"</span> <span class="p">:</span> <span class="s">"image/jpeg"</span><span class="p">,</span> + <span class="s">"etag"</span> <span class="p">:</span> <span class="s">"</span><span class="se">\"</span><span class="s">2e1db7299b0a667ed80e674a0ef9d653</span><span class="se">\"</span><span class="s">"</span><span class="p">,</span> + <span class="s">"last-modified"</span> <span class="p">:</span> <span class="mi">1399070010115</span><span class="p">,</span> + <span class="s">"content-length"</span> <span class="p">:</span> <span class="mi">28</span><span class="p">,</span> + <span class="s">"checksum"</span> <span class="p">:</span> <span class="s">"2e1db7299b0a667ed80e674a0ef9d653"</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">"likes"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"</span> + <span class="p">},</span> + <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376"</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">"/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span> + <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"</span> + <span class="p">},</span> + <span class="s">"connections"</span> <span class="p">:</span> <span class="p">{</span> + <span class="s">"follows"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"</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">"/users/410b213a-b379-11e3-a0e5-9953085ea376/activities"</span><span class="p">,</span> + <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/devices"</span><span class="p">,</span> + <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/feed"</span><span class="p">,</span> + <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/groups"</span><span class="p">,</span> + <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span> + <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/following"</span><span class="p">,</span> + <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/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">1399070009986</span><span class="p">,</span> + <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">441</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 class="section" id="updating-assets"> +<h2>Updating assets<a class="headerlink" href="#updating-assets" title="Permalink to this headline">¶</a></h2> +<p>To update the data for an asset, perform the same request outlined above +in ‘Uploading assets’ as a <code class="docutils literal"><span class="pre">PUT</span></code> request rather than a <code class="docutils literal"><span class="pre">POST</span></code>.</p> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="retrieving-assets.html" class="btn btn-neutral float-right" title="Retrieving assets" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../geolocation/geolocation.html" class="btn btn-neutral" title="Geolocating your Entities" 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/2a55601f/content/docs/assets/index.html ---------------------------------------------------------------------- diff --git a/content/docs/assets/index.html b/content/docs/assets/index.html deleted file mode 100644 index 1f7f16a..0000000 --- a/content/docs/assets/index.html +++ /dev/null @@ -1,319 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Assets</title> - <meta http-equiv="x-ua-compatible" content="ie=edge" /> - <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> - <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service"> - <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <meta property="og:title" content="Apache Usergrid" /> - <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <!-- Loading Typekit --> - <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script> - <script type="text/javascript">try{Typekit.load();}catch(e){}</script> - <!-- Loading Bootstrap --> - <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'> - <link href="/css/bootflat.css" rel="stylesheet" type='text/css'> - <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'> - <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"; rel="stylesheet" type="text/css"> - <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'> - - - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. --> - <!--[if lt IE 9]> - <script src="js/html5shiv.js"></script> - <script src="js/respond.min.js"></script> - <![endif]--> -</head> -<body> - - <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner"> - <div class="container"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - </div> - <a href="/" class="navbar-brand"> - <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" /> - </a> - <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav navbar-right"> - <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank"><span class="icns icon-book"></span></a></li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank"><span class="icns icon-github-sign"></span></a></li> - <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid"; target="_blank"><span class="icns icon-trello"></span></a></li>--> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank"><span class="icns icon-bug"></span></a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank"><span class="icns icon-stackexchange"></span></a></li> - <li><a href="/community/#live"><span class="icns icon-comments"></span></a></li> - <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"; target="_blank"><span class="icns icon-envelope"></span></a></li>--> - <li><a href="https://twitter.com/usergrid"; target="_blank"><span class="icns icon-twitter"></span></a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/"; target="_blank"><span class="icns icon-wiki"></span></a></li> - <li><a href="/releases/"><span class="icns icon-releases"></span></a></li> - </ul> - </nav> - </div> - </header> - - - -<div class="container bf-docs-container"> - <div class="row"> - <div class="col-md-3"> - <div class="bf-sidebar hidden-print" role="complementary"> - <ul class="nav nav-list"> - <li><a href="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li> - <li><a href="/docs/deploy-local/">Deploying to local Tomcat & Cassandra</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc";><code>ugc</code> â the Command-line Client</a></li> - - <li class="nav-header"><span>Concepts</span></li> - <li> - <a href="/docs/organizations-admins/">Organizations & Admins</a> - <ul> - <li> - <a href="/docs/applications/">Applications</a> - <ul> - <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li> - <!--<li><a href="#">Queues</a></li>--> - <li><a href="/docs/events-and-counters/">Events & Counters</a></li> - <li><a href="/docs/relationships/">Relationships (Joins)</a></li> - <li> - <a href="/docs/collections">Collections</a> - <ul> - <li><a href="/docs/query-language/">Query Language</a></li> - <li><a href="/docs/users-devices/">Users & Devices</a></li> - <li><a href="/docs/groups/">Groups</a></li> - <li><a href="/docs/activities/">Activities</a></li> - <li><a href="/docs/assets/">Assets</a></li> - </ul> - </li> - </ul> - </li> - </ul> - </li> - - - <li class="nav-header"><span>Usage</span></li> - <!-- <li>REST API â Coming Soon</li> --> - <li><a class="icns-apple" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ios";>iOS SDK</a></li> - <li><a class="icns-android" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/android";>Android SDK</a></li> - <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li> - <li><a class="icns-windows" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet";>Windows 8 / Windows Phone / .net SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs";>Node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby";>Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails";>Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php";>PHP library</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/java";>Java library</a></li> - - <!--<li class="nav-header"><span>Internals</span></li> - <li>Design & Goals â Coming Soon</li> - <li>Java Architecture â Coming Soon</li> - <li>Cassandra Schema â Coming Soon</li>--> - - <li class="nav-header"><span>Operations</span></li> - <!--<li>Deploying â Coming Soon</li>--> - <!-- <li>Monitoring â Coming Soon</li> --> - <li><a href="/docs/upgrading/">Upgrading</a></li> - <!-- <li>Security â Coming Soon</li> --> - - <li class="nav-header"><span>Presentations & Videos</span></li> - <li><a href="/docs/presentations/">Presentations</a></li> - <li><a href="/docs/videos/">Videos</a></li> - - <li class="nav-header"><span>We need your help!</span></li> - <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li> - <!-- - <li><a href="/docs/contribute-docs">How to contribute docs</a></li> - --> - </ul> - </div> - </div> - - <div class="col-md-9 main-article" role="main"> - <div class="page-article"> - <div class="page-header"> - <h1>Assets</h1> - <!-- TODO: reenable this when we sync SVN to GitHub - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/assets.md";>contribute to this article on github</a></small> - --> - </div> - <div class="toc"> - -</div> -<p>Asset entities are used primarily in Apache Usergrid to manage binary data objects such as images, video, and audio content. However, an asset does not have to be used for a binary object. For example, assets can be used to model a file system.</p> -<table> -<thead> -<tr class="header"> -<th align="left">Property</th> -<th align="left">Type</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">uuid</td> -<td align="left">UUID</td> -<td align="left">Assetâs unique entity ID</td> -</tr> -<tr class="even"> -<td align="left">type</td> -<td align="left">string</td> -<td align="left">âassetâ</td> -</tr> -<tr class="odd"> -<td align="left">name</td> -<td align="left">string</td> -<td align="left">Asset name (mandatory)</td> -</tr> -<tr class="even"> -<td align="left">created</td> -<td align="left">long</td> -<td align="left"> -<a href="http://en.wikipedia.org/wiki/Unix_time";>UNIX timestamp</a> of entity creation</td> -</tr> -<tr class="odd"> -<td align="left">modified</td> -<td align="left">long</td> -<td align="left"> -<a href="http://en.wikipedia.org/wiki/Unix_time";>UNIX timestamp</a> of entity modification</td> -</tr> -<tr class="even"> -<td align="left">owner</td> -<td align="left">UUID</td> -<td align="left">UUID of the assetâs owner (mandatory)</td> -</tr> -<tr class="odd"> -<td align="left">path</td> -<td align="left">string</td> -<td align="left">Relative path to the asset (mandatory)</td> -</tr> -<tr class="even"> -<td align="left">content-type</td> -<td align="left">string</td> -<td align="left">Content type of the asset (for example, âimage/jpegâ)</td> -</tr> -</tbody> -</table> -<p> </p> - </div> - </div> - </div> - <div class="row"> - <div class="col-md-3"></div> - <div class="col-md-9"> - <div class="github-callout"> - <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/> - <!-- - <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/assets.md";>this article on github</a>.</div> - --> - </div> - </div> - </div> -</div> - - -<footer class="bf-footer" role="contentinfo"> - <div class="container"> - <div class="row"> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="/">Home</a></li> - <li class="nav-header"><a href="/community/">Community</a></li> - <li><a href="/community/#events">Events</a></li> - <li><a href="/community/#mailing-lists">Mailing Lists</a></li> - <li><a href="/community/#deployments">Deployments</a></li> - <li><a href="/community/#committers">Commiters</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/"; target="_blank">Code</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack"; target="_blank">Server Stack</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal"; target="_blank">Admin Portal</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc"; target="_blank">ugc command line</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios"; target="_blank">iOS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android"; target="_blank">Android SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript"; target="_blank">HTML5/JS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs"; target="_blank">node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails"; target="_blank">Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby"; target="_blank">Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php"; target="_blank">PHP SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java"; target="_blank">Java SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/dotnet"; target="_blank">.NET / Windows SDK</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Resources</li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank">GitHub Code</a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank">Docs</a></li> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank">JIRA Bug Tracker</a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank">StackOverflow</a></li> - <li><a href="/community/#live">Live Chat</a></li> - <li><a href="https://twitter.com/usergrid"; target="_blank">Twitter</a></li> - <li><a href="http://incubator.apache.org/projects/usergrid.html"; target="_blank">Podling Listing</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack#requirements"; target="_blank">Getting Started</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow"; target="_blank">Contribution Guidelines</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Apache</li> - <li><a href="http://www.apache.org/licenses/"; target="_blank">License</a></li> - <li><a href="http://www.apache.org/foundation/sponsorship.html"; target="_blank">Sponsorship</a></li> - <li><a href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a></li> - <li><a href="http://www.apache.org/security/";>Security</a></li> - <li><a href="http://www.apache.org/"; target="_blank">Apache Foundation</a></li> - </ul> - </div> - <div class="col-md-4"> - <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"; data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a> - <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </div> - <!-- - <div class="col-md-4"> - <div class="input-group form-search"> - <input type="text" class="form-control search-query"> - <span class="input-group-btn"> - <button type="submit" class="btn btn-primary" data-type="last">Search</button> - </span> - </div> - </div> --> - </div> - <div class="row"> - <div id="copyright"> - <img src="/img/egg-logo.png" /><br/><br/> - <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> - <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br> - Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p> - <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee";>@ryuneeee</a> + <a href="https://github.com/realbeast";>@realbeast</a> + <a href="https://twitter.com/timanglade";>@timanglade</a>.</p> - </div> - </div> - </div> -</footer> - -<script type="text/javascript" src="/js/head.js"></script> -<script type="text/javascript"> - head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js"); -</script> -<script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-45815079-1', 'apache.org'); - ga('send', 'pageview'); - -</script> - - - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/authenticating-users-and-application-clients/index.html ---------------------------------------------------------------------- diff --git a/content/docs/authenticating-users-and-application-clients/index.html b/content/docs/authenticating-users-and-application-clients/index.html deleted file mode 100644 index 26deb0e..0000000 --- a/content/docs/authenticating-users-and-application-clients/index.html +++ /dev/null @@ -1,439 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Authenticating users and application clients</title> - <meta http-equiv="x-ua-compatible" content="ie=edge" /> - <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> - <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service"> - <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <meta property="og:title" content="Apache Usergrid" /> - <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <!-- Loading Typekit --> - <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script> - <script type="text/javascript">try{Typekit.load();}catch(e){}</script> - <!-- Loading Bootstrap --> - <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'> - <link href="/css/bootflat.css" rel="stylesheet" type='text/css'> - <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'> - <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"; rel="stylesheet" type="text/css"> - <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'> - - - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. --> - <!--[if lt IE 9]> - <script src="js/html5shiv.js"></script> - <script src="js/respond.min.js"></script> - <![endif]--> -</head> -<body> - - <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner"> - <div class="container"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - </div> - <a href="/" class="navbar-brand"> - <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" /> - </a> - <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav navbar-right"> - <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank"><span class="icns icon-book"></span></a></li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank"><span class="icns icon-github-sign"></span></a></li> - <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid"; target="_blank"><span class="icns icon-trello"></span></a></li>--> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank"><span class="icns icon-bug"></span></a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank"><span class="icns icon-stackexchange"></span></a></li> - <li><a href="/community/#live"><span class="icns icon-comments"></span></a></li> - <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"; target="_blank"><span class="icns icon-envelope"></span></a></li>--> - <li><a href="https://twitter.com/usergrid"; target="_blank"><span class="icns icon-twitter"></span></a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/"; target="_blank"><span class="icns icon-wiki"></span></a></li> - <li><a href="/releases/"><span class="icns icon-releases"></span></a></li> - </ul> - </nav> - </div> - </header> - - - -<div class="container bf-docs-container"> - <div class="row"> - <div class="col-md-3"> - <div class="bf-sidebar hidden-print" role="complementary"> - <ul class="nav nav-list"> - <li><a href="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li> - <li><a href="/docs/deploy-local/">Deploying to local Tomcat & Cassandra</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc";><code>ugc</code> â the Command-line Client</a></li> - - <li class="nav-header"><span>Concepts</span></li> - <li> - <a href="/docs/organizations-admins/">Organizations & Admins</a> - <ul> - <li> - <a href="/docs/applications/">Applications</a> - <ul> - <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li> - <!--<li><a href="#">Queues</a></li>--> - <li><a href="/docs/events-and-counters/">Events & Counters</a></li> - <li><a href="/docs/relationships/">Relationships (Joins)</a></li> - <li> - <a href="/docs/collections">Collections</a> - <ul> - <li><a href="/docs/query-language/">Query Language</a></li> - <li><a href="/docs/users-devices/">Users & Devices</a></li> - <li><a href="/docs/groups/">Groups</a></li> - <li><a href="/docs/activities/">Activities</a></li> - <li><a href="/docs/assets/">Assets</a></li> - </ul> - </li> - </ul> - </li> - </ul> - </li> - - - <li class="nav-header"><span>Usage</span></li> - <!-- <li>REST API â Coming Soon</li> --> - <li><a class="icns-apple" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ios";>iOS SDK</a></li> - <li><a class="icns-android" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/android";>Android SDK</a></li> - <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li> - <li><a class="icns-windows" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet";>Windows 8 / Windows Phone / .net SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs";>Node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby";>Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails";>Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php";>PHP library</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/java";>Java library</a></li> - - <!--<li class="nav-header"><span>Internals</span></li> - <li>Design & Goals â Coming Soon</li> - <li>Java Architecture â Coming Soon</li> - <li>Cassandra Schema â Coming Soon</li>--> - - <li class="nav-header"><span>Operations</span></li> - <!--<li>Deploying â Coming Soon</li>--> - <!-- <li>Monitoring â Coming Soon</li> --> - <li><a href="/docs/upgrading/">Upgrading</a></li> - <!-- <li>Security â Coming Soon</li> --> - - <li class="nav-header"><span>Presentations & Videos</span></li> - <li><a href="/docs/presentations/">Presentations</a></li> - <li><a href="/docs/videos/">Videos</a></li> - - <li class="nav-header"><span>We need your help!</span></li> - <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li> - <!-- - <li><a href="/docs/contribute-docs">How to contribute docs</a></li> - --> - </ul> - </div> - </div> - - <div class="col-md-9 main-article" role="main"> - <div class="page-article"> - <div class="page-header"> - <h1>Authenticating users and application clients</h1> - <!-- TODO: reenable this when we sync SVN to GitHub - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/authenticating-users-and-application-clients.md";>contribute to this article on github</a></small> - --> - </div> - <div class="toc"> - <ul> -<li> -<a href="#authenticating-users-and-application-clients">Authenticating users and application clients</a><ul> -<li><a href="#authentication-levels">Authentication levels</a></li> -<li> -<a href="#adding-code-to-support-authentication">Adding code to support authentication</a><ul> -<li><a href="#using-an-access-token">Using an access token</a></li> -<li><a href="#authenticating-asapplication-user">Authenticating as Application User</a></li> -<li><a href="#authenticating-asapplication">Authenticating as Application</a></li> -<li><a href="#authenticating-asadmin-user">Authenticating as Admin User</a></li> -<li><a href="#authenticating-asorganization">Authenticating as Organization</a></li> -</ul> -</li> -<li> -<a href="#authentication-token-time-to-live">Authentication token time to live</a><ul> -<li><a href="#changing-the-default-time-to-live">Changing the default time-to-live</a></li> -<li><a href="#changing-token-time-to-live">Changing token time-to-live</a></li> -</ul> -</li> -<li><a href="#revoking-authentication-tokens">Revoking authentication tokens</a></li> -<li><a href="#safe-mobile-access">Safe mobile access</a></li> -</ul> -</li> -</ul> -</div> -<h1 id="authenticating-users-and-application-clients">Authenticating users and application clients</h1> -<p>To protect your Apache Usergrid application data, one of the steps youâll take is to authenticate your appâs users. By ensuring that they are who they say they are, you can help ensure that your applicationâs data is available in secure ways. After youâve created permission rules that define access to your application and have associated these rules with users, youâll want to add code that authenticates your user, as described in this topic.</p> -<p><strong>Note: </strong>You manage access to your applicationâs data by creating permission rules that govern which users can do what. Users authenticated as Application User have access according to these rules. For more about managing permissions, see <a href="/managing-access-defining-permission-rules">Managing access by defining permission rules</a>.</p> -<h2 id="authentication-levels">Authentication levels</h2> -<p>Apache Usergrid supports four levels of authentication, but only one of them is used when checking a registered userâs permissions. The other three levels are useful for authenticating other web applications that want to access to your Apache Usergrid application. Because the scope of access that the other authentication levels provide is so broad (and as a result, so powerful), itâs a bad practice to use them from a mobile app. Instead, theyâre better suited to other client apps, such as web applications.</p> -<p>The following table describes each of the authentication levels. Note that only one of these is configurable using the admin portal. The others are independent of Application User level access, which is governed by permission rules you define (usually with the admin portal). In contrast, the level of acces provided by the others is only as described in the notes.</p> -<table> -<col width="25%"> -<col width="25%"> -<col width="25%"> -<col width="25%"> -<thead> -<tr class="header"> -<th align="left">Authentication Level</th> -<th align="left">Description</th> -<th align="left">Permissions Configurable in Admin Portal</th> -<th align="left">Notes</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>Application User</p></td> -<td align="left"><p>Allows access to your Apache Usergrid application as governed by the permission rules you create and associated with users and user groups.</p></td> -<td align="left"><p>Yes |</p></td> -<td align="left"> -<p>You allow specific | access to application resources by creating permission rules, then associating these rules with users. Typically, youâll begin by creating roles, then create permission rules for the roles, then associate the roles with users (or groups of users).</p> -<p>Each Application User is represented by a User entity in your Apache Usergrid application. (For more about the User entity, see <a href="/user">User</a>.)</p> -<p>For more about roles and permissions, see <a href="/managing-a%20ccess-defining-per%20mission-rules">Managing access by defining permission rules</a>. For a look at how security features fit together, see <a href="/app-sec%20urity-overview">App Security Overview</a>.</p> -</td> -</tr> -<tr class="even"> -<td align="left"><p>Application</p></td> -<td align="left"><p>Allows full access to perform any operation on an Apache Usergrid application account (but not other applications within the same organization). Should not be used from a mobile client.</p></td> -<td align="left"> -<p>No</p> -<p>|</p> -</td> -<td align="left"> -<p>Authentication at this level is useful in a | server-side application (not a mobile app) that needs access to resources through the Apache Usergrid API.</p> -<p>Imagine that you created a web site that lists every hiking trail in the Rocky Mountains. Anyone can go to the web site and view the content. However, you donât want anyone to have access to the App Services API, where all the data is stored. But you do want to give your web server access so that it can generate the pages to serve to the websiteâs visitors.</p> -<p><strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobi%20le">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -</td> -</tr> -<tr class="odd"> -<td align="left"><p>Admin User</p></td> -<td align="left"><p>Allows full access to perform any operation on all organization accounts of which the admin user is a member. Should not be used from a mobile client.</p></td> -<td align="left"><p>No</p></td> -<td align="left"> -<p>This authentication level is useful from applications that provide organization-wide administration features. For example, the App Services admin portal uses this level of access because it requires full access to the administration features.</p> -<p>Unless you have a specific need for administrative features, such as to run test scripts that require access to management functionality, you should not use the admin user authentication level.</p> -<p><strong>Note:</strong> Currently, organization and admin user access are effectively the same. Eventually, the admin user level will be a configurable subset of the organization level of access. <strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobi%20le">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -</td> -</tr> -<tr class="even"> -<td align="left"><p>Organization</p></td> -<td align="left"><p>Full access to perform any operation on an Apache Usergrid organization. Should not be used from a mobile client.</p></td> -<td align="left"> -<p>No</p> -<p>|</p> -</td> -<td align="left"> -<p>Providing the greatest amount of access, this | authentication level lets a client perform any operation on an Apache Usergrid organization. This level of access should be used sparingly and carefully.</p> -<p><strong>Note:</strong> Currently, organization and admin user access are effectively the same. Eventually, the admin user level will be a configurable subset of the organization level of access. <strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobi%20le">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -</td> -</tr> -</tbody> -</table> -<h2 id="adding-code-to-support-authentication">Adding code to support authentication</h2> -<h3 id="using-an-access-token">Using an access token</h3> -<p>When you obtain an access token, you must provide it with every subsequent API call that you make. There are two ways to provide your access token.</p> -<ul> -<li><p>You can add the token to the API query string:<br><br> https://api.usergrid.com/{org-name}/{app-name}/users?access_token={access_token}</p></li> -<li><p>You can include the token in an HTTP authorization header:<br><br> Authorization: Bearer {access_token}</p></li> -</ul> -<p><strong>Note:</strong> The App services documentation assumes you are providing a valid access token with every API call whether or not it is shown explicitly in the examples. Unless the documentation specifically says that you can access an API endpoint without an access token, you should assume that you must provide it. One application that does not require an access token is the sandbox application. The Guest role has been given full permissions (/** for GET, POST, PUT, and DELETE) for this application. This eliminates the need for a token when making application level calls to the sandbox app. For further information on specifying permissions, see <a href="/managing-access-defining-permission-rules">Managing access by defining permission rules</a>.</p> -<h3 id="authenticating-asapplication-user">Authenticating as Application User</h3> -<p>Using the username and password values specified when the user entity was created, your app can connect to the Apache Usergrid application endpoint to request an access token. (Note that itâs also possible to use the userâs email address in place of the username.) Here is an example in cURL format of a request for application user access:</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/my-org/my-app/token"; -d '{"grant_type":"password","username":"john.doe","password":"testpw"}'</code></pre> -<p>The results include the access token needed to make subsequent API requests on behalf of the application user:</p> -<pre><code>{ -"access_token": "5wuGd-lcEeCUBwBQVsAACA:F8zeMOlcEeCUBwBQVsAACA:YXU6AAABMq0hdy4Lh0ewmmnOWOR-DaepCrpWx9oPmw", -"expires_in": 3600, -"user": { -... -} -} - </code></pre> -<h3 id="authenticating-asapplication">Authenticating as Application</h3> -<p>Using your appâs client id and client secret values, your app can connect to the Apache Usergrid application endpoint to request an access token. Here is an example in cURL format of a request for application access:</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/my-org/my-app/token"; -d '{"grant_type":"client_credentials","client_id":"YXB7NAD7EM0MEeJ989xIxPRxEkQ","client_secret":"YXB7NAUtV9krhhMr8YCw0QbOZH2pxEf"}'</code></pre> -<p>The results include the access token needed to make subsequent API requests on behalf of the application:</p> -<pre><code>{ -"access_token": "F8zeMOlcEeCUBwBQVsAACA:YXA6AAABMq0d4Mep_UgbZA0-sOJRe5yWlkq7JrDCkA", -"expires_in": 3600, -"application": { -... -} -} - </code></pre> -<p><strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobile">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -<h3 id="authenticating-asadmin-user">Authenticating as Admin User</h3> -<p>If you do require admin user access, your app can connect to the App Services management endpoint to request an access token. Your app supplies the username and password of an admin user in the request. Here is an example in cURL format of a request for admin user access:</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/management/token"; -d '{"grant_type":"password","username":"testadmin","password":"testadminpw"}'</code></pre> -<p>The results include the access token needed to make subsequent API requests on behalf of the admin user:</p> -<pre><code>{ -"access_token": "f_GUbelXEeCfRgBQVsAACA:YWQ6AAABMqz_xUyYeErOkKjnzN7YQXXlpgmL69fvaA", -"expires_in": 3600, -"user": { -... -} -} - </code></pre> -<p><strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobile">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -<h3 id="authenticating-asorganization">Authenticating as Organization</h3> -<p>If you do require organization level access, your app can connect to the Apache Usergrid management endpoint to request an access token. Access to an organization requires the client id and client secret credentials. Here is an example in cURL format of a request for organization access:</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/management/token"; -d '{"grant_type":"client_credentials","client_id":"YXB7NAD7EM0MEeJ989xIxPRxEkQ","client_secret":"YXB7NAUtV9krhhMr8YCw0QbOZH2pxEf"}'</code></pre> -<p>The results include the access token needed to make subsequent API requests to the organization:</p> -<pre><code>{ -"access_token": "gAuFEOlXEeCfRgBQVsAACA:b3U6AAABMqz-Cn0wtDxxkxmQLgZvTMubcP20FulCZQ", -"expires_in": 3600, -"organization": { -... -} -} - </code></pre> -<p><strong>Warning:</strong> You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See <a href="#safe_mobile">Safe mobile access</a> for additional considerations in keeping access to your app and its data secure.</p> -<h2 id="authentication-token-time-to-live">Authentication token time to live</h2> -<p>An access token has a âtime-to-liveâ, which is the maximum time that the access token will be valid for use within the application, specified in milliseconds. By default, all tokens have a system-defined time-to-live of 24 hours.</p> -<h3 id="changing-the-default-time-to-live">Changing the default time-to-live</h3> -<p>You can change the default time-to-live for all application tokens by updating the Application entityâs accesstokenttl property. </p> -<p>For example, the following updates an application entity to have a default time-to-live value of 1800000 miliseconds (30 minutes) for all tokens:</p> -<pre><code>curl -X PUT -i -H "Content-Type: application/json" "https://api.usergrid.com/my-org/my-app"; -d '{"accesstokenttl":"1800000"}'</code></pre> -<h3 id="changing-token-time-to-live">Changing token time-to-live</h3> -<p>When you request an access token, you can override its time-to-live by including a ttl parameter in the request.</p> -<p>The ttl value must be equal to or less than the value of the accesstokenttl property. If you specify a ttl value greater than the value of accesstokenttl, an error message is returned that indicates the maximum time to live value that can be specified.</p> -<p><strong>Note: </strong>If you set ttl=0, the token will never expire. This can pose a security risk and should be used with caution.</p> -<p>For example, the following sets a time to live value of 1800000 miliseconds (30 minutes) for an admin user:</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/management/token?ttl=1800000"; -d '{"grant_type":"client_credentials","client_id":"YXB7NAD7EM0MEeJ989xIxPRxEkQ","client_secret":"YXB7NAUtV9krhhMr8YCw0QbOZH2pxEf"}'</code></pre> -<p>The following sets the same time to live value for an application user.</p> -<pre><code>curl -X POST -i -H "Content-Type: application/json" "https://api.usergrid.com/my-org/my-app/token?ttl=1800000"; -d '{"grant_type":"password","username":"testadmin","password":"testadminpw"}'</code></pre> -<h2 id="revoking-authentication-tokens">Revoking authentication tokens</h2> -<p>Under certain circumstances, you may need to explicitly revoke a userâs access token, such as when a user logs out. To revoke a specific authentication token, send the following <code>PUT</code> request:</p> -<pre><code>curl -X PUT https://api.usergrid.com/<org_name>/<app_name>/users/<user_uuid_or_username>/revoketokens?token="<token>";</code></pre> -<p>If the token is successfully revoked, you will receive the following response from the API:</p> -<pre><code>{ - "action" : "revoked user token", - "timestamp" : 1382050891455, - "duration" : 24 -}</code></pre> -<h2 id="safe-mobile-access">Safe mobile access</h2> -<p>For mobile access, it is recommended that you connect as an application user with configured access control policies. Mobile applications are inherently untrusted because they can be easily examined and even decompiled.</p> -<p>Any credentials stored in a mobile app should be considered secure only to the Application User level. This means that if you donât want the user to be able to access or delete data in your Apache Usergrid application, you need to make sure that you donât enable that capability through roles or permissions. Because most web applications talk to the database using some elevated level of permissions, such as root, itâs generally a good idea for mobile applications to connect with a more restricted set of permissions. For more information on restricting access through permission rules, see <a href="/managing-access-defining-permission-rules">Managing access by defining permission rules</a>.</p> - </div> - </div> - </div> - <div class="row"> - <div class="col-md-3"></div> - <div class="col-md-9"> - <div class="github-callout"> - <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/> - <!-- - <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/authenticating-users-and-application-clients.md";>this article on github</a>.</div> - --> - </div> - </div> - </div> -</div> - - -<footer class="bf-footer" role="contentinfo"> - <div class="container"> - <div class="row"> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="/">Home</a></li> - <li class="nav-header"><a href="/community/">Community</a></li> - <li><a href="/community/#events">Events</a></li> - <li><a href="/community/#mailing-lists">Mailing Lists</a></li> - <li><a href="/community/#deployments">Deployments</a></li> - <li><a href="/community/#committers">Commiters</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/"; target="_blank">Code</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack"; target="_blank">Server Stack</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal"; target="_blank">Admin Portal</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc"; target="_blank">ugc command line</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios"; target="_blank">iOS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android"; target="_blank">Android SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript"; target="_blank">HTML5/JS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs"; target="_blank">node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails"; target="_blank">Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby"; target="_blank">Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php"; target="_blank">PHP SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java"; target="_blank">Java SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/dotnet"; target="_blank">.NET / Windows SDK</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Resources</li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank">GitHub Code</a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank">Docs</a></li> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank">JIRA Bug Tracker</a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank">StackOverflow</a></li> - <li><a href="/community/#live">Live Chat</a></li> - <li><a href="https://twitter.com/usergrid"; target="_blank">Twitter</a></li> - <li><a href="http://incubator.apache.org/projects/usergrid.html"; target="_blank">Podling Listing</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack#requirements"; target="_blank">Getting Started</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow"; target="_blank">Contribution Guidelines</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Apache</li> - <li><a href="http://www.apache.org/licenses/"; target="_blank">License</a></li> - <li><a href="http://www.apache.org/foundation/sponsorship.html"; target="_blank">Sponsorship</a></li> - <li><a href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a></li> - <li><a href="http://www.apache.org/security/";>Security</a></li> - <li><a href="http://www.apache.org/"; target="_blank">Apache Foundation</a></li> - </ul> - </div> - <div class="col-md-4"> - <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"; data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a> - <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </div> - <!-- - <div class="col-md-4"> - <div class="input-group form-search"> - <input type="text" class="form-control search-query"> - <span class="input-group-btn"> - <button type="submit" class="btn btn-primary" data-type="last">Search</button> - </span> - </div> - </div> --> - </div> - <div class="row"> - <div id="copyright"> - <img src="/img/egg-logo.png" /><br/><br/> - <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> - <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br> - Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p> - <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee";>@ryuneeee</a> + <a href="https://github.com/realbeast";>@realbeast</a> + <a href="https://twitter.com/timanglade";>@timanglade</a>.</p> - </div> - </div> - </div> -</footer> - -<script type="text/javascript" src="/js/head.js"></script> -<script type="text/javascript"> - head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js"); -</script> -<script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-45815079-1', 'apache.org'); - ga('send', 'pageview'); - -</script> - - - -</body> -</html>
