http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/organizations-admins
2/index.html
----------------------------------------------------------------------
diff --git a/content/docs/organizations-admins 2/index.html
b/content/docs/organizations-admins 2/index.html
deleted file mode 100644
index 2d07cc0..0000000
--- a/content/docs/organizations-admins 2/index.html
+++ /dev/null
@@ -1,1807 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
- <meta charset="utf-8">
- <title>Apache Usergrid (incubating) â Organizations & Admins</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>Organizations & Admins</h1>
- <!-- TODO: reenable this when we sync SVN to GitHub
- <small><a target="_blank"
href="https://github.com/usergrid/website/blob/master/content/docs/organizations-admins
2.md">contribute to this article on github</a></small>
- -->
- </div>
- <div class="toc">
- <ul>
-<li>
-<a href="#organizations">Organizations</a><ul>
-<li><a href="#activating-an-organization">Activating an organization</a></li>
-<li><a href="#reactivating-an-organization">Reactivating an
organization</a></li>
-<li><a href="#generating-organization-client-credentials">Generating
organization client credentials</a></li>
-<li><a href="#retrieving-organization-client-credentials">Retrieving
organization client credentials</a></li>
-<li><a href="#getting-an-organizations-activity-feed">Getting an
organizationâs activity feed</a></li>
-<li><a href="#creating-an-organization-application">Creating an organization
application</a></li>
-<li><a href="#deleting-an-organization-application">Deleting an organization
application</a></li>
-<li><a href="#generating-application-credentials">Generating application
credentials</a></li>
-<li><a href="#getting-application-credentials">Getting application
credentials</a></li>
-<li><a href="#getting-the-applications-in-an-organization">Getting the
applications in an organization</a></li>
-<li><a href="#adding-an-admin-user-to-an-organization">Adding an admin user to
an organization</a></li>
-<li><a href="#getting-the-admin-users-in-an-organization">Getting the admin
users in an organization</a></li>
-<li><a href="#removing-an-admin-user-from-an-organization">Removing an admin
user from an organization</a></li>
-</ul>
-</li>
-<li>
-<a href="#admins">Admins</a><ul>
-<li><a href="#creating-an-admin-user">Creating an admin user</a></li>
-<li><a href="#updating-an-admin-user">Updating an admin user</a></li>
-<li><a href="#getting-an-admin-user">Getting an admin user</a></li>
-<li><a href="#setting-an-admin-users-password">Setting an admin userâs
password</a></li>
-<li><a href="#resetting-an-admin-users-password">Resetting an admin userâs
password</a></li>
-<li><a href="#activating-an-admin-user">Activating an admin user</a></li>
-<li><a href="#reactivating-an-admin-user">Reactivating an admin user</a></li>
-<li><a href="#getting-an-admin-users-activity-feed">Getting an admin userâs
activity feed</a></li>
-</ul>
-</li>
-</ul>
-</div>
-<h2 id="organizations">Organizations</h2>
-<p>An organization represents the highest level of the Apache Usergrid data
hierarchy. It contains applications (and the entities and collections they
contain)Â and is associated with one or more administrators. An organization
can be representative of a company, team, or project. It allows multiple
applications  to be shared within the organization with other
administrators.</p>
-<p>Using the App services API, you can create an organization through a form
post and get an organization by UUID or name. In addition, you can activate or
reactivate an organization, generate and retrieve an organizationâs client
credentials, and get an organizationâs activity feed. You can also create an
organization application through a form post, generate and retrieve credentials
for the application, and delete the application. You can also get the
applications in an organization. Additionally, you can add an admin user to an
organization, get the admin users in an organization, and remove an admin user
from an organization.</p>
-<table>
-<thead>
-<tr class="header">
-<th align="left">Property</th>
-<th align="left">Type</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">uuid</td>
-<td align="left">UUID</td>
-<td align="left">Organizationâs unique entity ID</td>
-</tr>
-<tr class="even">
-<td align="left">type</td>
-<td align="left">string</td>
-<td align="left">âorganizationâ</td>
-</tr>
-<tr class="odd">
-<td align="left">created</td>
-<td align="left">long</td>
-<td align="left">
-<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
creation</td>
-</tr>
-<tr class="even">
-<td align="left">modified</td>
-<td align="left">long</td>
-<td align="left">
-<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity
modification</td>
-</tr>
-<tr class="odd">
-<td align="left">organization</td>
-<td align="left">string</td>
-<td align="left">The name of the organization.</td>
-</tr>
-<tr class="even">
-<td align="left">username</td>
-<td align="left">string</td>
-<td align="left">The username of the administrator.</td>
-</tr>
-<tr class="odd">
-<td align="left">name</td>
-<td align="left">string</td>
-<td align="left">The name of the administrator.</td>
-</tr>
-<tr class="even">
-<td align="left">email</td>
-<td align="left">string</td>
-<td align="left">The email address of the administrator.</td>
-</tr>
-<tr class="odd">
-<td align="left">password</td>
-<td align="left">string</td>
-<td align="left">The password of the administrator. (create-only)</td>
-</tr>
-</tbody>
-</table>
-<h3 id="activating-an-organization">Activating an organization</h3>
-<p>Use the GET method to activate an organization from a link provided in an
email notification.</p>
-<h4 id="request-url">Request URL</h4>
-<p>GET
/organizations|orgs/{org_name}|{uuid}/activate?token={token}&confirm={confirm_email}</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization 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>
-<h4 id="example---request">Example - Request</h4>
-<ul>
-<li><a href="#curl_activate_org">cURL</a></li>
-<li><a href="#javascript_activate_org">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_activate_org">Ruby</a></li>
-<li><a href="#nodejs_activate_org">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/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/'
-mgmt['orgs/testorg/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/orgs/testorg/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>
-<h4 id="example---response">Example - Response</h4>
-<pre><code>{
- "action": "activate organization",
- "timestamp": 1337928462810,
- "duration": 3342
-}</code></pre>
-<h3 id="reactivating-an-organization">Reactivating an organization</h3>
-<p>Use the GET method to reactivate an organization.</p>
-<h4 id="request-uri">Request URI</h4>
-<p>GET /organizations|orgs/{org_name}|{uuid}/reactivate</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p>Â </p>
-<h4 id="example---request-1">Example - Request</h4>
-<ul>
-<li><a href="#curl_reactivate_org">cURL</a></li>
-<li><a href="#javascript_reactivate_org">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_reactivate_org">Ruby</a></li>
-<li><a href="#nodejs_reactivate_org">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/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>Â </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/'
-mgmt['orgs/testorg/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/orgs/testorg/reactivate'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-1">Example - Response</h4>
-<pre><code>{
- "action": "reactivate organization",
- "timestamp": 1349385280891,
- "duration": 3612
-}</code></pre>
-<h3 id="generating-organization-client-credentials">Generating organization
client credentials</h3>
-<p>Use the POST method to generate new credentials for an organization
client.</p>
-<h4 id="request-uri-1">Request URI</h4>
-<p>POST /organizations|orgs/{org_name}|{uuid}/credentials</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-2">Example - Request</h4>
-<ul>
-<li><a href="#curl_gen_org_credentials">cURL</a></li>
-<li><a href="#javascript_gen_org_credentials">JavaScript</a></li>
-<li><a href="#ruby_gen_org_credentials">Ruby</a></li>
-<li><a href="#nodejs_gen_org_credentials">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X POST
"https://api.usergrid.com/management/orgs/credentials"</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/'
-mgmt['orgs/credentials'].create</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/orgs/credentials'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â POST failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-2">Example - Response</h4>
-<pre><code>{
- "action": "generate organization client credentials",
- "timestamp": 1349385795647,
- "duration": 7,
- "credentials": {
- "client_id": "c2V7N61DY90MCdG78xIxPRxFdQ",
- "client_secret": "c2V7WEdXIutZWEkWdySLCt_lYDFVMMN"
- }
-}</code></pre>
-<h3 id="retrieving-organization-client-credentials">Retrieving organization
client credentials</h3>
-<p>Use the GET method to retrieve the credentials for an organization
client.</p>
-<h4 id="request-url-1">Request URL</h4>
-<p>GET /organizations|orgs/{org_name}|{uuid}/credentials</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-3">Example - Request</h4>
-<ul>
-<li><a href="#curl_get_org_credentials">cURL</a></li>
-<li><a href="#javascript_get_org_credentials">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_org_credentials">Ruby</a></li>
-<li><a href="#nodejs_get_org_credentials">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/credentials"</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/'
-mgmt['orgs/testorg/credentials']</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/orgs/testorg/credentials'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-3">Example - Response</h4>
-<pre><code>{
- "action": "get organization client credentials",
- "timestamp": 1349386672984,
- "duration": 690,
- "credentials": {
- "client_id": "c2V7N61DY90MCdG78xIxPRxFdQ",
- "client_secret": "c2V7WEdXIutZWEkWdySLCt_lYDFVMMN"
- }
-}</code></pre>
-<h3 id="getting-an-organizations-activity-feed">Getting an organizationâs
activity feed</h3>
-<p>Use the GET method to get an organizationâs activity feed.</p>
-<h4 id="request-uri-2">Request URI</h4>
-<p>GET /organizations|orgs/{org_name}|{uuid}/feed</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-4">Example - Request</h4>
-<ul>
-<li><a href="#curl_get_org_feed">cURL</a></li>
-<li><a href="#javascript_get_org_feed">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_org_feed">Ruby</a></li>
-<li><a href="#nodejs_get_org_feed">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/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/'
-activities = mgmt['orgs/testorg/feed'].collection</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/orgs/testorg/feed'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-4">Example - Response</h4>
-<pre><code>{
- {
- "action": "get organization feed",
- "status": "ok",
- "entities": [
- {
- "uuid": "cf4d981c-fe90-11e1-95c8-12313b122c56",
- "type": "activity",
- "created": 1347643370454,
- "modified": 1347643370454,
- "actor": {
- "displayName": "tester123",
- "objectType": "person",
- "uuid": "327b527f-cd0c-11e1-bcf7-12313d1c4491",
- "entityType": "user"
- },
- "category": "admin",
- "metadata": {
- "cursor":
"gGkAAQMAgGkABgE5xc3r1gCAdQAQz02YHP6QEeGVyBIxOxIsVgCAdQAQz3SoH_6QEeGVyBIxOxIsVgA",
- "path":
"/groups/33dd0563-cd0c-11e1-bcf7-12313d1c4491/feed/cf4d981c-fe90-11e1-95c8-12313b122c56"
- },
-"object": {
- "displayName": "testapp2",
- "objectType": "Application",
- "uuid": "cede5b7e-fe90-11e1-95c8-12313b122c56",
- "entityType": "application_info"
- },
- "published": 1347643370454,
- "title": "<a mailto="mailto:tester...@hotmail.com">tester123
(tester...@hotmail.com)</a> created a new application named testapp2",
- "verb": "create"
- },...
-,
- "timestamp": 1349387253811,</code></pre>
-<h3 id="creating-an-organization-application">Creating an organization
application</h3>
-<p>Use the POSTÂ method to create an application for an organization through a
form post.</p>
-<h4 id="request-uri-3">Request URI</h4>
-<p>POST /organizations|orgs/{org_name}|{org_uuid}/apps {request body}</p>
-<h4 id="parameters">Parameters</h4>
-<p>Parameter</p>
-<p>Description</p>
-<p>request body</p>
-<p>The following set of organization properties supplied through a form:.</p>
-<p>Property</p>
-<p>Description</p>
-<p>access token (string)</p>
-<p>The OAuth2 access token.</p>
-<p>name (string)</p>
-<p>The name of the application.</p>
-<p>Â </p>
-<h4 id="example---request-5">Example - Request</h4>
-<ul>
-<li><a href="#curl_create_org_app">cURL</a></li>
-<li><a href="#javascript_create_org_app">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_create_org_app">Ruby</a></li>
-<li><a href="#nodejs_create_org_app">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X -i POST
"https://api.usergrid.com/management/orgs/testorg/apps" -d
'{"access_token":"YWMtmNIFFBI6EeKvXSIACowF7QAAATpL0bVQtGOWe8PMwLfQ9kD_VKQa7IH4UBQ","name":"testapp1"}'</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/'
-mynewapp = mgmt['orgs/testorg/apps'].create name: 'testapp1', access_token:
'YWMtmNIFFBI6EeKvXSIACowF7QAAATpL0bVQtGOWe8PMwLfQ9kD_VKQa7IH4UBQ'</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/orgs/testorg/apps',
- body:{
-
access_token:'YWMtmNIFFBI6EeKvXSIACowF7QAAATpL0bVQtGOWe8PMwLfQ9kD_VKQa7IH4UBQ',
- name:'testapp1'
- }
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â POST failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-5">Example - Response</h4>
-<pre><code>{
- "action": "new application for organization",
- "timestamp": 1338914698135,
- "duration": 701
-}</code></pre>
-<h3 id="deleting-an-organization-application">Deleting an organization
application</h3>
-<p>Use the DELETE method to delete an application from an organization.</p>
-<h4 id="request-uri-4">Request URI</h4>
-<p>DELETE
/organizations|orgs/{org_name}|{org_uuid}/apps/{app_name}|{app_uuid}</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-<tr class="even">
-<td align="left">string app_name|arg uuid</td>
-<td align="left">Application name or application UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-6">Example - Request</h4>
-<ul>
-<li><a href="#curl_delete_org_app">cURL</a></li>
-<li><a href="#javascript_delete_org_app">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_delete_org_app">Ruby</a></li>
-<li><a href="#nodejs_delete_org_app">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X DELETE
"https://api.usergrid.com/management/orgs/testorg/apps/testapp1"</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/'
-mgmt['orgs/testorg/apps/testapp1'].delete</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:'DELETE',
- endpoint:'management/orgs/testorg/apps/testapp1'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â DELETE failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-6">Example - Response</h4>
-<pre><code>{
- "action": "delete application from organization",
- "timestamp": 1349817715666,
- "duration": 0
-}</code></pre>
-<h3 id="generating-application-credentials">Generating application
credentials</h3>
-<p>Use the POST method to generate the client ID and client secret credentials
for an application in an organization.</p>
-<h4 id="request-uri-5">Request URI</h4>
-<p>POST
/organizations|orgs/{org_name}|{uuid}/applications|apps/{app_name}|{uuid}/credentials</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-<tr class="even">
-<td align="left">string app_name|arg uuid</td>
-<td align="left">Application name or application UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-7">Example - Request</h4>
-<ul>
-<li><a href="#curl_gen_app_credentials">cURL</a></li>
-<li><a href="#javascript_gen_app_credentials">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_gen_app_credentials">Ruby</a></li>
-<li><a href="#nodejs_gen_app_credentials">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X POST
"https://api.usergrid.com/management/orgs/testorg/apps/testapp1/credentials"</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/'
-mgmt['orgs/testorg/apps/testapp1/credentials'].create</code></pre>
-<p>The example assumes use of the <a
href="https://github.com/scottganyo/usergrid_iron">Node.js module</a>.</p>
-<pre><code>var options = {
- method:'POST',
- endpoint:'management/orgs/testorg/apps/testapp1/credentials'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â POST failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-7">Example - Response</h4>
-<pre><code>{
- "action": "generate application client credentials",
- "timestamp": 1349815979529,
- "duration": 535,
- "credentials": {
- "client_id": "YXA7ygil-f3TEeG-yhIxPQK1cQ",
- "client_secret": "YXA65gYlqja8aYYSAy8Ox3Vg5aRZp48"
- }
-}</code></pre>
-<h3 id="getting-application-credentials">Getting application credentials</h3>
-<p>Use the GET method to retrieve the client ID and client secret credentials
for an application in an organization.</p>
-<h4 id="request-uri-6">Request URI</h4>
-<p>GET
/organizations|orgs/{org_name}|{uuid}/applications|apps/{app_name}|{uuid}/credentials</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-<tr class="even">
-<td align="left">string app_name|arg uuid</td>
-<td align="left">Application name or application UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-8">Example - Request</h4>
-<ul>
-<li><a href="#curl_get_app_credentials">cURL</a></li>
-<li><a href="#javascript_get_app_credentials">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_app_credentials">Ruby</a></li>
-<li><a href="#nodejs_get_app_credentials">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/apps/testapp1/credentials"</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/'
-mgmt['orgs/testorg/apps/testapp1/credentials']</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/orgs/testorg/apps/testapp1/credentials'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-8">Example - Response</h4>
-<pre><code>{
- "action": "get application client credentials",
- "timestamp": 1349816819545,
- "duration": 7,
- "credentials": {
- "client_id": "YXA7ygil-f3TEeG-yhIxPQK1cQ",
- "client_secret": "YXA65gYlqja8aYYSAy8Ox3Vg5aRZp48"
- }
-}</code></pre>
-<h3 id="getting-the-applications-in-an-organization">Getting the applications
in an organization</h3>
-<p>Use the GET method to retrieve the applications in an organization.</p>
-<h4 id="request-uri-7">Request URI</h4>
-<p>GET /organizations|orgs/{org_name}|{uuid}/applications|apps</p>
-<p>Parameters</p>
-<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 org_name|arg uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Note:</strong>Â You also need to provide a valid access token with
the API call. See <a
href="/authenticating-users-and-application-clients">Authenticating users and
application clients</a> for details.</p>
-<p>Â </p>
-<h4 id="example---request-9">Example - Request</h4>
-<ul>
-<li><a href="#curl_get_apps_org">cURL</a></li>
-<li><a href="#javascript_get_apps_org">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_apps_org">Ruby</a></li>
-<li><a href="#nodejs_get_apps_org">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/apps"</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/'
-apps = mgmt['orgs/testorg/apps'].collection</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/orgs/testorg/apps'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<p>Â </p>
-<h4 id="example---response-9">Example - Response</h4>
-<pre><code>{
- "action": "get organization application",
- "data": {
- "testorg/sandbox": "3500ba10-cd0c-11e1-bcf8-12313d1c5591",
- "testorg/testapp1": "be09a5f9-fdd3-11e1-beca-12313d027361",
- "testorg/testapp2": "cede5b8e-fe90-11e1-65c8-12313b111c56"
- },
- "timestamp": 1349815338635,
- "duration": 22
-}</code></pre>
-<h3 id="adding-an-admin-user-to-an-organization">Adding an admin user to an
organization</h3>
-<p>Use the PUT method to add an existing admin user to an organization.</p>
-<h4 id="request-uri-8">Request URI</h4>
-<p>PUT
/organizations|orgs/{org_name}|{org_uuid}/users/{username|email|uuid}</p>
-<h4 id="parameters-1">Parameters</h4>
-<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 org_name|arg org_uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-<tr class="even">
-<td align="left">string username|string email|arg uuid</td>
-<td align="left">User name, user email address, or user UUID.</td>
-</tr>
-</tbody>
-</table>
-<p>Â </p>
-<h4 id="example---request-10">Example - Request</h4>
-<ul>
-<li><a href="#curl_add_admin_user">cURL</a></li>
-<li><a href="#javascript_add_admin_user">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_add_admin_user">Ruby</a></li>
-<li><a href="#nodejs_add_admin_user">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X PUT
"https://api.usergrid.com/management/orgs/testorg/users/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>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/'
-mgmt['orgs/testorg/users/test123'].put nil</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/orgs/testorg/users/test123'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â PUT failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-10">Example - Response</h4>
-<pre><code>{
- "action": "add user to organization",
- "status": "ok",
- "data": {
- "user": {
- "applicationId": "00000000-0000-0000-0000-000000000001",
- "username": "tester123",
- "name": "test",
- "email": "tester...@hotmail.com",
- "activated": true,
- "disabled": false,
- "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591",
- "adminUser": true,
- "displayEmailAddress": "tester123 <tester...@hotmail.com>",
- "htmldisplayEmailAddress": "tester123 <<a
href="mailto:tester...@hotmail.com">tester...@hotmail.com</a>>"
- }
- },
- "timestamp": 1349390189106,
- "duration": 11808
-}</code></pre>
-<h3 id="getting-the-admin-users-in-an-organization">Getting the admin users in
an organization</h3>
-<p>Use the GET method to retrieve details about the admin users in an
organization.</p>
-<h4 id="request-uri-9">Request URI</h4>
-<p>GET /organizations|orgs/{org_name}|{org_uuid}/users</p>
-<h4 id="parameters-2">Parameters</h4>
-<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 org_name|arg org_uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-</tbody>
-</table>
-<p>Â </p>
-<h4 id="example---request-11">Example - Request</h4>
-<ul>
-<li><a href="#curl_get_admin_users">cURL</a></li>
-<li><a href="#javascript_get_admin_users">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_admin_users">Ruby</a></li>
-<li><a href="#nodejs_get_admin_users">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X GET
"https://api.usergrid.com/management/orgs/testorg/users"</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/'
-admins = mgmt['orgs/testorg/users']</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/orgs/testorg/users'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â GET failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-11">Example - Response</h4>
-<pre><code>{
- "action": "get organization users",
- "data": {
- "user": {
- "applicationId": "00000000-0000-0000-0000-000000000001",
- "username": "tester123",
- "name": "test",
- "email": "tester...@hotmail.com",
- "activated": true,
- "disabled": false,
- "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591",
- "adminUser": true,
- "displayEmailAddress": "tester123 <tester...@hotmail.com>",
- "htmldisplayEmailAddress": "tester123 <<a
href="mailto:tester...@hotmail.com">tester...@hotmail.com</a>>"
- }
- },
- "timestamp": 13494542201685,
- "duration": 10
-}</code></pre>
-<h3 id="removing-an-admin-user-from-an-organization">Removing an admin user
from an organization</h3>
-<p>Use the DELETE method to remove an admin user from an organization.</p>
-<h4 id="request-uri-10">Request URI</h4>
-<p>DELETE
/organizations|orgs/{org_name}|{org_uuid}/users/{username|email|uuid}</p>
-<h4 id="parameters-3">Parameters</h4>
-<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 org_name|arg org_uuid</td>
-<td align="left">Organization name or organization UUID.</td>
-</tr>
-<tr class="even">
-<td align="left">string username|string email|arg uuid</td>
-<td align="left">User name, user email address, or user UUID.</td>
-</tr>
-</tbody>
-</table>
-<p>Â </p>
-<h4 id="example---request-12">Example - Request</h4>
-<ul>
-<li><a href="#curl_delete_admin_user">cURL</a></li>
-<li><a href="#javascript_delete_admin_user">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_delete_admin_user">Ruby</a></li>
-<li><a href="#nodejs_delete_admin_user">Node.js</a></li>
-</ul>
-<!-- -->
-
-<pre><code>curl -X DELETE
"https://api.usergrid.com/management/orgs/testorg/users/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>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/'
-mgmt['orgs/testorg/users/test123'].delete</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:'DELETE',
- endpoint:'management/orgs/testorg/users/test123'
-};
-client.request(options, function (err, data) {
- if (err) {
- //error â DELETE failed
- } else {
- //success â data will contain raw results from API call
- }
-});</code></pre>
-<h4 id="example---response-12">Example - Response</h4>
-<pre><code>{
- "action": "remove user from organization",
- "status": "ok",
- "data": {
- "user": {
- "applicationId": "00000000-0000-0000-0000-000000000001",
- "username": "tester123",
- "name": "test",
- "email": "tester...@hotmail.com",
- "activated": true,
- "disabled": false,
- "uuid": "335b527f-cd0d-11e1-bef8-12331d1c5591",
- "adminUser": true,
- "displayEmailAddress": "tester123 <tester...@hotmail.com>",
- "htmldisplayEmailAddress": "tester123 <<a
href="mailto:tester...@hotmail.com">tester...@hotmail.com</a>>"
- }
- },
- "timestamp": 1349453590005,
- "duration": 727
-}</code></pre>
-<h2 id="admins">Admins</h2>
-<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>
-<h3 id="creating-an-admin-user">Creating an admin user</h3>
-<p>Use the POST method to create an admin user.</p>
-<h4 id="request-uri-11">Request URI</h4>
-<p>POST /management/organizations/{org}/users {request body}</p>
-<h4 id="parameters-4">Parameters</h4>
-<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>
-<h4 id="example---request-13">Example - Request</h4>
-<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>
-<h4 id="example---response-13">Example - Response</h4>
-<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>
-<h3 id="updating-an-admin-user">Updating an admin user</h3>
-<p>Use the PUT method to update an admin user.</p>
-<h4 id="request-uri-12">Request URI</h4>
-<p>PUT /management/organizations/{org}/users/{user|username|email|uuid}
{request body}</p>
-<h4 id="parameters-5">Parameters</h4>
-<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>
-<h4 id="example---request-14">Example - Request</h4>
-<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>
-<h4 id="example---response-14">Example - Response</h4>
-<pre><code>{
- "action": "update user info",
- "timestamp": 1349479321874,
- "duration": 0
-}</code></pre>
-<h3 id="getting-an-admin-user">Getting an admin user</h3>
-<p>Use the GET method to retrieve details about an admin user.</p>
-<h4 id="request-uri-13">Request URI</h4>
-<p>GET /management/organizations/{org}/users/{user|username|email|uuid}</p>
-<h4 id="parameters-6">Parameters</h4>
-<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>
-<h4 id="example---request-15">Example - Request</h4>
-<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>
-<h4 id="example---response-15">Example - Response</h4>
-<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>
-<h3 id="setting-an-admin-users-password">Setting an admin userâs
password</h3>
-<p>Use the PUT method to update an admin userâs password.</p>
-<h4 id="request-uri-14">Request URI</h4>
-<p>PUT
/management/organizations/{org}/users/{user|username|email|uuid}/password
{request body}</p>
-<h4 id="parameters-7">Parameters</h4>
-<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>
-<h4 id="example---request-16">Example - Request</h4>
-<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>
-<h4 id="example---response-16">Example - Response</h4>
-<pre><code>{
- "action": "set user password",
- "timestamp": 1349714010142,
- "duration": 0
-}</code></pre>
-<h3 id="resetting-an-admin-users-password">Resetting an admin userâs
password</h3>
-<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>
-<h4 id="initiating-a-password-reset">Initiating a password reset</h4>
-<p>Use the GET method to initiate the password reset.</p>
-<h4 id="request-uri-15">Request URI</h4>
-<p>GET /management/organizations/{org}/users/resetpw</p>
-<h4 id="example---request-17">Example - Request</h4>
-<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>
-<h4 id="example---response-17">Example - Response</h4>
-<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>
-<h4 id="completing-a-password-reset">Completing a password reset</h4>
-<p>Use the POST method to complete the password reset.</p>
-<h4 id="request-uri-16">Request URI</h4>
-<p>POST /management/organizations/{org}/users/resetpw {request body}</p>
-<h4 id="parameters-8">Parameters</h4>
-<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>
-<h4 id="example---request-18">Example - Request</h4>
-<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>
-<h4 id="example---response-18">Example - Response</h4>
-<pre><code>{
- "action": "reset user password",
- "timestamp": 13546154010321,
- "duration": 0
-}</code></pre>
-<h3 id="activating-an-admin-user">Activating an admin user</h3>
-<p>Use the GET method to activate an admin user from a link provided in an
email notification.</p>
-<h4 id="request-uri-17">Request URI</h4>
-<p>GET
/management/organizations/{org}/users/{user|username|email|uuid}/activate?token={token}&confirm={confirm_email}</p>
-<h4 id="parameters-9">Parameters</h4>
-<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>
-<h4 id="example---request-19">Example - Request</h4>
-<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>
-<h4 id="example---response-19">Example - Response</h4>
-<pre><code>{
- "action": "activate user",
- "timestamp": 1349718021324,
- "duration": 0
-}</code></pre>
-<h3 id="reactivating-an-admin-user">Reactivating an admin user</h3>
-<p>Use the GET method to reactivate an admin user.</p>
-<h4 id="request-uri-18">Request URI</h4>
-<p>GET
/management/organizations/{org}/users/{user|username|email|uuid}/reactivate</p>
-<h4 id="parameters-10">Parameters</h4>
-<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>
-<h4 id="example---request-20">Example - Request</h4>
-<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>
-<h4 id="example---response-20">Example - Response</h4>
-<pre><code>{
- "action": "reactivate user",
- "timestamp": 1349735217217,
- "duration": 3541
-}</code></pre>
-<h3 id="getting-an-admin-users-activity-feed">Getting an admin userâs
activity feed</h3>
-<p>Use the GET method to retrieve an admin userâs activity feed.</p>
-<h4 id="request-uri-19">Request URI</h4>
-<p>GET
/management/organizations/{org}/users/{user|username|email|uuid}/feed</p>
-<h4 id="parameters-11">Parameters</h4>
-<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>
-<h4 id="example---request-21">Example - Request</h4>
-<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>
-<h4 id="example---response-21">Example - Response</h4>
-<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/organizations-admins
2.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>