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/25 16:46:31 UTC
[44/45] usergrid git commit: Update docs portion of website.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ce749ac6/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 51f1909..8f17d69 100644
--- a/content/docs/_sources/rest-endpoints/api-docs.txt
+++ b/content/docs/_sources/rest-endpoints/api-docs.txt
@@ -4,15 +4,16 @@ Methods are organized by tag. Follow the methods are the [Model Definitions](#mo
<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)
-* [Organizations-Applications](#organizations-applications)
-* [Permissions-Roles](#permissions-roles)
+* [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>
@@ -38,12 +39,12 @@ Login credentials either username/password or id/secret. (Specified in body).
__200__
* Description: Object containing access_token.
-* Schema: [AccessTokenReponse](#accesstokenreponse)
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
@@ -59,13 +60,13 @@ Login credentials either username/password or id/secret. (Specified in body).
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [AccessTokenReponse](#accesstokenreponse)
+* Description: Object containing access_token.
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Activities
@@ -89,12 +90,12 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of group's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
@@ -117,12 +118,12 @@ One or more sets of activity properties. (Specified in body).
__200__
* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
@@ -143,12 +144,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of user's activity feed.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Admin-Users
@@ -168,12 +169,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved Admin user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
@@ -192,12 +193,12 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of deleted Admin user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/users</h2>
@@ -206,20 +207,20 @@ Create a whole new admin user.
<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).
+* __CreateAdminUser__ ([CreateAdminUser](#createadminuser))
+User entity with fields required for User creation. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [User](#user)
+* 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)
<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
@@ -234,12 +235,12 @@ Initiate the reset of an admin user's password.
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
@@ -256,12 +257,12 @@ Parameters and value for the Captcha challenge, the admin user's response to
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [](#)
__default__
-* Description: Unexpected error.
-* Schema: [Error](#error)
+* Description:
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
@@ -277,13 +278,13 @@ One of the user's identification which includes username, real name, email a
__200__
-* Description: An array of user's details
-* Schema: [User](#user)
+* 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-PUT-heading">PUT /management/users/{userId}</h2>
@@ -299,13 +300,13 @@ One of the user's identification which includes username, real name, email a
__200__
-* Description: An array of user's details.
-* Schema: [User](#user)
+* 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-GET-heading">GET /management/users/{userId}/activate</h2>
@@ -326,12 +327,12 @@ Query statement of whether send confimation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
@@ -350,12 +351,12 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
@@ -372,12 +373,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### App-Users
@@ -401,12 +402,12 @@ The query statement of the User. (Specified in query).
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
@@ -427,12 +428,12 @@ The properties of the user. (Specified in body).
__200__
* Description: An array of created user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
@@ -453,12 +454,12 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
@@ -479,12 +480,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of updated user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
@@ -505,12 +506,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* 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>
@@ -533,12 +534,12 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Entities-Collections
@@ -566,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>
@@ -594,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>
@@ -622,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>
@@ -654,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>
@@ -686,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>
@@ -714,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>
@@ -744,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>
@@ -772,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>
@@ -800,12 +801,12 @@ 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)
### Events
@@ -829,12 +830,12 @@ 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)
### Groups
@@ -858,12 +859,12 @@ 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-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
@@ -885,13 +886,13 @@ One or more sets of activity properties. (Specified in body).
__200__
-* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description:
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
@@ -914,12 +915,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
@@ -942,12 +943,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
@@ -968,12 +969,12 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of retrieved group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
@@ -994,12 +995,359 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of updated group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+### Notifications
+
+
+<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).
+* __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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/*/notifications</h2>
+
+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).
+* __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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/{deviceId}/notifications</h2>
+
+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).
+* __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 created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/groups/{path}/notifications</h2>
+
+Create notifications for a group. This request will target all users associated with a specific group 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).
+* __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 created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/notifications</h2>
+
+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).
+* __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 retrieved notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+
+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).
+* __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 API Response object containing an entity of type Notification.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+
+Delete an unsent Notification from the system.
+
+<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).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: API Response containing Notification entity that was deleted.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/receipts</h2>
+
+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 retrieved receipt's info.
+* Schema: [Receipt](#Receipt)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/users/{userId}/notifications</h2>
+
+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).
+* __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 created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{deviceId}/*/receipts</h2>
+
+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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/queue</h2>
+
+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).
+* __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 device's info.
+* Schema: [Device](#Device)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/receipts</h2>
+
+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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{receiptId}/*/notifications</h2>
+
+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).
+* __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 notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Organizations-Applications
@@ -1019,12 +1367,12 @@ A set of organization properties supplied through a form. (Specified in body).
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
@@ -1041,12 +1389,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
@@ -1067,12 +1415,12 @@ Send confirmation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
@@ -1089,12 +1437,36 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved application data.
-* Schema: [AppData](#appdata)
+* Schema: [AppData](#AppData)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
+
+Remove an application from 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).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted application info.
+* Schema: [AppData](#AppData)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
@@ -1113,12 +1485,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved credentials info.
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
@@ -1137,12 +1509,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of generated credentials info.
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
@@ -1159,12 +1531,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
@@ -1181,12 +1553,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
@@ -1203,12 +1575,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
@@ -1225,12 +1597,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
@@ -1247,12 +1619,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of user's activity
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Permissions-Roles
@@ -1274,12 +1646,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
@@ -1300,17 +1672,17 @@ The required properties of the role. (Specified in body).
__200__
* Description: An array of created role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
-Remove permissions from a role.
+Remove permissions from a role.
<h3>Parameters</h3>
@@ -1320,20 +1692,20 @@ 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).
-* __grant_url_pattern__ (string)
-The query statement of the url pattern. (Specified in query).
+* __Permissions__ ([Permissions](#permissions))
+The query statement of the url pattern. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted permission's info.
-* Schema: [Permission](#permission)
+* 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-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
@@ -1353,13 +1725,13 @@ One of the role's identification which includes name or uuid. (Specified in
__200__
-* Description: An array of retrieved 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-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
@@ -1382,12 +1754,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
@@ -1410,12 +1782,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
@@ -1436,1652 +1808,2237 @@ The name of the role. (Specified in path).
__200__
* Description: An array of deleted role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
+
+Retrieve permissions for a Role.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* 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-POST-heading">POST /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
+
+Add permissions to a 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).
+* __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: Permissions object with array of Usergrid Permission strings.
+* Schema: [Permission](#Permission)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
## Models
-Properties for Usergrid default entities.
+This section lists the properties for the Usergrid Default Entities:
### AccessTokenResponse
-__Properties__
-<table width="80%" class="usergrid-table">
- <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>ref</td>
- <td>User object if login was done as a user.</td>
- <td>false</td>
- </tr>
-</table>
-
-### 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-1HebcU9U0i)
+* [/{orgId}/{appId}/token](#op-mXXPrFJmmC)
+
-__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/orgs/{orgId}/activate](#op-Ri5St8h7Gc)
+* [/management/orgs/{orgId}/reactivate](#op-fH2NJRLasI)
+* [/management/users/{userId}/activate](#op-wKjTye05HW)
+* [/management/users/{userId}/password](#op-MMdB9wDDes)
+* [/management/users/resetpw](#op-QkIPEdzBjP)
+* [/management/users/{userId}/reactivate](#op-GM99nOrGSV)
+* [/{orgId}/{appId}/users/{user}/password](#op-5v0MCfiS5G)
+
+
+__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-rnsq6BYLky)
+* [/management/orgs/{orgId}/feed](#op-uewkqYn5If)
+* [/management/users/{userId}/feed](#op-b6aBkwtiaG)
+* [/{orgId}/{appId}/users/{userId}/feed](#op-tusGFCAem5)
+* [/{orgId}/{appId}/groups/{groupId}/activities](#op-c492AEoHXO)
+* [/{orgId}/{appId}/groups/{groupId}/feed](#op-w9rJiHwfL9)
+
-__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-HkIyImLJzN)
+
-__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/{appId}](#op-cITLQDbLyq)
+* [/management/orgs/{orgId}/apps](#op-2H5l6Ubhz3)
+
+
+__Referring Definitions__
+
+* [Organization](#organization)
+
+
### CreateActivity
+
+
__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></td>
- <td>true</td>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>image</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>verb</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>content</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>displayName</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>uuid</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>image</td>
+ <td>
+ [ImageModel](#imagemodel)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>verb</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>content</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
</table>
-### CreateAdminUser
+__Referring API Paths__
+
+* [/{orgId}/{appId}/users/{userId}/activities](#op-rnsq6BYLky)
+* [/{orgId}/{appId}/groups/{groupId}/activities](#op-c492AEoHXO)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>email</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>password</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
+### CreateAdminUser
+
-### CreateApp
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>token</td>
- <td>string</td>
- <td>The OAuth2 access token.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>The name of the application.</td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>password</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
-### CreateEntities
+__Referring API Paths__
+
+* [/management/users](#op-vAUBalI728)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
-</table>
+### CreateEntities
+
-### CreateEntity
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>property</td>
- <td>string</td>
- <td>The property of the entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>value</td>
- <td>string</td>
- <td>The relevant value of the property.</td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-Sfg6OF0vYD)
+* [/{orgId}/{appId}/{entitytype}](#op-aDC6vpIDpX)
+
+
+
### CreateEvent
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>timestamp</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>timestamp</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
</table>
-### CreateGroup
+__Referring API Paths__
+
+* [/{orgId}/{appId}/events](#op-edRuDPyfnd)
+
-__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 group.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>path</td>
- <td>string</td>
- <td>The path of the group.</td>
- <td>true</td>
- </tr>
-</table>
+### CreateGroup
+
-### CreateNotification
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>notifier</td>
- <td>ref</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>message</td>
- <td>string</td>
- <td>The push notitfication message that will be delivered to the user.</td>
- <td>true</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 group.</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>
+ string
+ </td>
+ <td>The path of the group.</td>
+ <td>true</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{appId}/groups](#op-Z77LLpsl5z)
+
+
+
### CreateNotifications
+An array of Notifications to be created.
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{applicationId}/devices](#op-TNEP24l6u6)
+* [/{orgId}/{applicationId}/devices/*/notifications](#op-yaLbJcBiew)
+* [/{orgId}/{applicationId}/devices/{deviceId}/notifications](#op-wnzNuk9xxw)
+* [/{orgId}/{applicationId}/users/{userId}/notifications](#op-NvprqwE5TX)
+* [/{orgId}/{applicationId}/groups/{path}/notifications](#op-B2QTJv3pAL)
+
+
+
### CreateOrg
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>organization</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>email</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>password</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>password</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/management/orgs](#op-7fsW44WZhb)
+
+
+
### CreateUser
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td></td>
- <td>true</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>true</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{appId}/users](#op-6F2xVpJ3MS)
+
+
+
### Credential
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>client_Id</td>
- <td>string</td>
- <td>The Id of the client.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>client_secret</td>
- <td>string</td>
- <td>The secret of the client.</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>client_Id</td>
+ <td>
+ string
+ </td>
+ <td>The Id of the client.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>client_secret</td>
+ <td>
+ string
+ </td>
+ <td>The secret of the client.</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}/credentials](#op-mGIYdBOZvr)
+* [/management/orgs/{orgId}/apps/{appId}/credentials](#op-BNmcGMn8K8)
+* [/management/orgs/{orgId}/apps/{appId}/credentials](#op-MffSE98VJ9)
+* [/management/orgs/{orgId}/credentials](#op-WxJjtXBmOK)
+
+
+
### Device
+Represents a single Device that is registered for recieving of Push Notifications.
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>Unique entity Id.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>Type of entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>Notifier display name.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>metadata</td>
- <td>ref</td>
- <td></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>uuid</td>
+ <td>
+ string
+ </td>
+ <td>Unique entity Id.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ string
+ </td>
+ <td>Type of entity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>
+ string
+ </td>
+ <td>Notifier display name.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp in milliseconds of when the entity was created.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>
+ [Metadata](#metadata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{applicationId}/{notificationId}/*/queue](#op-KJUS4mlszD)
+
+
+
### Entity
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>The UUID of the entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>The type of the entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>actorproperty</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>metadata</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>The name of the entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>message</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>uuid</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of the entity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ string
+ </td>
+ <td>The type of the entity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp of entity creation time.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>
+ [Actor](#actor)
+ </td>
+ <td>UTC timestamp of entity modified time.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>
+ [Metadata](#metadata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>
+ string
+ </td>
+ <td>The name of the entity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>message</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}](#op-DHirgZpbac)
+* [/{orgId}/{appId}/{collectionId}](#op-QD5NAJS8Bw)
+* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-yBCHzfA98f)
+* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-Sfg6OF0vYD)
+* [/{orgId}/{appId}/users/{userId}/{relation}](#op-oCg9os6raS)
+* [/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}](#op-0arPEfuhUz)
+* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-eOQMRLCY57)
+* [/{orgId}/{appId}/{collectionId}](#op-1ax4VLYiRu)
+* [/{orgId}/{appId}/{entitytype}](#op-aDC6vpIDpX)
+
+
+__Referring Definitions__
+
+* [Role](#role)
+* [Event](#event)
+* [ActivityFeed](#activityfeed)
+
+
### Error
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>code</td>
- <td>integer</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>message</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>fields</td>
- <td>object</td>
- <td></td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>code</td>
+ <td>
+ integer
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>message</td>
+ <td>
+ string
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>fields</td>
+ <td>
+ object
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
+
+
### Event
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>applicationName</td>
- <td>string</td>
- <td>The application name of the event.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>entity</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>url</td>
- <td>string</td>
- <td>The url of the event.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>applicationId</td>
- <td>string</td>
- <td>The application UUID of the event.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>parameters</td>
- <td>string</td>
- <td>The parameters of the event.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>organization</td>
- <td>string</td>
- <td>The title of the organization.</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>applicationName</td>
+ <td>
+ string
+ </td>
+ <td>The application name of the event.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>entity</td>
+ <td>
+ [Entity](#entity)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>url</td>
+ <td>
+ string
+ </td>
+ <td>The url of the event.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>applicationId</td>
+ <td>
+ string
+ </td>
+ <td>The application UUID of the event.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>
+ string
+ </td>
+ <td>The parameters of the event.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>
+ string
+ </td>
+ <td>The title of the organization.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
-### Group
+__Referring API Paths__
+
+* [/{orgId}/{appId}/events](#op-edRuDPyfnd)
+
-__Properties__
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>The UUID of the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>The type of the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>created</td>
- <td>string</td>
- <td>The created Id for the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>modified</td>
- <td>string</td>
- <td>The modified Id for the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>path</td>
- <td>string</td>
- <td>The path of the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>metadata</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>title</td>
- <td>string</td>
- <td>The title of the group.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>completeMsg</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
+### Group
+
-### ImageModel
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>url</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>wIdth</td>
- <td>integer</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>email</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>uuid</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ string
+ </td>
+ <td>The type of the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>
+ string
+ </td>
+ <td>The created Id for the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>
+ string
+ </td>
+ <td>The modified Id for the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>
+ string
+ </td>
+ <td>The path of the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>
+ [Metadata](#metadata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>
+ string
+ </td>
+ <td>The title of the group.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
+__Referring API Paths__
+
+* [/{org_Id}/{app_Id}/groups/{groupId}](#op-lgRtOYV2mn)
+* [/{org_Id}/{app_Id}/groups/{groupId}](#op-BfgDiwRk9Z)
+* [/{orgId}/{appId}/groups](#op-Z77LLpsl5z)
+
+
+
### LoginCredentials
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>grant_type</td>
- <td>string</td>
- <td>Grant-type must be 'password' or 'client_credentials'.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td>Username of user attempting login, required only if grant_type is 'password'.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>password</td>
- <td>string</td>
- <td>Password of user attempting login, required only if grant_type is 'password'.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>client_id</td>
- <td>string</td>
- <td>Client-ID portion of credentials, required only if grant_type is 'client_credentials'.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>client_secret</td>
- <td>string</td>
- <td>Client-Secret portion of credentials, required only if grant_type is 'client_credentials'.</td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>grant_type</td>
+ <td>
+ string
+ </td>
+ <td>Grant-type must be 'password' or 'client_credentials'.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td>Username of user attempting login, required only if grant_type is 'password'.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>password</td>
+ <td>
+ string
+ </td>
+ <td>Password of user attempting login, required only if grant_type is 'password'.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>client_id</td>
+ <td>
+ string
+ </td>
+ <td>Client-ID portion of credentials, required only if grant_type is 'client_credentials'.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>client_secret</td>
+ <td>
+ string
+ </td>
+ <td>Client-Secret portion of credentials, required only if grant_type is 'client_credentials'.</td>
+ <td>false</td>
+ </tr>
</table>
-### Metadata
+__Referring API Paths__
+
+* [/management/token](#op-1HebcU9U0i)
+* [/{orgId}/{appId}/token](#op-mXXPrFJmmC)
+
+
+
+### Notification
+
+Represents a Push Notification that is either scheduled, finished or cancelled.
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>cursor</td>
- <td>string</td>
- <td>The cursor of the metadata.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>path</td>
- <td>string</td>
- <td>The path of the metadata.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>sets</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>collections</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>uuid</td>
+ <td>
+ string
+ </td>
+ <td>Unique entity Id.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ string
+ </td>
+ <td>Type of entity.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp in milliseconds of when the entity was created.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>
+ number
+ </td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>payloads</td>
+ <td>
+ string
+ </td>
+ <td>The push notifications to be delivered.</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>errorMessage</td>
+ <td>
+ string
+ </td>
+ <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>scheduled</td>
+ <td>
+ boolean
+ </td>
+ <td>Whether the notification is currently scheduled for delivery.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>state</td>
+ <td>
+ string
+ </td>
+ <td>The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>
+ [Metadata](#metadata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
-### Notification
+__Referring API Paths__
+
+* [/{orgId}/{applicationId}/devices](#op-TNEP24l6u6)
+* [/{orgId}/{applicationId}/notifications](#op-3gofaCjjmP)
+* [/{orgId}/{applicationId}/devices/*/notifications](#op-yaLbJcBiew)
+* [/{orgId}/{applicationId}/devices/{deviceId}/notifications](#op-wnzNuk9xxw)
+* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-BGgtZs73kB)
+* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-mM31H6Jg4J)
+* [/{orgId}/{applicationId}/users/{userId}/notifications](#op-NvprqwE5TX)
+* [/{orgId}/{applicationId}/{receiptId}/*/notifications](#op-4YUgJxhYM8)
+* [/{orgId}/{applicationId}/groups/{path}/notifications](#op-B2QTJv3pAL)
+
+
+
+### NotificationUpdate
+
+Represents fields that may be updated on a Notification to cause changes in Push Notification processing.
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>Unique entity Id.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>Type of entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>payloads</td>
- <td>string</td>
- <td>The push notifications to be delivered.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>errorMessage</td>
- <td>string</td>
- <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>scheduled</td>
- <td>boolean</td>
- <td>whether the notification is currently scheduled for delivery.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>state</td>
- <td>string</td>
- <td>The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>metadata</td>
- <td>ref</td>
- <td></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>canceled</td>
+ <td>
+ boolean
+ </td>
+ <td>Setting this field to true will cancel a Notification, if it has not yet been sent.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>deliver</td>
+ <td>
+ number
+ </td>
+ <td>Specifies the UNIX timestamp time at which the Notification should be sent.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>expired</td>
+ <td>
+ number
+ </td>
+ <td>Specifies the UNIX timestamp time at which this Notification has expired.</td>
+ <td>false</td>
+ </tr>
</table>
-### Notifier
+__Referring API Paths__
+
+* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-BGgtZs73kB)
+
+
+
+### Organization
+
+
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>Unique entity Id.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>Type of entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>Notifier display name.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>provider</td>
- <td>string</td>
- <td>Push notification provider 'apple' or 'google'.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>environment</td>
- <td>string</td>
- <td>The environment that corresponds to your app 'development' or 'production'.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>metadata</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>applicationId</td>
+ <td>
+ string
+ </td>
+ <td>The application Id of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>
+ string
+ </td>
+ <td>The username of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>
+ string
+ </td>
+ <td>The name of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>
+ string
+ </td>
+ <td>The email of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>activated</td>
+ <td>
+ boolean
+ </td>
+ <td>Indicate whether the account is activated or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>
+ boolean
+ </td>
+ <td>Indicate whether the account is disabled or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>uuid</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>adminUser</td>
+ <td>
+ boolean
+ </td>
+ <td>Indicate whether the use is a adminUser or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>displayEmail</td>
+ <td>
+ string
+ </td>
+ <td>The display of the email of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>htmldisplayEmail</td>
+ <td>
+ string
+ </td>
+ <td>The HTML display of the email of the owner.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>orgname</td>
+ <td>
+ string
+ </td>
+ <td>The name of the organization.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>orguuId</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of the organization.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>applicationdata</td>
+ <td>
+ [AppData](#appdata)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>
+ [Action](#action)
+ </td>
+ <td></td>
+ <td>false</td>
+ </tr>
</table>
-### Object
+__Referring API Paths__
+
+* [/management/orgs](#op-7fsW44WZhb)
+* [/management/orgs/{orgId}](#op-OY12KWx1sz)
+
+
+
+### Permissions
+
+Represents a set of Permissions associated with a User or a Role, each being a Usergrid Permission String.
__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 object.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objecttype</td>
- <td>string</td>
- <td>The type of the object.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objectuuId</td>
- <td>string</td>
- <td>The UUID of the object.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>entitytype</td>
- <td>string</td>
- <td>The entitytype of the object.</td>
- <td>false</td>
- </tr>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>application</td>
+ <td>
+ string
+ </td>
+ <td>The UUID of the associated application.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>applicationName</td>
+ <td>
+ string
+ </td>
+ <td>The name of the associated application.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>
+ string
+ </td>
+ <td>The name of the associated organization.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>data</td>
+ <td>
+ array
+ </td>
+ <td>Array of strings each being a Usergrid Permission String.</td>
+ <td>true</td>
+ </tr>
</table>
-### Organization
+__Referring API Paths__
+
+* [/{orgId}/{appId}/roles/{roleId}/permissions](#op-z3MAiAdtJA)
+* [/{orgId}/{applicationId}/roles/{roleId}/permissions](#op-CQ5wbafAWD)
+* [/{orgId}/{applicationId}/roles/{roleId}/permissions](#op-wpGMGgSb0t)
+
+
+
+### Receipt
+
+Represents response received from Notification service indicating success or failure.
__Properties__
<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>applicationId</td>
- <td>string</td>
- <td>The application Id of the owner.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>username</td>
- <td>string</td>
- <td>The username of the owner.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>The name of the owner.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>email</td>
- <td>string</td>
- <td>The email of the owner.</td>
- <td>false</td>
- </tr>
-
<TRUNCATED>