You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sf...@apache.org on 2015/08/26 17:40:27 UTC
[16/36] usergrid git commit: Update generated website content.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/73186077/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
index 7368826..a3523fe 100644
--- a/content/docs/rest-endpoints/api-docs.html
+++ b/content/docs/rest-endpoints/api-docs.html
@@ -32,7 +32,7 @@
<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"/>
+ <link rel="prev" title="Admin user" href="../orgs-and-apps/admin-user.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<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/creating-a-new-application.html">Creating a new application</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>
@@ -113,10 +114,23 @@
<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">Push Notifications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/overview.html">Push notifications overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/adding-push-support.html">Adding push notifications support</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/getting-started.html">Getting started with push notifications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/tutorial.html">Tutorial: Push notifications sample app</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/registering.html">Registering with a notification service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-notifiers.html">Creating notifiers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/managing-users-and-devices.html">Managing users and devices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-and-managing-notifications.html">Creating and managing notifications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../push-notifications/troubleshooting.html">Troubleshooting</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/using-roles.html">Using roles</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>
@@ -141,9 +155,9 @@
</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>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,44 +172,34 @@
<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>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</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>
+<li class="toctree-l2"><a class="reference internal" href="#access-tokens">Access-Tokens</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#activities">Activities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#admin-users">Admin-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#app-users">App-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#entities-collections">Entities-Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#events">Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#groups">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#notifications">Notifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#organizations-applications">Organizations-Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#permissions-roles">Permissions-Roles</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="#accesstokenresponse">AccessTokenResponse</a></li>
<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>
@@ -205,23 +209,26 @@
<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="#logincredentials">LoginCredentials</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="#notificationupdate">NotificationUpdate</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="#permissions">Permissions</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>
+<li class="toctree-l1"><a class="reference internal" href="#sub-types">Sub-Types</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#collections">Collections</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="#object">Object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#sets">Sets</a></li>
+</ul>
+</li>
</ul>
<p class="caption"><span class="caption-text">Client SDKs</span></p>
<ul>
@@ -275,461 +282,472 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="methods">
+ <h1><p>Usergrid API Reference</p>
+</h1><p>Methods are organized by tag. Follow the methods are the <a class="reference external" href="#models">Model
+Definitions</a>.</p>
+<h2><p>Table of Contents</p>
+</h2><ul class="simple">
+<li><a class="reference external" href="#Access-Tokens">Access-Tokens</a></li>
+<li><a class="reference external" href="#Activities">Activities</a></li>
+<li><a class="reference external" href="#Admin-Users">Admin-Users</a></li>
+<li><a class="reference external" href="#App-Users">App-Users</a></li>
+<li><a class="reference external" href="#Entities-Collections">Entities-Collections</a></li>
+<li><a class="reference external" href="#Events">Events</a></li>
+<li><a class="reference external" href="#Groups">Groups</a></li>
+<li><a class="reference external" href="#Notifications">Notifications</a></li>
+<li><a class="reference external" href="#Organizations-Applications">Organizations-Applications</a></li>
+<li><a class="reference external" href="#Permissions-Roles">Permissions-Roles</a></li>
+</ul>
+<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>
+<div class="section" id="access-tokens">
+<h2>Access-Tokens<a class="headerlink" href="#access-tokens" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /management/token</p>
+</h2><p>Login with Admin-User or Organization credentials.</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>
+<li><strong>login-credentials</strong> (<a class="reference external" href="#logincredentials">LoginCredentials</a>)
+Login credentials either username/password or id/secret. (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>
+<li>Description: Object containing access_token.</li>
+<li>Schema: <a class="reference external" href="#AccessTokenResponse">AccessTokenResponse</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>
+<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>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/token</p>
+</h2><p>Login with App-User or Application credentials.</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>login-credentials</strong> (<a class="reference external" href="#logincredentials">LoginCredentials</a>)
+Login credentials either username/password or id/secret. (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>
+<li>Description: Object containing access_token.</li>
+<li>Schema: <a class="reference external" href="#AccessTokenResponse">AccessTokenResponse</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>
+<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>
+</div>
+<div class="section" id="activities">
+<h2>Activities<a class="headerlink" href="#activities" title="Permalink to this headline">¶</a></h2>
+<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>
-
-
+</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 complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<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>
+<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>
+<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>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>
+<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 complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<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>
+<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>
+<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>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>
+<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 complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<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>
+<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>
+</div>
+<div class="section" id="admin-users">
+<h2>Admin-Users<a class="headerlink" href="#admin-users" 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>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>
+<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>
+<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>
+<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>
+<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>userId</strong> (string) One of the user’s identification which includes
-username, real name, email address or UUID. (Specified in path).</li>
+<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 complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<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>
+<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>
+<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>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>
+<li><strong>CreateAdminUser</strong> (<a class="reference external" href="#createadminuser">CreateAdminUser</a>) User
+entity with fields required for User creation. (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>
+<li>Description: An API Response with a entities array containing the
+newly created Admin User.</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>
+<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>
+<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><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>
+
+
<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>
+<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>
+<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>
+<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>userId</strong> (string) One of the user’s identification which includes
-username, real name, email address or UUID. (Specified in path).</li>
+<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 user’s activity</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of complete messages.</li>
+<li>Schema: ` <#>`__</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>
+<li>Description:</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>
+<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>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>
+<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>
+<li>Description: An API Response with a entities array containing the
+Admin User.</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>
+<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>
+<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>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</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 group’s activity.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An API Response with a entities array containing the
+updated Admin User</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>
+<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>
+<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>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>
+<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> (string) Activation token’s query statement. (Specified in
+query).</li>
+<li><strong>confirm_email</strong> (boolean) 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 user’s activity.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<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>
+<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>
+<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>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>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 user’s activity feed.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<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>
+<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>
+<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>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
+<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 retrieved application data.</li>
-<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
+<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>
+<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>
+</div>
+<div class="section" id="app-users">
+<h2>App-Users<a class="headerlink" href="#app-users" title="Permalink to this headline">¶</a></h2>
+<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> (string) 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 deleted application info.</li>
-<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
+<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>
+<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>
+<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 retrieved credentials info.</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+<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>
+<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>
+<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 generated credentials info.</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+<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>
+<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>
+<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 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 Credential</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+<li>Description: An array of updated 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>
+<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>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Remove 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-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 Credential</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
+<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>
+<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>
+<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>notificationId</strong> (string) One of the notification’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 retrieved device’s info.</li>
-<li>Schema: <a class="reference external" href="#device">Device</a></li>
+<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>
+<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>
+<div class="section" id="entities-collections">
+<h2>Entities-Collections<a class="headerlink" href="#entities-collections" 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>
@@ -742,19 +760,19 @@ includes name or uuid. (Specified in path).</li>
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>
+<li><strong>queryStatement</strong> (string) 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>
+<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>
+<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>
@@ -766,19 +784,19 @@ includes name or uuid. (Specified in path).</li>
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>
+<li><strong>queryStatement</strong> (string) 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>
+<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>
+<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>
@@ -790,19 +808,19 @@ includes name or uuid. (Specified in path).</li>
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>
+<li><strong>queryStatement</strong> (string) 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>
+<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>
+<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>
@@ -823,12 +841,12 @@ which includes name or uuid. (Specified in path).</li>
</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>
+<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>
+<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>
@@ -851,12 +869,12 @@ which includes name or uuid. (Specified in path).</li>
</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>
+<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>
+<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,
@@ -876,12 +894,12 @@ includes name or uuid. (Specified in path).</li>
</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>
+<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>
+<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>
@@ -902,12 +920,12 @@ properties of the entity. (Specified in body).</li>
</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>
+<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>
+<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>
@@ -926,12 +944,12 @@ includes name or uuid. (Specified in path).</li>
</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>
+<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>
+<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
@@ -951,65 +969,143 @@ properties of the entity. (Specified in body).</li>
<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>
+<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="events">
+<h2>Events<a class="headerlink" href="#events" 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="groups">
+<h2>Groups<a class="headerlink" href="#groups" 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-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:</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>
+<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>
+<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>CreateEvent</strong> (<a class="reference external" href="#createevent">CreateEvent</a>) The required
-property of the event. (Specified in body).</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 created event’s info.</li>
-<li>Schema: <a class="reference external" href="#event">Event</a></li>
+<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>
+<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>
+<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>groupproperty</strong> (<a class="reference external" href="#creategroup">CreateGroup</a>) The property of
-the created group. (Specified in body).</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 created group’s info.</li>
-<li>Schema: <a class="reference external" href="#group">Group</a></li>
+<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>
+<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>
@@ -1026,12 +1122,12 @@ name or uuid. (Specified in path).</li>
</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>
+<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>
+<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>
@@ -1048,137 +1144,93 @@ name or uuid. (Specified in path).</li>
</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>
+<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>
+<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>
+<div class="section" id="notifications">
+<h2>Notifications<a class="headerlink" href="#notifications" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{applicationId}/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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<li><strong>queryStatement</strong> (string) 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>
+<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>
+<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 class="usergrid-POST-heading"><p>POST /{orgId}/{applicationId}/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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<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>
+<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 class="usergrid-POST-heading"><p>POST /{orgId}/{applicationId}/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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<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>
+<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 class="usergrid-POST-heading"><p>POST /{orgId}/{applicationId}/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>
@@ -1191,497 +1243,507 @@ 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>
+<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>
+<li>Schema: <a class="reference external" href="#Error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/notifications</p>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{applicationId}/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>
+<li><strong>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<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>
+<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>
+<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{applicationId}/notifications/{notificationId}</p>
+</h2><p>Update a Notification in order to cancel the notifcation or set a new
+expiration time.</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
+<li><strong>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (Specified in path).</li>
+<li><strong>notificationId</strong> (string) One of the notification’s identification
+which includes name or uuid. (Specified in path).</li>
+<li><strong>notificationUpdate</strong> (<a class="reference external" href="#notificationupdate">NotificationUpdate</a>)
+Object with Notification fields to be updated. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An API Response object containing an entity of type
+Notification.</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}/{applicationId}/notifications/{notificationId}</p>
+</h2><p>Delete an unsent Notification from the system.</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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<li>Description: API Response containing Notification entity that was
+deleted.</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}/{applicationId}/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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<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 class="usergrid-POST-heading"><p>POST /{orgId}/{applicationId}/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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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>
+<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>
+<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>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{applicationId}/{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>receiptId</strong> (string) One of the receipt’s identification which
+<li><strong>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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 notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+<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>
+<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>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{applicationId}/{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>CreateOrg</strong> (<a class="reference external" href="#createorg">CreateOrg</a>) A set of organization
-properties supplied through a form. (Specified in body).</li>
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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 created Organization.</li>
-<li>Schema: <a class="reference external" href="#organization">Organization</a></li>
+<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>
+<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>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{applicationId}/{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>applicationId</strong> (string) One of the application’s identification
+which includes name or uuid (same as appId). (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 created Organization.</li>
-<li>Schema: <a class="reference external" href="#organization">Organization</a></li>
+<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>
+<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="userg
<TRUNCATED>