http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/admin-portal/index.html ---------------------------------------------------------------------- diff --git a/content/docs/admin-portal/index.html b/content/docs/admin-portal/index.html deleted file mode 100644 index 8df9d31..0000000 --- a/content/docs/admin-portal/index.html +++ /dev/null @@ -1,626 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Admin portal</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>Admin portal</h1> - <!-- TODO: reenable this when we sync SVN to GitHub - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/admin-portal.md";>contribute to this article on github</a></small> - --> - </div> - <div class="toc"> - <ul> -<li> -<a href="#admin-portal">Admin portal</a><ul> -<li><a href="#account-home-page">Account Home page</a></li> -<li> -<a href="#applications">Applications</a><ul> -<li><a href="#application-dashboard">Application Dashboard</a></li> -<li><a href="#administration-for-multiple-organizations">Administration for multiple organizations</a></li> -</ul> -</li> -<li><a href="#authentication-credentials">Authentication credentials</a></li> -<li> -<a href="#exploring-the-api-using-the-shell">Exploring the API using the shell</a><ul> -<li><a href="#entering-api-requests-in-the-shell">Entering API requests in the shell</a></li> -<li><a href="#adding-properties-using-the-shell">Adding properties using the shell</a></li> -</ul> -</li> -<li><a href="#analytics">Analytics</a></li> -<li><a href="#creating-a-sandbox-app">Creating a sandbox app</a></li> -<li><a href="#displaying-api-calls-as-curl-commands">Displaying API calls as cURL commands</a></li> -</ul> -</li> -</ul> -</div> -<h1 id="admin-portal">Admin portal</h1> -<p>The <em>admin portal</em> is the primary administrative user interface for working with App services. The portal is also the most complete reference application that demonstrates how to incorporate App services with JavaScript.</p> -<p>The admin portal is available online at <a href="https://apigee.com/usergrid/";>https://apigee.com/usergrid/</a>. The portal source code is fully open source and forkable, available for download on GitHub at <a href="https://github.com/usergrid/portal";>https://github.com/usergrid/portal</a>. You can easily extend the portal, embed it into your own applications, or inspect the code to learn best practices associated with the App services API. The App services JavaScript client is also part of the GitHub portal project.</p> -<p>The portal opens in your default web browser, either Safari, Firefox, or Google Chrome. The article <a href="/messagee-example">Messagee Example</a> describes how to use the portal to run a sample application, whereas this section describes portal components in more detail and highlights App services features.</p> -<h2 id="account-home-page">Account Home page</h2> -<p>When you log in to the portal, you are presented with a Home page for managing applications and data for your organization. The Home page displays:</p> -<ul> -<li>Applications associated with the currently selected organization</li> -<li>Administrators that are part of that organization</li> -<li>API credentials for the organization</li> -<li>Activities performed recently by administrators</li> -<li>A menu for building, organizing, and managing application content</li> -</ul> -<h2 id="applications">Applications</h2> -<p>For every app that you build, you need a defined application space within App services.  By default, a test application called âsandboxâ is created for you automatically. For ease of use, this default app has all authentication disabled and should be used for learning / testing purposes only. You may also create as many additional applications as needed.</p> -<p>This unique application space allows each app to have its own private infrastructure to store its objects and data. In some cases, if you have multiple apps that share much of the same data and users, you might represent them in App services as a single application, which would allow those apps to share the same data space.</p> -<h3 id="application-dashboard">Application Dashboard</h3> -<p>The Dashboard shows a variety of statistical data for the selected application. You can see the activity level, the total number of entities, entities created in the last day, week, and month, and other vital statistics for monitoring application health as well as quota limits.</p> -<h3 id="administration-for-multiple-organizations">Administration for multiple organizations</h3> -<p>The portal is designed to let you work within the context of a single organization at any one point in time. Because it is possible to be an administrator for multiple organizations, you can switch between organizations using the menu in the upper right corner.</p> -<h2 id="authentication-credentials">Authentication credentials</h2> -<p>The portal provides a convenient way to set and retrieve credentials for API access. If you click your email address at the top of the Home page, you can set your password for both the portal and for OAuth2 username/password Admin-level access. On the Home page for the selected organization, you can see OAuth2 client credentials for organization-wide access to applications owned by that organization. Clicking the Settings button (on the left sidebar) displays OAuth2 credentials for the selected application. See the discussion on the <a href="/app-services-security-model">App services security model</a> for more information on specifying credentials and authentication.</p> -<h2 id="exploring-the-api-using-the-shell">Exploring the API using the shell</h2> -<p>When you first create a new Organization account, there are no applications associated with the account. To create an application, click New Application in your organizationâs Home page. You are presented with a dialog box that prompts you for the information needed to create a new app. When the app is created, a number of options are enabled in the left sidebar for viewing and administering that applicationâs data. Before you get started with the high-level tools, create a new application, go to the left sidebar, and click the Shell button to try out a few basic API commands.</p> -<h3 id="entering-api-requests-in-the-shell">Entering API requests in the shell</h3> -<p>The shell interface is a simple way to get started using the App services API. It provides a command-line environment within your web browser for trying out interactive commands. One thing to keep in mind when using the shell is that App services API endpoints usually take the form of:</p> -<pre><code>https://api.usergrid.com/my-org-id/my-app-id/users</code></pre> -<p>where my-org-id is the organization identifier(uuid), my-app-id is your application identifier(uuid) and users refers to the collection of user objects defined for your application. Refer to the <a href="/using-api">Using the API</a> section for more information on constructing API requests.</p> -<p>When using the shell, you can abbreviate a fully qualified path name, omitting everything through the application identifier. The above URL request, which lists all the users in the application my-app-id, simply becomes:</p> -<pre><code>/users</code></pre> -<p>If you type /users into the shell, itâs the same as an HTTP GET command to the API endpoint for the currently selected portal application. (The current application is selected using the Applications menu in the left sidebar.)</p> -<p>To create a new user entity using the shell, enter the following and press return:</p> -<pre><code>post /users {"username":"john.doe","email":"john....@gmail.com"}</code></pre> -<p>Note that there is a space after the path and before the JSON representation.</p> -<p>Youâve now created a new user in your application. You should see something like the following displayed as a result:</p> -<pre><code>> post /users {"username":"john.doe","email":"john....@gmail.com"} -/users -{ - "action": "post", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": {}, - "path": "/users", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/users";, - "entities": [ - { - "uuid": "0e47f040-da71-11e0-b93d-12313f0204bb", - "type": "user", - "username": "john.doe", - "email": "john....@gmail.com", - "created": 1315523992687007, - "modified": 1315523992687007, - "metadata": { - "path": "/users/0e47f040-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/permissions" - } - } - } - ], - "timestamp": 1315523992585, - "duration": 162 -} -></code></pre> -<p>Enter the following to create another user:</p> -<pre><code>post /users {"username":"jane.doe","email":"jane....@gmail.com"}</code></pre> -<p>You should see something like the following result:</p> -<pre><code>> post /users {"username":"jane.doe","email":"jane....@gmail.com"} -/users -{ - "action": "post", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": {}, - "path": "/users", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/users";, - "entities": [ - { - "uuid": "78c54a82-da71-11e0-b93d-12313f0204bb", - "type": "user", - "username": "jane.doe", - "email": "jane....@gmail.com", - "created": 1315524171347008, - "modified": 1315524171347008, - "metadata": { - "path": "/users/78c54a82-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/permissions" - } - } - } - ], - "timestamp": 1315524171329, - "duration": 110 -} -></code></pre> -<p>Now enter the command to list the elements of the users collection again:</p> -<pre><code>/users</code></pre> -<p>This time the results should show the two users you added:</p> -<pre><code>> /users -/users -{ - "action": "get", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": { - "_": [ - "1315524221412" - ] - }, - "path": "/users", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/users";, - "entities": [ - { - "uuid": "0e47f040-da71-11e0-b93d-12313f0204bb", - "type": "user", - "created": 1315523992687007, - "modified": 1315523992687007, - "email": "john....@gmail.com", - "metadata": { - "path": "/users/0e47f040-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/0e47f040-da71-11e0-b93d-12313f0204bb/permissions" - } - }, - "username": "john.doe" - }, - { - "uuid": "78c54a82-da71-11e0-b93d-12313f0204bb", - "type": "user", - "created": 1315524171347008, - "modified": 1315524171347008, - "email": "jane....@gmail.com", - "metadata": { - "path": "/users/78c54a82-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/permissions" - } - }, - "username": "jane.doe" - } - ], - "timestamp": 1315524225021, - "duration": 59 -} -></code></pre> -<p>To retrieve a specific user, try the following:</p> -<pre><code>/users/jane.doe</code></pre> -<p>You should see results similar to this:</p> -<pre><code>> /users/jane.doe -/users/jane.doe -{ - "action": "get", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": { - "_": [ - "1315524419746" - ] - }, - "path": "/users", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/users";, - "entities": [ - { - "uuid": "78c54a82-da71-11e0-b93d-12313f0204bb", - "type": "user", - "created": 1315524171347008, - "modified": 1315524171347008, - "email": "jane....@gmail.com", - "metadata": { - "path": "/users/78c54a82-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/permissions" - } - }, - "username": "jane.doe" - } - ], - "timestamp": 1315524421071, - "duration": 107 -} -></code></pre> -<h3 id="adding-properties-using-the-shell">Adding properties using the shell</h3> -<p>Now, letâs add some information (entity properties) for the user jane.doe. You can assign application-specific or system-defined properties to user entities. (See the You do not have access to view this node for a list of predefined properties for each system-defined entity type.) As an example of adding an application-specific property, letâs add the property city to the user jane.doe by typing:</p> -<pre><code>put /users/jane.doe {"city" : "san francisco" }</code></pre> -<p>You should see results similar to this:</p> -<pre><code>> put /users/jane.doe {"city" : "san francisco" } -/users/jane.doe -{ - "action": "put", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": {}, - "path": "/users", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/users";, - "entities": [ - { - "uuid": "78c54a82-da71-11e0-b93d-12313f0204bb", - "type": "user", - "created": 1315524171347008, - "modified": 1315524526405008, - "city": "san francisco", - "email": "jane....@gmail.com", - "metadata": { - "path": "/users/78c54a82-da71-11e0-b93d-12313f0204bb", - "collections": { - "activities": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/activities", - "feed": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/feed", - "groups": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/groups", - "messages": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/messages", - "queue": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/queue", - "roles": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/roles", - "following": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/following", - "followers": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/followers" - }, - "sets": { - "rolenames": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/rolenames", - "permissions": "/users/78c54a82-da71-11e0-b93d-12313f0204bb/permissions" - } - }, - "username": "jane.doe" - } - ], - "timestamp": 1315524526343, - "duration": 84 -} -></code></pre> -<p>Letâs create another type of object. Type the following:</p> -<pre><code>post /cats {"name" : "felix"}</code></pre> -<p>You should see results for the collection cats that you created with the entity felix:</p> -<pre><code>> post /cats {"name" : "felix"} -/cats -{ - "action": "post", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": {}, - "path": "/cats", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/cats";, - "entities": [ - { - "uuid": "89a05d85-da72-11e0-b93d-12313f0204bb", - "type": "cat", - "created": 1315524629123008, - "modified": 1315524629123008, - "metadata": { - "path": "/cats/89a05d85-da72-11e0-b93d-12313f0204bb" - }, - "name": "felix" - } - ], - "timestamp": 1315524629068, - "duration": 107 -} -></code></pre> -<p>Now letâs update this object by assigning a property color:</p> -<pre><code>put /cats/felix {"color" : "black"}</code></pre> -<p>You should see something like the following results:</p> -<pre><code>> put /cats/felix {"color" : "black"} -/cats/felix -{ - "action": "put", - "application": "1c8f60e4-da67-11e0-b93d-12313f0204bb", - "params": {}, - "path": "/cats", - "uri": "https://api.usergrid.com/1c8f60e4-da67-11e0-b93d-12313f0204bb/cats";, - "entities": [ - { - "uuid": "89a05d85-da72-11e0-b93d-12313f0204bb", - "type": "cat", - "created": 1315524629123008, - "modified": 1315524724093008, - "color": "black", - "metadata": { - "path": "/cats/89a05d85-da72-11e0-b93d-12313f0204bb" - }, - "name": "felix" - } - ], - "timestamp": 1315524724058, - "duration": 57 -} -></code></pre> -<p>You can now click the Collections button in the sidebar to see all of the collections in your application. There are two entities in the users collection and one in the cats collection. Feel free to look around and see how the portal provides a high-level alternative to the API for viewing and manipulating application objects.</p> -<p>Subsequent sections give details about using the API to access and modify application entities. If youâre ready to start using the App services API, see the You do not have access to view this node for details and examples for each API endpoint.</p> -<h2 id="analytics">Analytics</h2> -<p>On the left sidebar, click Analytics to explore this functionality. You can specify parameters for data collection, including what data points youâd like to collect, over what time period, and at what resolution. When you click the Generate button, the results are displayed in tabular form and graphically in the lower portion of the window.</p> -<h2 id="creating-a-sandbox-app">Creating a sandbox app</h2> -<p>When you create a new Apache Usergrid account, an app named sandbox is automatically created. In some cases you may want to create (or re-create) the sandbox app. For example, you may want to create a sandbox app for another organization or you may want to create another app for testing purposes. See <a href="/using-sandbox-application">Using a Sandbox Application</a> for details.</p> -<h2 id="displaying-api-calls-as-curl-commands">Displaying API calls as cURL commands</h2> -<p>You can display the equivalent cURL syntax for each API call that you make through the admin portal. The calls are displayed in the console area of any of the following browsers: Chrome, Internet Explorer (in the debugger), Firefox (in Firebug), and Safari. For details, see <a href="/displaying-app-services-api-calls-curl-commands">Displaying Apache Usergrid API calls as Curl commands</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/admin-portal.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/admin-user/index.html ---------------------------------------------------------------------- diff --git a/content/docs/admin-user/index.html b/content/docs/admin-user/index.html deleted file mode 100644 index 1751dcc..0000000 --- a/content/docs/admin-user/index.html +++ /dev/null @@ -1,967 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Admin user</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>Admin user</h1> - <!-- TODO: reenable this when we sync SVN to GitHub - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/admin-user.md";>contribute to this article on github</a></small> - --> - </div> - <div class="toc"> - <ul> -<li> -<a href="#admin-user">Admin user</a><ul> -<li> -<a href="#creating-an-admin-user">Creating an admin user</a><ul> -<li><a href="#request-uri">Request URI</a></li> -<li><a href="#parameters">Parameters</a></li> -<li><a href="#example---request">Example - Request</a></li> -<li><a href="#example---response">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#updating-an-admin-user">Updating an admin user</a><ul> -<li><a href="#request-uri-1">Request URI</a></li> -<li><a href="#parameters-1">Parameters</a></li> -<li><a href="#example---request-1">Example - Request</a></li> -<li><a href="#example---response-1">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#getting-an-admin-user">Getting an admin user</a><ul> -<li><a href="#request-uri-2">Request URI</a></li> -<li><a href="#parameters-2">Parameters</a></li> -<li><a href="#example---request-2">Example - Request</a></li> -<li><a href="#example---response-2">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#setting-an-admin-users-password">Setting an admin userâs password</a><ul> -<li><a href="#request-uri-3">Request URI</a></li> -<li><a href="#parameters-3">Parameters</a></li> -<li><a href="#example---request-3">Example - Request</a></li> -<li><a href="#example---response-3">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#resetting-an-admin-users-password">Resetting an admin userâs password</a><ul> -<li><a href="#initiating-a-password-reset">Initiating a password reset</a></li> -<li><a href="#request-uri-4">Request URI</a></li> -<li><a href="#example---request-4">Example - Request</a></li> -<li><a href="#example---response-4">Example - Response</a></li> -<li><a href="#completing-a-password-reset">Completing a password reset</a></li> -<li><a href="#request-uri-5">Request URI</a></li> -<li><a href="#parameters-4">Parameters</a></li> -<li><a href="#example---request-5">Example - Request</a></li> -<li><a href="#example---response-5">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#activating-an-admin-user">Activating an admin user</a><ul> -<li><a href="#request-uri-6">Request URI</a></li> -<li><a href="#parameters-5">Parameters</a></li> -<li><a href="#example---request-6">Example - Request</a></li> -<li><a href="#example---response-6">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#reactivating-an-admin-user">Reactivating an admin user</a><ul> -<li><a href="#request-uri-7">Request URI</a></li> -<li><a href="#parameters-6">Parameters</a></li> -<li><a href="#example---request-7">Example - Request</a></li> -<li><a href="#example---response-7">Example - Response</a></li> -</ul> -</li> -<li> -<a href="#getting-an-admin-users-activity-feed">Getting an admin userâs activity feed</a><ul> -<li><a href="#request-uri-8">Request URI</a></li> -<li><a href="#parameters-7">Parameters</a></li> -<li><a href="#example---request-8">Example - Request</a></li> -<li><a href="#example---response-8">Example - Response</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<h1 id="admin-user">Admin user</h1> -<p><a href="/docs/usergrid/content/management-resources">See all management resources</a><a href="/docs/usergrid/content/management-resources"><img src="/docs/sites/docs/files/learnmore%20arrow_0.png"></a></p> -<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 App services 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 href="/organization">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 href="/authenticating-users-and-application-clients">Authenticating users and application clients</a> for details.</p> -<h2 id="creating-an-admin-user">Creating an admin user</h2> -<p>Use the POST method to create an admin user.</p> -<h3 id="request-uri">Request URI</h3> -<p>POST /management/organizations/{org}/users {request body}</p> -<h3 id="parameters">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>request body</p></td> -<td align="left"> -<p>One or more sets of user properties, of which username is mandatory and must be unique:</p> -<pre><code>{ - "username" : "jim.admin", - "email" : "jim.ad...@gmail.com</code></pre> -<p>â,âname" : âJim Adminâ, âpasswordâ : âtest12345â }</p> -</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request">Example - Request</h3> -<ul> -<li><a href="#curl_create_admin_user">cURL</a></li> -<li><a href="#javascript_create_admin_user">JavaScript (HTML5)</a></li> -<li><a href="#ruby_create_admin_user">Ruby</a></li> -<li><a href="#nodejs_create_admin_user">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>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"}'</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -result = mgmt.create_user username: 'jim.admin', name: 'Jim Admin', email: 'jim.ad...@gmail.com', password: 'test12345' -jim_admin = result.entity</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'POST', - endpoint:'management/organizations/my-org/users', - body:{ username:'jim.admin', name:'Jim Admin', email:'jim.ad...@gmail.com', - password:'test12345' } -}; -client.request(options, function (err, data) { - if (err) { - //error â POST failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response">Example - Response</h3> -<pre><code>{ - "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 -}</code></pre> -<h2 id="updating-an-admin-user">Updating an admin user</h2> -<p>Use the PUT method to update an admin user.</p> -<h3 id="request-uri-1">Request URI</h3> -<p>PUT /management/organizations/{org}/users/{user|username|email|uuid} {request body}</p> -<h3 id="parameters-1">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>string user|string username|string email|arg uuid</p></td> -<td align="left"><p>Admin username, name, email address, or UUID.</p></td> -</tr> -<tr class="even"> -<td align="left"><p>request body</p></td> -<td align="left"> -<p>One or more sets of user properties:</p> -<pre><code>{ - "city" : "San Francisco", - "state" : "California" -}</code></pre> -</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-1">Example - Request</h3> -<ul> -<li><a href="#curl_update_admin_user">cURL</a></li> -<li><a href="#javascript_update_admin_user">JavaScript (HTML5)</a></li> -<li><a href="#ruby_update_admin_user">Ruby</a></li> -<li><a href="#nodejs_update_admin_user">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X -i PUT "https://api.usergrid.com/management/organizations/my-org/users/jim.admin"; -d '{"city":"San Francisco","state":"California"}'</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -jim_admin = mgmt['users/jim.admin'].entity -jim_admin.city = 'San Francisco' -jim_admin.state = 'California' -jim_admin.save</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'PUT', - endpoint:'management/organizations/my-org/users/jim.admin', - body:{ email:'john....@mail.com', city:'San Francisco', state:'California' } -}; -client.request(options, function (err, data) { - if (err) { - //error â PUT failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-1">Example - Response</h3> -<pre><code>{ - "action": "update user info", - "timestamp": 1349479321874, - "duration": 0 -}</code></pre> -<h2 id="getting-an-admin-user">Getting an admin user</h2> -<p>Use the GET method to retrieve details about an admin user.</p> -<h3 id="request-uri-2">Request URI</h3> -<p>GET /management/organizations/{org}/users/{user|username|email|uuid}</p> -<h3 id="parameters-2">Parameters</h3> -<table> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">string user|string username|string email|arg uuid</td> -<td align="left">Admin username, name, email address, or UUID.</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-2">Example - Request</h3> -<ul> -<li><a href="#curl_get_admin_user">cURL</a></li> -<li><a href="#javascript_get_admin_user">JavaScript (HTML5)</a></li> -<li><a href="#ruby_get_admin_user">Ruby</a></li> -<li><a href="#nodejs_get_admin_user">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin";</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -jim_admin = mgmt['users/jim.admin'].entity</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'GET', - endpoint:'management/organizations/my-org/users/jim.admin' -}; -client.request(options, function (err, data) { - if (err) { - //error â GET failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-2">Example - Response</h3> -<pre><code>{ - "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,</code></pre> -<h2 id="setting-an-admin-users-password">Setting an admin userâs password</h2> -<p>Use the PUT method to update an admin userâs password.</p> -<h3 id="request-uri-3">Request URI</h3> -<p>PUT /management/organizations/{org}/users/{user|username|email|uuid}/password {request body}</p> -<h3 id="parameters-3">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>string user|string username|string email|arg uuid</p></td> -<td align="left"><p>Admin username, name, email address, or UUID.</p></td> -</tr> -<tr class="even"> -<td align="left"><p>request body</p></td> -<td align="left"> -<p>The password property and value:</p> -<pre><code>{ - "password": "test123" -}</code></pre> -</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-3">Example - Request</h3> -<ul> -<li><a href="#curl_set_admin_pw">cURL</a></li> -<li><a href="#javascript_set_admin_pw">JavaScript (HTML5)</a></li> -<li><a href="#ruby_set_admin_pw">Ruby</a></li> -<li><a href="#nodejs_set_admin_pw">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X -i PUT "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/password"; -d '{"password":"test123"}'</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p> </p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org' -jim_admin = mgmt['users/jim.admin'].entity -jim_admin.password = 'test123' -jim_admin.save</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'PUT', - endpoint:'management/organizations/my-org/users/jim.admin', - body:{ password:'test123' } -}; -client.request(options, function (err, data) { - if (err) { - //error â PUT failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-3">Example - Response</h3> -<pre><code>{ - "action": "set user password", - "timestamp": 1349714010142, - "duration": 0 -}</code></pre> -<h2 id="resetting-an-admin-users-password">Resetting an admin userâs password</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> -<h3 id="initiating-a-password-reset">Initiating a password reset</h3> -<p>Use the GET method to initiate the password reset.</p> -<h3 id="request-uri-4">Request URI</h3> -<p>GET /management/organizations/{org}/users/resetpw</p> -<h3 id="example---request-4">Example - Request</h3> -<ul> -<li><a href="#curl_init_pw_reset">cURL</a></li> -<li><a href="#javascript_init_pw_reset">JavaScript (HTML5)</a></li> -<li><a href="#ruby_init_pw_reset">Ruby</a></li> -<li><a href="#nodejs_init_pw_reset">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/resetpw";</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -resetpw = mgmt['users/resetpw']</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'GET', - endpoint:'management/organizations/my-org/users/resetpw' -}; -client.request(options, function (err, data) { - if (err) { - //error â GET failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-4">Example - Response</h3> -<pre><code><!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></code></pre> -<h3 id="completing-a-password-reset">Completing a password reset</h3> -<p>Use the POST method to complete the password reset.</p> -<h3 id="request-uri-5">Request URI</h3> -<p>POST /management/organizations/{org}/users/resetpw {request body}</p> -<h3 id="parameters-4">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>request body</p></td> -<td align="left"> -<p>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> -<pre><code>{ - "recaptcha_response_field" : "</code></pre> -<p>Atistophanes tseFiaâ,ârecaptcha_challenge_field" : âAtistophanes tseFiaâ, âemailâ : âjim.ad...@gmail.comâ }</p> -</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-5">Example - Request</h3> -<ul> -<li><a href="#curl_complete_pw_reset">cURL</a></li> -<li><a href="#javascript_complete_pw_reset">JavaScript (HTML5)</a></li> -<li><a href="#ruby_complete_pw_reset">Ruby</a></li> -<li><a href="#nodejs_complete_pw_reset">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>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"}'</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p> </p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -resetpw = mgmt['users/resetpw'] -resetpw { recaptcha_response_field: 'Atistophanes tseFia', recaptcha_challenge_field: 'Atistophanes tseFia', email: 'jim.ad...@gmail.com' }</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'POST', - endpoint:'management/organizations/my-org/users/resetpw', - body:{ - recaptcha_response_field:'Atistophanes tseFia', - recaptcha_challenge_field:'Atistophanes tseFia', - email:'jim.ad...@gmail.com' - } -}; -client.request(options, function (err, data) { - if (err) { - //error â POST failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-5">Example - Response</h3> -<pre><code>{ - "action": "reset user password", - "timestamp": 13546154010321, - "duration": 0 -}</code></pre> -<h2 id="activating-an-admin-user">Activating an admin user</h2> -<p>Use the GET method to activate an admin user from a link provided in an email notification.</p> -<h3 id="request-uri-6">Request URI</h3> -<p>GET /management/organizations/{org}/users/{user|username|email|uuid}/activate?token={token}&confirm={confirm_email}</p> -<h3 id="parameters-5">Parameters</h3> -<table> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">string user|string username|string email|arg uuid</td> -<td align="left">Admin username, name, email address, or UUID.</td> -</tr> -<tr class="even"> -<td align="left">string token</td> -<td align="left">Activation token (supplied via email).</td> -</tr> -<tr class="odd"> -<td align="left">boolean confirm_email</td> -<td align="left">Send confirmation email (false is the default).</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-6">Example - Request</h3> -<ul> -<li><a href="#curl_activate_admin_user">cURL</a></li> -<li><a href="#javascript_activate_admin_user">JavaScript (HTML5)</a></li> -<li><a href="#ruby_activate_admin_user">Ruby</a></li> -<li><a href="#nodejs_activate_admin_user">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/activate?token=33dd0563-cd0c-11e1-bcf7-12313d1c4491";</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -mgmt['users/jim.admin/activate'].get params: { token: '33dd0563-cd0c-11e1-bcf7-12313d1c4491' }</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'GET', - endpoint:'management/organizations/my-org/users/jim.admin/activate', - qs:{token:'33dd0563-cd0c-11e1-bcf7-12313d1c4491'} -}; -client.request(options, function (err, data) { - if (err) { - //error â GET failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-6">Example - Response</h3> -<pre><code>{ - "action": "activate user", - "timestamp": 1349718021324, - "duration": 0 -}</code></pre> -<h2 id="reactivating-an-admin-user">Reactivating an admin user</h2> -<p>Use the GET method to reactivate an admin user.</p> -<h3 id="request-uri-7">Request URI</h3> -<p>GET /management/organizations/{org}/users/{user|username|email|uuid}/reactivate</p> -<h3 id="parameters-6">Parameters</h3> -<table> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">string user|string username|string email|arg uuid</td> -<td align="left">Admin username, name, email address, or UUID.</td> -</tr> -</tbody> -</table> -<p> </p> -<h3 id="example---request-7">Example - Request</h3> -<ul> -<li><a href="#curl_reactivate_admin_user">cURL</a></li> -<li><a href="#javascript_reactivate_admin_user">JavaScript (HTML5)</a></li> -<li><a href="#ruby_reactivate_admin_user">Ruby</a></li> -<li><a href="#nodejs_reactivate_admin_user">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/reactivate";</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -mgmt['users/jim.admin/reactivate']</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'GET', - endpoint:'management/organizations/my-org/users/jim.admin/reactivate' -}; -client.request(options, function (err, data) { - if (err) { - //error â GET failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-7">Example - Response</h3> -<pre><code>{ - "action": "reactivate user", - "timestamp": 1349735217217, - "duration": 3541 -}</code></pre> -<h2 id="getting-an-admin-users-activity-feed">Getting an admin userâs activity feed</h2> -<p>Use the GET method to retrieve an admin userâs activity feed.</p> -<h3 id="request-uri-8">Request URI</h3> -<p>GET /management/organizations/{org}/users/{user|username|email|uuid}/feed</p> -<h3 id="parameters-7">Parameters</h3> -<table> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">string user|string username|string email|arg uuid</td> -<td align="left">Admin username, name, email address, or UUID.</td> -</tr> -</tbody> -</table> -<h3 id="example---request-8">Example - Request</h3> -<ul> -<li><a href="#curl_get_user_feed">cURL</a></li> -<li><a href="#javascript_get_user_feed">JavaScript (HTML5)</a></li> -<li><a href="#ruby_get_user_feed">Ruby</a></li> -<li><a href="#nodejs_get_user_feed">Node.js</a></li> -</ul> -<!-- --> - -<pre><code>curl -X GET "https://api.usergrid.com/management/organizations/my-org/users/jim.admin/feed";</code></pre> -<p>It is recommended that you use the <a href="http://apigee.com/usergrid";>Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p> -<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p> -<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron";>Ruby SDK</a>.</p> -<pre><code>mgmt = Usergrid::Management.new 'https://api.usergrid.com/management/organizations/my-org/' -mgmt['users/jim.admin/feed'].get</code></pre> -<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-node-module";>Node.js module</a>.</p> -<pre><code>var options = { - method:'GET', - endpoint:'management/organizations/my-org/users/jim.admin/feed' -}; -client.request(options, function (err, data) { - if (err) { - //error â GET failed - } else { - //success â data will contain raw results from API call - } -});</code></pre> -<h3 id="example---response-8">Example - Response</h3> -<pre><code>{ - "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,</code></pre> - </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/admin-user.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>
