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:38 UTC
[27/36] usergrid git commit: Update generated website content.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/73186077/content/docs/_sources/rest-endpoints/api-docs.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/rest-endpoints/api-docs.txt b/content/docs/_sources/rest-endpoints/api-docs.txt
index 93a6e32..3a1b748 100644
--- a/content/docs/_sources/rest-endpoints/api-docs.txt
+++ b/content/docs/_sources/rest-endpoints/api-docs.txt
@@ -1,375 +1,392 @@
+<h1>Usergrid API Reference</h1>
+
+Methods are organized by tag. Follow the methods are the [Model Definitions](#models).
+
+<h2>Table of Contents</h2>
+
+* [Access-Tokens](#Access-Tokens)
+* [Activities](#Activities)
+* [Admin-Users](#Admin-Users)
+* [App-Users](#App-Users)
+* [Entities-Collections](#Entities-Collections)
+* [Events](#Events)
+* [Groups](#Groups)
+* [Notifications](#Notifications)
+* [Organizations-Applications](#Organizations-Applications)
+* [Permissions-Roles](#Permissions-Roles)
+
+<br>
+<br>
+
+
## Methods
-### Action Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
-Activate an organization from a link provIded in an email notification.
+### Access-Tokens
+
+
+<h2 class="usergrid-POST-heading">POST /management/token</h2>
+
+Login with Admin-User or Organization credentials.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __token__ ()
-Activation token. (Specified in query).
-* __confirm_email__ ()
-Send confirmation email or not. (Specified in query).
+* __login-credentials__ ([LoginCredentials](#logincredentials))
+Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: Object containing access_token.
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
-Reactivate an expired organization.
+Login with App-User or Application credentials.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
+* __login-credentials__ ([LoginCredentials](#logincredentials))
+Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: Object containing access_token.
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
+### Activities
-Initiate the reset of an admin user's password.
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2>
+
+Get a group's feed through providing all the identifications.
<h3>Parameters</h3>
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __groupId__ (string)
+One of the group's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An array of group's activity.
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
-Complete the password reset through getting the newpassword and the old one for identification.
+Create an activity in the activities collection.
<h3>Parameters</h3>
-* __ResetPWMsg__ ([ResetPWMsg](#resetpwmsg))
-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).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
+* __CreateActivity__ ([CreateActivity](#createactivity))
+One or more sets of activity properties. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An array of user's activity.
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
-Activate an admin user from a link provIded in an email notification.
+Retrieve a user's feed through providing all the identifications.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
-* __token__ ()
-Activation token's query statement. (Specified in query).
-* __confirm_email__ ()
-Query statement of whether send confimation email or not. (Specified in query).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An array of user's activity feed.
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
+### Admin-Users
-Update an admin user's password through getting the newpassword and the old one for identification.
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
+
+Retrieve details about the admin users in an organization.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
-* __ResetPW__ ([ResetPW](#resetpw))
-The user's old and new password. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An array of retrieved Admin user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
-Reactivate an expired admin user.
+Remove an admin user from an organization through providing both Id of application and organization.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __userId-2__ (string)
+One of the user's identification which includes username, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An array of deleted Admin user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
+<h2 class="usergrid-POST-heading">POST /management/users</h2>
-Set a user's password or reset the user's existing password.
+Create a whole new admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __username__ (string)
-The username of the user. (Specified in path).
-* __ResetPW__ ([ResetPW](#resetpw))
-The user's old and new password. (Specified in body).
+* __CreateAdminUser__ ([CreateAdminUser](#createadminuser))
+User entity with fields required for User creation. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Description: An API Response with a entities array containing the newly created Admin User.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### ActivityFeed Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
-Retrieve an organization's activity feed.
+Initiate the reset of an admin user's password.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
+<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
-Retrieve an admin user's activity feed.
+Complete the password reset through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __ResetPWMsg__ ([ResetPWMsg](#resetpwmsg))
+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).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of complete messages.
+* Schema: [](#)
__default__
-* Description: Unexpected error.
-* Schema: [Error](#error)
+* Description:
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
-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.
+Retrieve details about an admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __CreateActivity__ ([CreateActivity](#createactivity))
-One or more sets of activity properties. (Specified in body).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An API Response with a entities array containing the Admin User.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
-Get a group's feed through providing all the identifications.
+Update the info of an admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of group's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An API Response with a entities array containing the updated Admin User
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
-Create an activity in the activities collection.
+Activate an admin user from a link provIded in an email notification.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
-* __CreateActivity__ ([CreateActivity](#createactivity))
-One or more sets of activity properties. (Specified in body).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __token__ (string)
+Activation token's query statement. (Specified in query).
+* __confirm_email__ (boolean)
+Query statement of whether send confimation email or not. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
-Retrieve a user's feed through providing all the identifications.
+Update an admin user's password through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __ResetPW__ ([ResetPW](#resetpw))
+The user's old and new password. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity feed.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### AppData Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
-Retrieve the applications in an organization through providing both Id of application and organization.
+Reactivate an expired admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved application data.
-* Schema: [AppData](#appdata)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
+### App-Users
-Remove an application from an organization through providing both Id of application and organization.
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
+
+Retrieve users though query statement.
<h3>Parameters</h3>
@@ -377,24 +394,25 @@ Remove an application from an organization through providing both Id of applicat
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __queryStatement__ (string)
+The query statement of the User. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of deleted application info.
-* Schema: [AppData](#appdata)
+* Description: An array of retrieved user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Credential Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
-Retrieve the client Id and client secret credentials for an application in an organization.
+Create a user in the users collection through providing all the identifications.
<h3>Parameters</h3>
@@ -402,23 +420,25 @@ Retrieve the client Id and client secret credentials for an application in an or
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __CreateUser__ ([CreateUser](#createuser))
+The properties of the user. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved credentials info.
-* Schema: [Credential](#credential)
+* Description: An array of created user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
-Generate the client Id and client secret credentials for an application in an organization.
+Retrieve a user through providing all the identifications.
<h3>Parameters</h3>
@@ -426,68 +446,77 @@ Generate the client Id and client secret credentials for an application in an or
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-2__ (string)
+One of the user's identification which includes username, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of generated credentials info.
-* Schema: [Credential](#credential)
+* Description: An array of retrieved user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
-Retrieve the credentials for an organization client.
+Update a user through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Description: An array of updated user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
-Generate whole new credentials for an organization client.
+Remove a user through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Description: An array of deleted user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Devices Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
-Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.
+Set a user's password or reset the user's existing password.
<h3>Parameters</h3>
@@ -495,22 +524,26 @@ Retrieve the list of devices associated with one or more notifications before th
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
+* __username__ (string)
+The username of the user. (Specified in path).
+* __ResetPW__ ([ResetPW](#resetpw))
+The user's old and new password. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved device's info.
-* Schema: [Device](#device)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Entity Methods
+
+### Entities-Collections
+
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
@@ -526,7 +559,7 @@ One of the application's identification which includes name or uuid. (Specif
One of the user's identification which includes username or UUID. (Specified in path).
* __relation__ (string)
The relation between user and collections. (Specified in path).
-* __queryStatement__ ()
+* __queryStatement__ (string)
The query statement of the user. (Specified in query).
<h3>Responses</h3>
@@ -534,12 +567,12 @@ The query statement of the user. (Specified in query).
__200__
* Description: An array of user's collections info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
@@ -554,7 +587,7 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __collectionId__ (string)
One of the collection's identification which includes name or uuid. (Specified in path).
-* __queryStatement__ ()
+* __queryStatement__ (string)
Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
<h3>Responses</h3>
@@ -562,12 +595,12 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of retrieved collection's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
@@ -582,7 +615,7 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __collectionId__ (string)
One of the collection's identification which includes name or uuid. (Specified in path).
-* __queryStatement__ ()
+* __queryStatement__ (string)
Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
<h3>Responses</h3>
@@ -590,12 +623,12 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of updated collection's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
@@ -622,12 +655,12 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of added entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
@@ -654,12 +687,12 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -682,12 +715,12 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of retrieved entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -712,12 +745,12 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of updated entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -740,17 +773,17 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2>
-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.
+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.
<h3>Parameters</h3>
@@ -768,16 +801,18 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of created custom entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Event Methods
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
+### Events
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
Create an event through providing both Id of organization and application.
@@ -795,14 +830,16 @@ The required property of the event. (Specified in body).
__200__
* Description: An array of created event's info.
-* Schema: [Event](#event)
+* Schema: [Event](#Event)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Group Methods
+
+### Groups
+
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
@@ -822,17 +859,17 @@ The property of the created group. (Specified in body).
__200__
* Description: An array of created group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
-Get a group through through providing all the identifications.
+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.
<h3>Parameters</h3>
@@ -842,23 +879,25 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __groupId__ (string)
One of the group's identification which includes name or uuid. (Specified in path).
+* __CreateActivity__ ([CreateActivity](#createactivity))
+One or more sets of activity properties. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved group's info.
-* Schema: [Group](#group)
+* Description:
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
-Update a group through providing all the identifications.
+Add a user to a group through providing all the identifications.
<h3>Parameters</h3>
@@ -868,48 +907,53 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __groupId__ (string)
One of the group's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of updated group's info.
-* Schema: [Group](#group)
+* Description: An array of added user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Notification Methods
-<h2 class="usergrid-PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
-Cancel sent notifications through providing the Id of the notification.
+Delete user from a group through providing all the identifications.
<h3>Parameters</h3>
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
-* __cancelMsg__ ([CancelMSG](#cancelmsg))
-Indicete whether is canceled or not. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __groupId__ (string)
+One of the group's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of canceled notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of deleted user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices</h2>
+<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
-Create notifications for user through targeting by location and providing all the identifications.
+Get a group through through providing all the identifications.
<h3>Parameters</h3>
@@ -917,31 +961,25 @@ Create notifications for user through targeting by location and providing all th
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notification__ ([CreateNotifications](#createnotifications))
-These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-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).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-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).
-* __queryStatement__ ()
-The query statement of the location of the user. (Specified in query).
+* __groupId__ (string)
+One of the group's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of retrieved group's info.
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices/*/notifications</h2>
+<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
-Create notifications for all devices. This request will target all device entities.
+Update a group through providing all the identifications.
<h3>Parameters</h3>
@@ -949,117 +987,110 @@ Create notifications for all devices. This request will target all device entiti
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notification__ ([CreateNotifications](#createnotifications))
-These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-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).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-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).
+* __groupId__ (string)
+One of the group's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of updated group's info.
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices/{deviceId}/notifications</h2>
+### Notifications
-Create notifications for a single device. This request will target a specific device entity.
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices</h2>
+
+Create notifications for user through targeting by location and providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __deviceId__ (string)
-One of the device's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
* __notification__ ([CreateNotifications](#createnotifications))
These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-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).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-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).
+* __queryStatement__ (string)
+The query statement of the location of the user. (Specified in query).
<h3>Responses</h3>
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{path}/notifications</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/*/notifications</h2>
-Create notifications for a group. This request will target all users associated with a specific group entity.
+Create notifications for all devices. This request will target all device entities.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __path__ (string)
-The path of the group. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
* __notification__ ([CreateNotifications](#createnotifications))
These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-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).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-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).
<h3>Responses</h3>
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/notifications</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/{deviceId}/notifications</h2>
-Retrieve one or more notifications through providing all the identifications.
+Create notifications for a single device. This request will target a specific device entity.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __deviceId__ (string)
+One of the device's identification which includes name or uuid. (Specified in path).
+* __notification__ ([CreateNotifications](#createnotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/notifications/{notificationId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/groups/{path}/notifications</h2>
-Remove unsent notifications through providing all the identifications.
+Create notifications for a group. This request will target all users associated with a specific group entity.
<h3>Parameters</h3>
@@ -1067,215 +1098,216 @@ Remove unsent notifications through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
+* __path__ (string)
+The path of the group. (Specified in path).
+* __notification__ ([CreateNotifications](#createnotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/notifications</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/notifications</h2>
-Create notifications for a user. This request will target a specific user entity.
+Retrieve one or more notifications through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
-* __notification__ ([CreateNotifications](#createnotifications))
-These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-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).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-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).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of retrieved notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{receiptId}/*/notifications</h2>
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{applicationId}/notifications/{notificationId}</h2>
-Retrieve notifications associated with one or more receipts through providing all the identifications.
+Update a Notification in order to cancel the notifcation or set a new expiration time.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __receiptId__ (string)
-One of the receipt's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+* __notificationUpdate__ ([NotificationUpdate](#notificationupdate))
+Object with Notification fields to be updated. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved notification's info.
-* Schema: [Notification](#notification)
+* Description: An API Response object containing an entity of type Notification.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Organization Methods
-<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{applicationId}/notifications/{notificationId}</h2>
-Create an organization through a form post.
+Delete an unsent Notification from the system.
<h3>Parameters</h3>
-* __CreateOrg__ ([CreateOrg](#createorg))
-A set of organization properties supplied through a form. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Description: API Response containing Notification entity that was deleted.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/receipts</h2>
-Retrieve an organization given a specified UUID or username.
+Retrieve one or more receipts through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Description: An array of retrieved receipt's info.
+* Schema: [Receipt](#Receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Permission Methods
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/users/{userId}/notifications</h2>
-Remove permissions from a role.
+Create notifications for a user. This request will target a specific user entity.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __roleId__ (string)
-One of the role's identification which includes name or uuid. (Specified in path).
-* __grant_url_pattern__ ()
-The query statement of the url pattern. (Specified in query).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
+* __notification__ ([CreateNotifications](#createnotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted permission's info.
-* Schema: [Permission](#permission)
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Receipt Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/receipts</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{deviceId}/*/receipts</h2>
-Retrieve one or more receipts through providing all the identifications.
+Retrieve receipts associated with one or more devices through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __deviceId__ (string)
+One of the device's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#receipt)
+* Schema: [Receipt](#Receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{deviceId}/*/receipts</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/queue</h2>
-Retrieve receipts associated with one or more devices through providing all the identifications.
+Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __deviceId__ (string)
-One of the device's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#receipt)
+* Description: An array of retrieved device's info.
+* Schema: [Device](#Device)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/receipts</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/receipts</h2>
-Retrieve receipts for one or more notifications through providing all the identifications."
+Retrieve receipts for one or more notifications through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
* __notificationId__ (string)
One of the notification's identification which includes name or uuid. (Specified in path).
@@ -1284,263 +1316,323 @@ One of the notification's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#receipt)
+* Schema: [Receipt](#Receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### Role Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{receiptId}/*/notifications</h2>
-Retrieve the roles in an application through providing all the identifications.
+Retrieve notifications associated with one or more receipts through providing all the identifications.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __receiptId__ (string)
+One of the receipt's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved role's info.
-* Schema: [Role](#role)
+* Description: An array of retrieved notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
+### Organizations-Applications
-Create a new role through providing all the identifications.
+
+<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+
+Create an organization through a form post.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __roleproperty__ ([AddRole](#addrole))
-The required properties of the role. (Specified in body).
+* __CreateOrg__ ([CreateOrg](#createorg))
+A set of organization properties supplied through a form. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of created role's info.
-* Schema: [Role](#role)
+* Description: An array of created Organization.
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
-Remove a role through providing all the identifications.
+Retrieve an organization given a specified UUID or username.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __rolename__ (string)
-The name of the role. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted role's info.
-* Schema: [Role](#role)
+* Description: An array of created Organization.
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-### User Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
-Retrieve details about the admin users in an organization.
+Activate an organization from a link provIded in an email notification.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
+* __token__ (string)
+Activation token. (Specified in query).
+* __confirm_email__ (boolean)
+Send confirmation email or not. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved Admin user's info.
-* Schema: [User](#user)
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
-Remove an admin user from an organization through providing both Id of application and organization.
+Retrieve the applications in an organization through providing both Id of application and organization.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __userId-2__ (string)
-One of the user's identification which includes username, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted Admin user's info.
-* Schema: [User](#user)
+* Description: An array of retrieved application data.
+* Schema: [AppData](#AppData)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /management/users</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
-Create a whole new admin user.
+Remove an application from an organization through providing both Id of application and organization.
<h3>Parameters</h3>
-* __adminuserproperty__ ([CreateAdminUser](#createadminuser))
-One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [User](#user)
+* Description: An array of deleted application info.
+* Schema: [AppData](#AppData)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
-Retrieve details about an admin user.
+Retrieve the client Id and client secret credentials for an application in an organization.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of user's details
-* Schema: [User](#user)
+* Description: An array of retrieved credentials info.
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
-Update the info of an admin user.
+Generate the client Id and client secret credentials for an application in an organization.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of user's details.
-* Schema: [User](#user)
+* Description: An array of generated credentials info.
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
-Add a user to a group through providing all the identifications.
+Retrieve the credentials for an organization client.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of added user's info.
-* Schema: [User](#user)
+* Description: An array of Credential
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
-Delete user from a group through providing all the identifications.
+Generate whole new credentials for an organization client.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Description: An array of Credential
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
-Retrieve the users in a role through providing all the identifications.
+Retrieve an organization's activity feed.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of the organization's ActivityFeed.
+* Schema: [ActivityFeed](#ActivityFeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
+
+Reactivate an expired organization.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of complete messages.
+* Schema: [Action](#Action)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
+
+Retrieve an admin user's activity feed.
+
+<h3>Parameters</h3>
+
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of user's activity
+* Schema: [ActivityFeed](#ActivityFeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+### Permissions-Roles
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+
+Retrieve the roles in an application through providing all the identifications.
<h3>Parameters</h3>
@@ -1548,25 +1640,49 @@ Retrieve the users in a role through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __roleId__ (string)
-One of the role's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An array of retrieved role's info.
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
-Add a user to a role through providing all the identifications.
+Create a new role through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __roleproperty__ ([AddRole](#addrole))
+The required properties of the role. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created role's info.
+* Schema: [Role](#Role)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
+
+Remove permissions from a role.
<h3>Parameters</h3>
@@ -1576,25 +1692,25 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __roleId__ (string)
One of the role's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
+* __Permissions__ ([Permissions](#permissions))
+The query statement of the url pattern. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of added user's info.
-* Schema: [User](#user)
+* Description: Permissions object with array of the deleated Usergrid Permission strings.
+* Schema: [Permissions](#Permissions)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
-Remove a user from a role through providing all the identifications.
+Retrieve the users in a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1604,25 +1720,23 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __roleId__ (string)
One of the role's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Description: An API Response with a entities array of Users.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
-Retrieve users though query statement.
+Add a user to a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1630,25 +1744,27 @@ Retrieve users though query statement.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __queryStatement__ ()
-The query statement of the User. (Specified in query).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An array of added user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
-Create a user in the users collection through providing all the identifications.
+Remove a user from a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1656,25 +1772,27 @@ Create a user in the users collection through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __CreateUser__ ([CreateUser](#createuser))
-The properties of the user. (Specified in body).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created user's info.
-* Schema: [User](#user)
+* Description: An array of deleted user's info.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
-Retrieve a user through providing all the identifications.
+Remove a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1682,25 +1800,25 @@ Retrieve a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-2__ (string)
-One of the user's identification which includes username, email address or UUID. (Specified in path).
+* __rolename__ (string)
+The name of the role. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An array of deleted role's info.
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
-Update a user through providing all the identifications.
+Retrieve permissions for a Role.
<h3>Parameters</h3>
@@ -1708,25 +1826,25 @@ Update a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of updated user's info.
-* Schema: [User](#user)
+* Description: Permissions object with array of Usergrid Permission strings.
+* Schema: [Permissions](#Permissions)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
-Remove a user through providing all the identifications.
+Add permissions to a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1734,1586 +1852,2193 @@ Remove a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __Permissions__ ([Permissions](#permissions))
+Permissions object with array of Usergrid Permission strings to be added. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Description: Permissions object with array of Usergrid Permission strings.
+* Schema: [Permission](#Permission)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
## Models
-Properties for Usergrid default entities.
+This section lists the properties for the Usergrid Default Entities:
+
+### AccessTokenResponse
+
-### Action
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>action</td>
- <td>string</td>
- <td>The requested action.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>status</td>
- <td>string</td>
- <td>The status of the requested action.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>token</td>
- <td>string</td>
- <td>The token required for getting an AdminUser.</td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>access_token</td>
+ <td>
+ string
+ </td>
+ <td>Access-token that may be used on subsequent requests.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>expires_in</td>
+ <td>
+ number
+ </td>
+ <td>Time (in milliseconds) until access-token expires.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>user</td>
+ <td>
+ [User](#user)
+ </td>
+ <td>User object if login was done as a user.</td>
+ <td>false</td>
+ </tr>
</table>
-### ActivityFeed
+__Referring API Paths__
+
+* [/management/token](#op-MhD5hWgRwK)
+* [/{orgId}/{appId}/token](#op-9TDlDc0BL3)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>entityproperty</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>category</td>
- <td>string</td>
- <td>The category of the activity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>metadataproperty</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>objectproperty</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>title</td>
- <td>string</td>
- <td>The title of the activity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>verb</td>
- <td>string</td>
- <td>The verb of the activity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>completeMsg</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
+### Action
+
-### Actor
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>displayname</td>
- <td>string</td>
- <td>The display of the name of the actor.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objecttype</td>
- <td>string</td>
- <td>The type of the actor.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objectuuId</td>
- <td>string</td>
- <td>The UUID of the actor.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>entitytype</td>
- <td>string</td>
- <td>The entitytype of the actor.</td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>
+ string
+ </td>
+ <td>The requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>status</td>
+ <td>
+ string
+ </td>
+ <td>The status of the requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>timestamp</td>
+ <td>
+ number
+ </td>
+ <td>The timestamp of the requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>duration</td>
+ <td>
+ number
+ </td>
+ <td>The duration of the requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>token</td>
+ <td>
+ string
+ </td>
+ <td>The token required for getting an AdminUser.</td>
+ <td>false</td>
+ </tr>
</table>
-### AddPermission
+__Referring API Paths__
+
+* [/management/users/resetpw](#op-AiNhPeeyiq)
+* [/{orgId}/{appId}/users/{user}/password](#op-d0NWF6YZuK)
+* [/management/orgs/{orgId}/activate](#op-5138i0P1q8)
+* [/management/users/{userId}/activate](#op-c9LsV7Ulbr)
+* [/management/orgs/{orgId}/reactivate](#op-RIuF55JkgX)
+* [/management/users/{userId}/reactivate](#op-jk8tbzHamj)
+* [/management/users/{userId}/password](#op-yjg1hntm4R)
+
+
+__Referring Definitions__
+
+* [Receipt](#receipt)
+* [Device](#device)
+* [Notification](#notification)
+* [Role](#role)
+* [Event](#event)
+* [Group](#group)
+* [Credential](#credential)
+* [Organization](#organization)
+* [AppData](#appdata)
+* [User](#user)
+* [ActivityFeed](#activityfeed)
+
-__Properties__
+### ActivityFeed
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>operation</td>
- <td>string</td>
- <td>A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are allowed for the specified resource path.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>resource_path</td>
- <td>string</td>
- <td>The path to the resources to be accessed.</td>
- <td>true</td>
- </tr>
-</table>
-### AddRole
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>title</td>
- <td>string</td>
- <td>The title of the role.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>role name</td>
- <td>string</td>
- <td>The name of the role.</td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>entityproperty</td>
+ <td>
+ [Entity](#entity)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>category</td>
+ <td>
+ string
+ </td>
+ <td>The category of the activity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadataproperty</td>
+ <td>
+ [Metadata](#metadata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>objectproperty</td>
+ <td>
+ [Object](#object)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>
+ string
+ </td>
+ <td>The title of the activity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>verb</td>
+ <td>
+ string
+ </td>
+ <td>The verb of the activity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>published</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp of the feed publish time.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
-### AdminUserUpdate
+__Referring API Paths__
+
+* [/{orgId}/{appId}/users/{userId}/activities](#op-SgbcdXdHSq)
+* [/{orgId}/{appId}/users/{userId}/feed](#op-JOpALhJR9x)
+* [/management/orgs/{orgId}/feed](#op-FsWAA6TQ6j)
+* [/{orgId}/{appId}/groups/{groupId}/feed](#op-vjWBovszxD)
+* [/management/users/{userId}/feed](#op-oyQqxIeMTj)
+* [/{orgId}/{appId}/groups/{groupId}/activities](#op-Y8sHuGSnUK)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>city</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>state</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
+### AddRole
+
-### AppData
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>tester/sandbox</td>
- <td>string</td>
- <td>The UUID of tester/sandbox.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>tester/app1</td>
- <td>string</td>
- <td>The UUID of tester/app1.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>tester/app2</td>
- <td>string</td>
- <td>The UUID of tester/app2.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>completeMsg</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>
+ string
+ </td>
+ <td>The title of the role.</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>role name</td>
+ <td>
+ string
+ </td>
+ <td>The name of the role.</td>
+ <td>true</td>
+ </tr>
</table>
-### CancelMSG
+__Referring API Paths__
+
+* [/{orgId}/{appId}/roles](#op-77UvdX1AKS)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>canceled</td>
- <td>boolean</td>
- <td></td>
- <td>true</td>
- </tr>
-</table>
+### AppData
+
-### Collections
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>activities</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>feed</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>roles</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>users</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>tester/sandbox</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of tester/sandbox.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>tester/app1</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of tester/app1.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>tester/app2</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of tester/app2.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/management/orgs/{orgId}/apps](#op-FxESea37Iw)
+* [
<TRUNCATED>