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/07 23:05:59 UTC
[05/21] incubator-usergrid git commit: Minor refactoring in API doc
generation.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.html b/docs/rest-endpoints/api-docs.html
index 1241a65..c4841f9 100644
--- a/docs/rest-endpoints/api-docs.html
+++ b/docs/rest-endpoints/api-docs.html
@@ -21,573 +21,28 @@
<p>Generated from Swagger.</p>
<h2>Methods</h2><p>API methods are organized by the tags.</p>
<p>Following the methods is a listing of all <a href='#models'>Default Entity Models.</p>
-<a name='Action-method'></a>
-<h2>Action Methods</h2>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/activate
- <a data-toggle="collapse" data-target="#collapse-iN5h4Rfha6"
- href="#collapse-iN5h4Rfha6" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-iN5h4Rfha6" class="panel-body collapse">
-
- <p>Activate an organization from a link provIded in an email notification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>token</b> () <br>
- Activation token. (Specified in query).
- </li>
- <li>
- <b>confirm_email</b> () <br>
- Send confirmation email or not. (Specified in query).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-4JPBNBUnYR"
- href="#collapse-4JPBNBUnYR" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-4JPBNBUnYR" class="panel-body collapse">
-
- <p>Reactivate an expired organization.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-8Q4qhiQLvH"
- href="#collapse-8Q4qhiQLvH" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-8Q4qhiQLvH" class="panel-body collapse">
-
- <p>Initiate the reset of an admin user's password.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
+<a name='Access-Tokens-method'></a>
+<h2>Access-Tokens</h2>
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-TBw5HyJTTa"
- href="#collapse-TBw5HyJTTa" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-TBw5HyJTTa" class="panel-body collapse">
-
- <p>Complete the password reset through getting the newpassword and the old one for identification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br>
- 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>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
- <a data-toggle="collapse" data-target="#collapse-gPyb4FcquB"
- href="#collapse-gPyb4FcquB" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /management/token
+ <a data-toggle="collapse" data-target="#collapse-drcFs9dfPU"
+ href="#collapse-drcFs9dfPU" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-gPyb4FcquB" class="panel-body collapse">
+ <div id="collapse-drcFs9dfPU" class="panel-body collapse">
- <p>Activate an admin user from a link provIded in an email notification.</p>
+ <p>Login with Admin-User or Organization credentials.</p>
<h3>Parameters</h3>
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- <li>
- <b>token</b> () <br>
- Activation token's query statement. (Specified in query).
- </li>
- <li>
- <b>confirm_email</b> () <br>
- Query statement of whether send confimation email or not. (Specified in query).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
- <a data-toggle="collapse" data-target="#collapse-eOkQcznynD"
- href="#collapse-eOkQcznynD" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-eOkQcznynD" class="panel-body collapse">
-
- <p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- <li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
- The user's old and new password. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-pxE50B5nCD"
- href="#collapse-pxE50B5nCD" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-pxE50B5nCD" class="panel-body collapse">
-
- <p>Reactivate an expired admin user.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
- <a data-toggle="collapse" data-target="#collapse-sOcj4VS4JA"
- href="#collapse-sOcj4VS4JA" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-sOcj4VS4JA" class="panel-body collapse">
-
- <p>Set a user's password or reset the user's existing password.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>username</b> (string) <br>
- The username of the user. (Specified in path).
- </li>
- <li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
- The user's old and new password. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-<a name='ActivityFeed-method'></a>
-<h2>ActivityFeed Methods</h2>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/feed
- <a data-toggle="collapse" data-target="#collapse-HkB3lyybM0"
- href="#collapse-HkB3lyybM0" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-HkB3lyybM0" class="panel-body collapse">
-
- <p>Retrieve an organization's activity feed.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of the organization's ActivityFeed.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-trV5SjBRiv"
- href="#collapse-trV5SjBRiv" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-trV5SjBRiv" class="panel-body collapse">
-
- <p>Retrieve an admin user's activity feed.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of user's activity</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities
- <a data-toggle="collapse" data-target="#collapse-zj0yM6YokI"
- href="#collapse-zj0yM6YokI" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-zj0yM6YokI" class="panel-body collapse">
-
- <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>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
- One or more sets of activity properties. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
- <a data-toggle="collapse" data-target="#collapse-gIeQmdnsDx"
- href="#collapse-gIeQmdnsDx" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-gIeQmdnsDx" class="panel-body collapse">
-
- <p>Get a group's feed through providing all the identifications.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
+ <ul>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -597,8 +52,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of group's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Description: Object containing access_token.</li>
+ <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
</ul>
</li>
<li>
@@ -617,34 +72,22 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
- <a data-toggle="collapse" data-target="#collapse-L2T56Ztybh"
- href="#collapse-L2T56Ztybh" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/token
+ <a data-toggle="collapse" data-target="#collapse-XlaRG4JVxJ"
+ href="#collapse-XlaRG4JVxJ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-L2T56Ztybh" class="panel-body collapse">
+ <div id="collapse-XlaRG4JVxJ" class="panel-body collapse">
- <p>Create an activity in the activities collection.</p>
+ <p>Login with App-User or Application credentials.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
- </li>
- <li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
- One or more sets of activity properties. (Specified in body).
+ <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -654,8 +97,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Description: An array of new created Admin user's info.</li>
+ <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
</ul>
</li>
<li>
@@ -670,19 +113,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Activities-method'></a>
+<h2>Activities</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-q3sk3xVUu4"
- href="#collapse-q3sk3xVUu4" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
+ <a data-toggle="collapse" data-target="#collapse-tmnHUKGqLS"
+ href="#collapse-tmnHUKGqLS" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-q3sk3xVUu4" class="panel-body collapse">
+ <div id="collapse-tmnHUKGqLS" class="panel-body collapse">
- <p>Retrieve a user's feed through providing all the identifications.</p>
+ <p>Get a group's feed through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -696,8 +141,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
+ <b>groupId</b> (string) <br>
+ One of the group's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -707,7 +152,7 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's activity feed.</li>
+ <li>Description: An array of group's activity.</li>
<li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
@@ -723,21 +168,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='AppData-method'></a>
-<h2>AppData Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps
- <a data-toggle="collapse" data-target="#collapse-2aQqcShABU"
- href="#collapse-2aQqcShABU" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
+ <a data-toggle="collapse" data-target="#collapse-oOJfU8LsRY"
+ href="#collapse-oOJfU8LsRY" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2aQqcShABU" class="panel-body collapse">
+ <div id="collapse-oOJfU8LsRY" class="panel-body collapse">
- <p>Retrieve the applications in an organization through providing both Id of application and organization.</p>
+ <p>Create an activity in the activities collection.</p>
<h3>Parameters</h3>
@@ -746,54 +189,17 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of retrieved application data.</li>
- <li>Schema: [<a href="#appdata">AppData</a>]</li>
- </ul>
- </li>
<li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
+ <b>appId</b> (string) <br>
+ One of the application's identification which includes name or uuid. (Specified in path).
</li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}
- <a data-toggle="collapse" data-target="#collapse-G319AhhnWy"
- href="#collapse-G319AhhnWy" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-G319AhhnWy" class="panel-body collapse">
-
- <p>Remove an application from an organization through providing both Id of application and organization.</p>
-
- <h3>Parameters</h3>
-
- <ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
+ <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
+ One or more sets of activity properties. (Specified in body).
</li>
</ul>
@@ -803,8 +209,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted application info.</li>
- <li>Schema: [<a href="#appdata">AppData</a>]</li>
+ <li>Description: An array of user's activity.</li>
+ <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
@@ -819,21 +225,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Credential-method'></a>
-<h2>Credential Methods</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-AASgKtaSkG"
- href="#collapse-AASgKtaSkG" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
+ <a data-toggle="collapse" data-target="#collapse-pYJU4YKTd8"
+ href="#collapse-pYJU4YKTd8" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-AASgKtaSkG" class="panel-body collapse">
+ <div id="collapse-pYJU4YKTd8" class="panel-body collapse">
- <p>Retrieve the client Id and client secret credentials for an application in an organization.</p>
+ <p>Retrieve a user's feed through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -846,6 +250,10 @@
<b>appId</b> (string) <br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
+ <li>
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
+ </li>
</ul>
<h3>Responses</h3>
@@ -854,8 +262,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved credentials info.</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of user's activity feed.</li>
+ <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
@@ -870,19 +278,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Admin-Users-method'></a>
+<h2>Admin-Users</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-dKcFwuUjzH"
- href="#collapse-dKcFwuUjzH" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/users
+ <a data-toggle="collapse" data-target="#collapse-v3QdwGriJl"
+ href="#collapse-v3QdwGriJl" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-dKcFwuUjzH" class="panel-body collapse">
+ <div id="collapse-v3QdwGriJl" class="panel-body collapse">
- <p>Generate the client Id and client secret credentials for an application in an organization.</p>
+ <p>Retrieve details about the admin users in an organization.</p>
<h3>Parameters</h3>
@@ -891,10 +301,6 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
</ul>
<h3>Responses</h3>
@@ -903,8 +309,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of generated credentials info.</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of retrieved Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -922,16 +328,16 @@
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-ZMqkJ1AwIr"
- href="#collapse-ZMqkJ1AwIr" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-6cRMjJKYQr"
+ href="#collapse-6cRMjJKYQr" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ZMqkJ1AwIr" class="panel-body collapse">
+ <div id="collapse-6cRMjJKYQr" class="panel-body collapse">
- <p>Retrieve the credentials for an organization client.</p>
+ <p>Remove an admin user from an organization through providing both Id of application and organization.</p>
<h3>Parameters</h3>
@@ -940,6 +346,10 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
+ <li>
+ <b>userId-2</b> (string) <br>
+ One of the user's identification which includes username, email address or UUID. (Specified in path).
+ </li>
</ul>
<h3>Responses</h3>
@@ -948,8 +358,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of Credential</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of deleted Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -968,22 +378,22 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-eG7QcoefBR"
- href="#collapse-eG7QcoefBR" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /management/users
+ <a data-toggle="collapse" data-target="#collapse-bVYwPxPrHs"
+ href="#collapse-bVYwPxPrHs" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-eG7QcoefBR" class="panel-body collapse">
+ <div id="collapse-bVYwPxPrHs" class="panel-body collapse">
- <p>Generate whole new credentials for an organization client.</p>
+ <p>Create a whole new admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
+ <b>adminuserproperty</b> ( <a href="#createadminuser">CreateAdminUser</a>) <br>
+ One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
</li>
</ul>
@@ -993,8 +403,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of Credential</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of new created Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1009,37 +419,23 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Devices-method'></a>
-<h2>Devices Methods</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue
- <a data-toggle="collapse" data-target="#collapse-m94kArvzxi"
- href="#collapse-m94kArvzxi" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/resetpw
+ <a data-toggle="collapse" data-target="#collapse-7WBllKwJ3P"
+ href="#collapse-7WBllKwJ3P" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-m94kArvzxi" class="panel-body collapse">
+ <div id="collapse-7WBllKwJ3P" class="panel-body collapse">
- <p>Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.</p>
+ <p>Initiate the reset of an admin user's password.</p>
<h3>Parameters</h3>
<ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>notificationId</b> (string) <br>
- One of the notification's identification which includes name or uuid. (Specified in path).
- </li>
</ul>
<h3>Responses</h3>
@@ -1048,8 +444,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved device's info.</li>
- <li>Schema: [<a href="#device">Device</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1064,44 +460,26 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Entity-method'></a>
-<h2>Entity Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
- <a data-toggle="collapse" data-target="#collapse-pIaAhJWMZp"
- href="#collapse-pIaAhJWMZp" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /management/users/resetpw
+ <a data-toggle="collapse" data-target="#collapse-OBQT3BKr5H"
+ href="#collapse-OBQT3BKr5H" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-pIaAhJWMZp" class="panel-body collapse">
+ <div id="collapse-OBQT3BKr5H" class="panel-body collapse">
- <p>Retrieve a user's collections or connections through query statement.</p>
+ <p>Complete the password reset through getting the newpassword and the old one for identification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
- </li>
- <li>
- <b>relation</b> (string) <br>
- The relation between user and collections. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- The query statement of the user. (Specified in query).
+ <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br>
+ 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>
@@ -1111,8 +489,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's collections info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1131,34 +509,22 @@
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-xW56KedRyq"
- href="#collapse-xW56KedRyq" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-PiHbAwNiA5"
+ href="#collapse-PiHbAwNiA5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-xW56KedRyq" class="panel-body collapse">
+ <div id="collapse-PiHbAwNiA5" class="panel-body collapse">
- <p>Retrieve collection through query statement.</p>
+ <p>Retrieve details about an admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1168,8 +534,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of user's details</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1188,34 +554,22 @@
<div class="panel panel-default">
<div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-Zy8ncQAeme"
- href="#collapse-Zy8ncQAeme" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title PUT-heading">PUT /management/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-Gep5hzbYRO"
+ href="#collapse-Gep5hzbYRO" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Zy8ncQAeme" class="panel-body collapse">
+ <div id="collapse-Gep5hzbYRO" class="panel-body collapse">
- <p>Update collection through query statement.</p>
+ <p>Update the info of an admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1225,8 +579,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of user's details.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1244,43 +598,31 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-ocB2PheyLp"
- href="#collapse-ocB2PheyLp" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
+ <a data-toggle="collapse" data-target="#collapse-8lFgKne5Tw"
+ href="#collapse-8lFgKne5Tw" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ocB2PheyLp" class="panel-body collapse">
+ <div id="collapse-8lFgKne5Tw" class="panel-body collapse">
- <p>Add an entity to a collection through providing all the identifications.</p>
+ <p>Activate an admin user from a link provIded in an email notification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId1</b> (string) <br>
- The Id of the 1st entity. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>relation</b> (string) <br>
- The relation between 1st entity and 2nd entity. (Specified in path).
+ <b>token</b> (string) <br>
+ Activation token's query statement. (Specified in query).
</li>
- <li>
- <b>entityId2</b> (string) <br>
- The Id of the 2nd entity. (Specified in path).
+ <li>
+ <b>confirm_email</b> (boolean) <br>
+ Query statement of whether send confimation email or not. (Specified in query).
</li>
</ul>
@@ -1290,8 +632,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of added entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1309,43 +651,27 @@
<div class="panel panel-default">
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-5zFww1vFfs"
- href="#collapse-5zFww1vFfs" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
+ <a data-toggle="collapse" data-target="#collapse-xHaeQAbaqd"
+ href="#collapse-xHaeQAbaqd" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-5zFww1vFfs" class="panel-body collapse">
+ <div id="collapse-xHaeQAbaqd" class="panel-body collapse">
- <p>Remove an entity from a collection through providing all the identifications.</p>
+ <p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId1</b> (string) <br>
- The Id of the 1st entity. (Specified in path).
- </li>
- <li>
- <b>relation</b> (string) <br>
- The relation between 1st entity and 2nd entity. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>entityId2</b> (string) <br>
- The Id of the 2nd entity. (Specified in path).
+ <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ The user's old and new password. (Specified in body).
</li>
</ul>
@@ -1355,8 +681,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1375,34 +701,22 @@
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-1dov3vPnls"
- href="#collapse-1dov3vPnls" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
+ <a data-toggle="collapse" data-target="#collapse-aPY008UTT5"
+ href="#collapse-aPY008UTT5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-1dov3vPnls" class="panel-body collapse">
+ <div id="collapse-aPY008UTT5" class="panel-body collapse">
- <p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
+ <p>Reactivate an expired admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1412,8 +726,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1428,19 +742,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='App-Users-method'></a>
+<h2>App-Users</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-CMPoM2NkHk"
- href="#collapse-CMPoM2NkHk" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users
+ <a data-toggle="collapse" data-target="#collapse-yQoflCFgcD"
+ href="#collapse-yQoflCFgcD" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-CMPoM2NkHk" class="panel-body collapse">
+ <div id="collapse-yQoflCFgcD" class="panel-body collapse">
- <p>One or more properties can be updated with a single request.</p>
+ <p>Retrieve users though query statement.</p>
<h3>Parameters</h3>
@@ -1454,16 +770,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
- The properties of the entity. (Specified in body).
+ <b>queryStatement</b> (string) <br>
+ The query statement of the User. (Specified in query).
</li>
</ul>
@@ -1473,8 +781,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of retrieved user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1492,16 +800,16 @@
<div class="panel panel-default">
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-Jg2pLwSrSu"
- href="#collapse-Jg2pLwSrSu" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users
+ <a data-toggle="collapse" data-target="#collapse-xoM0nnodXH"
+ href="#collapse-xoM0nnodXH" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Jg2pLwSrSu" class="panel-body collapse">
+ <div id="collapse-xoM0nnodXH" class="panel-body collapse">
- <p>Delete an entity from the collection.</p>
+ <p>Create a user in the users collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1515,12 +823,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
+ <b>CreateUser</b> ( <a href="#createuser">CreateUser</a>) <br>
+ The properties of the user. (Specified in body).
</li>
</ul>
@@ -1530,8 +834,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of created user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1549,16 +853,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{entitytype}
- <a data-toggle="collapse" data-target="#collapse-o8OSLLkp41"
- href="#collapse-o8OSLLkp41" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-nwtxxd6sC5"
+ href="#collapse-nwtxxd6sC5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-o8OSLLkp41" class="panel-body collapse">
+ <div id="collapse-nwtxxd6sC5" class="panel-body collapse">
- <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>
+ <p>Retrieve a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1572,12 +876,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entitytype</b> (string) <br>
- The entity type to create. (Specified in path).
- </li>
- <li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
- The properties of the entity. (Specified in body).
+ <b>userId-2</b> (string) <br>
+ One of the user's identification which includes username, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1587,8 +887,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created custom entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of retrieved user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1603,21 +903,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Event-method'></a>
-<h2>Event Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/events
- <a data-toggle="collapse" data-target="#collapse-qnPBoA07vy"
- href="#collapse-qnPBoA07vy" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-1ouK9M0Buc"
+ href="#collapse-1ouK9M0Buc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-qnPBoA07vy" class="panel-body collapse">
+ <div id="collapse-1ouK9M0Buc" class="panel-body collapse">
- <p>Create an event through providing both Id of organization and application.</p>
+ <p>Update a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1631,8 +929,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>CreateEvent</b> ( <a href="#createevent">CreateEvent</a>) <br>
- The required property of the event. (Specified in body).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1642,8 +940,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created event's info.</li>
- <li>Schema: [<a href="#event">Event</a>]</li>
+ <li>Description: An array of updated user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1658,21 +956,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Group-method'></a>
-<h2>Group Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups
- <a data-toggle="collapse" data-target="#collapse-4qiW3TsSSu"
- href="#collapse-4qiW3TsSSu" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-Il1v6OOFVy"
+ href="#collapse-Il1v6OOFVy" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-4qiW3TsSSu" class="panel-body collapse">
+ <div id="collapse-Il1v6OOFVy" class="panel-body collapse">
- <p>Create a new group through providing both Id of organization and application.</p>
+ <p>Remove a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1686,8 +982,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupproperty</b> ( <a href="#creategroup">CreateGroup</a>) <br>
- The property of the created group. (Specified in body).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1697,8 +993,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of deleted user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1716,16 +1012,16 @@
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-mh3TFMiqlw"
- href="#collapse-mh3TFMiqlw" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
+ <a data-toggle="collapse" data-target="#collapse-imri2jPPiC"
+ href="#collapse-imri2jPPiC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-mh3TFMiqlw" class="panel-body collapse">
+ <div id="collapse-imri2jPPiC" class="panel-body collapse">
- <p>Get a group through through providing all the identifications.</p>
+ <p>Set a user's password or reset the user's existing password.</p>
<h3>Parameters</h3>
@@ -1739,8 +1035,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>username</b> (string) <br>
+ The username of the user. (Specified in path).
+ </li>
+ <li>
+ <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ The user's old and new password. (Specified in body).
</li>
</ul>
@@ -1750,8 +1050,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1766,19 +1066,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Entities-Collections-method'></a>
+<h2>Entities-Collections</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-Ytvz84UP9Q"
- href="#collapse-Ytvz84UP9Q" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
+ <a data-toggle="collapse" data-target="#collapse-SIBQHXJ8cG"
+ href="#collapse-SIBQHXJ8cG" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Ytvz84UP9Q" class="panel-body collapse">
+ <div id="collapse-SIBQHXJ8cG" class="panel-body collapse">
- <p>Update a group through providing all the identifications.</p>
+ <p>Retrieve a user's collections or connections through query statement.</p>
<h3>Parameters</h3>
@@ -1792,8 +1094,16 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
+ </li>
+ <li>
+ <b>relation</b> (string) <br>
+ The relation between user and collections. (Specified in path).
+ </li>
+ <li>
+ <b>queryStatement</b> (string) <br>
+ The query statement of the user. (Specified in query).
</li>
</ul>
@@ -1803,8 +1113,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of user's collections info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1819,32 +1129,38 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Notification-method'></a>
-<h2>Notification Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}
- <a data-toggle="collapse" data-target="#collapse-2X3BWwAy5v"
- href="#collapse-2X3BWwAy5v" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
+ <a data-toggle="collapse" data-target="#collapse-dJMRYq1Xcc"
+ href="#collapse-dJMRYq1Xcc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2X3BWwAy5v" class="panel-body collapse">
+ <div id="collapse-dJMRYq1Xcc" class="panel-body collapse">
- <p>Cancel sent notifications through providing the Id of the notification.</p>
+ <p>Retrieve collection through query statement.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>notificationId</b> (string) <br>
- One of the notification's identification which includes name or uuid. (Specified in path).
+ <b>orgId</b> (string) <br>
+ One of the organization's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>appId</b> (string) <br>
+ One of the application's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>cancelMsg</b> ( <a href="#cancelmsg">CancelMSG</a>) <br>
- Indicete whether is canceled or not. (Specified in body).
+ <b>queryStatement</b> (string) <br>
+ Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1854,8 +1170,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of canceled notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of retrieved collection's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1873,16 +1189,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices
- <a data-toggle="collapse" data-target="#collapse-oPXCIDKL6a"
- href="#collapse-oPXCIDKL6a" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
+ <a data-toggle="collapse" data-target="#collapse-5ueDq97AOE"
+ href="#collapse-5ueDq97AOE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-oPXCIDKL6a" class="panel-body collapse">
+ <div id="collapse-5ueDq97AOE" class="panel-body collapse">
- <p>Create notifications for user through targeting by location and providing all the identifications.</p>
+ <p>Update collection through query statement.</p>
<h3>Parameters</h3>
@@ -1896,20 +1212,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
- </li>
- <li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- 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>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- 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).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>queryStatement</b> () <br>
- The query statement of the location of the user. (Specified in query).
+ <b>queryStatement</b> (string) <br>
+ Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1919,8 +1227,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of updated collection's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1939,15 +1247,15 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/*/notifications
- <a data-toggle="collapse" data-target="#collapse-QHRHWLFRwh"
- href="#collapse-QHRHWLFRwh" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
+ <a data-toggle="collapse" data-target="#collapse-dKuOHbhgMw"
+ href="#collapse-dKuOHbhgMw" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-QHRHWLFRwh" class="panel-body collapse">
+ <div id="collapse-dKuOHbhgMw" class="panel-body collapse">
- <p>Create notifications for all devices. This request will target all device entities.</p>
+ <p>Add an entity to a collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1961,16 +1269,20 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>entityId1</b> (string) <br>
+ The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- 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).
+ <b>relation</b> (string) <br>
+ The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- 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).
+ <b>entityId2</b> (string) <br>
+ The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -1980,8 +1292,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of added entity's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1999,16 +1311,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/{deviceId}/notifications
- <a data-toggle="collapse" data-target="#collapse-YK5TdQKJ4Z"
- href="#collapse-YK5TdQKJ4Z" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
+ <a data-toggle="collapse" data-target="#collapse-0Db3hm26XC"
+ href="#collapse-0Db3hm26XC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-YK5TdQKJ4Z" class="panel-body collapse">
+ <div id="collapse-0Db3hm26XC" class="panel-body collapse">
- <p>Create notifications for a single device. This request will target a specific device entity.</p>
+ <p>Remove an entity from a collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -2022,20 +1334,20 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>deviceId</b> (string) <br>
- One of the device's identification which includes name or uuid. (Specified in path).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
+ <b>entityId1</b> (string) <br>
+ The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- 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).
+ <b>relation</b> (string) <br>
+ The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- 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).
+ <b>entityId2</b> (string) <br>
+ The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -2045,8 +1357,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of deleted entity's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -2064,16 +1376,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{path}/notifications
- <a data-toggle="collapse" data-target="#collapse-ygcIRQJpNR"
- href="#collapse-ygcIRQJpNR" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
+ <a data-toggle="collapse" data-target="#collapse-XcDzxtD3OE"
+ href="#collapse-XcDzxtD3OE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ygcIRQJpNR" class="panel-body collapse">
+ <div id="collapse-XcDzxtD3OE" class="panel-body collapse">
- <p>Create notifications for a group. This request will target all users associated with a specific group entity.</p>
+ <p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
<h3>Parameters</h3>
@@ -2087,20 +1399,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>path</b> (string) <br>
- The path of the group. (Specified in path).
- </li>
- <li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
- </li>
- <li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- 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).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- 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).
+ <b>entityId</b> (string) <br>
+ One of the entity's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -2110,8 +1414,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
<TRUNCATED>