http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/introduction/usergrid-features.html ---------------------------------------------------------------------- diff --git a/content/docs/introduction/usergrid-features.html b/content/docs/introduction/usergrid-features.html new file mode 100644 index 0000000..496a33d --- /dev/null +++ b/content/docs/introduction/usergrid-features.html @@ -0,0 +1,449 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Usergrid Features — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/> + <link rel="next" title="Usergrid Data model" href="data-model.html"/> + <link rel="prev" title="Apache Usergrid Documentation" href="../index.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="../index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid Features</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#data-storage-management">Data storage & management</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#application-data">Application data</a></li> +<li class="toctree-l3"><a class="reference internal" href="#files-assets">Files & assets</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#flexible-data-querying">Flexible data querying</a></li> +<li class="toctree-l2"><a class="reference internal" href="#social">Social</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#entity-relationships">Entity relationships</a></li> +<li class="toctree-l3"><a class="reference internal" href="#activity-streams">Activity streams</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#user-management">User management</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#registration-and-login">Registration and login</a></li> +<li class="toctree-l3"><a class="reference internal" href="#roles-permissions">Roles & permissions</a></li> +<li class="toctree-l3"><a class="reference internal" href="#groups">Groups</a></li> +<li class="toctree-l3"><a class="reference internal" href="#third-party-authentication">Third-party authentication</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#geolocation">Geolocation</a></li> +<li class="toctree-l2"><a class="reference internal" href="#push-notifications">Push notifications</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1"><a class="reference internal" href="async-vs-sync.html">Async vs. sync calls</a></li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & 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>Usergrid Features</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/introduction/usergrid-features.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="usergrid-features"> +<h1>Usergrid Features<a class="headerlink" href="#usergrid-features" title="Permalink to this headline">¶</a></h1> +<p>Usergrid provides developers with access to a flexible data store and +enables you to quickly integrate valuable features into your app, +including social graphs, user management, data storage, push +notifications, performance monitoring, and more.</p> +<p>With Usergrid, developers can set up their own cloud-based data platform +in minutes instead of months â no server-side coding or back-end +development needed. This allows your developers to focus on developing +the rich features and user experience that truly differentiate your app, +rather than on the time-consuming details of implementing core back-end +services and infrastructure.</p> +<div class="section" id="data-storage-management"> +<h2>Data storage & management<a class="headerlink" href="#data-storage-management" title="Permalink to this headline">¶</a></h2> +<div class="section" id="application-data"> +<h3>Application data<a class="headerlink" href="#application-data" title="Permalink to this headline">¶</a></h3> +<p>At the core of Usergrid is a flexible platform that can store any type +of application data, from simple records like a catalog of books to +complex associations like user relationships. No matter what type of +data drives your app, you can store it as collections of data entities +and immediately perform complex queries or full-text searches on any +field. You can also create custom entities with custom properties, +giving you the ability to store data and context in a way that makes +sense for your app.</p> +<p>To learn more about entities and collections, see Usergrid Data model.</p> +<p>For a complete list of the default data entities available, see Default +Data Entity Types.</p> +</div> +<div class="section" id="files-assets"> +<h3>Files & assets<a class="headerlink" href="#files-assets" title="Permalink to this headline">¶</a></h3> +<p>Images, video, and audio are key components of a great app experience. +With Usergrid, you can upload and retrieve binary objects from the same +data store as the rest of your application data, eliminating the need to +set up content delivery networks (CDNs) and easing implementation. We +handle all the back-end details that keep your content quickly +accessible.</p> +<p>To learn more about files and asset storage, see Uploading files and +assets .</p> +</div> +</div> +<div class="section" id="flexible-data-querying"> +<h2>Flexible data querying<a class="headerlink" href="#flexible-data-querying" title="Permalink to this headline">¶</a></h2> +<p>One of Usergrid’ most powerful features is the ability to perform +SQL-style queries and full-text searches on data entities, as well as +their properties. This lets you quickly retrieve specific data entities +based on multiple criteria, then utilize that data to power social +features, target push notifications, perform user analysis, and more.</p> +<p>Learn more about querying app data, see Data query overview.</p> +</div> +<div class="section" id="social"> +<h2>Social<a class="headerlink" href="#social" title="Permalink to this headline">¶</a></h2> +<div class="section" id="entity-relationships"> +<h3>Entity relationships<a class="headerlink" href="#entity-relationships" title="Permalink to this headline">¶</a></h3> +<p>You can create relationships between data entities to help build +features, improve user experience, and contextualize data. For example, +you might associate a user with their devices to capture valuable +geolocation data, create relationships between users to build social +graphs, or implement popular features such as activity streams.</p> +<p>To learn more about entity relationships, see Entity connections.</p> +</div> +<div class="section" id="activity-streams"> +<h3>Activity streams<a class="headerlink" href="#activity-streams" title="Permalink to this headline">¶</a></h3> +<p>A key aspect of social networking apps is the ability to provide and +publish data streams of user actions, such as ongoing lists of comments, +activities, and tweets. Usergrid simplifies management and routing of +these data streams by providing an activity entity that is specifically +designed to automatically create a relationship between activities and +the user who created them.</p> +<p>To learn more about activities and activity feeds, see Activity feeds.</p> +</div> +</div> +<div class="section" id="user-management"> +<h2>User management<a class="headerlink" href="#user-management" title="Permalink to this headline">¶</a></h2> +<div class="section" id="registration-and-login"> +<h3>Registration and login<a class="headerlink" href="#registration-and-login" title="Permalink to this headline">¶</a></h3> +<p>You can easily add and manage users by providing the core services +necessary to handle secure registration and log in, including OAuth +2.0-compliant client authentication. In addition, any number of default +or custom data entities and properties can be associated with a user +entity to create complete user profiles.</p> +<p>To learn more about user management, see User.</p> +<p>To learn more about authentication, see Authenticating users and +application clients.</p> +</div> +<div class="section" id="roles-permissions"> +<h3>Roles & permissions<a class="headerlink" href="#roles-permissions" title="Permalink to this headline">¶</a></h3> +<p>Applications often require the ability to configure fine-grain control +of user access to data, features and functionality. Usergrid solves the +implementation details of user access with roles and permissions. Simply +create roles that represent user types or access levels, such as +Administrator, then assign the necessary permissions to that role. With +a single API call, you can then associate your roles with any user or +group of users.</p> +<p>To learn more about user roles and permissions, see Managing access by +defining permission rules.</p> +</div> +<div class="section" id="groups"> +<h3>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h3> +<p>Groups are a flexible way to organize your users based on any number of +criteria. For example, you might group users based on interests or +location to more effectively deliver relevant content, target offers, or +customize campaigns. You can also take advantage of the groups entity to +enable group-based social networking activities, such as allowing your +users to create private information feeds or circles of friends.</p> +<p>To learn more about groups, see Working with group data.</p> +</div> +<div class="section" id="third-party-authentication"> +<h3>Third-party authentication<a class="headerlink" href="#third-party-authentication" title="Permalink to this headline">¶</a></h3> +<p>In addition to supporting user management and OAuth-based login for your +app, Usergrid also makes it easy to integrate third-party authentication +through such popular services as Facebook, Twitter and other +OAuth-enabled accounts. Providing third-party sign-in can improve user +experience, while increasing adoption, giving you access to valuable +information from social networks and services.</p> +<p>To learn more about using third-party sign-in, see Facebook sign in.</p> +</div> +</div> +<div class="section" id="geolocation"> +<h2>Geolocation<a class="headerlink" href="#geolocation" title="Permalink to this headline">¶</a></h2> +<p>The device entity allows you to capture geolocation data from your +users’ GPS-enabled devices to more effectively target campaigns, push +notifications, offers and more. Geolocation also gives you an important +data point for contextualizing and analyzing trends and user behavior.</p> +<p>To learn more about geolocation, see Geolocation.</p> +</div> +<div class="section" id="push-notifications"> +<h2>Push notifications<a class="headerlink" href="#push-notifications" title="Permalink to this headline">¶</a></h2> +<p>Push notifications are the most effective way to engage your users with +relevant content, and thanks to Usergrid, implementing them can be done +in minutes. Simply register your app and your user’s devices with a +notification provider, such as Apple Push Notification Service or Google +Cloud Messaging, then use the Usergrid notification entity to send +millions of push notifications a month at no cost. When used in +conjunction with queries of user and application data, push +notifications become a powerful tool for leveraging user data, ensuring +relevancy and driving engagement.</p> +<p>To learn more about push notifications, see Push notifications overview.</p> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="data-model.html" class="btn btn-neutral float-right" title="Usergrid Data model" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../index.html" class="btn btn-neutral" title="Apache Usergrid Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © 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/objects.inv ---------------------------------------------------------------------- diff --git a/content/docs/objects.inv b/content/docs/objects.inv new file mode 100644 index 0000000..aeca549 Binary files /dev/null and b/content/docs/objects.inv differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/orgs-and-apps/admin-user.html ---------------------------------------------------------------------- diff --git a/content/docs/orgs-and-apps/admin-user.html b/content/docs/orgs-and-apps/admin-user.html new file mode 100644 index 0000000..6696baa --- /dev/null +++ b/content/docs/orgs-and-apps/admin-user.html @@ -0,0 +1,780 @@ + + +<!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>Admin user$ — 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="managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="organization.html">Organization</a></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>Admin user$</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/orgs-and-apps/admin-user.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="admin-user"> +<h1>Admin user$<a class="headerlink" href="#admin-user" title="Permalink to this headline">¶</a></h1> +<p>An admin user has full access to perform any operation on all +organization accounts of which the admin user is a member. Using the API +Services BaaS API, you can create, update, or retrieve an admin user. +You can also set or reset an admin user’s password, activite or +reactivate an admin user, and get an admin user’s activity feed.</p> +<p>In addition, you can add, retrieve, or remove an admin user from an +organization. For information on these organization-related operations, +see <a class="reference external" href="organization.html">Organization</a>.</p> +<p><strong>Note</strong>: Although not shown in the API examples below, you need to +provide a valid access token with each API call. See <a class="reference external" href="../security_and_auth/authenticating-users-and-application-clients.html">Authenticating +users and application +clients</a> +for details.</p> +<div class="section" id="creating-an-admin-user"> +<h2>Creating an admin user<a class="headerlink" href="#creating-an-admin-user" title="Permalink to this headline">¶</a></h2> +<p>Use the POST method to create an admin user.</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 /management/organizations/{org}/users {request body} +</pre></div> +</div> +<p>In the request body send a JSON object that represents the new user, for +example:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"username"</span> <span class="p">:</span> <span class="s">"jim.admin"</span><span class="p">,</span> + <span class="s">"email"</span> <span class="p">:</span> <span class="s">"jim.ad...@gmail.com"</span><span class="p">,</span> + <span class="s">"name"</span> <span class="p">:</span> <span class="s">"Jim Admin"</span><span class="p">,</span> + <span class="s">"password"</span> <span class="p">:</span> <span class="s">"test12345"</span> +<span class="p">}</span> +</pre></div> +</div> +</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/organizations/my-org/users" -d '{"username":"jim.admin","name":"Jim Admin","email":"jim.ad...@gmail.com","password":"test12345"}' +</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": "post", + "status": "ok", + "data": { + "user": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "jim.admin", + "name": "Jim Admin", + "email": "jim.ad...@gmail.com", + "activated": true, + "disabled": false, + "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591", + "adminUser": true, + "displayEmailAddress": "jim.admin <jim.ad...@gmail.com>", + "htmldisplayEmailAddress": "jim.admin <a href="mailto:jim.ad...@gmail.com">jinm.ad...@gmail.com</a>" + } + }, + "timestamp": 1349390189106, + "duration": 11808 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="updating-an-admin-user"> +<h2>Updating an admin user<a class="headerlink" href="#updating-an-admin-user" title="Permalink to this headline">¶</a></h2> +<p>Use the PUT method to update an admin user.</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>PUT /management/organizations/{org}/users/{user|username|email|uuid} {request body} +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="79%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>User identifier</td> +<td>Username, name, email address, or UUID.</td> +</tr> +<tr class="row-odd"><td>request body</td> +<td>JSON object containing propties you would like to add/update on user.</td> +</tr> +</tbody> +</table> +<p>For example, to add city and state to user, send this:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"city"</span> <span class="p">:</span> <span class="s">"San Francisco"</span><span class="p">,</span> + <span class="s">"state"</span> <span class="p">:</span> <span class="s">"California"</span> +<span class="p">}</span> +</pre></div> +</div> +</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 -i PUT "https://api.usergrid.com/management/organizations/my-org/users/jim.admin" -d '{"city":"San Francisco","state":"California"}' +</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><span class="p">{</span> + <span class="s">"action"</span><span class="p">:</span> <span class="s">"update user info"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349479321874</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-an-admin-user"> +<h2>Getting an admin user<a class="headerlink" href="#getting-an-admin-user" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve details about an admin user.</p> +<div class="section" id="id4"> +<h3>Request URI<a class="headerlink" href="#id4" 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">management</span><span class="o">/</span><span class="n">organizations</span><span class="o">/</span><span class="p">{</span><span class="n">org</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">user</span><span class="o">|</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="28%" /> +<col width="72%" /> +</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>User identifier</td> +<td>Admin username, name, email address, or UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id5"> +<h3>Example - Request<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin" +</pre></div> +</div> +</div> +<div class="section" id="id6"> +<h3>Example - Response<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "action": "get admin user", + "status": "ok", + "data": { + "username": "jim.admin", + "token": "YWMt4NqE8Q9GEeLYJhIxPSiO4AAAATo5fQfcG0cEd2h9nwmDmRorkNNrEeQyDOF", + "email": "edo...@gmail.com", + "organizations": { + "jim.admin": { + "users": { + "jim.admin": { + "applicationId": "00000000-0000-0000-0000-000000000001", + "username": "jim.admin", + "name": "Jim Admin", + "email": "jim.ad...@gmail.com", + "activated": true, + "disabled": false, + "uuid": "328b526e-cd0c-11e1-bcf8-12424d1c4491", + "adminUser": true, + "displayEmailAddress": "jim.admin <jim.ad...@gmail.com>", + "htmldisplayEmailAddress": "jim.admin <<a href="mailto:jim.ad...@gmail.com">jim.ad...@gmail.com>" + }, + ... + "adminUser": true, + "activated": true, + "name": "edort1", + "applicationId": "00000000-0000-0000-0000-000000000001", + "uuid": "328b526e-cd0c-11e1-bcf8-12424d1c4491", + "htmldisplayEmailAddress": "jim.admin <<a href="mailto:jim.ad...@gmail.com">jim.ad...@gmail.com>>", + "displayEmailAddress": "jim.admin <jim.ad...@gmail.com>", + "disabled": false + }, + "timestamp": 1349480786906 +} +</pre></div> +</div> +</div> +</div> +<div class="section" id="setting-an-admin-user-s-password"> +<h2>Setting an admin user’s password<a class="headerlink" href="#setting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h2> +<p>Use the PUT method to update an admin user’s password.</p> +<div class="section" id="id7"> +<h3>Request URI<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>PUT /management/users/{user|username|email|uuid}/password {request body} +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="72%" /> +</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>User identifier</td> +<td>Admin username, name, email address, or UUID.</td> +</tr> +</tbody> +</table> +<p>Expects new and old password to be sent in request body:</p> +<div class="highlight-python"><div class="highlight"><pre>{ + "password": <old_password> + "newpassword":<new_password> +} +</pre></div> +</div> +</div> +<div class="section" id="id8"> +<h3>Example - Request<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X -i PUT "https://api.usergrid.com/management/users/jim.admin/password" -d '{"oldpassword":"test123", "newpassword":"mynewpassword"}' +</pre></div> +</div> +</div> +<div class="section" id="id9"> +<h3>Example - Response<a class="headerlink" href="#id9" 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">"set user password"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349714010142</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="resetting-an-admin-user-s-password"> +<h2>Resetting an admin user’s password<a class="headerlink" href="#resetting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h2> +<p>Resetting an admin user’s password is a two step process. In the first +step, you initiate the password reset. This returns a browser page. The +page includes a field for the user to enter his or her email address, +and a field to enter a response to a Captcha challenge. In the second +step, you handle the user’s responses from the form.</p> +<div class="section" id="initiating-a-password-reset"> +<h3>Initiating a password reset<a class="headerlink" href="#initiating-a-password-reset" title="Permalink to this headline">¶</a></h3> +<p>Use the GET method to initiate the password reset.</p> +</div> +<div class="section" id="id10"> +<h3>Request URI<a class="headerlink" href="#id10" 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">management</span><span class="o">/</span><span class="n">organizations</span><span class="o">/</span><span class="p">{</span><span class="n">org</span><span class="p">}</span><span class="o">/</span><span class="n">users</span><span class="o">/</span><span class="n">resetpw</span> +</pre></div> +</div> +</div> +<div class="section" id="id11"> +<h3>Example - Request<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/resetpw" +</pre></div> +</div> +</div> +<div class="section" id="id12"> +<h3>Example - Response<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Reset Password</title> + <link rel="stylesheet" type="text/css" href="../../css/styles.css" /> + <script type="text/javascript">> + var RecaptchaOptions = { + theme : 'clean' + }; + </script> +</head> +<body> + + <div class="dialog-area"> + <div class="dialog-form-message">Incorrect Captcha, try again...</div> + <form class="dialog-form" action="" method="post"> + <fieldset> + <p> + <label for="email">Please type your <strong>email + address</strong> or <strong>username</strong> below.</label> + </p> + <p> + <input class="text_field" id="email" name="email" type="text" /> + </p> + <p id="human-proof"></p> + <script type="text/javascript" src="https://www.google.com/recaptcha/api/challenge?k=6LdSTNESAAAAAKHdVglHmMu86_EoYxsJjqQD1IpZ"></script> + + <p class="buttons"> + <button type="submit">Submit</button> + </p> + </fieldset> + </form> + </div> +</pre> +</pre></div> +</div> +</div> +</div> +<div class="section" id="completing-a-password-reset"> +<h2>Completing a password reset<a class="headerlink" href="#completing-a-password-reset" title="Permalink to this headline">¶</a></h2> +<p>Use the POST method to complete the password reset.</p> +<div class="section" id="id13"> +<h3>Request URI<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>POST /management/organizations/{org}/users/resetpw {request body} +</pre></div> +</div> +<p>In the request body send parameters and value for the Captcha challenge, +the admin user’s response to the Captcha challenge, and the admin user’s +email address, for example:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"recaptcha_response_field"</span> <span class="p">:</span> <span class="s">"Atistophanes tseFia"</span><span class="p">,</span> + <span class="s">"recaptcha_challenge_field"</span> <span class="p">:</span> <span class="s">"Atistophanes tseFia"</span><span class="p">,</span> + <span class="s">"email"</span> <span class="p">:</span> <span class="s">"jim.ad...@gmail.com"</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +<div class="section" id="id14"> +<h3>Example - Request<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X -i POST "https://api.usergrid.com/management/organizations/my-org/users/resetpw" -d '{"recaptcha_response_field":"Atistophanes tseFia","recaptcha_challenge_field":"Atistophanes tseFia","email":"jim.ad...@gmail.com"}' +</pre></div> +</div> +</div> +<div class="section" id="id15"> +<h3>Example - Response<a class="headerlink" href="#id15" 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">"reset user password"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">13546154010321</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="activating-an-admin-user"> +<h2>Activating an admin user<a class="headerlink" href="#activating-an-admin-user" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to activate an admin user from a link provided in an +email notification.</p> +<div class="section" id="id16"> +<h3>Request URI<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>GET /management/organizations/{org}/users/{user|username|email|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>User identifier</td> +<td>Admin username, name, email address, or UUID.</td> +</tr> +<tr class="row-odd"><td>string token</td> +<td>Activation token (supplied via email).</td> +</tr> +<tr class="row-even"><td>confirm_email</td> +<td>Send confirmation email (false is the default).</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id17"> +<h3>Example - Request<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/activate?token=33dd0563-cd0c-11e1-bcf7-12313d1c4491" +</pre></div> +</div> +</div> +<div class="section" id="id18"> +<h3>Example - Response<a class="headerlink" href="#id18" 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 user"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349718021324</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="reactivating-an-admin-user"> +<h2>Reactivating an admin user<a class="headerlink" href="#reactivating-an-admin-user" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to reactivate an admin user.</p> +<div class="section" id="id19"> +<h3>Request URI<a class="headerlink" href="#id19" 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">management</span><span class="o">/</span><span class="n">organizations</span><span class="o">/</span><span class="p">{</span><span class="n">org</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">user</span><span class="o">|</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><span class="o">/</span><span class="n">reactivate</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="72%" /> +</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>User identifier</td> +<td>Admin username, name, email address, or UUID.</td> +</tr> +</tbody> +</table> +</div> +</div> +<div class="section" id="id20"> +<h2>Example - Request<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h2> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/reactivate" +</pre></div> +</div> +<div class="section" id="id21"> +<h3>Example - Response<a class="headerlink" href="#id21" 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 user"</span><span class="p">,</span> + <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1349735217217</span><span class="p">,</span> + <span class="s">"duration"</span><span class="p">:</span> <span class="mi">3541</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="getting-an-admin-user-s-activity-feed"> +<h2>Getting an admin user’s activity feed<a class="headerlink" href="#getting-an-admin-user-s-activity-feed" title="Permalink to this headline">¶</a></h2> +<p>Use the GET method to retrieve an admin user’s activity feed.</p> +<div class="section" id="id22"> +<h3>Request URI<a class="headerlink" href="#id22" 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">management</span><span class="o">/</span><span class="n">organizations</span><span class="o">/</span><span class="p">{</span><span class="n">org</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">user</span><span class="o">|</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><span class="o">/</span><span class="n">feed</span> +</pre></div> +</div> +<p>Parameters</p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="72%" /> +</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>User identifier</td> +<td>Admin username, name, email address, or UUID.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="id23"> +<h3>Example - Request<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/feed" +</pre></div> +</div> +</div> +<div class="section" id="id24"> +<h3>Example - Response<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3> +<div class="highlight-python"><div class="highlight"><pre>{ + "action": "get admin user feed", + "status": "ok", + "entities": [ + { + "uuid": "cf3e981c-fe80-11e1-95c8-12331b144c65", + "type": "activity", + "created": 1347643370454, + "modified": 1347643370454, + "actor": { + "displayName": "jim.admin", + "objectType": "person", + "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591", + "entityType": "user" + }, + "category": "admin", + "metadata": { + "cursor": "gGkAAQMAgGkABgE5xc3r1gCAdQAQz02YHP6QEeGVyBIxOxIsVgCAdQAQz4ZbYf6QEeGVyBIxOxIsVgA", + "path": "/users/327b527f-cd0c-11e1-bcf7-12313d1c4491/feed/cf4d981c-fe90-11e1-95c8-12313b122c56" + }, + "object": { + ... + }, + "published": 1342198809251, + "title": "<a mailto="jim.admingmail.com">jim.admin (jim.ad...@gmail.com)</a> created a new organization account named jim.admin", + "verb": "create" + } + ], + "timestamp": 1349735719320, +} +</pre></div> +</div> +</div> +</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
