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/05 16:56:33 UTC
[47/51] [abbrv] [partial] incubator-usergrid git commit: Switch over
to new docs for the website.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/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
new file mode 100644
index 0000000..93a6e32
--- /dev/null
+++ b/content/docs/_sources/rest-endpoints/api-docs.txt
@@ -0,0 +1,3319 @@
+## 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.
+
+<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).
+
+<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/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/resetpw</h2>
+
+Initiate the reset of an admin user's password.
+
+<h3>Parameters</h3>
+
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of complete messages.
+* Schema: [Action](#action)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
+
+Complete the password reset through getting the newpassword and the old one for identification.
+
+<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).
+
+<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}/activate</h2>
+
+Activate an admin user from a link provIded in an email notification.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of complete messages.
+* Schema: [Action](#action)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
+
+Update an admin user's password 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).
+* __ResetPW__ ([ResetPW](#resetpw))
+The user's old and new password. (Specified in body).
+
+<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}/reactivate</h2>
+
+Reactivate an expired admin user.
+
+<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 complete messages.
+* Schema: [Action](#action)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
+
+Set a user's password or reset the user's existing password.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of complete messages.
+* Schema: [Action](#action)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### ActivityFeed Methods
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
+
+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/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)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</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.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of user's activity.
+* Schema: [ActivityFeed](#activityfeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<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 group's activity.
+* Schema: [ActivityFeed](#activityfeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
+
+Create an activity in the activities collection.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of user's activity.
+* Schema: [ActivityFeed](#activityfeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
+
+Retrieve a user'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).
+* __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 user's activity feed.
+* Schema: [ActivityFeed](#activityfeed)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### AppData Methods
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
+
+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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved application data.
+* Schema: [AppData](#appdata)
+
+__default__
+
+* Description: Unexpected 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)
+
+### Credential Methods
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+
+Retrieve the client Id and client secret credentials for an application in an 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 retrieved credentials info.
+* Schema: [Credential](#credential)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+
+Generate the client Id and client secret credentials for an application in an 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 generated credentials info.
+* Schema: [Credential](#credential)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
+
+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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of Credential
+* Schema: [Credential](#credential)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
+
+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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of Credential
+* Schema: [Credential](#credential)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Devices Methods
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{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).
+* __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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved device's info.
+* Schema: [Device](#device)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Entity Methods
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
+
+Retrieve a user's collections or connections through query statement.
+
+<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).
+* __relation__ (string)
+The relation between user and collections. (Specified in path).
+* __queryStatement__ ()
+The query statement of the user. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of user's collections info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
+
+Retrieve collection through query statement.
+
+<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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __queryStatement__ ()
+Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved collection's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
+
+Update collection through query statement.
+
+<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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __queryStatement__ ()
+Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of updated collection's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+
+Add an entity to a collection 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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __entityId1__ (string)
+The Id of the 1st entity. (Specified in path).
+* __relation__ (string)
+The relation between 1st entity and 2nd entity. (Specified in path).
+* __entityId2__ (string)
+The Id of the 2nd entity. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of added entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+
+Remove an entity from a collection 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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __entityId1__ (string)
+The Id of the 1st entity. (Specified in path).
+* __relation__ (string)
+The relation between 1st entity and 2nd entity. (Specified in path).
+* __entityId2__ (string)
+The Id of the 2nd entity. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+
+Retrieve an entity through providing Id of application, organization, collection and 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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __entityId__ (string)
+One of the entity's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+
+One or more properties can be updated with a single request.
+
+<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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __entityId__ (string)
+One of the entity's identification which includes name or uuid. (Specified in path).
+* __entityproperty__ ([CreateEntities](#createentities))
+The properties of the entity. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of updated entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+
+Delete an entity from the collection.
+
+<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).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __entityId__ (string)
+One of the entity's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected 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.
+
+<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).
+* __entitytype__ (string)
+The entity type to create. (Specified in path).
+* __entityproperty__ ([CreateEntities](#createentities))
+The properties of the entity. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created custom entity's info.
+* Schema: [Entity](#entity)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Event Methods
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
+
+Create an event through providing both Id of organization and application.
+
+<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).
+* __CreateEvent__ ([CreateEvent](#createevent))
+The required property of the event. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created event's info.
+* Schema: [Event](#event)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Group Methods
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
+
+Create a new group through providing both Id of organization and application.
+
+<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).
+* __groupproperty__ ([CreateGroup](#creategroup))
+The property of the created group. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created group's info.
+* Schema: [Group](#group)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
+
+Get a group through 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 retrieved group's info.
+* Schema: [Group](#group)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
+
+Update a group 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 updated group's info.
+* Schema: [Group](#group)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Notification Methods
+
+<h2 class="usergrid-PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}</h2>
+
+Cancel sent notifications through providing the Id of the notification.
+
+<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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of canceled notification's info.
+* Schema: [Notification](#notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/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).
+* __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).
+
+<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}/{appId}/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).
+* __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).
+
+<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}/{appId}/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).
+* __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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/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).
+* __appId__ (string)
+One of the application'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)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/notifications/{notificationId}</h2>
+
+Remove unsent 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).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted notification's info.
+* Schema: [Notification](#notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/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).
+* __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).
+
+<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}/{appId}/{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).
+* __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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved notification's info.
+* Schema: [Notification](#notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Organization Methods
+
+<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+
+Create an organization through a form post.
+
+<h3>Parameters</h3>
+
+* __CreateOrg__ ([CreateOrg](#createorg))
+A set of organization properties supplied through a form. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created Organization.
+* Schema: [Organization](#organization)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
+
+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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created Organization.
+* Schema: [Organization](#organization)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Permission Methods
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
+
+Remove permissions from 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).
+* __grant_url_pattern__ ()
+The query statement of the url pattern. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted permission's info.
+* Schema: [Permission](#permission)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Receipt Methods
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/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).
+* __appId__ (string)
+One of the application'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}/{appId}/{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).
+* __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).
+
+<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}/{appId}/{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).
+* __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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved receipt's info.
+* Schema: [Receipt](#receipt)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### Role Methods
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+
+Retrieve the roles in an application 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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved role's info.
+* Schema: [Role](#role)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
+
+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/{rolename}</h2>
+
+Remove 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+### User Methods
+
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
+
+Retrieve details about the admin users in an 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 retrieved Admin user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
+
+Remove an admin user 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /management/users</h2>
+
+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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of new created Admin user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
+
+Retrieve details about an admin user.
+
+<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 details
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
+
+Update the info of an admin user.
+
+<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 details.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+
+Add a user to a group 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+
+Delete user from a group 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
+
+Retrieve the users in 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).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+
+Add a user 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+
+Remove a user from 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).
+* __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)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
+
+Retrieve users though query statement.
+
+<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).
+* __queryStatement__ ()
+The query statement of the User. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
+
+Create a user in the users collection 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).
+* __CreateUser__ ([CreateUser](#createuser))
+The properties of the user. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
+
+Retrieve 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-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 retrieved user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
+
+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 updated user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
+
+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 deleted user's info.
+* Schema: [User](#user)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#error)
+
+
+## Models
+Properties for Usergrid default entities.
+
+### 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>
+</table>
+
+### ActivityFeed
+
+__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>
+
+### 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>
+</table>
+
+### AddPermission
+
+__Properties__
+
+<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>
+</table>
+
+### AdminUserUpdate
+
+__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>
+
+### 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>
+</table>
+
+### CancelMSG
+
+__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>
+
+### 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>
+</table>
+
+### 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>
+</table>
+
+### CreateAdminUser
+
+__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>
+
+### 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>
+</table>
+
+### CreateEntities
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+</table>
+
+### 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>
+</table>
+
+### 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>
+</table>
+
+### CreateGroup
+
+__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>
+
+### 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>
+</table>
+
+### CreateNotifications
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+</table>
+
+### 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>
+</table>
+
+### 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>
+</table>
+
+### 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>
+</table>
+
+### Device
+
+__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>
+</table>
+
+### 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>
+</table>
+
+### 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>
+</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>
+</table>
+
+### Group
+
+__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>
+
+### 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>
+</table>
+
+### Metadata
+
+__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>
+</table>
+
+### Notification
+
+__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>
+</table>
+
+### Notifier
+
+__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>
+</table>
+
+### Object
+
+__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>
+</table>
+
+### Organization
+
+__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>
+ <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>ref</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>ref</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+</table>
+
+### Permission
+
+__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 name of the application of the permission.</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 permission.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>applicationId</td>
+ <td>string</td>
+ <td>The UUID of the application.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>string</td>
+ <td>The parameters of the permission.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>string</td>
+ <td>The organization of the permission.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>permissiondata</td>
+ <td>ref</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+</table>
+
+### Receipt
+
+__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>false</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>errorCode</td>
+ <td>string</td>
+ <td>Error code returned by the notification service.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>sent</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds for when the notification was sent.</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>
+</table>
+
+### ResetPW
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>password</td>
+ <td>string</td>
+ <td></td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>newpassword</td>
+ <td>string</td>
+ <td></td>
+ <td>true</td>
+ </tr>
+</table>
+
+### ResetPWMsg
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>recaptcha_response</td>
+ <td>string</td>
+ <td>Parameters and value for the Captcha challenge.</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>recaptcha_challenge</td>
+ <td>string</td>
+ <td>The admin user's response to the Captcha challenge.</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>string</td>
+ <td></td>
+ <td>true</td>
+ </tr>
+</table>
+
+### Role
+
+__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>
+ <td>path</td>
+ <td>string</td>
+ <td>The path of the role.</td>
+ <td>false</td>
+ </tr>
+</table>
+
+### ScheduleNotification
+
+__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>UTC timestamp in milliseconds of when schedule notifications.</td>
+ <td>true</td>
+ </tr>
+</table>
+
+### SetExpiration
+
+__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>UTC timestamp in milliseconds of when set expirations.</td>
+ <td>true</td>
+ </tr>
+</table>
+
+### Sets
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>rolenames</td>
+ <td>string</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>permissions</td>
+ <td>string</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+</table>
+
+### User
+
+__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 a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>string</td>
+ <td>The username of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>The name of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>string</td>
+ <td>The email of a user.</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 a user.</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 a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>htmldisplayEmail</td>
+ <td>string</td>
+ <td>The HTML display of the email of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>string</td>
+ <td>The organization of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>picture</td>
+ <td>string</td>
+ <td>The uri of the user's picture.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>uri</td>
+ <td>string</td>
+ <td>The uri of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>string</td>
+ <td>The path of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>ref</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/sdks/ios.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/ios.txt b/content/docs/_sources/sdks/ios.txt
new file mode 100644
index 0000000..328b09a
--- /dev/null
+++ b/content/docs/_sources/sdks/ios.txt
@@ -0,0 +1 @@
+# iOS SDK
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/sdks/java.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/java.txt b/content/docs/_sources/sdks/java.txt
new file mode 100644
index 0000000..a2a5086
--- /dev/null
+++ b/content/docs/_sources/sdks/java.txt
@@ -0,0 +1 @@
+# Java SDK
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/sdks/javascript.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/javascript.txt b/content/docs/_sources/sdks/javascript.txt
new file mode 100644
index 0000000..685d42d
--- /dev/null
+++ b/content/docs/_sources/sdks/javascript.txt
@@ -0,0 +1,3 @@
+# JavaScript/HTML5 SDK
+
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/sdks/tbd.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/tbd.txt b/content/docs/_sources/sdks/tbd.txt
new file mode 100644
index 0000000..279d128
--- /dev/null
+++ b/content/docs/_sources/sdks/tbd.txt
@@ -0,0 +1 @@
+# COMING SOON...
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/sdks/usage.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/usage.txt b/content/docs/_sources/sdks/usage.txt
new file mode 100644
index 0000000..2d2f139
--- /dev/null
+++ b/content/docs/_sources/sdks/usage.txt
@@ -0,0 +1,16 @@
+# SDKs & Tools
+
+## SDKs
+
+* [iOS SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/ios)
+* [Android SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/android)
+* [HTML5 / JavaScript SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/html5-javascript)
+* [Windows 8 / Windows Phone / .net SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet)
+* [Ruby gem](https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby)
+* [Ruby on Rails gem](https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails)
+* [PHP library](https://github.com/apache/incubator-usergrid/tree/master/sdks/php)
+* [Java library](https://github.com/apache/incubator-usergrid/tree/master/sdks/java)
+* [Perl module](https://github.com/apache/incubator-usergrid/tree/master/sdks/perl)
+
+## Tools
+[ugc — the Command-line Client](https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/_sources/security-and-auth/app-security.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/app-security.txt b/content/docs/_sources/security-and-auth/app-security.txt
new file mode 100644
index 0000000..9dcf3e2
--- /dev/null
+++ b/content/docs/_sources/security-and-auth/app-security.txt
@@ -0,0 +1,19 @@
+# Security & token authentication
+
+Any app you put into production should feature security that protects your app, your users, and your app's data. Implementing security means taking steps in your mobile app's code and in your API Services BaaS application.
+
+__Important__: When you register for the API Services BaaS, you get a sandbox application that you can use to try things out. This application is not for use in production. By default, the sandbox application is not protected by any security measures whatsoever. Use the sandbox only for experimentation, and only with data that isn't in any way sensitive.
+
+When securing your app, follow these high-level steps:
+
+1. Define the rules that will govern access by your app's users to your app's data and features. You do this with the admin portal by creating permission rules, then associating those rules with your users. For more information, see [Using Permissions](managing-access-defining-permission-rules.html).
+2. Write code through which your app's users can verify who they are to your application. You do this by writing code that uses their username and password as credentials to initially authenticate with your application, then uses a token thereafter. (This authentication style supports the OAuth 2.0 model.) For more information, see [Authenticating users & app clients](autheticating-users-and-application-clients.html).
+3. Be sure to use coding best practices that help ensure that your app is protected from malicious attacks. For more information, see [Security best practices](security-best-practices.html).
+
+The following illustration describes these high-level areas.
+
+.. image:: securitymodel0.png
+
+
+
+