You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/12 19:14:06 UTC
[11/60] [abbrv] incubator-usergrid git commit: cherry picking docs
from master
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/content/docs/rest-endpoints/api-docs.html b/content/docs/rest-endpoints/api-docs.html
new file mode 100644
index 0000000..7368826
--- /dev/null
+++ b/content/docs/rest-endpoints/api-docs.html
@@ -0,0 +1,4192 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Methods — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="COMING SOON..." href="../sdks/tbd.html"/>
+ <link rel="prev" title="Application" href="../orgs-and-apps/application.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="">Methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#action-methods">Action Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#activityfeed-methods">ActivityFeed Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#appdata-methods">AppData Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#credential-methods">Credential Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#devices-methods">Devices Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#entity-methods">Entity Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-methods">Event Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#group-methods">Group Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#notification-methods">Notification Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#organization-methods">Organization Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#permission-methods">Permission Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#receipt-methods">Receipt Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#role-methods">Role Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#user-methods">User Methods</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="#models">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#action">Action</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#activityfeed">ActivityFeed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#actor">Actor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#addpermission">AddPermission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#addrole">AddRole</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#adminuserupdate">AdminUserUpdate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#appdata">AppData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#cancelmsg">CancelMSG</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createactivity">CreateActivity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createadminuser">CreateAdminUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createapp">CreateApp</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createentities">CreateEntities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createentity">CreateEntity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createevent">CreateEvent</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#creategroup">CreateGroup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createnotification">CreateNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createnotifications">CreateNotifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createorg">CreateOrg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#createuser">CreateUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#credential">Credential</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#device">Device</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#entity">Entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#error">Error</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event">Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#group">Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#imagemodel">ImageModel</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#metadata">Metadata</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#notification">Notification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#notifier">Notifier</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#object">Object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#organization">Organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#permission">Permission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#receipt">Receipt</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#resetpw">ResetPW</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#resetpwmsg">ResetPWMsg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#role">Role</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#schedulenotification">ScheduleNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#setexpiration">SetExpiration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#sets">Sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#user">User</a></li>
+</ul>
+</li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Methods</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/rest-endpoints/api-docs.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="methods">
+<h1>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="action-methods">
+<h2>Action Methods<a class="headerlink" href="#action-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/activate</p>
+</h2><p>Activate an organization from a link provIded in an email notification.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>token</strong> () Activation token. (Specified in query).</li>
+<li><strong>confirm_email</strong> () Send confirmation email or not. (Specified in
+query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/reactivate</p>
+</h2><p>Reactivate an expired organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/resetpw</p>
+</h2><p>Initiate the reset of an admin user’s password.</p>
+<h3><p>Parameters</p>
+</h3>
+
+
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /management/users/resetpw</p>
+</h2><p>Complete the password reset through getting the newpassword and the old
+one for identification.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>ResetPWMsg</strong> (<a class="reference external" href="#resetpwmsg">ResetPWMsg</a>) Parameters and value
+for the Captcha challenge, the admin user’s response to the Captcha
+challenge, and the admin user’s email address. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/activate</p>
+</h2><p>Activate an admin user from a link provIded in an email notification.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>token</strong> () Activation token’s query statement. (Specified in
+query).</li>
+<li><strong>confirm_email</strong> () Query statement of whether send confimation
+email or not. (Specified in query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}/password</p>
+</h2><p>Update an admin user’s password through getting the newpassword and the
+old one for identification.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>ResetPW</strong> (<a class="reference external" href="#resetpw">ResetPW</a>) The user’s old and new password.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/reactivate</p>
+</h2><p>Reactivate an expired admin user.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{user}/password</p>
+</h2><p>Set a user’s password or reset the user’s existing password.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>username</strong> (string) The username of the user. (Specified in path).</li>
+<li><strong>ResetPW</strong> (<a class="reference external" href="#resetpw">ResetPW</a>) The user’s old and new password.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="activityfeed-methods">
+<h2>ActivityFeed Methods<a class="headerlink" href="#activityfeed-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/feed</p>
+</h2><p>Retrieve an organization’s activity feed.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of the organization’s ActivityFeed.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/feed</p>
+</h2><p>Retrieve an admin user’s activity feed.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s activity</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/activities</p>
+</h2><p>Create an activity to a specific group. In this case the activity is
+created in the activities collection and is accessible at the
+/activities endpoint to users who have the permission to read that
+endpoint. In addition, a relationship is established between the
+activity and the group, and because of that, the activity will appear in
+the group’s feed. The group ‘owns’ the activity. Also, the activity will
+be published in the feed of all users that are members of the group.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
+sets of activity properties. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/groups/{groupId}/feed</p>
+</h2><p>Get a group’s feed through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of group’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{userId}/activities</p>
+</h2><p>Create an activity in the activities collection.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
+sets of activity properties. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}/feed</p>
+</h2><p>Retrieve a user’s feed through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s activity feed.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="appdata-methods">
+<h2>AppData Methods<a class="headerlink" href="#appdata-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps</p>
+</h2><p>Retrieve the applications in an organization through providing both Id
+of application and organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved application data.</li>
+<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /management/orgs/{orgId}/apps/{appId}</p>
+</h2><p>Remove an application from an organization through providing both Id of
+application and organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted application info.</li>
+<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="credential-methods">
+<h2>Credential Methods<a class="headerlink" href="#credential-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps/{appId}/credentials</p>
+</h2><p>Retrieve the client Id and client secret credentials for an application
+in an organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved credentials info.</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/apps/{appId}/credentials</p>
+</h2><p>Generate the client Id and client secret credentials for an application
+in an organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of generated credentials info.</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/credentials</p>
+</h2><p>Retrieve the credentials for an organization client.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of Credential</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/credentials</p>
+</h2><p>Generate whole new credentials for an organization client.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of Credential</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="devices-methods">
+<h2>Devices Methods<a class="headerlink" href="#devices-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{notificationId}/*/queue</p>
+</h2><p>Retrieve the list of devices associated with one or more notifications
+before the notifications are sent through providing all the
+identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notificationId</strong> (string) One of the notification’s identification
+which includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved device’s info.</li>
+<li>Schema: <a class="reference external" href="#device">Device</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="entity-methods">
+<h2>Entity Methods<a class="headerlink" href="#entity-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}/{relation}</p>
+</h2><p>Retrieve a user’s collections or connections through query statement.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+<li><strong>relation</strong> (string) The relation between user and collections.
+(Specified in path).</li>
+<li><strong>queryStatement</strong> () The query statement of the user. (Specified in
+query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s collections info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{collectionId}</p>
+</h2><p>Retrieve collection through query statement.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>queryStatement</strong> () Any values specified in the query statement
+should be enclosed in single-quotes. (Specified in query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved collection’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{appId}/{collectionId}</p>
+</h2><p>Update collection through query statement.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>queryStatement</strong> () Any values specified in the query statement
+should be enclosed in single-quotes. (Specified in query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of updated collection’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</p>
+</h2><p>Add an entity to a collection through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>entityId1</strong> (string) The Id of the 1st entity. (Specified in path).</li>
+<li><strong>relation</strong> (string) The relation between 1st entity and 2nd entity.
+(Specified in path).</li>
+<li><strong>entityId2</strong> (string) The Id of the 2nd entity. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of added entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE
+/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</p>
+</h2><p>Remove an entity from a collection through providing all the
+identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>entityId1</strong> (string) The Id of the 1st entity. (Specified in path).</li>
+<li><strong>relation</strong> (string) The relation between 1st entity and 2nd entity.
+(Specified in path).</li>
+<li><strong>entityId2</strong> (string) The Id of the 2nd entity. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{collectionId}/{entityId}</p>
+</h2><p>Retrieve an entity through providing Id of application, organization,
+collection and entity.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>entityId</strong> (string) One of the entity’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{appId}/{collectionId}/{entityId}</p>
+</h2><p>One or more properties can be updated with a single request.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>entityId</strong> (string) One of the entity’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>entityproperty</strong> (<a class="reference external" href="#createentities">CreateEntities</a>) The
+properties of the entity. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of updated entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/{collectionId}/{entityId}</p>
+</h2><p>Delete an entity from the collection.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>collectionId</strong> (string) One of the collection’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>entityId</strong> (string) One of the entity’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/{entitytype}</p>
+</h2><p>When a new entity is created, Usergrid will automatically create a
+corresponding collection if one does not already exist. The collection
+will automatically be named with the plural form of the entity type.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>entitytype</strong> (string) The entity type to create. (Specified in
+path).</li>
+<li><strong>entityproperty</strong> (<a class="reference external" href="#createentities">CreateEntities</a>) The
+properties of the entity. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created custom entity’s info.</li>
+<li>Schema: <a class="reference external" href="#entity">Entity</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="event-methods">
+<h2>Event Methods<a class="headerlink" href="#event-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/events</p>
+</h2><p>Create an event through providing both Id of organization and
+application.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>CreateEvent</strong> (<a class="reference external" href="#createevent">CreateEvent</a>) The required
+property of the event. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created event’s info.</li>
+<li>Schema: <a class="reference external" href="#event">Event</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="group-methods">
+<h2>Group Methods<a class="headerlink" href="#group-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups</p>
+</h2><p>Create a new group through providing both Id of organization and
+application.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupproperty</strong> (<a class="reference external" href="#creategroup">CreateGroup</a>) The property of
+the created group. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created group’s info.</li>
+<li>Schema: <a class="reference external" href="#group">Group</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{org_Id}/{app_Id}/groups/{groupId}</p>
+</h2><p>Get a group through through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved group’s info.</li>
+<li>Schema: <a class="reference external" href="#group">Group</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /{org_Id}/{app_Id}/groups/{groupId}</p>
+</h2><p>Update a group through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of updated group’s info.</li>
+<li>Schema: <a class="reference external" href="#group">Group</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="notification-methods">
+<h2>Notification Methods<a class="headerlink" href="#notification-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-PUT-heading"><p>PUT /my-org/sandbox/notifications/{notificationId}</p>
+</h2><p>Cancel sent notifications through providing the Id of the notification.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>notificationId</strong> (string) One of the notification’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>cancelMsg</strong> (<a class="reference external" href="#cancelmsg">CancelMSG</a>) Indicete whether is
+canceled or not. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of canceled notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices</p>
+</h2><p>Create notifications for user through targeting by location and
+providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
+These parameters are used when forming the notification portion of
+the request. (Specified in body).</li>
+<li><strong>scheduleNotification</strong>
+(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
+notification for a later time add the deliver parameter with a UNIX
+timestamp to the body of your request. (Specified in body).</li>
+<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
+service can’t deliver a message to a device and needs to resend it
+you can set a notification to expire after a certain date/time.
+(Specified in body).</li>
+<li><strong>queryStatement</strong> () The query statement of the location of the
+user. (Specified in query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices/*/notifications</p>
+</h2><p>Create notifications for all devices. This request will target all
+device entities.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
+These parameters are used when forming the notification portion of
+the request. (Specified in body).</li>
+<li><strong>scheduleNotification</strong>
+(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
+notification for a later time add the deliver parameter with a UNIX
+timestamp to the body of your request. (Specified in body).</li>
+<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
+service can’t deliver a message to a device and needs to resend it
+you can set a notification to expire after a certain date/time.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices/{deviceId}/notifications</p>
+</h2><p>Create notifications for a single device. This request will target a
+specific device entity.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>deviceId</strong> (string) One of the device’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
+These parameters are used when forming the notification portion of
+the request. (Specified in body).</li>
+<li><strong>scheduleNotification</strong>
+(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
+notification for a later time add the deliver parameter with a UNIX
+timestamp to the body of your request. (Specified in body).</li>
+<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
+service can’t deliver a message to a device and needs to resend it
+you can set a notification to expire after a certain date/time.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{path}/notifications</p>
+</h2><p>Create notifications for a group. This request will target all users
+associated with a specific group entity.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>path</strong> (string) The path of the group. (Specified in path).</li>
+<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
+These parameters are used when forming the notification portion of
+the request. (Specified in body).</li>
+<li><strong>scheduleNotification</strong>
+(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
+notification for a later time add the deliver parameter with a UNIX
+timestamp to the body of your request. (Specified in body).</li>
+<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
+service can’t deliver a message to a device and needs to resend it
+you can set a notification to expire after a certain date/time.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/notifications</p>
+</h2><p>Retrieve one or more notifications through providing all the
+identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/notifications/{notificationId}</p>
+</h2><p>Remove unsent notifications through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notificationId</strong> (string) One of the notification’s identification
+which includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{userId}/notifications</p>
+</h2><p>Create notifications for a user. This request will target a specific
+user entity.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
+These parameters are used when forming the notification portion of
+the request. (Specified in body).</li>
+<li><strong>scheduleNotification</strong>
+(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
+notification for a later time add the deliver parameter with a UNIX
+timestamp to the body of your request. (Specified in body).</li>
+<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
+service can’t deliver a message to a device and needs to resend it
+you can set a notification to expire after a certain date/time.
+(Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{receiptId}/*/notifications</p>
+</h2><p>Retrieve notifications associated with one or more receipts through
+providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>receiptId</strong> (string) One of the receipt’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved notification’s info.</li>
+<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="organization-methods">
+<h2>Organization Methods<a class="headerlink" href="#organization-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /management/orgs</p>
+</h2><p>Create an organization through a form post.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>CreateOrg</strong> (<a class="reference external" href="#createorg">CreateOrg</a>) A set of organization
+properties supplied through a form. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created Organization.</li>
+<li>Schema: <a class="reference external" href="#organization">Organization</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}</p>
+</h2><p>Retrieve an organization given a specified UUID or username.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created Organization.</li>
+<li>Schema: <a class="reference external" href="#organization">Organization</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="permission-methods">
+<h2>Permission Methods<a class="headerlink" href="#permission-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/permissions</p>
+</h2><p>Remove permissions from a role.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>grant_url_pattern</strong> () The query statement of the url pattern.
+(Specified in query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted permission’s info.</li>
+<li>Schema: <a class="reference external" href="#permission">Permission</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="receipt-methods">
+<h2>Receipt Methods<a class="headerlink" href="#receipt-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/receipts</p>
+</h2><p>Retrieve one or more receipts through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved receipt’s info.</li>
+<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{deviceId}/*/receipts</p>
+</h2><p>Retrieve receipts associated with one or more devices through providing
+all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>deviceId</strong> (string) One of the device’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved receipt’s info.</li>
+<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{notificationId}/*/receipts</p>
+</h2><p>Retrieve receipts for one or more notifications through providing all
+the identifications.”</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>notificationId</strong> (string) One of the notification’s identification
+which includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved receipt’s info.</li>
+<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="role-methods">
+<h2>Role Methods<a class="headerlink" href="#role-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles</p>
+</h2><p>Retrieve the roles in an application through providing all the
+identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved role’s info.</li>
+<li>Schema: <a class="reference external" href="#role">Role</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles</p>
+</h2><p>Create a new role through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>roleproperty</strong> (<a class="reference external" href="#addrole">AddRole</a>) The required properties of
+the role. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created role’s info.</li>
+<li>Schema: <a class="reference external" href="#role">Role</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{rolename}</p>
+</h2><p>Remove a role through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>rolename</strong> (string) The name of the role. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted role’s info.</li>
+<li>Schema: <a class="reference external" href="#role">Role</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="user-methods">
+<h2>User Methods<a class="headerlink" href="#user-methods" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/users</p>
+</h2><p>Retrieve details about the admin users in an organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /management/orgs/{orgId}/users/{userId}</p>
+</h2><p>Remove an admin user from an organization through providing both Id of
+application and organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-2</strong> (string) One of the user’s identification which includes
+username, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /management/users</p>
+</h2><p>Create a whole new admin user.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>adminuserproperty</strong> (<a class="reference external" href="#createadminuser">CreateAdminUser</a>) One or
+more sets of user properties of which username is mandatory and must
+be unique. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of new created Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}</p>
+</h2><p>Retrieve details about an admin user.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s details</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}</p>
+</h2><p>Update the info of an admin user.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s details.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
+</h2><p>Add a user to a group through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of added user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
+</h2><p>Delete user from a group through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles/{roleId}/users</p>
+</h2><p>Retrieve the users in a role through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
+</h2><p>Add a user to a role through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of added user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
+</h2><p>Remove a user from a role through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users</p>
+</h2><p>Retrieve users though query statement.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>queryStatement</strong> () The query statement of the User. (Specified in
+query).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users</p>
+</h2><p>Create a user in the users collection through providing all the
+identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>CreateUser</strong> (<a class="reference external" href="#createuser">CreateUser</a>) The properties of the
+user. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of created user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Retrieve a user through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-2</strong> (string) One of the user’s identification which includes
+username, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Update a user through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name o
<TRUNCATED>