You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/07 23:05:55 UTC
[01/21] incubator-usergrid git commit: Complete Using Roles
conversion to Markdown.
Repository: incubator-usergrid
Updated Branches:
refs/heads/master 51734d426 -> 7662bc941
Complete Using Roles conversion to Markdown.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/c886d1f2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/c886d1f2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/c886d1f2
Branch: refs/heads/master
Commit: c886d1f2d7c70a55d83046371b4dbf96dc8aafe3
Parents: 51734d4
Author: Dave Johnson <sn...@apache.org>
Authored: Thu Aug 6 12:40:08 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Thu Aug 6 12:40:08 2015 -0400
----------------------------------------------------------------------
docs/security-and-auth/using-roles.md | 183 +++++++++++++++--------------
1 file changed, 97 insertions(+), 86 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c886d1f2/docs/security-and-auth/using-roles.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/using-roles.md b/docs/security-and-auth/using-roles.md
index 3428405..6404edb 100644
--- a/docs/security-and-auth/using-roles.md
+++ b/docs/security-and-auth/using-roles.md
@@ -1,10 +1,10 @@
# Using roles
-Roles are named sets of one or more permissions, and are useful for defining specific access levels to resources in your API BaaS data store. Multiple roles can be assigned to a user or group, giving you a great deal of flexibility in how access to resources are defined.
+Roles are named sets of one or more permissions, and are useful for defining specific access levels to resources in your Usergrid data store. Multiple roles can be assigned to a user or group, giving you a great deal of flexibility in how access to resources are defined.
For example, in a blogging app you might create a 'reviewer' role that allows GET and PUT access to an articles collection to allow the user to retrieve and update articles, but not allow them to create new articles.
## Default roles
-While you can create as many custom roles as you want per application, all API BaaS applications include three default roles. These roles each serve a special purpose and should not be deleted; however, you can and should adjust the permissions assigned to these roles to suit the needs of you app.
+While you can create as many custom roles as you want per application, all Usegrid applications include three default roles. These roles each serve a special purpose and should not be deleted; however, you can and should adjust the permissions assigned to these roles to suit the needs of you app.
The following table describes each pre-defined role, and the permissions that are assigned to them by default.
@@ -39,54 +39,28 @@ The following table describes each pre-defined role, and the permissions that ar
</td>
<td>
- Default for authenticated users. Assigns the associated permissions to all users whose requests are authenticated with a valid access token.
+Default for authenticated users. Assigns the associated permissions to all users whose requests are authenticated with a valid access token.
- <div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
- __Note__: By default, __grants full access for all resources in your application__. A first task in securing your application should be to restrict access by redefining this role to narrow the access it provides. Remove the default full permission rule and add restrictive permission rules for a production deployment.
- </p></div>
+<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
+By default, __grants full access for all resources in your application__. A first task in securing your application should be to restrict access by redefining this role to narrow the access it provides. Remove the default full permission rule and add restrictive permission rules for a production deployment.
+</p></div>
</td>
</tr>
<tr>
<td>Administrator</td>
- <td></td>
- <td></td>
-</tr>
-<tr>
- <td></td>
- <td></td>
- <td></td>
-</tr>
-<tr>
- <td></td>
- <td></td>
- <td></td>
+ <td>None</td>
+ <td>
+
+Unused until you associate it with users or groups. By default, includes no permissions that provide access. Grants no access. Consider this a blank slate. Add permission rules and associate this role with users and groups as needed.
+<div class="admonition note"> <p class="first admonition-title">NOTE</p> <p class="last">
+The Administrator role is <i>not</i> the same as an organization administrator, that is, someone who authenticates as an Admin User. The Admin User is an implicit user created when you create an organization. After authenticating, the Admin User has full access to all of the administration features of the Usergrid API. By comparison, the Administrator role is simply a role (initially without permissions) that can be assigned to any user.
+</p></div>
+
+ </td>
</tr>
</table>
-Role Permissions Description
-Guest
-post: /devices
-post: /users
-put: /devices/*
-Assigned to all unauthenticated requests. Includes a basic set of permissions that are commonly needed by unregistered or unauthenticated users.
-
-Grants permission for a user to create a user account and for their device to be registered.
-
-Default
-get, post, put, delete: /**
-Default for authenticated users. Assigns the associated permissions to all users whose requests are authenticated with a valid access token.
-
-By default, grants full access for all resources in your application. A first task in securing your application should be to restrict access by redefining this role to narrow the access it provides. Remove the default full permission rule and add restrictive permission rules for a production deployment.
-Administrator
-None
-
-Unused until you associate it with users or groups. By default, includes no permissions that provide access.
-
-Grants no access. Consider this a blank slate. Add permission rules and associate this role with users and groups as needed.
-
-Note: The Administrator role is not the same as an organization administrator -- that is, someone who authenticates as an Admin User. The Admin User is an implicit user created when you create an organization. After authenticating, the Admin User has full access to all of the administration features of the API BaaS API. By comparison, the Administrator role is simply a role (initially without permissions) that can be assigned to any user.
-
## Creating roles
Generally, it is easiest to a create a role for each access type you want to enable in your app. You may, however, assign multiple roles to any user or group entity, so you have the flexibility to define any schema for applying roles that you like.
@@ -144,6 +118,18 @@ roleName The name of the role to be created
"organization" : "your-org",
"applicationName" : "your-app"
}
+
+
+### Creating Roles in the Admin Portal
+
+1. In the left sidebar of the Usergrid portal, click Users > Roles. This displays the roles defined for the application.
+Click the '+' button.
+2. In the dialog box, provide a 'title' and 'role name.' A title is an alias for the role name.
+3. Click 'Create'. The role will be created, but will not have any permissions assigned to it.
+4. Click the role you created in the list.
+5. Click the 'Add permissions' button.
+6. In the dialog box, click the check boxes for the HTTP methods you want to grant permissions for, and enter the resource path in the 'Path' field.
+7. The 'Inactivity' field lets you control automatic user logout during periods of inactivity. Set a number of seconds of inactivity before users assigned to this role are automatically logged out.
## Assigning roles
Once you have created some roles, you will need to explicitly assign them to a user or group entity. The permissions associated with that role will be granted to the entity immediately for any requests they send that are authenticated by a valid access token. Please note that assigning a role to a group will grant the associated permissions to every user in that group.
@@ -172,51 +158,65 @@ For groups, the 'name' property can be used. For users, the 'username' property
### Example response
-{
- "action" : "post",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
- "uri" : "https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
- "entities" : [ {
- "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376",
- "type" : "user",
- "name" : "someUser",
- "created" : 1395681911491,
- "modified" : 1399070010291,
- "username" : "someUser",
- "activated" : true,
- "file" : "fobnszewobnioerabnoiawegbrn\n",
- "metadata" : {
- "connecting" : {
- "friends" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends",
- "likes" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"
- },
- "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376",
- "sets" : {
- "rolenames" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
- "permissions" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"
- },
- "connections" : {
- "completed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed",
- "follows" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"
- },
- "collections" : {
- "activities" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities",
- "devices" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices",
- "feed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed",
- "groups" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups",
- "roles" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
- "following" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following",
- "followers" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"
- }
- }
- } ],
- "timestamp" : 1402965083889,
- "duration" : 41,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "uri" : "https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "entities" : [ {
+ "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376",
+ "type" : "user",
+ "name" : "someUser",
+ "created" : 1395681911491,
+ "modified" : 1399070010291,
+ "username" : "someUser",
+ "activated" : true,
+ "file" : "fobnszewobnioerabnoiawegbrn\n",
+ "metadata" : {
+ "connecting" : {
+ "friends" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends",
+ "likes" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"
+ },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376",
+ "sets" : {
+ "rolenames" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "permissions" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"
+ },
+ "connections" : {
+ "completed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed",
+ "follows" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"
+ },
+ "collections" : {
+ "activities" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities",
+ "devices" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices",
+ "feed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed",
+ "groups" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups",
+ "roles" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "following" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following",
+ "followers" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1402965083889,
+ "duration" : 41,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### Assigning Roles in the Admin Portal
+
+The easiest way to assign roles to user or group entities is to use the 'Users' tab of the Usergrid admin portal, by doing the following:
+
+1. In the left sidebar of the admin portal, click Users > Users or Users > Groups to display either the list of users or groups in your application.
+2. In the list, click the name of the user or group entity you want to assign roles to to display its details in the right pane.
+3. Click the 'Roles & Permissions' tab above the right pane.
+4. Click the 'Add Role' button.
+5. In the popup, select a role from the drop down menu.
+6. Click the 'Add' button.
+
## Removing roles
At times it may be necessary to remove a role from a user or group entity, for example if a user changes jobs, or the duties of a group are altered. Please note that removing a role from a group will remove the associated permissions from every user in that group.
@@ -290,4 +290,15 @@ For groups, the 'name' property can be used. For users, the 'username' property
"organization" : "your-org",
"applicationName" : "your-app"
}
+
+### Removing Roles in the Admin Portal
+
+The easiest way to remove roles from user or group entities is to use the 'Users' tab of the Usergrid admin portal, by doing the following:
+
+1. In the left sidebar of the Usergrid admin portal, click Users > Users or Users > Groups to display either the list of users or groups in your application.
+2. In the list, click the name of the user or group entity you want to remove roles from to display its details in the right pane.
+3. Click the 'Roles & Permissions' tab above the right pane.
+4. Click the role you created in the list.
+5. Under 'Roles', click the checkbox beside the role you want to remove from the entity.
+6. Click the 'Leave roles' button.
\ No newline at end of file
[05/21] incubator-usergrid git commit: Minor refactoring in API doc
generation.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.html b/docs/rest-endpoints/api-docs.html
index 1241a65..c4841f9 100644
--- a/docs/rest-endpoints/api-docs.html
+++ b/docs/rest-endpoints/api-docs.html
@@ -21,573 +21,28 @@
<p>Generated from Swagger.</p>
<h2>Methods</h2><p>API methods are organized by the tags.</p>
<p>Following the methods is a listing of all <a href='#models'>Default Entity Models.</p>
-<a name='Action-method'></a>
-<h2>Action Methods</h2>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/activate
- <a data-toggle="collapse" data-target="#collapse-iN5h4Rfha6"
- href="#collapse-iN5h4Rfha6" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-iN5h4Rfha6" class="panel-body collapse">
-
- <p>Activate an organization from a link provIded in an email notification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>token</b> () <br>
- Activation token. (Specified in query).
- </li>
- <li>
- <b>confirm_email</b> () <br>
- Send confirmation email or not. (Specified in query).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-4JPBNBUnYR"
- href="#collapse-4JPBNBUnYR" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-4JPBNBUnYR" class="panel-body collapse">
-
- <p>Reactivate an expired organization.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-8Q4qhiQLvH"
- href="#collapse-8Q4qhiQLvH" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-8Q4qhiQLvH" class="panel-body collapse">
-
- <p>Initiate the reset of an admin user's password.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
+<a name='Access-Tokens-method'></a>
+<h2>Access-Tokens</h2>
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-TBw5HyJTTa"
- href="#collapse-TBw5HyJTTa" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-TBw5HyJTTa" class="panel-body collapse">
-
- <p>Complete the password reset through getting the newpassword and the old one for identification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br>
- Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
- <a data-toggle="collapse" data-target="#collapse-gPyb4FcquB"
- href="#collapse-gPyb4FcquB" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /management/token
+ <a data-toggle="collapse" data-target="#collapse-drcFs9dfPU"
+ href="#collapse-drcFs9dfPU" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-gPyb4FcquB" class="panel-body collapse">
+ <div id="collapse-drcFs9dfPU" class="panel-body collapse">
- <p>Activate an admin user from a link provIded in an email notification.</p>
+ <p>Login with Admin-User or Organization credentials.</p>
<h3>Parameters</h3>
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- <li>
- <b>token</b> () <br>
- Activation token's query statement. (Specified in query).
- </li>
- <li>
- <b>confirm_email</b> () <br>
- Query statement of whether send confimation email or not. (Specified in query).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
- <a data-toggle="collapse" data-target="#collapse-eOkQcznynD"
- href="#collapse-eOkQcznynD" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-eOkQcznynD" class="panel-body collapse">
-
- <p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- <li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
- The user's old and new password. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-pxE50B5nCD"
- href="#collapse-pxE50B5nCD" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-pxE50B5nCD" class="panel-body collapse">
-
- <p>Reactivate an expired admin user.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
- <a data-toggle="collapse" data-target="#collapse-sOcj4VS4JA"
- href="#collapse-sOcj4VS4JA" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-sOcj4VS4JA" class="panel-body collapse">
-
- <p>Set a user's password or reset the user's existing password.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>username</b> (string) <br>
- The username of the user. (Specified in path).
- </li>
- <li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
- The user's old and new password. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-<a name='ActivityFeed-method'></a>
-<h2>ActivityFeed Methods</h2>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/feed
- <a data-toggle="collapse" data-target="#collapse-HkB3lyybM0"
- href="#collapse-HkB3lyybM0" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-HkB3lyybM0" class="panel-body collapse">
-
- <p>Retrieve an organization's activity feed.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of the organization's ActivityFeed.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-trV5SjBRiv"
- href="#collapse-trV5SjBRiv" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-trV5SjBRiv" class="panel-body collapse">
-
- <p>Retrieve an admin user's activity feed.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>userId</b> (string) <br>
- One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of user's activity</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities
- <a data-toggle="collapse" data-target="#collapse-zj0yM6YokI"
- href="#collapse-zj0yM6YokI" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-zj0yM6YokI" class="panel-body collapse">
-
- <p>Create an activity to a specific group. In this case the activity is created in the activities collection and is accessible at the /activities endpoint to users who have the permission to read that endpoint. In addition, a relationship is established between the activity and the group, and because of that, the activity will appear in the group’s feed. The group 'owns' the activity. Also, the activity will be published in the feed of all users that are members of the group.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
- One or more sets of activity properties. (Specified in body).
- </li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
- </ul>
- </li>
- <li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
- </li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
- <a data-toggle="collapse" data-target="#collapse-gIeQmdnsDx"
- href="#collapse-gIeQmdnsDx" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-gIeQmdnsDx" class="panel-body collapse">
-
- <p>Get a group's feed through providing all the identifications.</p>
-
- <h3>Parameters</h3>
-
- <ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
+ <ul>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -597,8 +52,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of group's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Description: Object containing access_token.</li>
+ <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
</ul>
</li>
<li>
@@ -617,34 +72,22 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
- <a data-toggle="collapse" data-target="#collapse-L2T56Ztybh"
- href="#collapse-L2T56Ztybh" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/token
+ <a data-toggle="collapse" data-target="#collapse-XlaRG4JVxJ"
+ href="#collapse-XlaRG4JVxJ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-L2T56Ztybh" class="panel-body collapse">
+ <div id="collapse-XlaRG4JVxJ" class="panel-body collapse">
- <p>Create an activity in the activities collection.</p>
+ <p>Login with App-User or Application credentials.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
- </li>
- <li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
- One or more sets of activity properties. (Specified in body).
+ <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -654,8 +97,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Description: An array of new created Admin user's info.</li>
+ <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
</ul>
</li>
<li>
@@ -670,19 +113,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Activities-method'></a>
+<h2>Activities</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-q3sk3xVUu4"
- href="#collapse-q3sk3xVUu4" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
+ <a data-toggle="collapse" data-target="#collapse-tmnHUKGqLS"
+ href="#collapse-tmnHUKGqLS" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-q3sk3xVUu4" class="panel-body collapse">
+ <div id="collapse-tmnHUKGqLS" class="panel-body collapse">
- <p>Retrieve a user's feed through providing all the identifications.</p>
+ <p>Get a group's feed through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -696,8 +141,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
+ <b>groupId</b> (string) <br>
+ One of the group's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -707,7 +152,7 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's activity feed.</li>
+ <li>Description: An array of group's activity.</li>
<li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
@@ -723,21 +168,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='AppData-method'></a>
-<h2>AppData Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps
- <a data-toggle="collapse" data-target="#collapse-2aQqcShABU"
- href="#collapse-2aQqcShABU" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
+ <a data-toggle="collapse" data-target="#collapse-oOJfU8LsRY"
+ href="#collapse-oOJfU8LsRY" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2aQqcShABU" class="panel-body collapse">
+ <div id="collapse-oOJfU8LsRY" class="panel-body collapse">
- <p>Retrieve the applications in an organization through providing both Id of application and organization.</p>
+ <p>Create an activity in the activities collection.</p>
<h3>Parameters</h3>
@@ -746,54 +189,17 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- <li>
- <b>200</b>
- <ul>
- <li>Description: An array of retrieved application data.</li>
- <li>Schema: [<a href="#appdata">AppData</a>]</li>
- </ul>
- </li>
<li>
- <b>default</b>
- <ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
- </ul>
+ <b>appId</b> (string) <br>
+ One of the application's identification which includes name or uuid. (Specified in path).
</li>
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}
- <a data-toggle="collapse" data-target="#collapse-G319AhhnWy"
- href="#collapse-G319AhhnWy" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-G319AhhnWy" class="panel-body collapse">
-
- <p>Remove an application from an organization through providing both Id of application and organization.</p>
-
- <h3>Parameters</h3>
-
- <ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
+ <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
+ One or more sets of activity properties. (Specified in body).
</li>
</ul>
@@ -803,8 +209,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted application info.</li>
- <li>Schema: [<a href="#appdata">AppData</a>]</li>
+ <li>Description: An array of user's activity.</li>
+ <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
@@ -819,21 +225,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Credential-method'></a>
-<h2>Credential Methods</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-AASgKtaSkG"
- href="#collapse-AASgKtaSkG" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
+ <a data-toggle="collapse" data-target="#collapse-pYJU4YKTd8"
+ href="#collapse-pYJU4YKTd8" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-AASgKtaSkG" class="panel-body collapse">
+ <div id="collapse-pYJU4YKTd8" class="panel-body collapse">
- <p>Retrieve the client Id and client secret credentials for an application in an organization.</p>
+ <p>Retrieve a user's feed through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -846,6 +250,10 @@
<b>appId</b> (string) <br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
+ <li>
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
+ </li>
</ul>
<h3>Responses</h3>
@@ -854,8 +262,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved credentials info.</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of user's activity feed.</li>
+ <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
@@ -870,19 +278,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Admin-Users-method'></a>
+<h2>Admin-Users</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-dKcFwuUjzH"
- href="#collapse-dKcFwuUjzH" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/users
+ <a data-toggle="collapse" data-target="#collapse-v3QdwGriJl"
+ href="#collapse-v3QdwGriJl" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-dKcFwuUjzH" class="panel-body collapse">
+ <div id="collapse-v3QdwGriJl" class="panel-body collapse">
- <p>Generate the client Id and client secret credentials for an application in an organization.</p>
+ <p>Retrieve details about the admin users in an organization.</p>
<h3>Parameters</h3>
@@ -891,10 +301,6 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
</ul>
<h3>Responses</h3>
@@ -903,8 +309,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of generated credentials info.</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of retrieved Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -922,16 +328,16 @@
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-ZMqkJ1AwIr"
- href="#collapse-ZMqkJ1AwIr" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-6cRMjJKYQr"
+ href="#collapse-6cRMjJKYQr" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ZMqkJ1AwIr" class="panel-body collapse">
+ <div id="collapse-6cRMjJKYQr" class="panel-body collapse">
- <p>Retrieve the credentials for an organization client.</p>
+ <p>Remove an admin user from an organization through providing both Id of application and organization.</p>
<h3>Parameters</h3>
@@ -940,6 +346,10 @@
<b>orgId</b> (string) <br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
+ <li>
+ <b>userId-2</b> (string) <br>
+ One of the user's identification which includes username, email address or UUID. (Specified in path).
+ </li>
</ul>
<h3>Responses</h3>
@@ -948,8 +358,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of Credential</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of deleted Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -968,22 +378,22 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-eG7QcoefBR"
- href="#collapse-eG7QcoefBR" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /management/users
+ <a data-toggle="collapse" data-target="#collapse-bVYwPxPrHs"
+ href="#collapse-bVYwPxPrHs" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-eG7QcoefBR" class="panel-body collapse">
+ <div id="collapse-bVYwPxPrHs" class="panel-body collapse">
- <p>Generate whole new credentials for an organization client.</p>
+ <p>Create a whole new admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
+ <b>adminuserproperty</b> ( <a href="#createadminuser">CreateAdminUser</a>) <br>
+ One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
</li>
</ul>
@@ -993,8 +403,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of Credential</li>
- <li>Schema: [<a href="#credential">Credential</a>]</li>
+ <li>Description: An array of new created Admin user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1009,37 +419,23 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Devices-method'></a>
-<h2>Devices Methods</h2>
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue
- <a data-toggle="collapse" data-target="#collapse-m94kArvzxi"
- href="#collapse-m94kArvzxi" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/resetpw
+ <a data-toggle="collapse" data-target="#collapse-7WBllKwJ3P"
+ href="#collapse-7WBllKwJ3P" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-m94kArvzxi" class="panel-body collapse">
+ <div id="collapse-7WBllKwJ3P" class="panel-body collapse">
- <p>Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.</p>
+ <p>Initiate the reset of an admin user's password.</p>
<h3>Parameters</h3>
<ul>
- <li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>notificationId</b> (string) <br>
- One of the notification's identification which includes name or uuid. (Specified in path).
- </li>
</ul>
<h3>Responses</h3>
@@ -1048,8 +444,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved device's info.</li>
- <li>Schema: [<a href="#device">Device</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1064,44 +460,26 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Entity-method'></a>
-<h2>Entity Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
- <a data-toggle="collapse" data-target="#collapse-pIaAhJWMZp"
- href="#collapse-pIaAhJWMZp" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /management/users/resetpw
+ <a data-toggle="collapse" data-target="#collapse-OBQT3BKr5H"
+ href="#collapse-OBQT3BKr5H" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-pIaAhJWMZp" class="panel-body collapse">
+ <div id="collapse-OBQT3BKr5H" class="panel-body collapse">
- <p>Retrieve a user's collections or connections through query statement.</p>
+ <p>Complete the password reset through getting the newpassword and the old one for identification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>userId-3</b> (string) <br>
- One of the user's identification which includes username or UUID. (Specified in path).
- </li>
- <li>
- <b>relation</b> (string) <br>
- The relation between user and collections. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- The query statement of the user. (Specified in query).
+ <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br>
+ Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
</li>
</ul>
@@ -1111,8 +489,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's collections info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1131,34 +509,22 @@
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-xW56KedRyq"
- href="#collapse-xW56KedRyq" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-PiHbAwNiA5"
+ href="#collapse-PiHbAwNiA5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-xW56KedRyq" class="panel-body collapse">
+ <div id="collapse-PiHbAwNiA5" class="panel-body collapse">
- <p>Retrieve collection through query statement.</p>
+ <p>Retrieve details about an admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1168,8 +534,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of user's details</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1188,34 +554,22 @@
<div class="panel panel-default">
<div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-Zy8ncQAeme"
- href="#collapse-Zy8ncQAeme" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title PUT-heading">PUT /management/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-Gep5hzbYRO"
+ href="#collapse-Gep5hzbYRO" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Zy8ncQAeme" class="panel-body collapse">
+ <div id="collapse-Gep5hzbYRO" class="panel-body collapse">
- <p>Update collection through query statement.</p>
+ <p>Update the info of an admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>queryStatement</b> () <br>
- Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1225,8 +579,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of user's details.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1244,43 +598,31 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-ocB2PheyLp"
- href="#collapse-ocB2PheyLp" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
+ <a data-toggle="collapse" data-target="#collapse-8lFgKne5Tw"
+ href="#collapse-8lFgKne5Tw" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ocB2PheyLp" class="panel-body collapse">
+ <div id="collapse-8lFgKne5Tw" class="panel-body collapse">
- <p>Add an entity to a collection through providing all the identifications.</p>
+ <p>Activate an admin user from a link provIded in an email notification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId1</b> (string) <br>
- The Id of the 1st entity. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>relation</b> (string) <br>
- The relation between 1st entity and 2nd entity. (Specified in path).
+ <b>token</b> (string) <br>
+ Activation token's query statement. (Specified in query).
</li>
- <li>
- <b>entityId2</b> (string) <br>
- The Id of the 2nd entity. (Specified in path).
+ <li>
+ <b>confirm_email</b> (boolean) <br>
+ Query statement of whether send confimation email or not. (Specified in query).
</li>
</ul>
@@ -1290,8 +632,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of added entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1309,43 +651,27 @@
<div class="panel panel-default">
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-5zFww1vFfs"
- href="#collapse-5zFww1vFfs" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
+ <a data-toggle="collapse" data-target="#collapse-xHaeQAbaqd"
+ href="#collapse-xHaeQAbaqd" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-5zFww1vFfs" class="panel-body collapse">
+ <div id="collapse-xHaeQAbaqd" class="panel-body collapse">
- <p>Remove an entity from a collection through providing all the identifications.</p>
+ <p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId1</b> (string) <br>
- The Id of the 1st entity. (Specified in path).
- </li>
- <li>
- <b>relation</b> (string) <br>
- The relation between 1st entity and 2nd entity. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>entityId2</b> (string) <br>
- The Id of the 2nd entity. (Specified in path).
+ <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ The user's old and new password. (Specified in body).
</li>
</ul>
@@ -1355,8 +681,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1375,34 +701,22 @@
<div class="panel panel-default">
<div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-1dov3vPnls"
- href="#collapse-1dov3vPnls" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
+ <a data-toggle="collapse" data-target="#collapse-aPY008UTT5"
+ href="#collapse-aPY008UTT5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-1dov3vPnls" class="panel-body collapse">
+ <div id="collapse-aPY008UTT5" class="panel-body collapse">
- <p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
+ <p>Reactivate an expired admin user.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
- One of the organization's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>appId</b> (string) <br>
- One of the application's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
+ <b>userId</b> (string) <br>
+ One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1412,8 +726,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1428,19 +742,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='App-Users-method'></a>
+<h2>App-Users</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-CMPoM2NkHk"
- href="#collapse-CMPoM2NkHk" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users
+ <a data-toggle="collapse" data-target="#collapse-yQoflCFgcD"
+ href="#collapse-yQoflCFgcD" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-CMPoM2NkHk" class="panel-body collapse">
+ <div id="collapse-yQoflCFgcD" class="panel-body collapse">
- <p>One or more properties can be updated with a single request.</p>
+ <p>Retrieve users though query statement.</p>
<h3>Parameters</h3>
@@ -1454,16 +770,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
- The properties of the entity. (Specified in body).
+ <b>queryStatement</b> (string) <br>
+ The query statement of the User. (Specified in query).
</li>
</ul>
@@ -1473,8 +781,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of retrieved user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1492,16 +800,16 @@
<div class="panel panel-default">
- <div class="panel-heading DELETE">
- <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-Jg2pLwSrSu"
- href="#collapse-Jg2pLwSrSu" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users
+ <a data-toggle="collapse" data-target="#collapse-xoM0nnodXH"
+ href="#collapse-xoM0nnodXH" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Jg2pLwSrSu" class="panel-body collapse">
+ <div id="collapse-xoM0nnodXH" class="panel-body collapse">
- <p>Delete an entity from the collection.</p>
+ <p>Create a user in the users collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1515,12 +823,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
- One of the collection's identification which includes name or uuid. (Specified in path).
- </li>
- <li>
- <b>entityId</b> (string) <br>
- One of the entity's identification which includes name or uuid. (Specified in path).
+ <b>CreateUser</b> ( <a href="#createuser">CreateUser</a>) <br>
+ The properties of the user. (Specified in body).
</li>
</ul>
@@ -1530,8 +834,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of created user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1549,16 +853,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{entitytype}
- <a data-toggle="collapse" data-target="#collapse-o8OSLLkp41"
- href="#collapse-o8OSLLkp41" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-nwtxxd6sC5"
+ href="#collapse-nwtxxd6sC5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-o8OSLLkp41" class="panel-body collapse">
+ <div id="collapse-nwtxxd6sC5" class="panel-body collapse">
- <p>When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type. </p>
+ <p>Retrieve a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1572,12 +876,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entitytype</b> (string) <br>
- The entity type to create. (Specified in path).
- </li>
- <li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
- The properties of the entity. (Specified in body).
+ <b>userId-2</b> (string) <br>
+ One of the user's identification which includes username, email address or UUID. (Specified in path).
</li>
</ul>
@@ -1587,8 +887,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created custom entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Description: An array of retrieved user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1603,21 +903,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Event-method'></a>
-<h2>Event Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/events
- <a data-toggle="collapse" data-target="#collapse-qnPBoA07vy"
- href="#collapse-qnPBoA07vy" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-1ouK9M0Buc"
+ href="#collapse-1ouK9M0Buc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-qnPBoA07vy" class="panel-body collapse">
+ <div id="collapse-1ouK9M0Buc" class="panel-body collapse">
- <p>Create an event through providing both Id of organization and application.</p>
+ <p>Update a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1631,8 +929,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>CreateEvent</b> ( <a href="#createevent">CreateEvent</a>) <br>
- The required property of the event. (Specified in body).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1642,8 +940,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created event's info.</li>
- <li>Schema: [<a href="#event">Event</a>]</li>
+ <li>Description: An array of updated user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1658,21 +956,19 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Group-method'></a>
-<h2>Group Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups
- <a data-toggle="collapse" data-target="#collapse-4qiW3TsSSu"
- href="#collapse-4qiW3TsSSu" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}
+ <a data-toggle="collapse" data-target="#collapse-Il1v6OOFVy"
+ href="#collapse-Il1v6OOFVy" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-4qiW3TsSSu" class="panel-body collapse">
+ <div id="collapse-Il1v6OOFVy" class="panel-body collapse">
- <p>Create a new group through providing both Id of organization and application.</p>
+ <p>Remove a user through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1686,8 +982,8 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupproperty</b> ( <a href="#creategroup">CreateGroup</a>) <br>
- The property of the created group. (Specified in body).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1697,8 +993,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of deleted user's info.</li>
+ <li>Schema: [<a href="#user">User</a>]</li>
</ul>
</li>
<li>
@@ -1716,16 +1012,16 @@
<div class="panel panel-default">
- <div class="panel-heading GET">
- <h2 class="panel-title GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-mh3TFMiqlw"
- href="#collapse-mh3TFMiqlw" class="collapsed collapse-button"> </a>
+ <div class="panel-heading POST">
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
+ <a data-toggle="collapse" data-target="#collapse-imri2jPPiC"
+ href="#collapse-imri2jPPiC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-mh3TFMiqlw" class="panel-body collapse">
+ <div id="collapse-imri2jPPiC" class="panel-body collapse">
- <p>Get a group through through providing all the identifications.</p>
+ <p>Set a user's password or reset the user's existing password.</p>
<h3>Parameters</h3>
@@ -1739,8 +1035,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>username</b> (string) <br>
+ The username of the user. (Specified in path).
+ </li>
+ <li>
+ <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ The user's old and new password. (Specified in body).
</li>
</ul>
@@ -1750,8 +1050,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of retrieved group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of complete messages.</li>
+ <li>Schema: [<a href="#action">Action</a>]</li>
</ul>
</li>
<li>
@@ -1766,19 +1066,21 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
+<a name='Entities-Collections-method'></a>
+<h2>Entities-Collections</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-Ytvz84UP9Q"
- href="#collapse-Ytvz84UP9Q" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
+ <a data-toggle="collapse" data-target="#collapse-SIBQHXJ8cG"
+ href="#collapse-SIBQHXJ8cG" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Ytvz84UP9Q" class="panel-body collapse">
+ <div id="collapse-SIBQHXJ8cG" class="panel-body collapse">
- <p>Update a group through providing all the identifications.</p>
+ <p>Retrieve a user's collections or connections through query statement.</p>
<h3>Parameters</h3>
@@ -1792,8 +1094,16 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
- One of the group's identification which includes name or uuid. (Specified in path).
+ <b>userId-3</b> (string) <br>
+ One of the user's identification which includes username or UUID. (Specified in path).
+ </li>
+ <li>
+ <b>relation</b> (string) <br>
+ The relation between user and collections. (Specified in path).
+ </li>
+ <li>
+ <b>queryStatement</b> (string) <br>
+ The query statement of the user. (Specified in query).
</li>
</ul>
@@ -1803,8 +1113,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of updated group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Description: An array of user's collections info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1819,32 +1129,38 @@
</div>
<!--<div class="panel-footer"></div>-->
</div>
-<a name='Notification-method'></a>
-<h2>Notification Methods</h2>
<div class="panel panel-default">
- <div class="panel-heading PUT">
- <h2 class="panel-title PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}
- <a data-toggle="collapse" data-target="#collapse-2X3BWwAy5v"
- href="#collapse-2X3BWwAy5v" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
+ <a data-toggle="collapse" data-target="#collapse-dJMRYq1Xcc"
+ href="#collapse-dJMRYq1Xcc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2X3BWwAy5v" class="panel-body collapse">
+ <div id="collapse-dJMRYq1Xcc" class="panel-body collapse">
- <p>Cancel sent notifications through providing the Id of the notification.</p>
+ <p>Retrieve collection through query statement.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>notificationId</b> (string) <br>
- One of the notification's identification which includes name or uuid. (Specified in path).
+ <b>orgId</b> (string) <br>
+ One of the organization's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>appId</b> (string) <br>
+ One of the application's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>cancelMsg</b> ( <a href="#cancelmsg">CancelMSG</a>) <br>
- Indicete whether is canceled or not. (Specified in body).
+ <b>queryStatement</b> (string) <br>
+ Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1854,8 +1170,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of canceled notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of retrieved collection's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1873,16 +1189,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices
- <a data-toggle="collapse" data-target="#collapse-oPXCIDKL6a"
- href="#collapse-oPXCIDKL6a" class="collapsed collapse-button"> </a>
+ <div class="panel-heading PUT">
+ <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
+ <a data-toggle="collapse" data-target="#collapse-5ueDq97AOE"
+ href="#collapse-5ueDq97AOE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-oPXCIDKL6a" class="panel-body collapse">
+ <div id="collapse-5ueDq97AOE" class="panel-body collapse">
- <p>Create notifications for user through targeting by location and providing all the identifications.</p>
+ <p>Update collection through query statement.</p>
<h3>Parameters</h3>
@@ -1896,20 +1212,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
- </li>
- <li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
- </li>
- <li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>queryStatement</b> () <br>
- The query statement of the location of the user. (Specified in query).
+ <b>queryStatement</b> (string) <br>
+ Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1919,8 +1227,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of updated collection's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1939,15 +1247,15 @@
<div class="panel panel-default">
<div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/*/notifications
- <a data-toggle="collapse" data-target="#collapse-QHRHWLFRwh"
- href="#collapse-QHRHWLFRwh" class="collapsed collapse-button"> </a>
+ <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
+ <a data-toggle="collapse" data-target="#collapse-dKuOHbhgMw"
+ href="#collapse-dKuOHbhgMw" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-QHRHWLFRwh" class="panel-body collapse">
+ <div id="collapse-dKuOHbhgMw" class="panel-body collapse">
- <p>Create notifications for all devices. This request will target all device entities.</p>
+ <p>Add an entity to a collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -1961,16 +1269,20 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
+ </li>
+ <li>
+ <b>entityId1</b> (string) <br>
+ The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
+ <b>relation</b> (string) <br>
+ The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
+ <b>entityId2</b> (string) <br>
+ The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -1980,8 +1292,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of added entity's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -1999,16 +1311,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/{deviceId}/notifications
- <a data-toggle="collapse" data-target="#collapse-YK5TdQKJ4Z"
- href="#collapse-YK5TdQKJ4Z" class="collapsed collapse-button"> </a>
+ <div class="panel-heading DELETE">
+ <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
+ <a data-toggle="collapse" data-target="#collapse-0Db3hm26XC"
+ href="#collapse-0Db3hm26XC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-YK5TdQKJ4Z" class="panel-body collapse">
+ <div id="collapse-0Db3hm26XC" class="panel-body collapse">
- <p>Create notifications for a single device. This request will target a specific device entity.</p>
+ <p>Remove an entity from a collection through providing all the identifications.</p>
<h3>Parameters</h3>
@@ -2022,20 +1334,20 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>deviceId</b> (string) <br>
- One of the device's identification which includes name or uuid. (Specified in path).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
+ <b>entityId1</b> (string) <br>
+ The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
+ <b>relation</b> (string) <br>
+ The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
+ <b>entityId2</b> (string) <br>
+ The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -2045,8 +1357,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
+ <li>Description: An array of deleted entity's info.</li>
+ <li>Schema: [<a href="#entity">Entity</a>]</li>
</ul>
</li>
<li>
@@ -2064,16 +1376,16 @@
<div class="panel panel-default">
- <div class="panel-heading POST">
- <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{path}/notifications
- <a data-toggle="collapse" data-target="#collapse-ygcIRQJpNR"
- href="#collapse-ygcIRQJpNR" class="collapsed collapse-button"> </a>
+ <div class="panel-heading GET">
+ <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
+ <a data-toggle="collapse" data-target="#collapse-XcDzxtD3OE"
+ href="#collapse-XcDzxtD3OE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ygcIRQJpNR" class="panel-body collapse">
+ <div id="collapse-XcDzxtD3OE" class="panel-body collapse">
- <p>Create notifications for a group. This request will target all users associated with a specific group entity.</p>
+ <p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
<h3>Parameters</h3>
@@ -2087,20 +1399,12 @@
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>path</b> (string) <br>
- The path of the group. (Specified in path).
- </li>
- <li>
- <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br>
- These parameters are used when forming the notification portion of the request. (Specified in body).
- </li>
- <li>
- <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br>
- To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
+ <b>collectionId</b> (string) <br>
+ One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br>
- If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
+ <b>entityId</b> (string) <br>
+ One of the entity's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -2110,8 +1414,8 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of created notification's info.</li>
- <li>Schema: [<a href="#notification">Notification</a>]</li>
<TRUNCATED>
[08/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/working-user-data.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/working-user-data.html b/content/docs/user-management/working-user-data.html
index 58e40bc..80d952f 100644
--- a/content/docs/user-management/working-user-data.html
+++ b/content/docs/user-management/working-user-data.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -168,9 +170,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -185,6 +187,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -249,8 +252,9 @@
your application, you can add support for a wide variety of features
common to mobile apps. For example, you can:</p>
<ul class="simple">
-<li>Control access to data by defining permission rules. (See Security &
-token authentication for more.)</li>
+<li>Control access to data by defining permission rules. (See <a class="reference external" href="../security-and-auth/app-security.html">Security &
+token authentication</a> for
+more.)</li>
<li>Present content specific to each user, such as their list of
favorites.</li>
<li>Support social features, such as letting users “follow” one another,
@@ -263,10 +267,10 @@ things done with user data.</p>
<div class="section" id="creating-users">
<h2>Creating users<a class="headerlink" href="#creating-users" title="Permalink to this headline">¶</a></h2>
<p>A user entity represents an application user. Using API Services you can
-create, retrieve, update, delete, and query user entities. See User
-entity properties for a list of the system-defined properties for user
-entities. In addition, you can create user properties specific to your
-application.</p>
+create, retrieve, update, delete, and query user entities. See <a class="reference external" href="../rest-endpoints/api-doc.html#user">User
+entity properties</a> for a list of
+the system-defined properties for user entities. In addition, you can
+create user properties specific to your application.</p>
<div class="section" id="request-syntax">
<h3>Request Syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/your-org/your-app/users" -d '{ "username": "john.doe", "email": "john.doe@gmail.com", "name": "John Doe", "password": "test1234" }'
@@ -314,15 +318,18 @@ application.</p>
<p>Although the password parameter is not mandatory, if you don’t specify
it, the user will not be able to log in using username and password
credentials. If a password is not specified for the user, and you’re an
-Admin, you can set a password for the user (see Setting a password).</p>
+Admin, you can set a password for the user (see <a class="reference external" href="#changing-a-user-password">Changing a User
+Password</a>).</p>
<p>__ Note__: The username can contain any combination of characters,
including those that represent letters, numbers, and symbols.</p>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
</div>
<div class="section" id="request">
<h3>Request<a class="headerlink" href="#request" title="Permalink to this headline">¶</a></h3>
@@ -379,9 +386,9 @@ users and application clients for details.</p>
<p>You can retrieve data about users through cURL or one of the SDKs. Each
provides a way to filter the list of users by data associated with the
user, such as username or UUID, or other properties in the user entity.</p>
-<p>See User entity properties for a list of the system-defined properties
-for user entities. In addition, you can create user properties specific
-to your application.</p>
+<p>See <a class="reference external" href="../rest-endpoints/api-doc.html#user">User entity properties</a> for
+a list of the system-defined properties for user entities. In addition,
+you can create user properties specific to your application.</p>
<div class="section" id="id1">
<h3>Request Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X GET "https://api.usergrid.com/your-org/your-app/users"
@@ -420,9 +427,10 @@ to your application.</p>
<p>The alias <code class="docutils literal"><span class="pre">/users/me</span></code> can be used in place of the current user’s uuid,
username, or email address. Note: The <code class="docutils literal"><span class="pre">/users/me</span></code> endpoint is
accessible only if you provide an access token with the request (see
-Authenticating users and application clients). If you make an anonymous
-(“guest”) call, the system will not be able to determine which user to
-return as /users/me.</p>
+<a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users and application
+clients</a>).
+If you make an anonymous (“guest”) call, the system will not be able to
+determine which user to return as <code class="docutils literal"><span class="pre">/users/me</span></code>.</p>
<p><strong>Note</strong>: The username can contain any combination of characters,
including those that represent letters, numbers, and symbols.</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.html b/docs/rest-endpoints/api-docs.html
index c4841f9..af9121f 100644
--- a/docs/rest-endpoints/api-docs.html
+++ b/docs/rest-endpoints/api-docs.html
@@ -28,12 +28,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/token
- <a data-toggle="collapse" data-target="#collapse-drcFs9dfPU"
- href="#collapse-drcFs9dfPU" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-cmZMwwFK7m"
+ href="#collapse-cmZMwwFK7m" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-drcFs9dfPU" class="panel-body collapse">
+ <div id="collapse-cmZMwwFK7m" class="panel-body collapse">
<p>Login with Admin-User or Organization credentials.</p>
@@ -73,12 +73,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/token
- <a data-toggle="collapse" data-target="#collapse-XlaRG4JVxJ"
- href="#collapse-XlaRG4JVxJ" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-9bwBQQ9E8H"
+ href="#collapse-9bwBQQ9E8H" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-XlaRG4JVxJ" class="panel-body collapse">
+ <div id="collapse-9bwBQQ9E8H" class="panel-body collapse">
<p>Login with App-User or Application credentials.</p>
@@ -120,12 +120,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
- <a data-toggle="collapse" data-target="#collapse-tmnHUKGqLS"
- href="#collapse-tmnHUKGqLS" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-exqRBt1fJf"
+ href="#collapse-exqRBt1fJf" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-tmnHUKGqLS" class="panel-body collapse">
+ <div id="collapse-exqRBt1fJf" class="panel-body collapse">
<p>Get a group's feed through providing all the identifications.</p>
@@ -173,12 +173,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
- <a data-toggle="collapse" data-target="#collapse-oOJfU8LsRY"
- href="#collapse-oOJfU8LsRY" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-JxAIGXKO4s"
+ href="#collapse-JxAIGXKO4s" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-oOJfU8LsRY" class="panel-body collapse">
+ <div id="collapse-JxAIGXKO4s" class="panel-body collapse">
<p>Create an activity in the activities collection.</p>
@@ -230,12 +230,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-pYJU4YKTd8"
- href="#collapse-pYJU4YKTd8" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-AbL9xxckcn"
+ href="#collapse-AbL9xxckcn" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-pYJU4YKTd8" class="panel-body collapse">
+ <div id="collapse-AbL9xxckcn" class="panel-body collapse">
<p>Retrieve a user's feed through providing all the identifications.</p>
@@ -285,12 +285,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/users
- <a data-toggle="collapse" data-target="#collapse-v3QdwGriJl"
- href="#collapse-v3QdwGriJl" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-1pGl58DjyV"
+ href="#collapse-1pGl58DjyV" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-v3QdwGriJl" class="panel-body collapse">
+ <div id="collapse-1pGl58DjyV" class="panel-body collapse">
<p>Retrieve details about the admin users in an organization.</p>
@@ -330,12 +330,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-6cRMjJKYQr"
- href="#collapse-6cRMjJKYQr" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-6s9X1sa0oT"
+ href="#collapse-6s9X1sa0oT" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-6cRMjJKYQr" class="panel-body collapse">
+ <div id="collapse-6s9X1sa0oT" class="panel-body collapse">
<p>Remove an admin user from an organization through providing both Id of application and organization.</p>
@@ -379,12 +379,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/users
- <a data-toggle="collapse" data-target="#collapse-bVYwPxPrHs"
- href="#collapse-bVYwPxPrHs" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-CffAy8PFG0"
+ href="#collapse-CffAy8PFG0" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-bVYwPxPrHs" class="panel-body collapse">
+ <div id="collapse-CffAy8PFG0" class="panel-body collapse">
<p>Create a whole new admin user.</p>
@@ -424,12 +424,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-7WBllKwJ3P"
- href="#collapse-7WBllKwJ3P" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-puhv9tWxAI"
+ href="#collapse-puhv9tWxAI" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-7WBllKwJ3P" class="panel-body collapse">
+ <div id="collapse-puhv9tWxAI" class="panel-body collapse">
<p>Initiate the reset of an admin user's password.</p>
@@ -465,12 +465,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-OBQT3BKr5H"
- href="#collapse-OBQT3BKr5H" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-slmKGt1TxI"
+ href="#collapse-slmKGt1TxI" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-OBQT3BKr5H" class="panel-body collapse">
+ <div id="collapse-slmKGt1TxI" class="panel-body collapse">
<p>Complete the password reset through getting the newpassword and the old one for identification.</p>
@@ -510,12 +510,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-PiHbAwNiA5"
- href="#collapse-PiHbAwNiA5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-5ONpkPJETJ"
+ href="#collapse-5ONpkPJETJ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-PiHbAwNiA5" class="panel-body collapse">
+ <div id="collapse-5ONpkPJETJ" class="panel-body collapse">
<p>Retrieve details about an admin user.</p>
@@ -555,12 +555,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /management/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-Gep5hzbYRO"
- href="#collapse-Gep5hzbYRO" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-AAUTXtRESK"
+ href="#collapse-AAUTXtRESK" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Gep5hzbYRO" class="panel-body collapse">
+ <div id="collapse-AAUTXtRESK" class="panel-body collapse">
<p>Update the info of an admin user.</p>
@@ -600,12 +600,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
- <a data-toggle="collapse" data-target="#collapse-8lFgKne5Tw"
- href="#collapse-8lFgKne5Tw" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-d2BwAnUMRh"
+ href="#collapse-d2BwAnUMRh" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-8lFgKne5Tw" class="panel-body collapse">
+ <div id="collapse-d2BwAnUMRh" class="panel-body collapse">
<p>Activate an admin user from a link provIded in an email notification.</p>
@@ -653,12 +653,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
- <a data-toggle="collapse" data-target="#collapse-xHaeQAbaqd"
- href="#collapse-xHaeQAbaqd" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-iIdJ1A84uU"
+ href="#collapse-iIdJ1A84uU" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-xHaeQAbaqd" class="panel-body collapse">
+ <div id="collapse-iIdJ1A84uU" class="panel-body collapse">
<p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
@@ -702,12 +702,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-aPY008UTT5"
- href="#collapse-aPY008UTT5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-PhIPbnIHGc"
+ href="#collapse-PhIPbnIHGc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-aPY008UTT5" class="panel-body collapse">
+ <div id="collapse-PhIPbnIHGc" class="panel-body collapse">
<p>Reactivate an expired admin user.</p>
@@ -749,12 +749,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users
- <a data-toggle="collapse" data-target="#collapse-yQoflCFgcD"
- href="#collapse-yQoflCFgcD" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-V01GZ7JOxQ"
+ href="#collapse-V01GZ7JOxQ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-yQoflCFgcD" class="panel-body collapse">
+ <div id="collapse-V01GZ7JOxQ" class="panel-body collapse">
<p>Retrieve users though query statement.</p>
@@ -802,12 +802,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users
- <a data-toggle="collapse" data-target="#collapse-xoM0nnodXH"
- href="#collapse-xoM0nnodXH" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-PaYXkTXJ5G"
+ href="#collapse-PaYXkTXJ5G" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-xoM0nnodXH" class="panel-body collapse">
+ <div id="collapse-PaYXkTXJ5G" class="panel-body collapse">
<p>Create a user in the users collection through providing all the identifications.</p>
@@ -855,12 +855,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-nwtxxd6sC5"
- href="#collapse-nwtxxd6sC5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-0mWFb57I4U"
+ href="#collapse-0mWFb57I4U" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-nwtxxd6sC5" class="panel-body collapse">
+ <div id="collapse-0mWFb57I4U" class="panel-body collapse">
<p>Retrieve a user through providing all the identifications.</p>
@@ -908,12 +908,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-1ouK9M0Buc"
- href="#collapse-1ouK9M0Buc" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-cgjV8htU81"
+ href="#collapse-cgjV8htU81" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-1ouK9M0Buc" class="panel-body collapse">
+ <div id="collapse-cgjV8htU81" class="panel-body collapse">
<p>Update a user through providing all the identifications.</p>
@@ -961,12 +961,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-Il1v6OOFVy"
- href="#collapse-Il1v6OOFVy" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-ykHqVqQ6Oj"
+ href="#collapse-ykHqVqQ6Oj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Il1v6OOFVy" class="panel-body collapse">
+ <div id="collapse-ykHqVqQ6Oj" class="panel-body collapse">
<p>Remove a user through providing all the identifications.</p>
@@ -1014,12 +1014,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
- <a data-toggle="collapse" data-target="#collapse-imri2jPPiC"
- href="#collapse-imri2jPPiC" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-VhPgf00cla"
+ href="#collapse-VhPgf00cla" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-imri2jPPiC" class="panel-body collapse">
+ <div id="collapse-VhPgf00cla" class="panel-body collapse">
<p>Set a user's password or reset the user's existing password.</p>
@@ -1073,12 +1073,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
- <a data-toggle="collapse" data-target="#collapse-SIBQHXJ8cG"
- href="#collapse-SIBQHXJ8cG" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-jlZmpUyBZV"
+ href="#collapse-jlZmpUyBZV" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-SIBQHXJ8cG" class="panel-body collapse">
+ <div id="collapse-jlZmpUyBZV" class="panel-body collapse">
<p>Retrieve a user's collections or connections through query statement.</p>
@@ -1134,12 +1134,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-dJMRYq1Xcc"
- href="#collapse-dJMRYq1Xcc" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-pr3vboKDpc"
+ href="#collapse-pr3vboKDpc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-dJMRYq1Xcc" class="panel-body collapse">
+ <div id="collapse-pr3vboKDpc" class="panel-body collapse">
<p>Retrieve collection through query statement.</p>
@@ -1191,12 +1191,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-5ueDq97AOE"
- href="#collapse-5ueDq97AOE" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-sS3PjGnyPg"
+ href="#collapse-sS3PjGnyPg" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-5ueDq97AOE" class="panel-body collapse">
+ <div id="collapse-sS3PjGnyPg" class="panel-body collapse">
<p>Update collection through query statement.</p>
@@ -1248,12 +1248,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-dKuOHbhgMw"
- href="#collapse-dKuOHbhgMw" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-kBZa6UmQ6K"
+ href="#collapse-kBZa6UmQ6K" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-dKuOHbhgMw" class="panel-body collapse">
+ <div id="collapse-kBZa6UmQ6K" class="panel-body collapse">
<p>Add an entity to a collection through providing all the identifications.</p>
@@ -1313,12 +1313,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-0Db3hm26XC"
- href="#collapse-0Db3hm26XC" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-q1XdQp1Vz1"
+ href="#collapse-q1XdQp1Vz1" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-0Db3hm26XC" class="panel-body collapse">
+ <div id="collapse-q1XdQp1Vz1" class="panel-body collapse">
<p>Remove an entity from a collection through providing all the identifications.</p>
@@ -1378,12 +1378,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-XcDzxtD3OE"
- href="#collapse-XcDzxtD3OE" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-sBQn2Zm73y"
+ href="#collapse-sBQn2Zm73y" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-XcDzxtD3OE" class="panel-body collapse">
+ <div id="collapse-sBQn2Zm73y" class="panel-body collapse">
<p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
@@ -1435,12 +1435,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-eVlugGfJwi"
- href="#collapse-eVlugGfJwi" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-0A3aKSddRW"
+ href="#collapse-0A3aKSddRW" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-eVlugGfJwi" class="panel-body collapse">
+ <div id="collapse-0A3aKSddRW" class="panel-body collapse">
<p>One or more properties can be updated with a single request.</p>
@@ -1496,12 +1496,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-EUCGreTvl5"
- href="#collapse-EUCGreTvl5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-ucAcC4Nd0j"
+ href="#collapse-ucAcC4Nd0j" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-EUCGreTvl5" class="panel-body collapse">
+ <div id="collapse-ucAcC4Nd0j" class="panel-body collapse">
<p>Delete an entity from the collection.</p>
@@ -1553,12 +1553,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{entitytype}
- <a data-toggle="collapse" data-target="#collapse-U44E7MPent"
- href="#collapse-U44E7MPent" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-YRfWP8ftG3"
+ href="#collapse-YRfWP8ftG3" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-U44E7MPent" class="panel-body collapse">
+ <div id="collapse-YRfWP8ftG3" class="panel-body collapse">
<p>When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type. </p>
@@ -1612,12 +1612,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/events
- <a data-toggle="collapse" data-target="#collapse-UWAdvDH0bL"
- href="#collapse-UWAdvDH0bL" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-MZcDD1JU53"
+ href="#collapse-MZcDD1JU53" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-UWAdvDH0bL" class="panel-body collapse">
+ <div id="collapse-MZcDD1JU53" class="panel-body collapse">
<p>Create an event through providing both Id of organization and application.</p>
@@ -1667,12 +1667,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups
- <a data-toggle="collapse" data-target="#collapse-ycHjhQQJCT"
- href="#collapse-ycHjhQQJCT" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-OTdDKZ0fWp"
+ href="#collapse-OTdDKZ0fWp" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ycHjhQQJCT" class="panel-body collapse">
+ <div id="collapse-OTdDKZ0fWp" class="panel-body collapse">
<p>Create a new group through providing both Id of organization and application.</p>
@@ -1720,12 +1720,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities
- <a data-toggle="collapse" data-target="#collapse-p7uBB9oKlO"
- href="#collapse-p7uBB9oKlO" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-VyScbjchTt"
+ href="#collapse-VyScbjchTt" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-p7uBB9oKlO" class="panel-body collapse">
+ <div id="collapse-VyScbjchTt" class="panel-body collapse">
<p>Create an activity to a specific group. In this case the activity is created in the activities collection and is accessible at the /activities endpoint to users who have the permission to read that endpoint. In addition, a relationship is established between the activity and the group, and because of that, the activity will appear in the group’s feed. The group 'owns' the activity. Also, the activity will be published in the feed of all users that are members of the group.</p>
@@ -1777,12 +1777,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-HGywTPCNT5"
- href="#collapse-HGywTPCNT5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Egsbqj0eRD"
+ href="#collapse-Egsbqj0eRD" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-HGywTPCNT5" class="panel-body collapse">
+ <div id="collapse-Egsbqj0eRD" class="panel-body collapse">
<p>Add a user to a group through providing all the identifications.</p>
@@ -1834,12 +1834,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-BuWSmsHs3b"
- href="#collapse-BuWSmsHs3b" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-CVwrOal4S0"
+ href="#collapse-CVwrOal4S0" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-BuWSmsHs3b" class="panel-body collapse">
+ <div id="collapse-CVwrOal4S0" class="panel-body collapse">
<p>Delete user from a group through providing all the identifications.</p>
@@ -1891,12 +1891,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-tRFQTk3Ol4"
- href="#collapse-tRFQTk3Ol4" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-613XnsbBRS"
+ href="#collapse-613XnsbBRS" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-tRFQTk3Ol4" class="panel-body collapse">
+ <div id="collapse-613XnsbBRS" class="panel-body collapse">
<p>Get a group through through providing all the identifications.</p>
@@ -1944,12 +1944,12 @@
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-lW2FPyQeP3"
- href="#collapse-lW2FPyQeP3" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-yvm6z86RQd"
+ href="#collapse-yvm6z86RQd" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-lW2FPyQeP3" class="panel-body collapse">
+ <div id="collapse-yvm6z86RQd" class="panel-body collapse">
<p>Update a group through providing all the identifications.</p>
@@ -1999,12 +1999,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/orgs
- <a data-toggle="collapse" data-target="#collapse-37l1VorzOo"
- href="#collapse-37l1VorzOo" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-nYv042esF9"
+ href="#collapse-nYv042esF9" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-37l1VorzOo" class="panel-body collapse">
+ <div id="collapse-nYv042esF9" class="panel-body collapse">
<p>Create an organization through a form post.</p>
@@ -2044,12 +2044,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}
- <a data-toggle="collapse" data-target="#collapse-ncgjtz5lor"
- href="#collapse-ncgjtz5lor" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-V8QZt2X1X1"
+ href="#collapse-V8QZt2X1X1" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ncgjtz5lor" class="panel-body collapse">
+ <div id="collapse-V8QZt2X1X1" class="panel-body collapse">
<p>Retrieve an organization given a specified UUID or username.</p>
@@ -2089,12 +2089,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/activate
- <a data-toggle="collapse" data-target="#collapse-vic45DAlkP"
- href="#collapse-vic45DAlkP" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-bubo8aV7Tg"
+ href="#collapse-bubo8aV7Tg" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-vic45DAlkP" class="panel-body collapse">
+ <div id="collapse-bubo8aV7Tg" class="panel-body collapse">
<p>Activate an organization from a link provIded in an email notification.</p>
@@ -2142,12 +2142,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps
- <a data-toggle="collapse" data-target="#collapse-N6feTuPsJp"
- href="#collapse-N6feTuPsJp" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-3yg9gYRBk9"
+ href="#collapse-3yg9gYRBk9" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-N6feTuPsJp" class="panel-body collapse">
+ <div id="collapse-3yg9gYRBk9" class="panel-body collapse">
<p>Retrieve the applications in an organization through providing both Id of application and organization.</p>
@@ -2187,12 +2187,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-bA27pkj7ct"
- href="#collapse-bA27pkj7ct" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-hgnKhvanvP"
+ href="#collapse-hgnKhvanvP" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-bA27pkj7ct" class="panel-body collapse">
+ <div id="collapse-hgnKhvanvP" class="panel-body collapse">
<p>Retrieve the client Id and client secret credentials for an application in an organization.</p>
@@ -2236,12 +2236,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials
- <a data-toggle="collapse" data-target="#collapse-idn5Hsr0gf"
- href="#collapse-idn5Hsr0gf" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-7aNLdtTAzC"
+ href="#collapse-7aNLdtTAzC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-idn5Hsr0gf" class="panel-body collapse">
+ <div id="collapse-7aNLdtTAzC" class="panel-body collapse">
<p>Generate the client Id and client secret credentials for an application in an organization.</p>
@@ -2285,12 +2285,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-ErM6BOzLfO"
- href="#collapse-ErM6BOzLfO" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-qpOqV3R8xj"
+ href="#collapse-qpOqV3R8xj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ErM6BOzLfO" class="panel-body collapse">
+ <div id="collapse-qpOqV3R8xj" class="panel-body collapse">
<p>Retrieve the credentials for an organization client.</p>
@@ -2330,12 +2330,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/credentials
- <a data-toggle="collapse" data-target="#collapse-1cTvmbBs8Y"
- href="#collapse-1cTvmbBs8Y" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-BQLJAUimHf"
+ href="#collapse-BQLJAUimHf" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-1cTvmbBs8Y" class="panel-body collapse">
+ <div id="collapse-BQLJAUimHf" class="panel-body collapse">
<p>Generate whole new credentials for an organization client.</p>
@@ -2375,12 +2375,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/feed
- <a data-toggle="collapse" data-target="#collapse-JJV9qTl0Mx"
- href="#collapse-JJV9qTl0Mx" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-nddvUe6VhI"
+ href="#collapse-nddvUe6VhI" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-JJV9qTl0Mx" class="panel-body collapse">
+ <div id="collapse-nddvUe6VhI" class="panel-body collapse">
<p>Retrieve an organization's activity feed.</p>
@@ -2420,12 +2420,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-CRSWKTk8wQ"
- href="#collapse-CRSWKTk8wQ" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-OSVJ53TPMj"
+ href="#collapse-OSVJ53TPMj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-CRSWKTk8wQ" class="panel-body collapse">
+ <div id="collapse-OSVJ53TPMj" class="panel-body collapse">
<p>Reactivate an expired organization.</p>
@@ -2465,12 +2465,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-jM2XxRqKvk"
- href="#collapse-jM2XxRqKvk" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-UnMr8HHcuY"
+ href="#collapse-UnMr8HHcuY" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-jM2XxRqKvk" class="panel-body collapse">
+ <div id="collapse-UnMr8HHcuY" class="panel-body collapse">
<p>Retrieve an admin user's activity feed.</p>
@@ -2512,12 +2512,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/roles
- <a data-toggle="collapse" data-target="#collapse-kZEHb6XDt5"
- href="#collapse-kZEHb6XDt5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-02qXg6VF4Q"
+ href="#collapse-02qXg6VF4Q" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-kZEHb6XDt5" class="panel-body collapse">
+ <div id="collapse-02qXg6VF4Q" class="panel-body collapse">
<p>Retrieve the roles in an application through providing all the identifications.</p>
@@ -2561,12 +2561,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/roles
- <a data-toggle="collapse" data-target="#collapse-XTCUoYnhzQ"
- href="#collapse-XTCUoYnhzQ" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-jHrXxXHofL"
+ href="#collapse-jHrXxXHofL" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-XTCUoYnhzQ" class="panel-body collapse">
+ <div id="collapse-jHrXxXHofL" class="panel-body collapse">
<p>Create a new role through providing all the identifications.</p>
@@ -2614,12 +2614,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions
- <a data-toggle="collapse" data-target="#collapse-kMyEXuBYhy"
- href="#collapse-kMyEXuBYhy" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-SaKTfihQh7"
+ href="#collapse-SaKTfihQh7" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-kMyEXuBYhy" class="panel-body collapse">
+ <div id="collapse-SaKTfihQh7" class="panel-body collapse">
<p>Remove permissions from a role. </p>
@@ -2671,12 +2671,12 @@
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users
- <a data-toggle="collapse" data-target="#collapse-fnsrTNHffU"
- href="#collapse-fnsrTNHffU" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-6D2PU6f6RC"
+ href="#collapse-6D2PU6f6RC" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-fnsrTNHffU" class="panel-body collapse">
+ <div id="collapse-6D2PU6f6RC" class="panel-body collapse">
<p>Retrieve the users in a role through providing all the identifications.</p>
@@ -2724,12 +2724,12 @@
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-fUSF9jW6Db"
- href="#collapse-fUSF9jW6Db" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-tUInKPzm2F"
+ href="#collapse-tUInKPzm2F" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-fUSF9jW6Db" class="panel-body collapse">
+ <div id="collapse-tUInKPzm2F" class="panel-body collapse">
<p>Add a user to a role through providing all the identifications.</p>
@@ -2781,12 +2781,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-epVX5Ao1Vg"
- href="#collapse-epVX5Ao1Vg" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-NYYuAZhEPl"
+ href="#collapse-NYYuAZhEPl" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-epVX5Ao1Vg" class="panel-body collapse">
+ <div id="collapse-NYYuAZhEPl" class="panel-body collapse">
<p>Remove a user from a role through providing all the identifications.</p>
@@ -2838,12 +2838,12 @@
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}
- <a data-toggle="collapse" data-target="#collapse-btVFN0gXNe"
- href="#collapse-btVFN0gXNe" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-l7U48ELoVm"
+ href="#collapse-l7U48ELoVm" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-btVFN0gXNe" class="panel-body collapse">
+ <div id="collapse-l7U48ELoVm" class="panel-body collapse">
<p>Remove a role through providing all the identifications.</p>
@@ -2897,12 +2897,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">AccessTokenResponse
- <a data-toggle="collapse" data-target="#collapse-C9FYpTnpsm"
- href="#collapse-C9FYpTnpsm" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-1VgkmUAYh5"
+ href="#collapse-1VgkmUAYh5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-C9FYpTnpsm" class="panel-body collapse">
+ <div id="collapse-1VgkmUAYh5" class="panel-body">
<h3>Properties</h3>
@@ -2945,12 +2945,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Action
- <a data-toggle="collapse" data-target="#collapse-mK1P8RIaPW"
- href="#collapse-mK1P8RIaPW" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-DtFp77e7x2"
+ href="#collapse-DtFp77e7x2" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-mK1P8RIaPW" class="panel-body collapse">
+ <div id="collapse-DtFp77e7x2" class="panel-body">
<h3>Properties</h3>
@@ -2993,12 +2993,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">ActivityFeed
- <a data-toggle="collapse" data-target="#collapse-uhiFD99YEh"
- href="#collapse-uhiFD99YEh" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-S9a8e4EjD2"
+ href="#collapse-S9a8e4EjD2" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-uhiFD99YEh" class="panel-body collapse">
+ <div id="collapse-S9a8e4EjD2" class="panel-body">
<h3>Properties</h3>
@@ -3065,12 +3065,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Actor
- <a data-toggle="collapse" data-target="#collapse-NuNJAiwPam"
- href="#collapse-NuNJAiwPam" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-gIjjHKrX23"
+ href="#collapse-gIjjHKrX23" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-NuNJAiwPam" class="panel-body collapse">
+ <div id="collapse-gIjjHKrX23" class="panel-body">
<h3>Properties</h3>
@@ -3119,12 +3119,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">AddPermission
- <a data-toggle="collapse" data-target="#collapse-N2iYCk1iLC"
- href="#collapse-N2iYCk1iLC" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-pwduKH8dO9"
+ href="#collapse-pwduKH8dO9" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-N2iYCk1iLC" class="panel-body collapse">
+ <div id="collapse-pwduKH8dO9" class="panel-body">
<h3>Properties</h3>
@@ -3161,12 +3161,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">AddRole
- <a data-toggle="collapse" data-target="#collapse-IPdB8IUs1w"
- href="#collapse-IPdB8IUs1w" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-FinNyqBhKV"
+ href="#collapse-FinNyqBhKV" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-IPdB8IUs1w" class="panel-body collapse">
+ <div id="collapse-FinNyqBhKV" class="panel-body">
<h3>Properties</h3>
@@ -3203,12 +3203,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">AdminUserUpdate
- <a data-toggle="collapse" data-target="#collapse-wtC6eTToQj"
- href="#collapse-wtC6eTToQj" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-i3p3LgpRaj"
+ href="#collapse-i3p3LgpRaj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-wtC6eTToQj" class="panel-body collapse">
+ <div id="collapse-i3p3LgpRaj" class="panel-body">
<h3>Properties</h3>
@@ -3245,12 +3245,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">AppData
- <a data-toggle="collapse" data-target="#collapse-mwW0WjuHQp"
- href="#collapse-mwW0WjuHQp" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Jh2Q2K53Gs"
+ href="#collapse-Jh2Q2K53Gs" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-mwW0WjuHQp" class="panel-body collapse">
+ <div id="collapse-Jh2Q2K53Gs" class="panel-body">
<h3>Properties</h3>
@@ -3299,12 +3299,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CancelMSG
- <a data-toggle="collapse" data-target="#collapse-pT05ReO3iR"
- href="#collapse-pT05ReO3iR" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-71Rqez85Rn"
+ href="#collapse-71Rqez85Rn" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-pT05ReO3iR" class="panel-body collapse">
+ <div id="collapse-71Rqez85Rn" class="panel-body">
<h3>Properties</h3>
@@ -3335,12 +3335,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Collections
- <a data-toggle="collapse" data-target="#collapse-BQC4xq9l8A"
- href="#collapse-BQC4xq9l8A" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-OEadoL8nvN"
+ href="#collapse-OEadoL8nvN" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-BQC4xq9l8A" class="panel-body collapse">
+ <div id="collapse-OEadoL8nvN" class="panel-body">
<h3>Properties</h3>
@@ -3389,12 +3389,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateActivity
- <a data-toggle="collapse" data-target="#collapse-AaFdsytOBy"
- href="#collapse-AaFdsytOBy" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Y31L0Wg7xM"
+ href="#collapse-Y31L0Wg7xM" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-AaFdsytOBy" class="panel-body collapse">
+ <div id="collapse-Y31L0Wg7xM" class="panel-body">
<h3>Properties</h3>
@@ -3455,12 +3455,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateAdminUser
- <a data-toggle="collapse" data-target="#collapse-ZfboKg0LwB"
- href="#collapse-ZfboKg0LwB" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-vCmnLKgY36"
+ href="#collapse-vCmnLKgY36" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ZfboKg0LwB" class="panel-body collapse">
+ <div id="collapse-vCmnLKgY36" class="panel-body">
<h3>Properties</h3>
@@ -3509,12 +3509,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateApp
- <a data-toggle="collapse" data-target="#collapse-adezvV37wJ"
- href="#collapse-adezvV37wJ" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-beN1ggs3PY"
+ href="#collapse-beN1ggs3PY" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-adezvV37wJ" class="panel-body collapse">
+ <div id="collapse-beN1ggs3PY" class="panel-body">
<h3>Properties</h3>
@@ -3551,12 +3551,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateEntities
- <a data-toggle="collapse" data-target="#collapse-g0DWfkALDO"
- href="#collapse-g0DWfkALDO" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-wU53SAmgzG"
+ href="#collapse-wU53SAmgzG" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-g0DWfkALDO" class="panel-body collapse">
+ <div id="collapse-wU53SAmgzG" class="panel-body">
<h3>Properties</h3>
@@ -3581,12 +3581,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateEntity
- <a data-toggle="collapse" data-target="#collapse-4iZ92myEIw"
- href="#collapse-4iZ92myEIw" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-qyZ27UlHfi"
+ href="#collapse-qyZ27UlHfi" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-4iZ92myEIw" class="panel-body collapse">
+ <div id="collapse-qyZ27UlHfi" class="panel-body">
<h3>Properties</h3>
@@ -3623,12 +3623,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateEvent
- <a data-toggle="collapse" data-target="#collapse-KvZTLMpA4e"
- href="#collapse-KvZTLMpA4e" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-8LQ8nv73uE"
+ href="#collapse-8LQ8nv73uE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-KvZTLMpA4e" class="panel-body collapse">
+ <div id="collapse-8LQ8nv73uE" class="panel-body">
<h3>Properties</h3>
@@ -3659,12 +3659,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateGroup
- <a data-toggle="collapse" data-target="#collapse-aIT2x2F8pu"
- href="#collapse-aIT2x2F8pu" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Wi4dHosBBt"
+ href="#collapse-Wi4dHosBBt" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-aIT2x2F8pu" class="panel-body collapse">
+ <div id="collapse-Wi4dHosBBt" class="panel-body">
<h3>Properties</h3>
@@ -3701,12 +3701,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateNotification
- <a data-toggle="collapse" data-target="#collapse-SSMWJ1Uivr"
- href="#collapse-SSMWJ1Uivr" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-4z5Lf4uKaq"
+ href="#collapse-4z5Lf4uKaq" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-SSMWJ1Uivr" class="panel-body collapse">
+ <div id="collapse-4z5Lf4uKaq" class="panel-body">
<h3>Properties</h3>
@@ -3743,12 +3743,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateNotifications
- <a data-toggle="collapse" data-target="#collapse-jeJAK2xdIL"
- href="#collapse-jeJAK2xdIL" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-t5n87Qi0L6"
+ href="#collapse-t5n87Qi0L6" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-jeJAK2xdIL" class="panel-body collapse">
+ <div id="collapse-t5n87Qi0L6" class="panel-body">
<h3>Properties</h3>
@@ -3773,12 +3773,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateOrg
- <a data-toggle="collapse" data-target="#collapse-khqY8hSlFF"
- href="#collapse-khqY8hSlFF" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-bwyuITnD1a"
+ href="#collapse-bwyuITnD1a" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-khqY8hSlFF" class="panel-body collapse">
+ <div id="collapse-bwyuITnD1a" class="panel-body">
<h3>Properties</h3>
@@ -3833,12 +3833,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">CreateUser
- <a data-toggle="collapse" data-target="#collapse-EDWVAtA9fP"
- href="#collapse-EDWVAtA9fP" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-EzeY0pv0Eu"
+ href="#collapse-EzeY0pv0Eu" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-EDWVAtA9fP" class="panel-body collapse">
+ <div id="collapse-EzeY0pv0Eu" class="panel-body">
<h3>Properties</h3>
@@ -3869,12 +3869,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Credential
- <a data-toggle="collapse" data-target="#collapse-uF9KZWiFUS"
- href="#collapse-uF9KZWiFUS" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Cmel6Fikjq"
+ href="#collapse-Cmel6Fikjq" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-uF9KZWiFUS" class="panel-body collapse">
+ <div id="collapse-Cmel6Fikjq" class="panel-body">
<h3>Properties</h3>
@@ -3917,12 +3917,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Device
- <a data-toggle="collapse" data-target="#collapse-cZt0sF4mwS"
- href="#collapse-cZt0sF4mwS" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-QkPJF7ue7S"
+ href="#collapse-QkPJF7ue7S" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-cZt0sF4mwS" class="panel-body collapse">
+ <div id="collapse-QkPJF7ue7S" class="panel-body">
<h3>Properties</h3>
@@ -3977,12 +3977,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Entity
- <a data-toggle="collapse" data-target="#collapse-GkNgHGU1fg"
- href="#collapse-GkNgHGU1fg" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-UYP54x37oV"
+ href="#collapse-UYP54x37oV" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-GkNgHGU1fg" class="panel-body collapse">
+ <div id="collapse-UYP54x37oV" class="panel-body">
<h3>Properties</h3>
@@ -4043,12 +4043,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Error
- <a data-toggle="collapse" data-target="#collapse-p1xwDWFZK2"
- href="#collapse-p1xwDWFZK2" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-5nsYc6XE55"
+ href="#collapse-5nsYc6XE55" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-p1xwDWFZK2" class="panel-body collapse">
+ <div id="collapse-5nsYc6XE55" class="panel-body">
<h3>Properties</h3>
@@ -4091,12 +4091,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Event
- <a data-toggle="collapse" data-target="#collapse-p5yHkfpvFx"
- href="#collapse-p5yHkfpvFx" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-25buB50hbv"
+ href="#collapse-25buB50hbv" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-p5yHkfpvFx" class="panel-body collapse">
+ <div id="collapse-25buB50hbv" class="panel-body">
<h3>Properties</h3>
@@ -4163,12 +4163,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Group
- <a data-toggle="collapse" data-target="#collapse-lxvMo7llKA"
- href="#collapse-lxvMo7llKA" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-I7kkgtbZo9"
+ href="#collapse-I7kkgtbZo9" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-lxvMo7llKA" class="panel-body collapse">
+ <div id="collapse-I7kkgtbZo9" class="panel-body">
<h3>Properties</h3>
@@ -4241,12 +4241,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">ImageModel
- <a data-toggle="collapse" data-target="#collapse-Y7zHleqjxY"
- href="#collapse-Y7zHleqjxY" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-7o9yErJ18S"
+ href="#collapse-7o9yErJ18S" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Y7zHleqjxY" class="panel-body collapse">
+ <div id="collapse-7o9yErJ18S" class="panel-body">
<h3>Properties</h3>
@@ -4289,12 +4289,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">LoginCredentials
- <a data-toggle="collapse" data-target="#collapse-gHqB6pucMU"
- href="#collapse-gHqB6pucMU" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-kqkJnCAume"
+ href="#collapse-kqkJnCAume" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-gHqB6pucMU" class="panel-body collapse">
+ <div id="collapse-kqkJnCAume" class="panel-body">
<h3>Properties</h3>
@@ -4349,12 +4349,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Metadata
- <a data-toggle="collapse" data-target="#collapse-VqzzQgZn2H"
- href="#collapse-VqzzQgZn2H" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-AJhMBgM8Xl"
+ href="#collapse-AJhMBgM8Xl" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-VqzzQgZn2H" class="panel-body collapse">
+ <div id="collapse-AJhMBgM8Xl" class="panel-body">
<h3>Properties</h3>
@@ -4403,12 +4403,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Notification
- <a data-toggle="collapse" data-target="#collapse-iSuJL82f8H"
- href="#collapse-iSuJL82f8H" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-lKa68lpEPh"
+ href="#collapse-lKa68lpEPh" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-iSuJL82f8H" class="panel-body collapse">
+ <div id="collapse-lKa68lpEPh" class="panel-body">
<h3>Properties</h3>
@@ -4481,12 +4481,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Notifier
- <a data-toggle="collapse" data-target="#collapse-YN9DNaFsZV"
- href="#collapse-YN9DNaFsZV" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-VoOmIooPnV"
+ href="#collapse-VoOmIooPnV" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-YN9DNaFsZV" class="panel-body collapse">
+ <div id="collapse-VoOmIooPnV" class="panel-body">
<h3>Properties</h3>
@@ -4547,12 +4547,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Object
- <a data-toggle="collapse" data-target="#collapse-uZHTCf56UD"
- href="#collapse-uZHTCf56UD" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-Vbl4bmihKj"
+ href="#collapse-Vbl4bmihKj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-uZHTCf56UD" class="panel-body collapse">
+ <div id="collapse-Vbl4bmihKj" class="panel-body">
<h3>Properties</h3>
@@ -4601,12 +4601,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Organization
- <a data-toggle="collapse" data-target="#collapse-nnIzV9Idtb"
- href="#collapse-nnIzV9Idtb" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-2EtGCAuZQg"
+ href="#collapse-2EtGCAuZQg" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-nnIzV9Idtb" class="panel-body collapse">
+ <div id="collapse-2EtGCAuZQg" class="panel-body">
<h3>Properties</h3>
@@ -4715,12 +4715,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Permission
- <a data-toggle="collapse" data-target="#collapse-0K0WFHZmMV"
- href="#collapse-0K0WFHZmMV" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-fByUqjSqNW"
+ href="#collapse-fByUqjSqNW" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-0K0WFHZmMV" class="panel-body collapse">
+ <div id="collapse-fByUqjSqNW" class="panel-body">
<h3>Properties</h3>
@@ -4787,12 +4787,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Receipt
- <a data-toggle="collapse" data-target="#collapse-JK3DoZwmHv"
- href="#collapse-JK3DoZwmHv" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-yTz4JcW5tQ"
+ href="#collapse-yTz4JcW5tQ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-JK3DoZwmHv" class="panel-body collapse">
+ <div id="collapse-yTz4JcW5tQ" class="panel-body">
<h3>Properties</h3>
@@ -4865,12 +4865,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">ResetPW
- <a data-toggle="collapse" data-target="#collapse-wpj0rQk6pi"
- href="#collapse-wpj0rQk6pi" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-hefkUNr7BD"
+ href="#collapse-hefkUNr7BD" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-wpj0rQk6pi" class="panel-body collapse">
+ <div id="collapse-hefkUNr7BD" class="panel-body">
<h3>Properties</h3>
@@ -4907,12 +4907,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">ResetPWMsg
- <a data-toggle="collapse" data-target="#collapse-IIwuDWIbr9"
- href="#collapse-IIwuDWIbr9" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-ISZNi9vNd6"
+ href="#collapse-ISZNi9vNd6" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-IIwuDWIbr9" class="panel-body collapse">
+ <div id="collapse-ISZNi9vNd6" class="panel-body">
<h3>Properties</h3>
@@ -4955,12 +4955,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Role
- <a data-toggle="collapse" data-target="#collapse-kDsQN2KUGF"
- href="#collapse-kDsQN2KUGF" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-AUEqAZauGO"
+ href="#collapse-AUEqAZauGO" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-kDsQN2KUGF" class="panel-body collapse">
+ <div id="collapse-AUEqAZauGO" class="panel-body">
<h3>Properties</h3>
@@ -5033,12 +5033,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">ScheduleNotification
- <a data-toggle="collapse" data-target="#collapse-QCaonuSs5E"
- href="#collapse-QCaonuSs5E" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-BSOrAEpkbc"
+ href="#collapse-BSOrAEpkbc" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-QCaonuSs5E" class="panel-body collapse">
+ <div id="collapse-BSOrAEpkbc" class="panel-body">
<h3>Properties</h3>
@@ -5069,12 +5069,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">SetExpiration
- <a data-toggle="collapse" data-target="#collapse-hO4H02u2JU"
- href="#collapse-hO4H02u2JU" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-iT8KaThZfy"
+ href="#collapse-iT8KaThZfy" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-hO4H02u2JU" class="panel-body collapse">
+ <div id="collapse-iT8KaThZfy" class="panel-body">
<h3>Properties</h3>
@@ -5105,12 +5105,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">Sets
- <a data-toggle="collapse" data-target="#collapse-ridmnrfMxK"
- href="#collapse-ridmnrfMxK" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-vH41Ft59qR"
+ href="#collapse-vH41Ft59qR" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ridmnrfMxK" class="panel-body collapse">
+ <div id="collapse-vH41Ft59qR" class="panel-body">
<h3>Properties</h3>
@@ -5147,12 +5147,12 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">User
- <a data-toggle="collapse" data-target="#collapse-MNzJQameul"
- href="#collapse-MNzJQameul" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-WkFQsYdCQ1"
+ href="#collapse-WkFQsYdCQ1" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-MNzJQameul" class="panel-body collapse">
+ <div id="collapse-WkFQsYdCQ1" class="panel-body">
<h3>Properties</h3>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/docs/src/main/resources/html/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/model.mustache b/docs/src/main/resources/html/model.mustache
index 8672641..7cb45ef 100644
--- a/docs/src/main/resources/html/model.mustache
+++ b/docs/src/main/resources/html/model.mustache
@@ -12,7 +12,7 @@
</h2>
</div>
- <div id="collapse-{{modelid}}" class="panel-body collapse">
+ <div id="collapse-{{modelid}}" class="panel-body">
<h3>Properties</h3>
[15/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/introduction/data-model.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/data-model.html b/content/docs/introduction/data-model.html
index e8aba1e..7d7385f 100644
--- a/content/docs/introduction/data-model.html
+++ b/content/docs/introduction/data-model.html
@@ -82,6 +82,7 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid Data model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#organizations">Organizations</a></li>
@@ -97,8 +98,8 @@
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -126,6 +127,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -150,9 +152,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -167,6 +169,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -251,8 +254,8 @@ wish. This allows you to utilize the backend in a way that corresponds
to your development process. For example, you might create separate
applications for development and production instances of your app. By
default, all organization have a sandbox application (see Using a
-Sandbox Application for important information regarding the default
-sandbox application).</p>
+<a class="reference external" href="../getting-started/using-a-sandbox-app.html">Sandbox Application</a>
+for important information regarding the default sandbox application).</p>
<p>Each application provides the infrastructure for storing, retrieving,
updating and deleting the entities and collections associated with a
specific app instance.</p>
@@ -294,20 +297,20 @@ user perspective.</p>
<div class="section" id="default-entities">
<h2>Default entities<a class="headerlink" href="#default-entities" title="Permalink to this headline">¶</a></h2>
<p>The following entity types are predefined in Usergrid. For more details,
-see Default Data Entity Types.</p>
+see the <a class="reference external" href="../rest-endpoints/api-docs.html">API Reference</a></p>
<ul class="simple">
-<li>user</li>
-<li>group</li>
-<li>role</li>
-<li>application</li>
-<li>activity</li>
-<li>device</li>
-<li>asset</li>
-<li>folder</li>
-<li>event</li>
-<li>notifier</li>
-<li>notification</li>
-<li>receipt</li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#user">user</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#group">group</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#role">role</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#application">application</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#activity">activity</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#device">device</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#asset">asset</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#folder">folder</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#event">event</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#notifier">notifier</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#notification">notification</a></li>
+<li><a class="reference external" href="../rest-endpoints/api-docs.html#recept">receipt</a></li>
</ul>
</div>
<div class="section" id="properties">
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/introduction/overview.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/overview.html b/content/docs/introduction/overview.html
new file mode 100644
index 0000000..7362a9f
--- /dev/null
+++ b/content/docs/introduction/overview.html
@@ -0,0 +1,320 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Documentation Overview — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Usergrid Features" href="usergrid-features.html"/>
+ <link rel="prev" title="Apache Usergrid Documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Documentation Overview</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/introduction/overview.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="documentation-overview">
+<h1>Documentation Overview<a class="headerlink" href="#documentation-overview" title="Permalink to this headline">¶</a></h1>
+<p>The Usergrid documentation is written for a couple of distinctly
+different audiences:</p>
+<ul class="simple">
+<li><strong>Application Developer</strong>: this is you if you are a Javascript, iOS,
+Android, Java or other developer who wants to build an app that uses
+the Usergrid APIs for data storage, user management, authentication,
+etc. <strong>Most of our docs are written for application developers</strong> so
+browse the left side-bar and work your way down the topics list.</li>
+<li><strong>Deployment/Operations Engineer</strong>: this is for you if you are the
+person who will be installing Usergrid, setting up the required
+Cassandra database and other things that Usergrid needs. Currently,
+we have limited docs for installation, deployment and maintenance of
+Usergrid:<ul>
+<li><a class="reference external" href="../ug1-deploy-to-tomacat">Deploying to Tomcat</a>: How to build
+and deploy Usergrid to Tomcat and Cassandra.</li>
+<li><a class="reference external" href="../ug1-launcher-quick-start">Launcher Quick Start</a>: How to
+build and run Usergrid via the Usergrid Launcher.</li>
+</ul>
+</li>
+<li><strong>Open Source Contributor</strong>: How to “give back” and contribute to
+Usergrid. Usergrid welcomes code and documentation contributions,
+GitHub pull-requests, bug reports and suggestions for improvement.<ul>
+<li><a class="reference external" href="../reference/contribute-code">How to Contribute Code & Docs</a>:</li>
+</ul>
+</li>
+</ul>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="usergrid-features.html" class="btn btn-neutral float-right" title="Usergrid Features" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../index.html" class="btn btn-neutral" title="Apache Usergrid Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/introduction/usergrid-features.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/usergrid-features.html b/content/docs/introduction/usergrid-features.html
index 496a33d..88c8bfc 100644
--- a/content/docs/introduction/usergrid-features.html
+++ b/content/docs/introduction/usergrid-features.html
@@ -32,7 +32,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
<link rel="next" title="Usergrid Data model" href="data-model.html"/>
- <link rel="prev" title="Apache Usergrid Documentation" href="../index.html"/>
+ <link rel="prev" title="Documentation Overview" href="overview.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,6 +82,7 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="overview.html">Documentation Overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#data-storage-management">Data storage & management</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#application-data">Application data</a></li>
@@ -102,7 +103,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#geolocation">Geolocation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#push-notifications">Push notifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#push-notifications-coming-soon">Push notifications (Coming soon...)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li>
@@ -110,8 +111,8 @@
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -139,6 +140,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -163,9 +165,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -180,6 +182,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -262,9 +265,10 @@ and immediately perform complex queries or full-text searches on any
field. You can also create custom entities with custom properties,
giving you the ability to store data and context in a way that makes
sense for your app.</p>
-<p>To learn more about entities and collections, see Usergrid Data model.</p>
-<p>For a complete list of the default data entities available, see Default
-Data Entity Types.</p>
+<p>To learn more about entities and collections, see <a class="reference external" href="data-model.html">Usergrid Data
+model</a>.</p>
+<p>For a complete list of the default data entities available, see
+<a class="reference external" href="../rest-endpoint/api-docs.html#models">Models</a>.</p>
</div>
<div class="section" id="files-assets">
<h3>Files & assets<a class="headerlink" href="#files-assets" title="Permalink to this headline">¶</a></h3>
@@ -274,8 +278,8 @@ data store as the rest of your application data, eliminating the need to
set up content delivery networks (CDNs) and easing implementation. We
handle all the back-end details that keep your content quickly
accessible.</p>
-<p>To learn more about files and asset storage, see Uploading files and
-assets .</p>
+<p>To learn more about files and asset storage, see <a class="reference external" href="../assets-and-files/uploading-assets.html">Uploading files and
+assets</a>.</p>
</div>
</div>
<div class="section" id="flexible-data-querying">
@@ -285,7 +289,8 @@ SQL-style queries and full-text searches on data entities, as well as
their properties. This lets you quickly retrieve specific data entities
based on multiple criteria, then utilize that data to power social
features, target push notifications, perform user analysis, and more.</p>
-<p>Learn more about querying app data, see Data query overview.</p>
+<p>Learn more about querying app data, see <a class="reference external" href="../data-queries/querying-your-data.html">Data query
+overview</a>.</p>
</div>
<div class="section" id="social">
<h2>Social<a class="headerlink" href="#social" title="Permalink to this headline">¶</a></h2>
@@ -296,7 +301,8 @@ features, improve user experience, and contextualize data. For example,
you might associate a user with their devices to capture valuable
geolocation data, create relationships between users to build social
graphs, or implement popular features such as activity streams.</p>
-<p>To learn more about entity relationships, see Entity connections.</p>
+<p>To learn more about entity relationships, see <a class="reference external" href="../entity-connections/connecting-entities.html">Entity
+connections</a>.</p>
</div>
<div class="section" id="activity-streams">
<h3>Activity streams<a class="headerlink" href="#activity-streams" title="Permalink to this headline">¶</a></h3>
@@ -306,7 +312,8 @@ activities, and tweets. Usergrid simplifies management and routing of
these data streams by providing an activity entity that is specifically
designed to automatically create a relationship between activities and
the user who created them.</p>
-<p>To learn more about activities and activity feeds, see Activity feeds.</p>
+<p>To learn more about activities and activity feeds, see <a class="reference external" href="../user-management/activity.html">Activity
+feeds</a>.</p>
</div>
</div>
<div class="section" id="user-management">
@@ -318,7 +325,8 @@ necessary to handle secure registration and log in, including OAuth
2.0-compliant client authentication. In addition, any number of default
or custom data entities and properties can be associated with a user
entity to create complete user profiles.</p>
-<p>To learn more about user management, see User.</p>
+<p>To learn more about user management, see <a class="reference external" href="../user-management/user-management.html">User
+Management</a>.</p>
<p>To learn more about authentication, see Authenticating users and
application clients.</p>
</div>
@@ -331,8 +339,8 @@ create roles that represent user types or access levels, such as
Administrator, then assign the necessary permissions to that role. With
a single API call, you can then associate your roles with any user or
group of users.</p>
-<p>To learn more about user roles and permissions, see Managing access by
-defining permission rules.</p>
+<p>To learn more about user roles and permissions, see <a class="reference external" href="../security-and-auth/securing-your-app.html">Using
+Permissions</a>.</p>
</div>
<div class="section" id="groups">
<h3>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h3>
@@ -342,7 +350,8 @@ location to more effectively deliver relevant content, target offers, or
customize campaigns. You can also take advantage of the groups entity to
enable group-based social networking activities, such as allowing your
users to create private information feeds or circles of friends.</p>
-<p>To learn more about groups, see Working with group data.</p>
+<p>To learn more about groups, see <a class="reference external" href="../user-management/groups.html">Working with group
+data</a>.</p>
</div>
<div class="section" id="third-party-authentication">
<h3>Third-party authentication<a class="headerlink" href="#third-party-authentication" title="Permalink to this headline">¶</a></h3>
@@ -352,7 +361,8 @@ through such popular services as Facebook, Twitter and other
OAuth-enabled accounts. Providing third-party sign-in can improve user
experience, while increasing adoption, giving you access to valuable
information from social networks and services.</p>
-<p>To learn more about using third-party sign-in, see Facebook sign in.</p>
+<p>To learn more about using third-party sign-in, see <a class="reference external" href="../security-and-auth/facebook-sign.html">Facebook sign
+in</a>.</p>
</div>
</div>
<div class="section" id="geolocation">
@@ -361,20 +371,22 @@ information from social networks and services.</p>
users’ GPS-enabled devices to more effectively target campaigns, push
notifications, offers and more. Geolocation also gives you an important
data point for contextualizing and analyzing trends and user behavior.</p>
-<p>To learn more about geolocation, see Geolocation.</p>
+<p>To learn more about geolocation, see
+<a class="reference external" href="../geolocation/geolocation.html">Geolocation</a>.</p>
</div>
-<div class="section" id="push-notifications">
-<h2>Push notifications<a class="headerlink" href="#push-notifications" title="Permalink to this headline">¶</a></h2>
-<p>Push notifications are the most effective way to engage your users with
-relevant content, and thanks to Usergrid, implementing them can be done
-in minutes. Simply register your app and your user’s devices with a
-notification provider, such as Apple Push Notification Service or Google
-Cloud Messaging, then use the Usergrid notification entity to send
-millions of push notifications a month at no cost. When used in
-conjunction with queries of user and application data, push
-notifications become a powerful tool for leveraging user data, ensuring
-relevancy and driving engagement.</p>
-<p>To learn more about push notifications, see Push notifications overview.</p>
+<div class="section" id="push-notifications-coming-soon">
+<h2>Push notifications (Coming soon...)<a class="headerlink" href="#push-notifications-coming-soon" title="Permalink to this headline">¶</a></h2>
+<p><strong>(Coming Usergrid 2.0)</strong> Push notifications are the most effective way
+to engage your users with relevant content, and thanks to Usergrid,
+implementing them can be done in minutes. Simply register your app and
+your user’s devices with a notification provider, such as Apple Push
+Notification Service or Google Cloud Messaging, then use the Usergrid
+notification entity to send millions of push notifications a month at no
+cost. When used in conjunction with queries of user and application
+data, push notifications become a powerful tool for leveraging user
+data, ensuring relevancy and driving engagement.</p>
+<p>To learn more about push notifications, see <a class="reference external" href="../push-notifications/tbd.html">Push notifications
+overview</a>.</p>
</div>
</div>
@@ -388,7 +400,7 @@ relevancy and driving engagement.</p>
<a href="data-model.html" class="btn btn-neutral float-right" title="Usergrid Data model" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../index.html" class="btn btn-neutral" title="Apache Usergrid Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="overview.html" class="btn btn-neutral" title="Documentation Overview" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/objects.inv
----------------------------------------------------------------------
diff --git a/content/docs/objects.inv b/content/docs/objects.inv
index aeca549..e4a6676 100644
Binary files a/content/docs/objects.inv and b/content/docs/objects.inv differ
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/orgs-and-apps/admin-user.html
----------------------------------------------------------------------
diff --git a/content/docs/orgs-and-apps/admin-user.html b/content/docs/orgs-and-apps/admin-user.html
index 6696baa..0070821 100644
--- a/content/docs/orgs-and-apps/admin-user.html
+++ b/content/docs/orgs-and-apps/admin-user.html
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Admin user$ — Apache Usergrid 1.0 documentation</title>
+ <title>Admin user — Apache Usergrid 1.0 documentation</title>
@@ -30,7 +30,9 @@
- <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Methods" href="../rest-endpoints/api-docs.html"/>
+ <link rel="prev" title="Application" href="application.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -80,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -152,10 +156,70 @@
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
</ul>
<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
-<ul>
+<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="application.html">Application</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Admin user</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#creating-an-admin-user">Creating an admin user</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#request-uri">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-request">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-response">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#updating-an-admin-user">Updating an admin user</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id1">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id2">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id3">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#getting-an-admin-user">Getting an admin user</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id4">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id5">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id6">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#setting-an-admin-user-s-password">Setting an admin user’s password</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id7">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id8">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id9">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#resetting-an-admin-user-s-password">Resetting an admin user’s password</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#initiating-a-password-reset">Initiating a password reset</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id10">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id11">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id12">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#completing-a-password-reset">Completing a password reset</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id13">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id14">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id15">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#activating-an-admin-user">Activating an admin user</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id16">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id17">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id18">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#reactivating-an-admin-user">Reactivating an admin user</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id19">Request URI</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#id20">Example - Request</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id21">Example - Response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#getting-an-admin-user-s-activity-feed">Getting an admin user’s activity feed</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id22">Request URI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id23">Example - Request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id24">Example - Response</a></li>
+</ul>
+</li>
+</ul>
+</li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -200,7 +264,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
- <li>Admin user$</li>
+ <li>Admin user</li>
<li class="wy-breadcrumbs-aside">
@@ -215,7 +279,7 @@
<div itemprop="articleBody">
<div class="section" id="admin-user">
-<h1>Admin user$<a class="headerlink" href="#admin-user" title="Permalink to this headline">¶</a></h1>
+<h1>Admin user<a class="headerlink" href="#admin-user" title="Permalink to this headline">¶</a></h1>
<p>An admin user has full access to perform any operation on all
organization accounts of which the admin user is a member. Using the API
Services BaaS API, you can create, update, or retrieve an admin user.
@@ -723,6 +787,15 @@ email notification.</p>
</div>
<footer>
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../rest-endpoints/api-docs.html" class="btn btn-neutral float-right" title="Methods" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="application.html" class="btn btn-neutral" title="Application" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
<hr/>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/orgs-and-apps/application.html
----------------------------------------------------------------------
diff --git a/content/docs/orgs-and-apps/application.html b/content/docs/orgs-and-apps/application.html
index 7213562..8352413 100644
--- a/content/docs/orgs-and-apps/application.html
+++ b/content/docs/orgs-and-apps/application.html
@@ -31,7 +31,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Methods" href="../rest-endpoints/api-docs.html"/>
+ <link rel="next" title="Admin user" href="admin-user.html"/>
<link rel="prev" title="Organization" href="organization.html"/>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -178,6 +180,7 @@
</li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -240,11 +243,12 @@
<h1>Application<a class="headerlink" href="#application" title="Permalink to this headline">¶</a></h1>
<p>You can create a new application in an organization through the Admin
portal. The Admin portal creates the new application by issuing a post
-against the management endpoint (see the “Creating an organization
-application” section in Organization for details). If you need to create
-an application programmatically in your app, you can also use the API to
-do this. You can access application entities using your app name or
-UUID, prefixed with the organization name or UUID:</p>
+against the management endpoint (see the <a class="reference external" href="../orgs-and-apps/application.html#creating-an-application">Creating an
+Application</a>
+section in Organization for details). If you need to create an
+application programmatically in your app, you can also use the API to do
+this. You can access application entities using your app name or UUID,
+prefixed with the organization name or UUID:</p>
<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/{org_name|uuid}/{app_name|uuid}
</pre></div>
</div>
@@ -431,7 +435,7 @@ for details.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../rest-endpoints/api-docs.html" class="btn btn-neutral float-right" title="Methods" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="admin-user.html" class="btn btn-neutral float-right" title="Admin user" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="organization.html" class="btn btn-neutral" title="Organization" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/orgs-and-apps/managing.html
----------------------------------------------------------------------
diff --git a/content/docs/orgs-and-apps/managing.html b/content/docs/orgs-and-apps/managing.html
index 817a6f2..240d024 100644
--- a/content/docs/orgs-and-apps/managing.html
+++ b/content/docs/orgs-and-apps/managing.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/orgs-and-apps/organization.html
----------------------------------------------------------------------
diff --git a/content/docs/orgs-and-apps/organization.html b/content/docs/orgs-and-apps/organization.html
index 47f0c4f..4c3c8d9 100644
--- a/content/docs/orgs-and-apps/organization.html
+++ b/content/docs/orgs-and-apps/organization.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -226,6 +228,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/push-notifications/tbd.html
----------------------------------------------------------------------
diff --git a/content/docs/push-notifications/tbd.html b/content/docs/push-notifications/tbd.html
index a5e2846..44e8aff 100644
--- a/content/docs/push-notifications/tbd.html
+++ b/content/docs/push-notifications/tbd.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/push-notifications/users-devices.html
----------------------------------------------------------------------
diff --git a/content/docs/push-notifications/users-devices.html b/content/docs/push-notifications/users-devices.html
index 618e5f3..ddbb1f8 100644
--- a/content/docs/push-notifications/users-devices.html
+++ b/content/docs/push-notifications/users-devices.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/reference/contribute-code.html
----------------------------------------------------------------------
diff --git a/content/docs/reference/contribute-code.html b/content/docs/reference/contribute-code.html
index 03fc9c8..094e4b7 100644
--- a/content/docs/reference/contribute-code.html
+++ b/content/docs/reference/contribute-code.html
@@ -81,14 +81,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -116,6 +117,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -140,9 +142,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -157,6 +159,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/reference/presos-and-videos.html
----------------------------------------------------------------------
diff --git a/content/docs/reference/presos-and-videos.html b/content/docs/reference/presos-and-videos.html
index 6df605c..6943345 100644
--- a/content/docs/reference/presos-and-videos.html
+++ b/content/docs/reference/presos-and-videos.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
[14/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/content/docs/rest-endpoints/api-docs.html b/content/docs/rest-endpoints/api-docs.html
index 7368826..c1f823b 100644
--- a/content/docs/rest-endpoints/api-docs.html
+++ b/content/docs/rest-endpoints/api-docs.html
@@ -32,7 +32,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
<link rel="next" title="COMING SOON..." href="../sdks/tbd.html"/>
- <link rel="prev" title="Application" href="../orgs-and-apps/application.html"/>
+ <link rel="prev" title="Admin user" href="../orgs-and-apps/admin-user.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,27 +160,24 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Methods</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#action-methods">Action Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#activityfeed-methods">ActivityFeed Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#appdata-methods">AppData Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#credential-methods">Credential Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#devices-methods">Devices Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#entity-methods">Entity Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#event-methods">Event Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#group-methods">Group Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#notification-methods">Notification Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#organization-methods">Organization Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#permission-methods">Permission Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#receipt-methods">Receipt Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#role-methods">Role Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#user-methods">User Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#access-tokens">Access-Tokens</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#activities">Activities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#admin-users">Admin-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#app-users">App-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#entities-collections">Entities-Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#events">Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#groups">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#organizations-applications">Organizations-Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#permissions-roles">Permissions-Roles</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#models">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#accesstokenresponse">AccessTokenResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="#action">Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="#activityfeed">ActivityFeed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#actor">Actor</a></li>
@@ -206,6 +205,7 @@
<li class="toctree-l2"><a class="reference internal" href="#event">Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="#group">Group</a></li>
<li class="toctree-l2"><a class="reference internal" href="#imagemodel">ImageModel</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#logincredentials">LoginCredentials</a></li>
<li class="toctree-l2"><a class="reference internal" href="#metadata">Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notification">Notification</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notifier">Notifier</a></li>
@@ -275,43 +275,189 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="methods">
+ <h1><p>Usergrid API Reference</p>
+</h1><p>Methods are organized by tag. Follow the methods are the <a class="reference external" href="#models">Model
+Definitions</a>.</p>
+<h2><p>Table of Contents</p>
+</h2><ul class="simple">
+<li><a class="reference external" href="#access-tokens">Access-Tokens</a></li>
+<li><a class="reference external" href="#activities">Activities</a></li>
+<li><a class="reference external" href="#admin-users">Admin-Users</a></li>
+<li><a class="reference external" href="#app-users">App-Users</a></li>
+<li><a class="reference external" href="#entities-collections">Entities-Collections</a></li>
+<li><a class="reference external" href="#events">Events</a></li>
+<li><a class="reference external" href="#groups">Groups</a></li>
+<li><a class="reference external" href="#organizations-applications">Organizations-Applications</a></li>
+<li><a class="reference external" href="#permissions-roles">Permissions-Roles</a></li>
+</ul>
+<div class="section" id="methods">
<h1>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="action-methods">
-<h2>Action Methods<a class="headerlink" href="#action-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/activate</p>
-</h2><p>Activate an organization from a link provIded in an email notification.</p>
+<div class="section" id="access-tokens">
+<h2>Access-Tokens<a class="headerlink" href="#access-tokens" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-POST-heading"><p>POST /management/token</p>
+</h2><p>Login with Admin-User or Organization credentials.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>login-credentials</strong> (<a class="reference external" href="#logincredentials">LoginCredentials</a>)
+Login credentials either username/password or id/secret. (Specified
+in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: Object containing access_token.</li>
+<li>Schema: <a class="reference external" href="#accesstokenreponse">AccessTokenReponse</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/token</p>
+</h2><p>Login with App-User or Application credentials.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>login-credentials</strong> (<a class="reference external" href="#logincredentials">LoginCredentials</a>)
+Login credentials either username/password or id/secret. (Specified
+in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of new created Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#accesstokenreponse">AccessTokenReponse</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="activities">
+<h2>Activities<a class="headerlink" href="#activities" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/groups/{groupId}/feed</p>
+</h2><p>Get a group’s feed through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>token</strong> () Activation token. (Specified in query).</li>
-<li><strong>confirm_email</strong> () Send confirmation email or not. (Specified in
-query).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<li>Description: An array of group’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/reactivate</p>
-</h2><p>Reactivate an expired organization.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{userId}/activities</p>
+</h2><p>Create an activity in the activities collection.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
+sets of activity properties. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<li>Description: An array of user’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}/feed</p>
+</h2><p>Retrieve a user’s feed through providing all the identifications.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of user’s activity feed.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+</div>
+<div class="section" id="admin-users">
+<h2>Admin-Users<a class="headerlink" href="#admin-users" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/users</p>
+</h2><p>Retrieve details about the admin users in an organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of retrieved Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /management/orgs/{orgId}/users/{userId}</p>
+</h2><p>Remove an admin user from an organization through providing both Id of
+application and organization.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>userId-2</strong> (string) One of the user’s identification which includes
+username, email address or UUID. (Specified in path).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of deleted Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
+</ul>
+<p><strong>default</strong></p>
+<ul class="simple">
+<li>Description: Unexpected error.</li>
+<li>Schema: <a class="reference external" href="#error">Error</a></li>
+</ul>
+<h2 class="usergrid-POST-heading"><p>POST /management/users</p>
+</h2><p>Create a whole new admin user.</p>
+<h3><p>Parameters</p>
+</h3><ul class="simple">
+<li><strong>adminuserproperty</strong> (<a class="reference external" href="#createadminuser">CreateAdminUser</a>) One or
+more sets of user properties of which username is mandatory and must
+be unique. (Specified in body).</li>
+</ul>
+<h3><p>Responses</p>
+</h3><p><strong>200</strong></p>
+<ul class="simple">
+<li>Description: An array of new created Admin user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
@@ -355,55 +501,52 @@ challenge, and the admin user’s email address. (Specified in body).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/activate</p>
-</h2><p>Activate an admin user from a link provIded in an email notification.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}</p>
+</h2><p>Retrieve details about an admin user.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>userId</strong> (string) One of the user’s identification which includes
username, real name, email address or UUID. (Specified in path).</li>
-<li><strong>token</strong> () Activation token’s query statement. (Specified in
-query).</li>
-<li><strong>confirm_email</strong> () Query statement of whether send confimation
-email or not. (Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<li>Description: An array of user’s details</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}/password</p>
-</h2><p>Update an admin user’s password through getting the newpassword and the
-old one for identification.</p>
+<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}</p>
+</h2><p>Update the info of an admin user.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>userId</strong> (string) One of the user’s identification which includes
username, real name, email address or UUID. (Specified in path).</li>
-<li><strong>ResetPW</strong> (<a class="reference external" href="#resetpw">ResetPW</a>) The user’s old and new password.
-(Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of complete messages.</li>
-<li>Schema: <a class="reference external" href="#action">Action</a></li>
+<li>Description: An array of user’s details.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/reactivate</p>
-</h2><p>Reactivate an expired admin user.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/activate</p>
+</h2><p>Activate an admin user from a link provIded in an email notification.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>userId</strong> (string) One of the user’s identification which includes
username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>token</strong> (string) Activation token’s query statement. (Specified in
+query).</li>
+<li><strong>confirm_email</strong> (boolean) Query statement of whether send
+confimation email or not. (Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
@@ -416,15 +559,13 @@ username, real name, email address or UUID. (Specified in path).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{user}/password</p>
-</h2><p>Set a user’s password or reset the user’s existing password.</p>
+<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}/password</p>
+</h2><p>Update an admin user’s password through getting the newpassword and the
+old one for identification.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>username</strong> (string) The username of the user. (Specified in path).</li>
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
<li><strong>ResetPW</strong> (<a class="reference external" href="#resetpw">ResetPW</a>) The user’s old and new password.
(Specified in body).</li>
</ul>
@@ -439,99 +580,96 @@ includes name or uuid. (Specified in path).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-</div>
-<div class="section" id="activityfeed-methods">
-<h2>ActivityFeed Methods<a class="headerlink" href="#activityfeed-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/feed</p>
-</h2><p>Retrieve an organization’s activity feed.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/reactivate</p>
+</h2><p>Reactivate an expired admin user.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of the organization’s ActivityFeed.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/feed</p>
-</h2><p>Retrieve an admin user’s activity feed.</p>
+</div>
+<div class="section" id="app-users">
+<h2>App-Users<a class="headerlink" href="#app-users" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users</p>
+</h2><p>Retrieve users though query statement.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>userId</strong> (string) One of the user’s identification which includes
-username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>queryStatement</strong> (string) The query statement of the User.
+(Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s activity</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of retrieved user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/activities</p>
-</h2><p>Create an activity to a specific group. In this case the activity is
-created in the activities collection and is accessible at the
-/activities endpoint to users who have the permission to read that
-endpoint. In addition, a relationship is established between the
-activity and the group, and because of that, the activity will appear in
-the group’s feed. The group ‘owns’ the activity. Also, the activity will
-be published in the feed of all users that are members of the group.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users</p>
+</h2><p>Create a user in the users collection through providing all the
+identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>groupId</strong> (string) One of the group’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
-sets of activity properties. (Specified in body).</li>
+<li><strong>CreateUser</strong> (<a class="reference external" href="#createuser">CreateUser</a>) The properties of the
+user. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s activity.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of created user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/groups/{groupId}/feed</p>
-</h2><p>Get a group’s feed through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Retrieve a user through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>groupId</strong> (string) One of the group’s identification which includes
-name or uuid. (Specified in path).</li>
+<li><strong>userId-2</strong> (string) One of the user’s identification which includes
+username, email address or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of group’s activity.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of retrieved user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{userId}/activities</p>
-</h2><p>Create an activity in the activities collection.</p>
+<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Update a user through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
@@ -540,22 +678,20 @@ includes name or uuid. (Specified in path).</li>
includes name or uuid. (Specified in path).</li>
<li><strong>userId-3</strong> (string) One of the user’s identification which includes
username or UUID. (Specified in path).</li>
-<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
-sets of activity properties. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s activity.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of updated user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}/feed</p>
-</h2><p>Retrieve a user’s feed through providing all the identifications.</p>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/users/{userId}</p>
+</h2><p>Remove a user through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
@@ -568,159 +704,31 @@ username or UUID. (Specified in path).</li>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s activity feed.</li>
-<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
+<li>Description: An array of deleted user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-</div>
-<div class="section" id="appdata-methods">
-<h2>AppData Methods<a class="headerlink" href="#appdata-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps</p>
-</h2><p>Retrieve the applications in an organization through providing both Id
-of application and organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved application data.</li>
-<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /management/orgs/{orgId}/apps/{appId}</p>
-</h2><p>Remove an application from an organization through providing both Id of
-application and organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of deleted application info.</li>
-<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="credential-methods">
-<h2>Credential Methods<a class="headerlink" href="#credential-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps/{appId}/credentials</p>
-</h2><p>Retrieve the client Id and client secret credentials for an application
-in an organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved credentials info.</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/apps/{appId}/credentials</p>
-</h2><p>Generate the client Id and client secret credentials for an application
-in an organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of generated credentials info.</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/credentials</p>
-</h2><p>Retrieve the credentials for an organization client.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of Credential</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/credentials</p>
-</h2><p>Generate whole new credentials for an organization client.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of Credential</li>
-<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="devices-methods">
-<h2>Devices Methods<a class="headerlink" href="#devices-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{notificationId}/*/queue</p>
-</h2><p>Retrieve the list of devices associated with one or more notifications
-before the notifications are sent through providing all the
-identifications.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{user}/password</p>
+</h2><p>Set a user’s password or reset the user’s existing password.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>notificationId</strong> (string) One of the notification’s identification
-which includes name or uuid. (Specified in path).</li>
+<li><strong>username</strong> (string) The username of the user. (Specified in path).</li>
+<li><strong>ResetPW</strong> (<a class="reference external" href="#resetpw">ResetPW</a>) The user’s old and new password.
+(Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved device’s info.</li>
-<li>Schema: <a class="reference external" href="#device">Device</a></li>
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
@@ -728,8 +736,8 @@ which includes name or uuid. (Specified in path).</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
</div>
-<div class="section" id="entity-methods">
-<h2>Entity Methods<a class="headerlink" href="#entity-methods" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="entities-collections">
+<h2>Entities-Collections<a class="headerlink" href="#entities-collections" title="Permalink to this headline">¶</a></h2>
<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}/{relation}</p>
</h2><p>Retrieve a user’s collections or connections through query statement.</p>
<h3><p>Parameters</p>
@@ -742,8 +750,8 @@ includes name or uuid. (Specified in path).</li>
username or UUID. (Specified in path).</li>
<li><strong>relation</strong> (string) The relation between user and collections.
(Specified in path).</li>
-<li><strong>queryStatement</strong> () The query statement of the user. (Specified in
-query).</li>
+<li><strong>queryStatement</strong> (string) The query statement of the user.
+(Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
@@ -766,8 +774,8 @@ includes name or uuid. (Specified in path).</li>
includes name or uuid. (Specified in path).</li>
<li><strong>collectionId</strong> (string) One of the collection’s identification
which includes name or uuid. (Specified in path).</li>
-<li><strong>queryStatement</strong> () Any values specified in the query statement
-should be enclosed in single-quotes. (Specified in query).</li>
+<li><strong>queryStatement</strong> (string) Any values specified in the query
+statement should be enclosed in single-quotes. (Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
@@ -790,8 +798,8 @@ includes name or uuid. (Specified in path).</li>
includes name or uuid. (Specified in path).</li>
<li><strong>collectionId</strong> (string) One of the collection’s identification
which includes name or uuid. (Specified in path).</li>
-<li><strong>queryStatement</strong> () Any values specified in the query statement
-should be enclosed in single-quotes. (Specified in query).</li>
+<li><strong>queryStatement</strong> (string) Any values specified in the query
+statement should be enclosed in single-quotes. (Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
@@ -960,8 +968,8 @@ properties of the entity. (Specified in body).</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
</div>
-<div class="section" id="event-methods">
-<h2>Event Methods<a class="headerlink" href="#event-methods" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="events">
+<h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2>
<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/events</p>
</h2><p>Create an event through providing both Id of organization and
application.</p>
@@ -986,8 +994,8 @@ property of the event. (Specified in body).</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
</div>
-<div class="section" id="group-methods">
-<h2>Group Methods<a class="headerlink" href="#group-methods" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="groups">
+<h2>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h2>
<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups</p>
</h2><p>Create a new group through providing both Id of organization and
application.</p>
@@ -1011,8 +1019,14 @@ the created group. (Specified in body).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{org_Id}/{app_Id}/groups/{groupId}</p>
-</h2><p>Get a group through through providing all the identifications.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/activities</p>
+</h2><p>Create an activity to a specific group. In this case the activity is
+created in the activities collection and is accessible at the
+/activities endpoint to users who have the permission to read that
+endpoint. In addition, a relationship is established between the
+activity and the group, and because of that, the activity will appear in
+the group’s feed. The group ‘owns’ the activity. Also, the activity will
+be published in the feed of all users that are members of the group.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
@@ -1021,20 +1035,22 @@ includes name or uuid. (Specified in path).</li>
includes name or uuid. (Specified in path).</li>
<li><strong>groupId</strong> (string) One of the group’s identification which includes
name or uuid. (Specified in path).</li>
+<li><strong>CreateActivity</strong> (<a class="reference external" href="#createactivity">CreateActivity</a>) One or more
+sets of activity properties. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved group’s info.</li>
-<li>Schema: <a class="reference external" href="#group">Group</a></li>
+<li>Description: An array of user’s activity.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-PUT-heading"><p>PUT /{org_Id}/{app_Id}/groups/{groupId}</p>
-</h2><p>Update a group through providing all the identifications.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
+</h2><p>Add a user to a group through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
@@ -1043,268 +1059,82 @@ includes name or uuid. (Specified in path).</li>
includes name or uuid. (Specified in path).</li>
<li><strong>groupId</strong> (string) One of the group’s identification which includes
name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of updated group’s info.</li>
-<li>Schema: <a class="reference external" href="#group">Group</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="notification-methods">
-<h2>Notification Methods<a class="headerlink" href="#notification-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-PUT-heading"><p>PUT /my-org/sandbox/notifications/{notificationId}</p>
-</h2><p>Cancel sent notifications through providing the Id of the notification.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>notificationId</strong> (string) One of the notification’s identification
-which includes name or uuid. (Specified in path).</li>
-<li><strong>cancelMsg</strong> (<a class="reference external" href="#cancelmsg">CancelMSG</a>) Indicete whether is
-canceled or not. (Specified in body).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of canceled notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices</p>
-</h2><p>Create notifications for user through targeting by location and
-providing all the identifications.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
-These parameters are used when forming the notification portion of
-the request. (Specified in body).</li>
-<li><strong>scheduleNotification</strong>
-(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
-notification for a later time add the deliver parameter with a UNIX
-timestamp to the body of your request. (Specified in body).</li>
-<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
-service can’t deliver a message to a device and needs to resend it
-you can set a notification to expire after a certain date/time.
-(Specified in body).</li>
-<li><strong>queryStatement</strong> () The query statement of the location of the
-user. (Specified in query).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of created notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices/*/notifications</p>
-</h2><p>Create notifications for all devices. This request will target all
-device entities.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
-These parameters are used when forming the notification portion of
-the request. (Specified in body).</li>
-<li><strong>scheduleNotification</strong>
-(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
-notification for a later time add the deliver parameter with a UNIX
-timestamp to the body of your request. (Specified in body).</li>
-<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
-service can’t deliver a message to a device and needs to resend it
-you can set a notification to expire after a certain date/time.
-(Specified in body).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of created notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/devices/{deviceId}/notifications</p>
-</h2><p>Create notifications for a single device. This request will target a
-specific device entity.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>deviceId</strong> (string) One of the device’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
-These parameters are used when forming the notification portion of
-the request. (Specified in body).</li>
-<li><strong>scheduleNotification</strong>
-(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
-notification for a later time add the deliver parameter with a UNIX
-timestamp to the body of your request. (Specified in body).</li>
-<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
-service can’t deliver a message to a device and needs to resend it
-you can set a notification to expire after a certain date/time.
-(Specified in body).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of created notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{path}/notifications</p>
-</h2><p>Create notifications for a group. This request will target all users
-associated with a specific group entity.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>path</strong> (string) The path of the group. (Specified in path).</li>
-<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
-These parameters are used when forming the notification portion of
-the request. (Specified in body).</li>
-<li><strong>scheduleNotification</strong>
-(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
-notification for a later time add the deliver parameter with a UNIX
-timestamp to the body of your request. (Specified in body).</li>
-<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
-service can’t deliver a message to a device and needs to resend it
-you can set a notification to expire after a certain date/time.
-(Specified in body).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of created notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/notifications</p>
-</h2><p>Retrieve one or more notifications through providing all the
-identifications.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+<li>Description: An array of added user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/notifications/{notificationId}</p>
-</h2><p>Remove unsent notifications through providing all the identifications.</p>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
+</h2><p>Delete user from a group through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>notificationId</strong> (string) One of the notification’s identification
-which includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of deleted notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+<li>Description: An array of deleted user’s info.</li>
+<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users/{userId}/notifications</p>
-</h2><p>Create notifications for a user. This request will target a specific
-user entity.</p>
+<h2 class="usergrid-GET-heading"><p>GET /{org_Id}/{app_Id}/groups/{groupId}</p>
+</h2><p>Get a group through through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>userId-3</strong> (string) One of the user’s identification which includes
-username or UUID. (Specified in path).</li>
-<li><strong>notification</strong> (<a class="reference external" href="#createnotifications">CreateNotifications</a>)
-These parameters are used when forming the notification portion of
-the request. (Specified in body).</li>
-<li><strong>scheduleNotification</strong>
-(<a class="reference external" href="#schedulenotification">ScheduleNotification</a>) To schedule a
-notification for a later time add the deliver parameter with a UNIX
-timestamp to the body of your request. (Specified in body).</li>
-<li><strong>setExpiration</strong> (<a class="reference external" href="#setexpiration">SetExpiration</a>) If a push
-service can’t deliver a message to a device and needs to resend it
-you can set a notification to expire after a certain date/time.
-(Specified in body).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of created notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+<li>Description: An array of retrieved group’s info.</li>
+<li>Schema: <a class="reference external" href="#group">Group</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{receiptId}/*/notifications</p>
-</h2><p>Retrieve notifications associated with one or more receipts through
-providing all the identifications.</p>
+<h2 class="usergrid-PUT-heading"><p>PUT /{org_Id}/{app_Id}/groups/{groupId}</p>
+</h2><p>Update a group through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>receiptId</strong> (string) One of the receipt’s identification which
-includes name or uuid. (Specified in path).</li>
+<li><strong>groupId</strong> (string) One of the group’s identification which includes
+name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved notification’s info.</li>
-<li>Schema: <a class="reference external" href="#notification">Notification</a></li>
+<li>Description: An array of updated group’s info.</li>
+<li>Schema: <a class="reference external" href="#group">Group</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
@@ -1312,8 +1142,8 @@ includes name or uuid. (Specified in path).</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
</div>
-<div class="section" id="organization-methods">
-<h2>Organization Methods<a class="headerlink" href="#organization-methods" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="organizations-applications">
+<h2>Organizations-Applications<a class="headerlink" href="#organizations-applications" title="Permalink to this headline">¶</a></h2>
<h2 class="usergrid-POST-heading"><p>POST /management/orgs</p>
</h2><p>Create an organization through a form post.</p>
<h3><p>Parameters</p>
@@ -1350,422 +1180,263 @@ includes name or uuid. (Specified in path).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-</div>
-<div class="section" id="permission-methods">
-<h2>Permission Methods<a class="headerlink" href="#permission-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/permissions</p>
-</h2><p>Remove permissions from a role.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/activate</p>
+</h2><p>Activate an organization from a link provIded in an email notification.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>roleId</strong> (string) One of the role’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>grant_url_pattern</strong> () The query statement of the url pattern.
+<li><strong>token</strong> (string) Activation token. (Specified in query).</li>
+<li><strong>confirm_email</strong> (boolean) Send confirmation email or not.
(Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of deleted permission’s info.</li>
-<li>Schema: <a class="reference external" href="#permission">Permission</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="receipt-methods">
-<h2>Receipt Methods<a class="headerlink" href="#receipt-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/receipts</p>
-</h2><p>Retrieve one or more receipts through providing all the identifications.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved receipt’s info.</li>
-<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{deviceId}/*/receipts</p>
-</h2><p>Retrieve receipts associated with one or more devices through providing
-all the identifications.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>deviceId</strong> (string) One of the device’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved receipt’s info.</li>
-<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/{notificationId}/*/receipts</p>
-</h2><p>Retrieve receipts for one or more notifications through providing all
-the identifications.”</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>notificationId</strong> (string) One of the notification’s identification
-which includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved receipt’s info.</li>
-<li>Schema: <a class="reference external" href="#receipt">Receipt</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="role-methods">
-<h2>Role Methods<a class="headerlink" href="#role-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles</p>
-</h2><p>Retrieve the roles in an application through providing all the
-identifications.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved role’s info.</li>
-<li>Schema: <a class="reference external" href="#role">Role</a></li>
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles</p>
-</h2><p>Create a new role through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps</p>
+</h2><p>Retrieve the applications in an organization through providing both Id
+of application and organization.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>roleproperty</strong> (<a class="reference external" href="#addrole">AddRole</a>) The required properties of
-the role. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of created role’s info.</li>
-<li>Schema: <a class="reference external" href="#role">Role</a></li>
+<li>Description: An array of retrieved application data.</li>
+<li>Schema: <a class="reference external" href="#appdata">AppData</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{rolename}</p>
-</h2><p>Remove a role through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/apps/{appId}/credentials</p>
+</h2><p>Retrieve the client Id and client secret credentials for an application
+in an organization.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>rolename</strong> (string) The name of the role. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of deleted role’s info.</li>
-<li>Schema: <a class="reference external" href="#role">Role</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-</div>
-<div class="section" id="user-methods">
-<h2>User Methods<a class="headerlink" href="#user-methods" title="Permalink to this headline">¶</a></h2>
-<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/users</p>
-</h2><p>Retrieve details about the admin users in an organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of retrieved Admin user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
-</ul>
-<p><strong>default</strong></p>
-<ul class="simple">
-<li>Description: Unexpected error.</li>
-<li>Schema: <a class="reference external" href="#error">Error</a></li>
-</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /management/orgs/{orgId}/users/{userId}</p>
-</h2><p>Remove an admin user from an organization through providing both Id of
-application and organization.</p>
-<h3><p>Parameters</p>
-</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>userId-2</strong> (string) One of the user’s identification which includes
-username, email address or UUID. (Specified in path).</li>
-</ul>
-<h3><p>Responses</p>
-</h3><p><strong>200</strong></p>
-<ul class="simple">
-<li>Description: An array of deleted Admin user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of retrieved credentials info.</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /management/users</p>
-</h2><p>Create a whole new admin user.</p>
+<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/apps/{appId}/credentials</p>
+</h2><p>Generate the client Id and client secret credentials for an application
+in an organization.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>adminuserproperty</strong> (<a class="reference external" href="#createadminuser">CreateAdminUser</a>) One or
-more sets of user properties of which username is mandatory and must
-be unique. (Specified in body).</li>
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
+<li><strong>appId</strong> (string) One of the application’s identification which
+includes name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of new created Admin user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of generated credentials info.</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}</p>
-</h2><p>Retrieve details about an admin user.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/credentials</p>
+</h2><p>Retrieve the credentials for an organization client.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>userId</strong> (string) One of the user’s identification which includes
-username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s details</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of Credential</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-PUT-heading"><p>PUT /management/users/{userId}</p>
-</h2><p>Update the info of an admin user.</p>
+<h2 class="usergrid-POST-heading"><p>POST /management/orgs/{orgId}/credentials</p>
+</h2><p>Generate whole new credentials for an organization client.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>userId</strong> (string) One of the user’s identification which includes
-username, real name, email address or UUID. (Specified in path).</li>
+<li><strong>orgId</strong> (string) One of the organization’s identification which
+includes name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of user’s details.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of Credential</li>
+<li>Schema: <a class="reference external" href="#credential">Credential</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
-</h2><p>Add a user to a group through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/feed</p>
+</h2><p>Retrieve an organization’s activity feed.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>groupId</strong> (string) One of the group’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>userId-3</strong> (string) One of the user’s identification which includes
-username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of added user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of the organization’s ActivityFeed.</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</p>
-</h2><p>Delete user from a group through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/orgs/{orgId}/reactivate</p>
+</h2><p>Reactivate an expired organization.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>groupId</strong> (string) One of the group’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>userId-3</strong> (string) One of the user’s identification which includes
-username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of deleted user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of complete messages.</li>
+<li>Schema: <a class="reference external" href="#action">Action</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles/{roleId}/users</p>
-</h2><p>Retrieve the users in a role through providing all the identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /management/users/{userId}/feed</p>
+</h2><p>Retrieve an admin user’s activity feed.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
-<li><strong>orgId</strong> (string) One of the organization’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>appId</strong> (string) One of the application’s identification which
-includes name or uuid. (Specified in path).</li>
-<li><strong>roleId</strong> (string) One of the role’s identification which includes
-name or uuid. (Specified in path).</li>
+<li><strong>userId</strong> (string) One of the user’s identification which includes
+username, real name, email address or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of user’s activity</li>
+<li>Schema: <a class="reference external" href="#activityfeed">ActivityFeed</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
-</h2><p>Add a user to a role through providing all the identifications.</p>
+</div>
+<div class="section" id="permissions-roles">
+<h2>Permissions-Roles<a class="headerlink" href="#permissions-roles" title="Permalink to this headline">¶</a></h2>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles</p>
+</h2><p>Retrieve the roles in an application through providing all the
+identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>roleId</strong> (string) One of the role’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>userId-3</strong> (string) One of the user’s identification which includes
-username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of added user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of retrieved role’s info.</li>
+<li>Schema: <a class="reference external" href="#role">Role</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
-</h2><p>Remove a user from a role through providing all the identifications.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles</p>
+</h2><p>Create a new role through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>roleId</strong> (string) One of the role’s identification which includes
-name or uuid. (Specified in path).</li>
-<li><strong>userId-3</strong> (string) One of the user’s identification which includes
-username or UUID. (Specified in path).</li>
+<li><strong>roleproperty</strong> (<a class="reference external" href="#addrole">AddRole</a>) The required properties of
+the role. (Specified in body).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of deleted user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of created role’s info.</li>
+<li>Schema: <a class="reference external" href="#role">Role</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users</p>
-</h2><p>Retrieve users though query statement.</p>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/permissions</p>
+</h2><p>Remove permissions from a role.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>queryStatement</strong> () The query statement of the User. (Specified in
-query).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>grant_url_pattern</strong> (string) The query statement of the url
+pattern. (Specified in query).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved user’s info.</li>
-<li>Schema: <a class="reference external" href="#user">User</a></li>
+<li>Description: An array of deleted permission’s info.</li>
+<li>Schema: <a class="reference external" href="#permission">Permission</a></li>
</ul>
<p><strong>default</strong></p>
<ul class="simple">
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/users</p>
-</h2><p>Create a user in the users collection through providing all the
-identifications.</p>
+<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/roles/{roleId}/users</p>
+</h2><p>Retrieve the users in a role through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>CreateUser</strong> (<a class="reference external" href="#createuser">CreateUser</a>) The properties of the
-user. (Specified in body).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of created user’s info.</li>
+<li>Description: An array of retrieved user’s info.</li>
<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
@@ -1773,21 +1444,23 @@ user. (Specified in body).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-GET-heading"><p>GET /{orgId}/{appId}/users/{userId}</p>
-</h2><p>Retrieve a user through providing all the identifications.</p>
+<h2 class="usergrid-POST-heading"><p>POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
+</h2><p>Add a user to a role through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
-<li><strong>userId-2</strong> (string) One of the user’s identification which includes
-username, email address or UUID. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
+<li><strong>userId-3</strong> (string) One of the user’s identification which includes
+username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of retrieved user’s info.</li>
+<li>Description: An array of added user’s info.</li>
<li>Schema: <a class="reference external" href="#user">User</a></li>
</ul>
<p><strong>default</strong></p>
@@ -1795,21 +1468,23 @@ username, email address or UUID. (Specified in path).</li>
<li>Description: Unexpected error.</li>
<li>Schema: <a class="reference external" href="#error">Error</a></li>
</ul>
-<h2 class="usergrid-PUT-heading"><p>PUT /{orgId}/{appId}/users/{userId}</p>
-</h2><p>Update a user through providing all the identifications.</p>
+<h2 class="usergrid-DELETE-heading"><p>DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</p>
+</h2><p>Remove a user from a role through providing all the identifications.</p>
<h3><p>Parameters</p>
</h3><ul class="simple">
<li><strong>orgId</strong> (string) One of the organization’s identification which
includes name or uuid. (Specified in path).</li>
<li><strong>appId</strong> (string) One of the application’s identification which
includes name or uuid. (Specified in path).</li>
+<li><strong>roleId</strong> (string) One of the role’s identification which includes
+name or uuid. (Specified in path).</li>
<li><strong>userId-3</strong> (string) One of the user’s identification which includes
username or UUID. (Specified in path).</li>
</ul>
<h3><p>Responses</p>
</h3><p><strong>200</strong></p>
<ul class="simple">
-<li>Description: An array of updated user’s info.</li>
+<li>Description: An array of deleted user’s info.<
<TRUNCATED>
[18/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_static/css/theme.css
----------------------------------------------------------------------
diff --git a/content/docs/_static/css/theme.css b/content/docs/_static/css/theme.css
index 870e633..b0b1c33 100644
--- a/content/docs/_static/css/theme.css
+++ b/content/docs/_static/css/theme.css
@@ -5314,19 +5314,27 @@ span[id*='MathJax-Span'] {
/*# sourceMappingURL=theme.css.map */
-/* Usergrid specific */
+/* Start - Usergrid Additions */
-.usergrid-table {
+.usergrid-table, docutils {
border: 1px solid grey;
margin-bottom: 2em;
}
+.usergrid-30 {
+ width:30%;
+}
+
.usergrid-table tr td {
padding: 0.5em;
border: 1px solid grey;
font-size: 80%;
}
+.usergrid-table th, .docutils th {
+ background-color: #e5ebeb;
+}
+
.caption-text {
font-size:140%;
}
@@ -5356,159 +5364,21 @@ h2.usergrid-DELETE-heading {
margin-bottom: 2em;
}
-/* css from petstore example */
-
-body {
- font-family: Trebuchet MS, sans-serif;
+div.wy-menu-vertical li {
font-size: 15px;
- color: #444;
- margin-right: 24px;
+ margin-bottom: 0.0em;
+ margin-left: 1.5em;
}
-h1 {
- font-size: 25px;
-}
-h2 {
- font-size: 20px;
-}
-h3 {
+ul.simple li, ol.simple li {
font-size: 16px;
- font-weight: bold;
-}
-hr {
- height: 1px;
- border: 0;
- color: #ddd;
- background-color: #ddd;
- display: none;
-}
-
-.app-desc {
- clear: both;
- margin-left: 20px;
-}
-.param-name {
- width: 100%;
-}
-.license-info {
- margin-left: 20px;
-}
-
-.license-url {
- margin-left: 20px;
-}
-
-.model {
- margin: 0 0 0px 20px;
-}
-
-.method {
- margin-left: 20px;
-}
-
-.method-notes {
- margin: 10px 0 20px 0;
- font-size: 90%;
- color: #555;
-}
-
-pre {
- padding: 10px;
- margin-bottom: 2px;
-}
-
-pre.get {
- background-color: #0f6ab4;
-}
-
-pre.post {
- background-color: #10a54a;
-}
-
-pre.put {
- background-color: #c5862b;
-}
-
-pre.delete {
- background-color: #a41e22;
-}
-
-.huge {
- color: #fff;
-}
-
-pre.example {
- background-color: #f3f3f3;
- padding: 10px;
- border: 1px solid #ddd;
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
}
-code {
- white-space: pre;
+h1 p {
+ font-size:150%;
}
-.nickname {
- font-weight: bold;
-}
-
-.method-path {
- font-size: 1.5em;
- background-color: #0f6ab4;
-}
-
-.parameter {
- width: 500px;
-}
-
-.param {
- width: 500px;
- padding: 10px 0 0 20px;
- font-weight: bold;
-}
-
-.param-desc {
- width: 700px;
- padding: 0 0 0 20px;
- color: #777;
-}
-
-.param-type {
- font-style: italic;
-}
-
-.field-label {
- padding: 0;
- margin: 0;
- clear: both;
-}
-
-.field-items {
- padding: 0 0 15px 0;
- margin-bottom: 15px;
-}
-
-.return-type {
- clear: both;
- padding-bottom: 10px;
-}
-
-.param-header {
- font-weight: bold;
-}
-
-.method-tags {
- text-align: right;
-}
-
-.method-tag {
- background: none repeat scroll 0% 0% #24A600;
- border-radius: 3px;
- padding: 2px 10px;
- margin: 2px;
- color: #FFF;
- display: inline-block;
- text-decoration: none;
-}
-
-
+/* End - Usergrid Additions */
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/assets-and-files/file-storage-configuration.html
----------------------------------------------------------------------
diff --git a/content/docs/assets-and-files/file-storage-configuration.html b/content/docs/assets-and-files/file-storage-configuration.html
new file mode 100644
index 0000000..14fd360
--- /dev/null
+++ b/content/docs/assets-and-files/file-storage-configuration.html
@@ -0,0 +1,322 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>File storage configuration — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>File storage configuration</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/assets-and-files/file-storage-configuration.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="file-storage-configuration">
+<h1>File storage configuration<a class="headerlink" href="#file-storage-configuration" title="Permalink to this headline">¶</a></h1>
+<p>Usergrid can store your assets either on your hard drive or in the
+Amazon S3 cloud.</p>
+<div class="section" id="local-storage-configuration">
+<h2>Local storage configuration<a class="headerlink" href="#local-storage-configuration" title="Permalink to this headline">¶</a></h2>
+<p>By default assets are stored in the temporary folder /tmp/usergrid This
+can be changed by editing this file
+/stack/rest/src/main/resources/usergrid-rest-context.xml and replacing
+{usergrid.temp.files} by the wanted destination</p>
+<div class="code xml highlight-python"><div class="highlight"><pre><bean id="binaryStore" class="org.apache.usergrid.services.assets.data.LocalFileBinaryStore">
+ <property name="reposLocation" value="${usergrid.temp.files}"/>
+</bean>
+</pre></div>
+</div>
+</div>
+<div class="section" id="aws-s3-configuration">
+<h2>AwS S3 configuration<a class="headerlink" href="#aws-s3-configuration" title="Permalink to this headline">¶</a></h2>
+<p>To use your AWS S3 storage you need to change the binaryStore classpath
+and add several constructor arguments in
+/stack/rest/src/main/resources/usergrid-rest-context.xml</p>
+<p>Some examples :</p>
+<div class="code xml highlight-python"><div class="highlight"><pre><bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore">
+ <constructor-arg name="accessId" value="x" />
+ <constructor-arg name="secretKey" value="xx" />
+ <constructor-arg name="bucketName" value="x" />
+ <constructor-arg name="regionName" value="eu-central-1" />
+</bean>
+</pre></div>
+</div>
+<p>the regionName field is not mandatory, this code is also valid</p>
+<div class="code xml highlight-python"><div class="highlight"><pre><bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore">
+ <constructor-arg name="accessId" value="x" />
+ <constructor-arg name="secretKey" value="xx" />
+ <constructor-arg name="bucketName" value="x" />
+</bean>
+</pre></div>
+</div>
+<p>The filesize is limited to 50GB but you need to keep in mind that the
+file has to be stored on the hard drive before being sended to Amazon.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/assets-and-files/folders.html
----------------------------------------------------------------------
diff --git a/content/docs/assets-and-files/folders.html b/content/docs/assets-and-files/folders.html
new file mode 100644
index 0000000..c799c80
--- /dev/null
+++ b/content/docs/assets-and-files/folders.html
@@ -0,0 +1,391 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Folders — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Counters & events" href="../counters-and-events/events-and-counters.html"/>
+ <link rel="prev" title="Retrieving assets" href="retrieving-assets.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Folders</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
+</ul>
+</li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Folders</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/assets-and-files/folders.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="folders">
+<h1>Folders<a class="headerlink" href="#folders" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="linking-a-folder-to-an-asset">
+<h2>Linking a folder to an asset<a class="headerlink" href="#linking-a-folder-to-an-asset" title="Permalink to this headline">¶</a></h2>
+<p>In order to access the asset for the image in the folder, you need to
+link the folder to the asset. You can do that by issuing a POST request
+in the following format:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">POST</span> <span class="o">/</span><span class="p">{</span><span class="n">org</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">folders</span><span class="o">/</span><span class="p">{</span><span class="n">folder</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">assets</span><span class="o">/</span><span class="p">{</span><span class="n">assets_id</span><span class="p">}</span>
+</pre></div>
+</div>
+<p>where <code class="docutils literal"><span class="pre">{folder-uuid}</span></code> is the UUID of the folder, and <code class="docutils literal"><span class="pre">{assets-uuid}</span></code>
+is the UUID of the assets entity.</p>
+<p>Here’s how you could link the folder and the asset you created for the
+my-image.jpg image:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b
+</pre></div>
+</div>
+<p>In the response, you should see the assets entity for the image added to
+the folder:</p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "action": "post",
+ "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491",
+ "params": {},
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "entities": [
+ {
+ "uuid": "9501cda1-2d21-11e2-b4c6-02e81ac5a17b",
+ "type": "asset",
+ "name": "my-image.jpg",
+ "created": 1352763303163,
+ "modified": 1352763303163,
+ "metadata": {
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b"
+ },
+ "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1",
+ "path": "/myassets/asset1"
+ }
+ ],
+ "timestamp": 1352830448045,
+ "duration": 54,
+ "organization": "my-org”,
+ "applicationName": "my-app"
+}
+</pre></div>
+</div>
+</div>
+<div class="section" id="retrieve-list-of-folder-assets">
+<h2>Retrieve list of folder assets<a class="headerlink" href="#retrieve-list-of-folder-assets" title="Permalink to this headline">¶</a></h2>
+<p>You can also request a list of the linked contents of the folder like
+this:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets
+</pre></div>
+</div>
+<p>The response should look something like this:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span><span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span><span class="p">:</span> <span class="s">"3400ba10-cd0c-11e1-bcf7-12313d1c4491"</span><span class="p">,</span>
+ <span class="s">"params"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"_"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"1352830364891"</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets"</span><span class="p">,</span>
+ <span class="s">"uri"</span><span class="p">:</span> <span class="s">"https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets"</span><span class="p">,</span>
+ <span class="s">"entities"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"uuid"</span><span class="p">:</span> <span class="s">"7bf47435-2ac8-11e2-b4c6-02e81ac5a17b"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"asset"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"my-image.jpg"</span><span class="p">,</span>
+ <span class="s">"created"</span><span class="p">:</span> <span class="mi">1352505133598</span><span class="p">,</span>
+ <span class="s">"modified"</span><span class="p">:</span> <span class="mi">1352507245108</span><span class="p">,</span>
+ <span class="s">"checksum"</span><span class="p">:</span> <span class="s">"8e0cd3866ee20746c99e9a9825f38ad8"</span><span class="p">,</span>
+ <span class="s">"content-length"</span><span class="p">:</span> <span class="mi">11853</span><span class="p">,</span>
+ <span class="s">"content-type"</span><span class="p">:</span> <span class="s">"image/jpeg"</span><span class="p">,</span>
+ <span class="s">"etag"</span><span class="p">:</span> <span class="s">"</span><span class="se">\"</span><span class="s">8e0cd3866ee20746c99e9a9825f38ad8</span><span class="se">\"</span><span class="s">"</span><span class="p">,</span>
+ <span class="s">"metadata"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"connecting"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"assets"</span><span class="p">:</span> <span class="s">"/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets"</span>
+ <span class="p">},</span>
+ <span class="s">"connection"</span><span class="p">:</span> <span class="s">"assets"</span><span class="p">,</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b"</span>
+ <span class="p">},</span>
+ <span class="s">"owner"</span><span class="p">:</span> <span class="s">"5c0c1789-d503-11e1-b36a-12313b01d5c1"</span><span class="p">,</span>
+ <span class="s">"path"</span><span class="p">:</span> <span class="s">"my-image"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s">"timestamp"</span><span class="p">:</span> <span class="mi">1352830363797</span><span class="p">,</span>
+ <span class="s">"duration"</span><span class="p">:</span> <span class="mi">57</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"my-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span><span class="p">:</span> <span class="s">"my-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../counters-and-events/events-and-counters.html" class="btn btn-neutral float-right" title="Counters & events" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="retrieving-assets.html" class="btn btn-neutral" title="Retrieving assets" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/assets-and-files/legacy-asset-support.html
----------------------------------------------------------------------
diff --git a/content/docs/assets-and-files/legacy-asset-support.html b/content/docs/assets-and-files/legacy-asset-support.html
new file mode 100644
index 0000000..df68efb
--- /dev/null
+++ b/content/docs/assets-and-files/legacy-asset-support.html
@@ -0,0 +1,280 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title><no title> — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><no title></li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/assets-and-files/legacy-asset-support.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/assets-and-files/retrieving-assets.html
----------------------------------------------------------------------
diff --git a/content/docs/assets-and-files/retrieving-assets.html b/content/docs/assets-and-files/retrieving-assets.html
new file mode 100644
index 0000000..4f57376
--- /dev/null
+++ b/content/docs/assets-and-files/retrieving-assets.html
@@ -0,0 +1,359 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Retrieving assets — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Folders" href="folders.html"/>
+ <link rel="prev" title="Uploading assets" href="uploading-assets.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Retrieving assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#retrieving-asset-data">Retrieving asset data</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#request-syntax">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-request">Example request</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#retrieving-an-asset-entity">Retrieving an asset entity</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Retrieving assets</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/assets-and-files/retrieving-assets.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="retrieving-assets">
+<h1>Retrieving assets<a class="headerlink" href="#retrieving-assets" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="retrieving-asset-data">
+<h2>Retrieving asset data<a class="headerlink" href="#retrieving-asset-data" title="Permalink to this headline">¶</a></h2>
+<p>To retrieve the asset from an entity, send a <code class="docutils literal"><span class="pre">GET</span></code> request with the
+<code class="docutils literal"><span class="pre">Accept</span></code> header set to the content type of the asset. The content type
+can be retrieved from the <code class="docutils literal"><span class="pre">file-metadata.content-type</span></code> property of the
+entity the asset is attached to.</p>
+<div class="section" id="request-syntax">
+<h3>Request syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X GET -H 'Accept: <content_type>' 'https://api.usergrid.com/<org>/<app>/<collection>/<entity>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>content_type</td>
+<td>The content type of the attached asset. For example, text/plain, image/jpeg.</td>
+</tr>
+<tr class="row-odd"><td>org Organization</td>
+<td>UUID or organization name</td>
+</tr>
+<tr class="row-even"><td>app Application</td>
+<td>UUID or application name</td>
+</tr>
+<tr class="row-odd"><td>collection</td>
+<td>Name or UUID of the collection of the entity the asset is attached to.</td>
+</tr>
+<tr class="row-even"><td>entity</td>
+<td>Name or UUID of the entity the asset is attached to.</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="example-request">
+<h3>Example request<a class="headerlink" href="#example-request" title="Permalink to this headline">¶</a></h3>
+<p>The following request will retrieve the data for a jpeg file attached to
+an entity named ‘cloud’ in the ‘pictures’ collection:</p>
+<div class="highlight-python"><div class="highlight"><pre>curl -X GET -H 'Accept: image/jpeg' 'https://api.usergrid.com/your-org/your-app/pictures/cloud
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="retrieving-an-asset-entity">
+<h2>Retrieving an asset entity<a class="headerlink" href="#retrieving-an-asset-entity" title="Permalink to this headline">¶</a></h2>
+<p>To retrieve the entity that an asset is attached to, perform a <code class="docutils literal"><span class="pre">GET</span></code>
+request as you normally would to retrieve an entity. For more
+information, see <a class="reference external" href="../data-storage/entities.html#retrieving-data-entities">Retrieving Data
+Entities</a>.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="folders.html" class="btn btn-neutral float-right" title="Folders" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="uploading-assets.html" class="btn btn-neutral" title="Uploading assets" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
[07/21] incubator-usergrid git commit: Fix broken links and add
missing references.
Posted by sn...@apache.org.
Fix broken links and add missing references.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/6b144189
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/6b144189
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/6b144189
Branch: refs/heads/master
Commit: 6b144189aba9de1d6ca1a8c95f41f789583e0f5b
Parents: fc52c0e
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Aug 7 13:51:15 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Aug 7 13:51:15 2015 -0400
----------------------------------------------------------------------
docs/README.md | 2 +-
docs/_static/css/theme.css | 164 +++---------------------------
docs/data-storage/data-store-dbms.md | 8 +-
docs/index.rst | 5 +-
docs/introduction/data-model.md | 28 ++---
docs/introduction/overview.md | 17 ++++
docs/orgs-and-apps/admin-user.md | 2 +-
7 files changed, 55 insertions(+), 171 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 07ab32b..2f7888c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -65,6 +65,6 @@ __NOTE__: Mustache.hava is not in Maven Central so unfortunately, you will have
This is the command to run the generation:
- groovy src/main/groovy/usergrid.ApiDocGenerator.groovy
+ groovy src/main/groovy/usergrid/ApiDocGenerator.groovy
The script will update the file ``rest-endpoints/api-docs.md`` and when you are happy with your update you should commit and push that file with Git.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/_static/css/theme.css
----------------------------------------------------------------------
diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css
index f225469..b0b1c33 100755
--- a/docs/_static/css/theme.css
+++ b/docs/_static/css/theme.css
@@ -5314,9 +5314,9 @@ span[id*='MathJax-Span'] {
/*# sourceMappingURL=theme.css.map */
-/* Usergrid specific */
+/* Start - Usergrid Additions */
-.usergrid-table {
+.usergrid-table, docutils {
border: 1px solid grey;
margin-bottom: 2em;
}
@@ -5331,6 +5331,10 @@ span[id*='MathJax-Span'] {
font-size: 80%;
}
+.usergrid-table th, .docutils th {
+ background-color: #e5ebeb;
+}
+
.caption-text {
font-size:140%;
}
@@ -5360,159 +5364,21 @@ h2.usergrid-DELETE-heading {
margin-bottom: 2em;
}
-/* css from petstore example
-
-body {
- font-family: Trebuchet MS, sans-serif;
+div.wy-menu-vertical li {
font-size: 15px;
- color: #444;
- margin-right: 24px;
+ margin-bottom: 0.0em;
+ margin-left: 1.5em;
}
-h1 {
- font-size: 25px;
-}
-h2 {
- font-size: 20px;
-}
-h3 {
+ul.simple li, ol.simple li {
font-size: 16px;
- font-weight: bold;
-}
-hr {
- height: 1px;
- border: 0;
- color: #ddd;
- background-color: #ddd;
- display: none;
-}
-
-.app-desc {
- clear: both;
- margin-left: 20px;
-}
-.param-name {
- width: 100%;
-}
-.license-info {
- margin-left: 20px;
-}
-
-.license-url {
- margin-left: 20px;
-}
-
-.model {
- margin: 0 0 0px 20px;
-}
-
-.method {
- margin-left: 20px;
-}
-
-.method-notes {
- margin: 10px 0 20px 0;
- font-size: 90%;
- color: #555;
-}
-
-pre {
- padding: 10px;
- margin-bottom: 2px;
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
}
-pre.get {
- background-color: #0f6ab4;
-}
-
-pre.post {
- background-color: #10a54a;
-}
-
-pre.put {
- background-color: #c5862b;
-}
-
-pre.delete {
- background-color: #a41e22;
-}
-
-.huge {
- color: #fff;
-}
-
-pre.example {
- background-color: #f3f3f3;
- padding: 10px;
- border: 1px solid #ddd;
-}
-
-code {
- white-space: pre;
-}
-
-.nickname {
- font-weight: bold;
-}
-
-.method-path {
- font-size: 1.5em;
- background-color: #0f6ab4;
-}
-
-.parameter {
- width: 500px;
-}
-
-.param {
- width: 500px;
- padding: 10px 0 0 20px;
- font-weight: bold;
-}
-
-.param-desc {
- width: 700px;
- padding: 0 0 0 20px;
- color: #777;
-}
-
-.param-type {
- font-style: italic;
-}
-
-.field-label {
- padding: 0;
- margin: 0;
- clear: both;
-}
-
-.field-items {
- padding: 0 0 15px 0;
- margin-bottom: 15px;
-}
-
-.return-type {
- clear: both;
- padding-bottom: 10px;
-}
-
-.param-header {
- font-weight: bold;
-}
-
-.method-tags {
- text-align: right;
-}
-
-.method-tag {
- background: none repeat scroll 0% 0% #24A600;
- border-radius: 3px;
- padding: 2px 10px;
- margin: 2px;
- color: #FFF;
- display: inline-block;
- text-decoration: none;
+h1 p {
+ font-size:150%;
}
-*/
+/* End - Usergrid Additions */
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/data-storage/data-store-dbms.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/data-store-dbms.md b/docs/data-storage/data-store-dbms.md
index 0ea09d4..56fbbdb 100644
--- a/docs/data-storage/data-store-dbms.md
+++ b/docs/data-storage/data-store-dbms.md
@@ -20,10 +20,10 @@ If you have experience with relational databases and are unfamiliar with "NoSQL"
<table class="usergrid-table">
<tr>
- <td></td>
- <td>RDBMS</td>
- <td>Cassandra</td>
- <td>Usergrid</td>
+ <th></th>
+ <th>RDBMS</th>
+ <th>Cassandra</th>
+ <th>Usergrid</th>
</tr>
<tr>
<td>Each tuple is modeled as</td>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index bcb3092..1afd267 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,6 +8,7 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Introduction
+ introduction/overview.md
introduction/usergrid-features
introduction/data-model
introduction/async-vs-sync
@@ -122,7 +123,7 @@ Apache Usergrid Documentation
orgs-and-apps/managing
orgs-and-apps/organization
orgs-and-apps/application
- orgs-and-apps/adminuser
+ orgs-and-apps/admin-user
.. _rest-endpoints:
@@ -139,7 +140,7 @@ Apache Usergrid Documentation
:caption: Client SDKs
sdks/tbd
-
+
.. _installation:
.. toctree::
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/introduction/data-model.md
----------------------------------------------------------------------
diff --git a/docs/introduction/data-model.md b/docs/introduction/data-model.md
index 111e225..41421bd 100644
--- a/docs/introduction/data-model.md
+++ b/docs/introduction/data-model.md
@@ -33,20 +33,20 @@ Here is a simple example of an entity:
}
## Default entities
-The following entity types are predefined in Usergrid. For more details, see Default Data Entity Types.
-
-* user
-* group
-* role
-* application
-* activity
-* device
-* asset
-* folder
-* event
-* notifier
-* notification
-* receipt
+The following entity types are predefined in Usergrid. For more details, see the [API Reference](../rest-endpoints/api-docs.html)
+
+* [user](../rest-endpoints/api-docs.html#user)
+* [group](../rest-endpoints/api-docs.html#group)
+* [role](../rest-endpoints/api-docs.html#role)
+* [application](../rest-endpoints/api-docs.html#application)
+* [activity](../rest-endpoints/api-docs.html#activity)
+* [device](../rest-endpoints/api-docs.html#device)
+* [asset](../rest-endpoints/api-docs.html#asset)
+* [folder](../rest-endpoints/api-docs.html#folder)
+* [event](../rest-endpoints/api-docs.html#event)
+* [notifier](../rest-endpoints/api-docs.html#notifier)
+* [notification](../rest-endpoints/api-docs.html#notification)
+* [receipt](../rest-endpoints/api-docs.html#recept)
## Properties
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/introduction/overview.md
----------------------------------------------------------------------
diff --git a/docs/introduction/overview.md b/docs/introduction/overview.md
new file mode 100644
index 0000000..e9c6968
--- /dev/null
+++ b/docs/introduction/overview.md
@@ -0,0 +1,17 @@
+# Documentation Overview
+
+The Usergrid documentation is written for a couple of distinctly different audiences:
+
+* __Application Developer__: this is you if you are a Javascript, iOS, Android, Java or other developer who wants to build an app that uses the Usergrid APIs for data storage, user management, authentication, etc. __Most of our docs are written for application developers__ so browse the left side-bar and work your way down the topics list.
+
+
+* __Deployment/Operations Engineer__: this is for you if you are the person who will be installing Usergrid, setting up the required Cassandra database and other things that Usergrid needs. Currently, we have limited docs for installation, deployment and maintenance of Usergrid:
+ * [Deploying to Tomcat](../ug1-deploy-to-tomacat): How to build and deploy Usergrid to Tomcat and Cassandra.
+ * [Launcher Quick Start](../ug1-launcher-quick-start): How to build and run Usergrid via the Usergrid Launcher.
+
+
+* __Open Source Contributor__: How to "give back" and contribute to Usergrid. Usergrid welcomes code and documentation contributions, GitHub pull-requests, bug reports and suggestions for improvement.
+ * [How to Contribute Code & Docs](../reference/contribute-code):
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/orgs-and-apps/admin-user.md
----------------------------------------------------------------------
diff --git a/docs/orgs-and-apps/admin-user.md b/docs/orgs-and-apps/admin-user.md
index 87b96f9..6b1b7d3 100644
--- a/docs/orgs-and-apps/admin-user.md
+++ b/docs/orgs-and-apps/admin-user.md
@@ -1,4 +1,4 @@
-# Admin user$
+# Admin user
An admin user has full access to perform any operation on all organization accounts of which the admin user is a member. Using the API Services BaaS API, you can create, update, or retrieve an admin user. You can also set or reset an admin user's password, activite or reactivate an admin user, and get an admin user's activity feed.
In addition, you can add, retrieve, or remove an admin user from an organization. For information on these organization-related operations, see [Organization](organization.html).
[16/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/entity-connections/disconnecting-entities.html
----------------------------------------------------------------------
diff --git a/content/docs/entity-connections/disconnecting-entities.html b/content/docs/entity-connections/disconnecting-entities.html
index cae444b..ed92735 100644
--- a/content/docs/entity-connections/disconnecting-entities.html
+++ b/content/docs/entity-connections/disconnecting-entities.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -120,6 +121,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -144,9 +146,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -161,6 +163,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/entity-connections/retrieving-entities.html
----------------------------------------------------------------------
diff --git a/content/docs/entity-connections/retrieving-entities.html b/content/docs/entity-connections/retrieving-entities.html
index bafe45f..bffa9bc 100644
--- a/content/docs/entity-connections/retrieving-entities.html
+++ b/content/docs/entity-connections/retrieving-entities.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -123,6 +124,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -147,9 +149,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -164,6 +166,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -224,15 +227,15 @@
<div class="section" id="retrieving-connections">
<h1>Retrieving connections<a class="headerlink" href="#retrieving-connections" title="Permalink to this headline">¶</a></h1>
-<p>Viewing all of an entities connections To see all of the connection
-types associated with an entity, simply retrieve the entity.</p>
+<p>To see all of the connection types associated with an entity, simply
+retrieve the entity.</p>
<p>All of the connection types the entity has made to other entities will
-appear in the metadata.connections property.</p>
+appear in the <code class="docutils literal"><span class="pre">metadata.connections</span></code> property.</p>
<p>All of the connection types that other entities have made to the entity
-will appear in the metadata.connecting property.</p>
+will appear in the <code class="docutils literal"><span class="pre">metadata.connecting</span></code> property.</p>
<p>For user entities, following/followers connections can be accessed by
-sending a GET request to the URL in the collections.following and
-collections.followers properties.</p>
+sending a <code class="docutils literal"><span class="pre">GET</span></code> request to the URL in the <code class="docutils literal"><span class="pre">collections.following</span></code>
+and <code class="docutils literal"><span class="pre">collections.follower</span></code>s properties.</p>
<p>Retrieve connected entities by connection type To get a list of entities
a specified entity has connected to with a specific connection type, do
the following:</p>
@@ -334,7 +337,7 @@ response.</p>
<p>To get a list of all the entities that have created a connection of a
specific type to a specified entity, use the same method as shown above
in Retrieve connected entities by connection type, and set the
-relationship to connecting/.</p>
+relationship to <code class="docutils literal"><span class="pre">connecting/<relationship></span></code>.</p>
<p>All of the entities that have made a connection to the specified entity
will be returned in the entities property of the response.</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/genindex.html
----------------------------------------------------------------------
diff --git a/content/docs/genindex.html b/content/docs/genindex.html
index 59ecb7c..5233bf0 100644
--- a/content/docs/genindex.html
+++ b/content/docs/genindex.html
@@ -81,14 +81,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -116,6 +117,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -140,9 +142,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -157,6 +159,7 @@
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/geolocation/geolocation.html
----------------------------------------------------------------------
diff --git a/content/docs/geolocation/geolocation.html b/content/docs/geolocation/geolocation.html
index ed574ae..bea779e 100644
--- a/content/docs/geolocation/geolocation.html
+++ b/content/docs/geolocation/geolocation.html
@@ -31,7 +31,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Uploading assets" href="../asset-and-files/uploading-assets.html"/>
+ <link rel="next" title="Uploading assets" href="../assets-and-files/uploading-assets.html"/>
<link rel="prev" title="App Example - Messagee" href="../user-management/messagee-example.html"/>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -146,9 +148,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -163,6 +165,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -279,7 +282,7 @@ property:</p>
the same location are returned in the order they were created.</p>
<p>The location parameter can be appended to any standard API Services
query. For more information on how to query your API Services data, see
-Querying your data.</p>
+<a class="reference external" href="../data-queries/querying-your-data.html">Querying your Data</a>.</p>
<p>For example, here is how you would find all the devices within 8,046
meters (~10 miles) of the center of San Francisco:</p>
<div class="highlight-python"><div class="highlight"><pre>curl -X GET https://api.usergrid.com/your-org/your-app/devices?ql=location within 8046 of 37.774989,-122.419413
@@ -349,7 +352,7 @@ happened.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../asset-and-files/uploading-assets.html" class="btn btn-neutral float-right" title="Uploading assets" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../assets-and-files/uploading-assets.html" class="btn btn-neutral float-right" title="Uploading assets" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../user-management/messagee-example.html" class="btn btn-neutral" title="App Example - Messagee" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/getting-started/creating-a-new-application.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/creating-a-new-application.html b/content/docs/getting-started/creating-a-new-application.html
index c470fc1..07a3129 100644
--- a/content/docs/getting-started/creating-a-new-application.html
+++ b/content/docs/getting-started/creating-a-new-application.html
@@ -31,8 +31,8 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Creating an Usergrid Account" href="creating-account.html"/>
- <link rel="prev" title="Async vs. sync calls" href="../introduction/async-vs-sync.html"/>
+ <link rel="next" title="Using a Sandbox Application" href="using-a-sandbox-app.html"/>
+ <link rel="prev" title="Creating an Usergrid Account" href="creating-account.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,18 +82,19 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Creating a new application</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#creating-an-application">Creating an application</a></li>
<li class="toctree-l2"><a class="reference internal" href="#securing-an-application">Securing an application</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-the-api.html">Using the API</a></li>
</ul>
@@ -121,6 +122,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -145,9 +147,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -162,6 +164,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -236,16 +239,18 @@ select the organization to which you will add the new application.</li>
to the application drop-down.</li>
<li>In the dialog box, enter a new application name, then click the
Create button. Your new application will automatically be selected in
-the applications drop-down menu. Applications can also be created
-programmatically with a POST request to the API. For more, see
-Application.</li>
+the applications drop-down menu.</li>
</ol>
+<p>Applications can also be created programatically with a <code class="docutils literal"><span class="pre">POST</span></code> request
+to the API. For more, see
+<a class="reference external" href="../orgs-and-apps/application.html">Application</a>.</p>
</div>
<div class="section" id="securing-an-application">
<h2>Securing an application<a class="headerlink" href="#securing-an-application" title="Permalink to this headline">¶</a></h2>
<p>If this is going to be a production application, be sure to configure
security roles that provide only the level of access your users will
-need. For more on security, see Security best practices.</p>
+need. For more on security, see <a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> .</p>
</div>
</div>
@@ -256,10 +261,10 @@ need. For more on security, see Security best practices.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="creating-account.html" class="btn btn-neutral float-right" title="Creating an Usergrid Account" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="using-a-sandbox-app.html" class="btn btn-neutral float-right" title="Using a Sandbox Application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../introduction/async-vs-sync.html" class="btn btn-neutral" title="Async vs. sync calls" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="creating-account.html" class="btn btn-neutral" title="Creating an Usergrid Account" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/getting-started/creating-account.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/creating-account.html b/content/docs/getting-started/creating-account.html
index e3b6ed6..82a1522 100644
--- a/content/docs/getting-started/creating-account.html
+++ b/content/docs/getting-started/creating-account.html
@@ -31,8 +31,8 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Using a Sandbox Application" href="using-a-sandbox-app.html"/>
- <link rel="prev" title="Creating a new application" href="creating-a-new-application.html"/>
+ <link rel="next" title="Creating a new application" href="creating-a-new-application.html"/>
+ <link rel="prev" title="Async vs. sync calls" href="../introduction/async-vs-sync.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,17 +82,18 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Creating an Usergrid Account</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#next-steps">Next steps</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-the-api.html">Using the API</a></li>
</ul>
@@ -120,6 +121,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -144,9 +146,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -161,6 +163,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -231,7 +234,8 @@ might want to read Usergrid features first.)</p>
create one for you with your new account). The sandbox is a
partitioned area of the data store where you can add example data and
try out API calls. The sandbox isn’t secure, but it’s handy to play
-in. For more about the sandbox, see “Using Your Application Sandbox”.</li>
+in. For more about the sandbox, see <a class="reference external" href="../getting-started/using-a-sandbox-app.html">Using Your Application
+Sandbox</a>.</li>
<li>The ability to create more applications (in addition to the sandbox).
You can (and should!) make these as secure as you need to. These are
the applications that you’ll have behind the apps you make available
@@ -242,14 +246,16 @@ including access levels. ** Manage the data in your app. **
Manage app features, including push notifications, activities,
analytics, and so on. ** Try out API calls with a shell command
window. ** To create an Usergrid account and see a very short
-tutorial to get started with, go to the get started page.</li>
+tutorial to get started with, go to the get started page of the
+Portal.</li>
</ul>
<div class="section" id="next-steps">
<h2>Next steps<a class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2>
<p>Ready to learn and do more?</p>
<ul class="simple">
<li>Install an SDK that will be most useful for your application
-environment. For more about Usergrid’s SDKs, see SDKs.</li>
+environment. For more about Usergrid’s SDKs, see
+<a class="reference external" href="../sdks/tbd.html">SDKs</a>.</li>
<li>Review Usergrid features for information on concepts and features.</li>
<li>Consult the API Reference for usage details.</li>
</ul>
@@ -263,10 +269,10 @@ environment. For more about Usergrid’s SDKs, see SDKs.</li>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="using-a-sandbox-app.html" class="btn btn-neutral float-right" title="Using a Sandbox Application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="creating-a-new-application.html" class="btn btn-neutral float-right" title="Creating a new application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="creating-a-new-application.html" class="btn btn-neutral" title="Creating a new application" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../introduction/async-vs-sync.html" class="btn btn-neutral" title="Async vs. sync calls" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/getting-started/using-a-sandbox-app.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/using-a-sandbox-app.html b/content/docs/getting-started/using-a-sandbox-app.html
index a2494dc..8610705 100644
--- a/content/docs/getting-started/using-a-sandbox-app.html
+++ b/content/docs/getting-started/using-a-sandbox-app.html
@@ -32,7 +32,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
<link rel="next" title="Using the API" href="using-the-api.html"/>
- <link rel="prev" title="Creating an Usergrid Account" href="creating-account.html"/>
+ <link rel="prev" title="Creating a new application" href="creating-a-new-application.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Using a Sandbox Application</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-the-sandbox-application">What is the sandbox application?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#is-the-sandbox-secure">Is the sandbox secure?</a></li>
@@ -122,6 +123,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -146,9 +148,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -163,6 +165,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -225,11 +228,12 @@
<h1>Using a Sandbox Application<a class="headerlink" href="#using-a-sandbox-application" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-is-the-sandbox-application">
<h2>What is the sandbox application?<a class="headerlink" href="#what-is-the-sandbox-application" title="Permalink to this headline">¶</a></h2>
-<p>When you create a new Usergrid account (see Creating an Usergrid
-Account) to use services for developers, Usergrid creates a new
-application for you on its servers. With the new application, called
-“sandbox,” you can add your own example data and try out API calls that
-do things with the data. Be sure to see Using the API for suggestions.</p>
+<p>When you create a new Usergrid account (see <a class="reference external" href="creating-account.html">Creating an Usergrid
+Account</a>) to use services for developers,
+Usergrid creates a new application for you on its servers. With the new
+application, called “sandbox,” you can add your own example data and try
+out API calls that do things with the data. Be sure to see Using the API
+for suggestions.</p>
</div>
<div class="section" id="is-the-sandbox-secure">
<h2>Is the sandbox secure?<a class="headerlink" href="#is-the-sandbox-secure" title="Permalink to this headline">¶</a></h2>
@@ -296,7 +300,7 @@ application whatever you like (including “sandbox”).</li>
<a href="using-the-api.html" class="btn btn-neutral float-right" title="Using the API" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="creating-account.html" class="btn btn-neutral" title="Creating an Usergrid Account" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="creating-a-new-application.html" class="btn btn-neutral" title="Creating a new application" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/getting-started/using-the-api.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/using-the-api.html b/content/docs/getting-started/using-the-api.html
index d80add6..2420715 100644
--- a/content/docs/getting-started/using-the-api.html
+++ b/content/docs/getting-started/using-the-api.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Using the API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#supported-http-methods">Supported HTTP methods</a></li>
@@ -128,6 +129,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -152,9 +154,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -169,6 +171,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -312,7 +315,8 @@ john:</p>
<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where facebook.first_name ='john'
</pre></div>
</div>
-<p>For further information about queries, see Queries and parameters.</p>
+<p>For further information about queries, see <a class="reference external" href="../data-queries/querying-your-data.html">Querying your
+Data</a></p>
</div>
<div class="section" id="authentication-oauth">
<h2>Authentication (OAuth)<a class="headerlink" href="#authentication-oauth" title="Permalink to this headline">¶</a></h2>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/index.html
----------------------------------------------------------------------
diff --git a/content/docs/index.html b/content/docs/index.html
index 81812d4..c640b16 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -31,7 +31,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="#"/>
- <link rel="next" title="Usergrid Features" href="introduction/usergrid-features.html"/>
+ <link rel="next" title="Documentation Overview" href="introduction/overview.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -81,14 +81,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -116,6 +117,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -140,9 +142,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -157,6 +159,7 @@
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -220,13 +223,14 @@
<div class="toctree-wrapper compound" id="introduction">
<p class="caption"><span class="caption-text">Introduction</span><a class="headerlink" href="#introduction" title="Permalink to this toctree">¶</a></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#data-storage-management">Data storage & management</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#flexible-data-querying">Flexible data querying</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#social">Social</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#user-management">User management</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#geolocation">Geolocation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#push-notifications">Push notifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#push-notifications-coming-soon">Push notifications (Coming soon...)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a><ul>
@@ -249,15 +253,15 @@
<div class="toctree-wrapper compound" id="id1">
<span id="getting-started"></span><p class="caption"><span class="caption-text">Getting Started</span><a class="headerlink" href="#id1" title="Permalink to this toctree">¶</a></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-account.html#next-steps">Next steps</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#creating-an-application">Creating an application</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#securing-an-application">Securing an application</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-account.html#next-steps">Next steps</a></li>
-</ul>
-</li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#what-is-the-sandbox-application">What is the sandbox application?</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#is-the-sandbox-secure">Is the sandbox secure?</a></li>
@@ -361,6 +365,13 @@
<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#removing-permissions">Removing permissions</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-roles.html#default-roles">Default roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-roles.html#creating-roles">Creating roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-roles.html#assigning-roles">Assigning roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-roles.html#removing-roles">Removing roles</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#authentication-levels">Authentication levels</a></li>
<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#application-user-authentication-user-login">Application user authentication (user login)</a></li>
@@ -472,19 +483,19 @@
<div class="toctree-wrapper compound" id="assets-files">
<span id="asset-and-file-management"></span><p class="caption"><span class="caption-text">Assets & Files</span><a class="headerlink" href="#assets-files" title="Permalink to this toctree">¶</a></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#id1">Uploading assets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#updating-assets">Updating assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/uploading-assets.html#id1">Uploading assets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/uploading-assets.html#updating-assets">Updating assets</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-asset-data">Retrieving asset data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-an-asset-entity">Retrieving an asset entity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/retrieving-assets.html#retrieving-asset-data">Retrieving asset data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/retrieving-assets.html#retrieving-an-asset-entity">Retrieving an asset entity</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
-<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/folders.html#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets-and-files/folders.html#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
</ul>
</li>
</ul>
@@ -514,7 +525,7 @@
</ul>
</div>
<div class="toctree-wrapper compound" id="organizations-applications">
-<p class="caption"><span class="caption-text">Organizations & Applications</span><a class="headerlink" href="#organizations-applications" title="Permalink to this toctree">¶</a></p>
+<span id="organization-and-application-management"></span><p class="caption"><span class="caption-text">Organizations & Applications</span><a class="headerlink" href="#organizations-applications" title="Permalink to this toctree">¶</a></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a><ul>
@@ -537,29 +548,38 @@
<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#getting-application-credentials">Getting application credentials</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#creating-an-admin-user">Creating an admin user</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#updating-an-admin-user">Updating an admin user</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#getting-an-admin-user">Getting an admin user</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#setting-an-admin-user-s-password">Setting an admin user’s password</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#resetting-an-admin-user-s-password">Resetting an admin user’s password</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#completing-a-password-reset">Completing a password reset</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#activating-an-admin-user">Activating an admin user</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#reactivating-an-admin-user">Reactivating an admin user</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#id20">Example - Request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/admin-user.html#getting-an-admin-user-s-activity-feed">Getting an admin user’s activity feed</a></li>
+</ul>
+</li>
</ul>
</div>
<div class="toctree-wrapper compound" id="api-reference">
<span id="rest-endpoints"></span><p class="caption"><span class="caption-text">API Reference</span><a class="headerlink" href="#api-reference" title="Permalink to this toctree">¶</a></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action-methods">Action Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed-methods">ActivityFeed Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#appdata-methods">AppData Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#credential-methods">Credential Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#devices-methods">Devices Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entity-methods">Entity Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event-methods">Event Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group-methods">Group Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification-methods">Notification Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organization-methods">Organization Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permission-methods">Permission Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#receipt-methods">Receipt Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#role-methods">Role Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#user-methods">User Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#access-tokens">Access-Tokens</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activities">Activities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#admin-users">Admin-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#app-users">App-Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entities-collections">Entities-Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#events">Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#groups">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organizations-applications">Organizations-Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permissions-roles">Permissions-Roles</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#accesstokenresponse">AccessTokenResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action">Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed">ActivityFeed</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#actor">Actor</a></li>
@@ -587,6 +607,7 @@
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event">Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group">Group</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#imagemodel">ImageModel</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#logincredentials">LoginCredentials</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#metadata">Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification">Notification</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notifier">Notifier</a></li>
@@ -670,7 +691,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="introduction/usergrid-features.html" class="btn btn-neutral float-right" title="Usergrid Features" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="introduction/overview.html" class="btn btn-neutral float-right" title="Documentation Overview" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/installation/ug1-deploy-to-tomcat.html
----------------------------------------------------------------------
diff --git a/content/docs/installation/ug1-deploy-to-tomcat.html b/content/docs/installation/ug1-deploy-to-tomcat.html
index 5a13447..ed9ba1e 100644
--- a/content/docs/installation/ug1-deploy-to-tomcat.html
+++ b/content/docs/installation/ug1-deploy-to-tomcat.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/installation/ug1-launcher-quick-start.html
----------------------------------------------------------------------
diff --git a/content/docs/installation/ug1-launcher-quick-start.html b/content/docs/installation/ug1-launcher-quick-start.html
index 5ae2501..a6b848f 100644
--- a/content/docs/installation/ug1-launcher-quick-start.html
+++ b/content/docs/installation/ug1-launcher-quick-start.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/installation/ug2-deploy-to-tomcat.html
----------------------------------------------------------------------
diff --git a/content/docs/installation/ug2-deploy-to-tomcat.html b/content/docs/installation/ug2-deploy-to-tomcat.html
index 1557115..ee90c8b 100644
--- a/content/docs/installation/ug2-deploy-to-tomcat.html
+++ b/content/docs/installation/ug2-deploy-to-tomcat.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/introduction/async-vs-sync.html
----------------------------------------------------------------------
diff --git a/content/docs/introduction/async-vs-sync.html b/content/docs/introduction/async-vs-sync.html
index caf0163..30c76a3 100644
--- a/content/docs/introduction/async-vs-sync.html
+++ b/content/docs/introduction/async-vs-sync.html
@@ -31,7 +31,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Creating a new application" href="../getting-started/creating-a-new-application.html"/>
+ <link rel="next" title="Creating an Usergrid Account" href="../getting-started/creating-account.html"/>
<link rel="prev" title="Usergrid Data model" href="data-model.html"/>
@@ -82,6 +82,7 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Async vs. sync calls</a><ul>
@@ -92,8 +93,8 @@
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -121,6 +122,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -145,9 +147,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -162,6 +164,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -277,7 +280,7 @@ execution completes.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../getting-started/creating-a-new-application.html" class="btn btn-neutral float-right" title="Creating a new application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../getting-started/creating-account.html" class="btn btn-neutral float-right" title="Creating an Usergrid Account" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="data-model.html" class="btn btn-neutral" title="Usergrid Data model" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
[09/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/using-roles.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/using-roles.html b/content/docs/security-and-auth/using-roles.html
new file mode 100644
index 0000000..03b0856
--- /dev/null
+++ b/content/docs/security-and-auth/using-roles.html
@@ -0,0 +1,740 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Using roles — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Authenticating users & app clients" href="authenticating-users-and-application-clients.html"/>
+ <link rel="prev" title="Using permissions" href="using-permissions.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Using roles</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#default-roles">Default roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#creating-roles">Creating roles</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#request-syntax">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-request">Example request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-response">Example response</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#creating-roles-in-the-admin-portal">Creating Roles in the Admin Portal</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#assigning-roles">Assigning roles</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id1">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id2">Example request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id3">Example response</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#assigning-roles-in-the-admin-portal">Assigning Roles in the Admin Portal</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#removing-roles">Removing roles</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#id4">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id5">Example request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#id6">Example response</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#removing-roles-in-the-admin-portal">Removing Roles in the Admin Portal</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Using roles</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/security-and-auth/using-roles.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="using-roles">
+<h1>Using roles<a class="headerlink" href="#using-roles" title="Permalink to this headline">¶</a></h1>
+<p>Roles are named sets of one or more permissions, and are useful for
+defining specific access levels to resources in your Usergrid data
+store. Multiple roles can be assigned to a user or group, giving you a
+great deal of flexibility in how access to resources are defined.</p>
+<p>For example, in a blogging app you might create a ‘reviewer’ role that
+allows GET and PUT access to an articles collection to allow the user to
+retrieve and update articles, but not allow them to create new articles.</p>
+<div class="section" id="default-roles">
+<h2>Default roles<a class="headerlink" href="#default-roles" title="Permalink to this headline">¶</a></h2>
+<p>While you can create as many custom roles as you want per application,
+all Usegrid applications include three default roles. These roles each
+serve a special purpose and should not be deleted; however, you can and
+should adjust the permissions assigned to these roles to suit the needs
+of you app.</p>
+<p>The following table describes each pre-defined role, and the permissions
+that are assigned to them by default.</p>
+<table class="usergrid-table">
+<tr>
+ <th><p>Role</p>
+</th>
+ <th class="usergrid-30"><p>Permissions</p>
+</th>
+ <th><p>Description</p>
+</th>
+</tr>
+<tr>
+ <td><p>Guest</p>
+</td>
+ <td><ul class="simple">
+<li>post: /devices</li>
+<li>post: /users</li>
+<li>put: /devices/*</li>
+</ul>
+</td>
+ <td><p>Assigned to all unauthenticated requests. Includes a basic set of
+permissions that are commonly needed by unregistered or unauthenticated
+users.</p>
+<p><p>Grants permission for a user to create a user account and for their
+device to be registered.</p>
+</td>
+</tr>
+<tr>
+ <td><p>Default</p>
+</td>
+ <td><ul class="simple">
+<li>get, post, put, delete: /**</li>
+</ul>
+</td>
+ <td><p>Default for authenticated users. Assigns the associated permissions to
+all users whose requests are authenticated with a valid access token.</p>
+<div class="admonition warning"> <p class="first admonition-title"><p>WARNING</p>
+ </p> <p class="last">
+
+
+By default, **grants full access for all resources in your<p>application**. A first task in securing your application should be to
+restrict access by redefining this role to narrow the access it
+provides. Remove the default full permission rule and add restrictive
+permission rules for a production deployment.</p>
+</p></div></td>
+</tr>
+<tr>
+ <td><p>Administrator</p>
+</td>
+ <td><p>None</p>
+</td>
+ <td><p>Unused until you associate it with users or groups. By default, includes
+no permissions that provide access. Grants no access. Consider this a
+blank slate. Add permission rules and associate this role with users and
+groups as needed.</p>
+<div class="admonition note"> <p class="first admonition-title"><p>NOTE</p>
+ </p> <p class="last">
+
+
+The Administrator role is not the same as an organization<p>administrator, that is, someone who authenticates as an Admin User. The
+Admin User is an implicit user created when you create an organization.
+After authenticating, the Admin User has full access to all of the
+administration features of the Usergrid API. By comparison, the
+Administrator role is simply a role (initially without permissions) that
+can be assigned to any user.</p>
+</p></div></td>
+</tr>
+</table></div>
+<div class="section" id="creating-roles">
+<h2>Creating roles<a class="headerlink" href="#creating-roles" title="Permalink to this headline">¶</a></h2>
+<p>Generally, it is easiest to a create a role for each access type you
+want to enable in your app. You may, however, assign multiple roles to
+any user or group entity, so you have the flexibility to define any
+schema for applying roles that you like.</p>
+<p>The following shows how to create a new role and assign permissions to
+it.</p>
+<div class="section" id="request-syntax">
+<h3>Request syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
+<p>With cURL requests a role entity is created with a POST request, then
+permissions must be assigned to it with a separate request. For more on
+assigning permissions with cURL, see <a class="reference external" href="security-and-auth/using-permissions.html">Using
+Permissions</a>.</p>
+<p>The following details how to create a new role entity.</p>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST https://api.usergrid.com/<org>/<app>/roles -d '{"name":<roleName>}'
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>org</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>app</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>roleName</td>
+<td>The name of the role to be created</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="example-request">
+<h3>Example request<a class="headerlink" href="#example-request" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/ -d '{"name":"manager"}'
+</pre></div>
+</div>
+</div>
+<div class="section" id="example-response">
+<h3>Example response<a class="headerlink" href="#example-response" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/your-org/your-app/roles"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"382d0991-74bb-3548-8166-6b07e44495ef"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"role"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"manager"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1402612783104</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1402612783104</span><span class="p">,</span>
+ <span class="s">"roleName"</span> <span class="p">:</span> <span class="s">"manager"</span><span class="p">,</span>
+ <span class="s">"title"</span> <span class="p">:</span> <span class="s">"manager"</span><span class="p">,</span>
+ <span class="s">"inactivity"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles/382d0991-74bb-3548-8166-6b07e44495ef"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/roles/382d0991-74bb-3548-8166-6b07e44495ef/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/roles/382d0991-74bb-3548-8166-6b07e44495ef/groups"</span><span class="p">,</span>
+ <span class="s">"users"</span> <span class="p">:</span> <span class="s">"/roles/382d0991-74bb-3548-8166-6b07e44495ef/users"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1402612783102</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">30</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="creating-roles-in-the-admin-portal">
+<h3>Creating Roles in the Admin Portal<a class="headerlink" href="#creating-roles-in-the-admin-portal" title="Permalink to this headline">¶</a></h3>
+<ol class="arabic simple">
+<li>In the left sidebar of the Usergrid portal, click Users > Roles. This
+displays the roles defined for the application. Click the ‘+’ button.</li>
+<li>In the dialog box, provide a ‘title’ and ‘role name.’ A title is an
+alias for the role name.</li>
+<li>Click ‘Create’. The role will be created, but will not have any
+permissions assigned to it.</li>
+<li>Click the role you created in the list.</li>
+<li>Click the ‘Add permissions’ button.</li>
+<li>In the dialog box, click the check boxes for the HTTP methods you
+want to grant permissions for, and enter the resource path in the
+‘Path’ field.</li>
+<li>The ‘Inactivity’ field lets you control automatic user logout during
+periods of inactivity. Set a number of seconds of inactivity before
+users assigned to this role are automatically logged out.</li>
+</ol>
+</div>
+</div>
+<div class="section" id="assigning-roles">
+<h2>Assigning roles<a class="headerlink" href="#assigning-roles" title="Permalink to this headline">¶</a></h2>
+<p>Once you have created some roles, you will need to explicitly assign
+them to a user or group entity. The permissions associated with that
+role will be granted to the entity immediately for any requests they
+send that are authenticated by a valid access token. Please note that
+assigning a role to a group will grant the associated permissions to
+every user in that group.</p>
+<p>The following shows how to assign a role to an entity.</p>
+<div class="section" id="id1">
+<h3>Request syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST https://api.usergrid.com/<org>/<app>/roles/<roleName>/<entityType>/<entityID>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="87%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>org</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>app</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>roleName</td>
+<td>The name of the role to be created</td>
+</tr>
+<tr class="row-odd"><td>entityType</td>
+<td>The type of the entity the role is being assigned to. ‘Group’ and ‘user’ are valid values.</td>
+</tr>
+<tr class="row-even"><td>entityID</td>
+<td>The UUID of the entity the role is being assigned to.</td>
+</tr>
+</tbody>
+</table>
+<p>For groups, the ‘name’ property can be used. For users, the ‘username’
+property can be used.</p>
+</div>
+<div class="section" id="id2">
+<h3>Example request<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/users/someUser
+</pre></div>
+</div>
+</div>
+<div class="section" id="id3">
+<h3>Example response<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1395681911491</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1399070010291</span><span class="p">,</span>
+ <span class="s">"username"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"activated"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"file"</span> <span class="p">:</span> <span class="s">"fobnszewobnioerabnoiawegbrn</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"connecting"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"friends"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends"</span><span class="p">,</span>
+ <span class="s">"likes"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"connections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"completed"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed"</span><span class="p">,</span>
+ <span class="s">"follows"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1402965083889</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">41</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="assigning-roles-in-the-admin-portal">
+<h3>Assigning Roles in the Admin Portal<a class="headerlink" href="#assigning-roles-in-the-admin-portal" title="Permalink to this headline">¶</a></h3>
+<p>The easiest way to assign roles to user or group entities is to use the
+‘Users’ tab of the Usergrid admin portal, by doing the following:</p>
+<ol class="arabic simple">
+<li>In the left sidebar of the admin portal, click Users > Users or Users
+> Groups to display either the list of users or groups in your
+application.</li>
+<li>In the list, click the name of the user or group entity you want to
+assign roles to to display its details in the right pane.</li>
+<li>Click the ‘Roles & Permissions’ tab above the right pane.</li>
+<li>Click the ‘Add Role’ button.</li>
+<li>In the popup, select a role from the drop down menu.</li>
+<li>Click the ‘Add’ button.</li>
+</ol>
+</div>
+</div>
+<div class="section" id="removing-roles">
+<h2>Removing roles<a class="headerlink" href="#removing-roles" title="Permalink to this headline">¶</a></h2>
+<p>At times it may be necessary to remove a role from a user or group
+entity, for example if a user changes jobs, or the duties of a group are
+altered. Please note that removing a role from a group will remove the
+associated permissions from every user in that group.</p>
+<p>The following shows how to remove a role from an entity.</p>
+<div class="section" id="id4">
+<h3>Request syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/<org>/<app>/roles/<roleName>/<entityType>/<entityID>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="87%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>org</td>
+<td>Organization UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>app</td>
+<td>Application UUID or application name</td>
+</tr>
+<tr class="row-even"><td>roleName</td>
+<td>The name of the role to be created</td>
+</tr>
+<tr class="row-odd"><td>entityType</td>
+<td>The type of the entity the role is being removed from. ‘Group’ and ‘user’ are valid values.</td>
+</tr>
+<tr class="row-even"><td>entityID</td>
+<td>The UUID of the entity the role is being removed from.</td>
+</tr>
+</tbody>
+</table>
+<p>For groups, the ‘name’ property can be used. For users, the ‘username’
+property can be used.</p>
+</div>
+<div class="section" id="id5">
+<h3>Example request<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/my-org/my-app/roles/manager/users/someUser
+</pre></div>
+</div>
+</div>
+<div class="section" id="id6">
+<h3>Example response<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"delete"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1395681911491</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1399070010291</span><span class="p">,</span>
+ <span class="s">"username"</span> <span class="p">:</span> <span class="s">"someUser"</span><span class="p">,</span>
+ <span class="s">"activated"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"connecting"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"friends"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends"</span><span class="p">,</span>
+ <span class="s">"likes"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"connections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"completed"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed"</span><span class="p">,</span>
+ <span class="s">"follows"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1403214283808</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">358</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="removing-roles-in-the-admin-portal">
+<h3>Removing Roles in the Admin Portal<a class="headerlink" href="#removing-roles-in-the-admin-portal" title="Permalink to this headline">¶</a></h3>
+<p>The easiest way to remove roles from user or group entities is to use
+the ‘Users’ tab of the Usergrid admin portal, by doing the following:</p>
+<ol class="arabic simple">
+<li>In the left sidebar of the Usergrid admin portal, click Users > Users
+or Users > Groups to display either the list of users or groups in
+your application.</li>
+<li>In the list, click the name of the user or group entity you want to
+remove roles from to display its details in the right pane.</li>
+<li>Click the ‘Roles & Permissions’ tab above the right pane.</li>
+<li>Click the role you created in the list.</li>
+<li>Under ‘Roles’, click the checkbox beside the role you want to remove
+from the entity.</li>
+<li>Click the ‘Leave roles’ button.</li>
+</ol>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="authenticating-users-and-application-clients.html" class="btn btn-neutral float-right" title="Authenticating users & app clients" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="using-permissions.html" class="btn btn-neutral" title="Using permissions" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/activity.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/activity.html b/content/docs/user-management/activity.html
index 12e632b..42b6636 100644
--- a/content/docs/user-management/activity.html
+++ b/content/docs/user-management/activity.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -173,9 +175,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -190,6 +192,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -264,12 +267,12 @@ information about these actions).</p>
<p>When a user creates an activity, it creates a relationship between the
activity and the user who created it. Because this relationship exists,
the activity will appear in the feed of any of the user’s followers.
-Think of the Activities endpoint (/users/{uuid|username}/activities) as
-an “outbox” of news items created by the user. Think of the Feed
-endpoint (/users/{uuid|username}/feed) as an “inbox” of news items
+Think of the Activities endpoint (<code class="docutils literal"><span class="pre">/users/{uuid|username}/activities</span></code>)
+as an “outbox” of news items created by the user. Think of the Feed
+endpoint (<code class="docutils literal"><span class="pre">/users/{uuid|username}/feed</span></code>) as an “inbox” of news items
meant to be seen or consumed by the user.</p>
<p>A user can also post an activity to a group (located at
-/groups/{uuid|groupname}/activities). This allows you to emulate
+<code class="docutils literal"><span class="pre">/groups/{uuid|groupname}/activities</span></code>). This allows you to emulate
Facebook-style group functionality, where a limited number of users can
share content on a common “wall”. In any of these cases, there is no
need to construct publish/subscribe relationships manually.</p>
@@ -281,8 +284,7 @@ posts a short, 140-character or less, “tweet”, that activity gets ad
to the user’s activity stream for display as well as to the activity
streams of any of the user’s followers.</p>
<p>Using Usergrid APIs you can create, retrieve, update, and delete
-activity entities. See You do not have access to view this node for
-descriptions of these APIs.</p>
+activity entities.</p>
<p><strong>Note:</strong> Although not shown in the API examples below, you need to
provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
users and application
@@ -406,11 +408,12 @@ the <code class="docutils literal"><span class="pre">/activities</span></code> e
that endpoint.</p>
<p>Notice the properties specified in the request body in the previous
example are actor, verb, and content. The actor, verb, and content
-properties are built into the Activity entity (see Default Data Entity
-Types). The actor property specifies properties of the entity that
-performs the action (here, user john.doe). The gravatar URL is used to
-create an icon for the activity. And because an Activity is simply an
-API Services data entity, you can also create custom properties.</p>
+properties are built into the Activity entity (see <a class="reference external" href="../rest-endpoints/api-doc.html#activity">Activity entity
+properties</a> ). The actor
+property specifies properties of the entity that performs the action
+(here, user john.doe). The gravatar URL is used to create an icon for
+the activity. And because an Activity is simply an API Services data
+entity, you can also create custom properties.</p>
<p>The verb parameter is descriptive. You can use it to indicate what type
of activity is posted, for example, an image versus text. The value post
is defined in the JSON Activity Streams specification as “the act of
@@ -421,12 +424,12 @@ authoring an object and then publishing it online.“</p>
<h2>Posting an activity to a group<a class="headerlink" href="#posting-an-activity-to-a-group" title="Permalink to this headline">¶</a></h2>
<p>Use the POST method to post an activity to a specific group. In this
case the activity is created in the activities collection and is
-accessible at the /activities endpoint to users who have the permission
-to read that endpoint. In addition, a relationship is established
-between the activity and the group, and because of that, the activity
-will appear in the group’s feed. The group “owns” the activity. Also,
-the activity will be published in the feed of all users that are members
-of the group.</p>
+accessible at the <code class="docutils literal"><span class="pre">/activities</span></code> endpoint to users who have the
+permission to read that endpoint. In addition, a relationship is
+established between the activity and the group, and because of that, the
+activity will appear in the group’s feed. The group “owns” the activity.
+Also, the activity will be published in the feed of all users that are
+members of the group.</p>
<div class="section" id="id1">
<h3>Request URI<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>POST /{org_id}/{app_id}/groups/{uuid|groupname}/activities {request body}
@@ -545,9 +548,8 @@ cross-posted to the group’s activity endpoint
automatically created between the activity entity that was just created
and the user within that group
(<code class="docutils literal"><span class="pre">/groups/{uuid|groupname}/users/{uuid|username}</span></code>) The user within the
-group (``/groups/{uuid|groupname}/users/{uuid|username}```)
-becomes the owner of the activity (through the owner property in the
-activity).</p>
+group (<code class="docutils literal"><span class="pre">/groups/{uuid|groupname}/users/{uuid|username}</span></code>) becomes the
+owner of the activity (through the owner property in the activity).</p>
<div class="section" id="id4">
<h3>Request URI<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>POST /{org_id}/{app_id}/groups/{uuid|groupname}/users/{uuid|username}/activities {request body}
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/group.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/group.html b/content/docs/user-management/group.html
index 0f2a33d..03db84b 100644
--- a/content/docs/user-management/group.html
+++ b/content/docs/user-management/group.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -183,9 +185,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -200,6 +202,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -279,10 +282,10 @@ create group properties specific to your application.</p>
<div class="section" id="creating-groups">
<h2>Creating groups<a class="headerlink" href="#creating-groups" title="Permalink to this headline">¶</a></h2>
<p>A group entity represents an application group of users. You can create,
-retrieve, update, delete, and query group entities. See User entity
-properties for a list of the system-defined properties for group
-entities. In addition, you can create group properties specific to your
-application.</p>
+retrieve, update, delete, and query group entities. See <a class="reference external" href="../rest-endpoints/api-doc.html#user">User entity
+properties</a> for a list of the
+system-defined properties for group entities. In addition, you can
+create group properties specific to your application.</p>
<div class="section" id="request-syntax">
<h3>Request Syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/your-org/your-app/groups" '{ request body }'
@@ -333,8 +336,10 @@ forward slashes to denote hierarchical relationships.</p>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
</div>
<div class="section" id="request">
<h3>Request<a class="headerlink" href="#request" title="Permalink to this headline">¶</a></h3>
@@ -409,7 +414,8 @@ create group properties specific to your application.</p>
<p>org_id | uuid Organization UUID or organization name app_id | uuid
Application UUID or application name groupPath | uuid Group UUID or
group path, which must be unique. query_string A data store query. For
-more on queries, see Data queries.</p>
+more on queries, see <a class="reference external" href="../data-queries/querying-your-data.html">Data
+queries</a>.</p>
<div class="section" id="id3">
<h3>Request<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre># Get a group by the group path, "employees/managers".
@@ -559,14 +565,14 @@ Entities</a>.</p>
</div>
<div class="section" id="adding-a-user-to-a-group">
<h2>Adding a user to a group<a class="headerlink" href="#adding-a-user-to-a-group" title="Permalink to this headline">¶</a></h2>
-<p>See all application entities</p>
<p>You can add users to groups from client code using cURL commands or one
of the SDKs, as described here.</p>
<p>When setting up your application on the server, you might find it easier
and more convenient to create and populate groups with the admin portal.
There, you can create groups, create roles, and define permission rules
that govern user access to data and services in your application. For
-more information, see Security & token authentication.</p>
+more information, see <a class="reference external" href="../security-and-auth/app-security.html">Security & Token
+Authentication</a>.</p>
<p>Use the POST method to add a user to a group. If the named group does
not yet exist, an error message is returned.</p>
<div class="section" id="id6">
@@ -610,8 +616,10 @@ not yet exist, an error message is returned.</p>
<div class="section" id="id8">
<h3>Example<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
</div>
<div class="section" id="id9">
<h3>Request<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/groups.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/groups.html b/content/docs/user-management/groups.html
index 6fd0a61..6f6bed9 100644
--- a/content/docs/user-management/groups.html
+++ b/content/docs/user-management/groups.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/messagee-example.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/messagee-example.html b/content/docs/user-management/messagee-example.html
index fa24fbd..3582fa8 100644
--- a/content/docs/user-management/messagee-example.html
+++ b/content/docs/user-management/messagee-example.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -166,9 +168,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -183,6 +185,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -259,9 +262,7 @@ client</a></li>
users, and run the app. You also learn how to use the Usergrid admin
portal, a user interface that streamlines data and application
management in the Usergrid system. The portal is also a reference
-application that shows how to incorporate Usergrid APIs with JavaScript.
-For a more detailed discussion of the portal’s functionality, see Admin
-portal.</p>
+application that shows how to incorporate Usergrid APIs with JavaScript.</p>
<div class="section" id="creating-a-user-account-in-usergrid">
<h2>Creating a user account in Usergrid<a class="headerlink" href="#creating-a-user-account-in-usergrid" title="Permalink to this headline">¶</a></h2>
<p>Go to the Usergrid portal and login. If you are new to Usergrid, sign up
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/user-connections.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/user-connections.html b/content/docs/user-management/user-connections.html
index a743066..f9718a4 100644
--- a/content/docs/user-management/user-connections.html
+++ b/content/docs/user-management/user-connections.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -145,9 +147,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -162,6 +164,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/user-management/user-management.html
----------------------------------------------------------------------
diff --git a/content/docs/user-management/user-management.html b/content/docs/user-management/user-management.html
index e74d5dc..81984e1 100644
--- a/content/docs/user-management/user-management.html
+++ b/content/docs/user-management/user-management.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -147,9 +149,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -164,6 +166,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
[17/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/assets-and-files/uploading-assets.html
----------------------------------------------------------------------
diff --git a/content/docs/assets-and-files/uploading-assets.html b/content/docs/assets-and-files/uploading-assets.html
new file mode 100644
index 0000000..f7f66e9
--- /dev/null
+++ b/content/docs/assets-and-files/uploading-assets.html
@@ -0,0 +1,419 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Uploading assets — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Retrieving assets" href="retrieving-assets.html"/>
+ <link rel="prev" title="Geolocating your Entities" href="../geolocation/geolocation.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="">Uploading assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id1">Uploading assets</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#request-syntax">Request syntax</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-request">Example request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#example-response">Example response</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#updating-assets">Updating assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Uploading assets</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/assets-and-files/uploading-assets.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="uploading-assets">
+<h1>Uploading assets<a class="headerlink" href="#uploading-assets" title="Permalink to this headline">¶</a></h1>
+<p>With Usergrid, you can store and retrieve files and assets that hold
+data objects such as images, video, and audio content.</p>
+<p>Usergrid manages these objects as Asset entities. Optionally, you can
+use Folder entities to organize related assets.</p>
+<div class="section" id="id1">
+<h2>Uploading assets<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<p>Assets can be any file type and can be attached to any entity. When an
+asset is uploaded, Usergrid will automatically detect the file metadata
+for the asset and save it in the associated entity as a
+<code class="docutils literal"><span class="pre">file-metadata</span></code> property. Only 1 asset can be attached to an entity.</p>
+<p>To attach an asset to an entity, do the following:</p>
+<div class="section" id="request-syntax">
+<h3>Request syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity>
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>filename</td>
+<td>A filename to associate with the asset.</td>
+</tr>
+<tr class="row-odd"><td>file_location</td>
+<td>The location of the asset to be uploaded.</td>
+</tr>
+<tr class="row-even"><td>org Organization</td>
+<td>UUID or organization name</td>
+</tr>
+<tr class="row-odd"><td>app Application</td>
+<td>UUID or application name</td>
+</tr>
+<tr class="row-even"><td>collection</td>
+<td>Name or UUID of the collection of the entity you want to attach the asset to.</td>
+</tr>
+<tr class="row-odd"><td>entity</td>
+<td>Name or UUID of an existing entity you want to attach the asset to.</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="example-request">
+<h3>Example request<a class="headerlink" href="#example-request" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-python"><div class="highlight"><pre>curl -X POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/'
+</pre></div>
+</div>
+</div>
+<div class="section" id="example-response">
+<h3>Example response<a class="headerlink" href="#example-response" title="Permalink to this headline">¶</a></h3>
+<p>Notice the <code class="docutils literal"><span class="pre">file-metadata</span></code> property in the response.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"https://api.usergrid.com/amuramoto/sandbox/pictures"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"user"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"test"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1395681911491</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1399069838919</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"clouds"</span><span class="p">,</span>
+ <span class="s">"file"</span> <span class="p">:</span> <span class="s">"fobnszewobnioerabnoiawegbrn</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span>
+ <span class="s">"file-metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"content-type"</span> <span class="p">:</span> <span class="s">"image/jpeg"</span><span class="p">,</span>
+ <span class="s">"etag"</span> <span class="p">:</span> <span class="s">"</span><span class="se">\"</span><span class="s">2e1db7299b0a667ed80e674a0ef9d653</span><span class="se">\"</span><span class="s">"</span><span class="p">,</span>
+ <span class="s">"last-modified"</span> <span class="p">:</span> <span class="mi">1399070010115</span><span class="p">,</span>
+ <span class="s">"content-length"</span> <span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
+ <span class="s">"checksum"</span> <span class="p">:</span> <span class="s">"2e1db7299b0a667ed80e674a0ef9d653"</span>
+ <span class="p">},</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"connecting"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"likes"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376"</span><span class="p">,</span>
+ <span class="s">"sets"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"rolenames"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"permissions"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"</span>
+ <span class="p">},</span>
+ <span class="s">"connections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"follows"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"</span>
+ <span class="p">},</span>
+ <span class="s">"collections"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"activities"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/activities"</span><span class="p">,</span>
+ <span class="s">"devices"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/devices"</span><span class="p">,</span>
+ <span class="s">"feed"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/feed"</span><span class="p">,</span>
+ <span class="s">"groups"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/groups"</span><span class="p">,</span>
+ <span class="s">"roles"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/roles"</span><span class="p">,</span>
+ <span class="s">"following"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/following"</span><span class="p">,</span>
+ <span class="s">"followers"</span> <span class="p">:</span> <span class="s">"/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1399070009986</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">441</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="updating-assets">
+<h2>Updating assets<a class="headerlink" href="#updating-assets" title="Permalink to this headline">¶</a></h2>
+<p>To update the data for an asset, perform the same request outlined above
+in ‘Uploading assets’ as a <code class="docutils literal"><span class="pre">PUT</span></code> request rather than a <code class="docutils literal"><span class="pre">POST</span></code>.</p>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="retrieving-assets.html" class="btn btn-neutral float-right" title="Retrieving assets" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../geolocation/geolocation.html" class="btn btn-neutral" title="Geolocating your Entities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/counters-and-events/creating-and-incrementing-counters.html
----------------------------------------------------------------------
diff --git a/content/docs/counters-and-events/creating-and-incrementing-counters.html b/content/docs/counters-and-events/creating-and-incrementing-counters.html
index 511a0e3..1751de1 100644
--- a/content/docs/counters-and-events/creating-and-incrementing-counters.html
+++ b/content/docs/counters-and-events/creating-and-incrementing-counters.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul class="current">
@@ -163,6 +165,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/counters-and-events/events-and-counters.html
----------------------------------------------------------------------
diff --git a/content/docs/counters-and-events/events-and-counters.html b/content/docs/counters-and-events/events-and-counters.html
index d759fc5..80dbacc 100644
--- a/content/docs/counters-and-events/events-and-counters.html
+++ b/content/docs/counters-and-events/events-and-counters.html
@@ -32,7 +32,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
<link rel="next" title="Creating & incrementing counters" href="creating-and-incrementing-counters.html"/>
- <link rel="prev" title="Folders" href="../asset-and-files/folders.html"/>
+ <link rel="prev" title="Folders" href="../assets-and-files/folders.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul class="current">
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -242,7 +245,7 @@ you might track with a user-defined counter are:</p>
<a href="creating-and-incrementing-counters.html" class="btn btn-neutral float-right" title="Creating & incrementing counters" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../asset-and-files/folders.html" class="btn btn-neutral" title="Folders" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../assets-and-files/folders.html" class="btn btn-neutral" title="Folders" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/counters-and-events/retrieving-counters.html
----------------------------------------------------------------------
diff --git a/content/docs/counters-and-events/retrieving-counters.html b/content/docs/counters-and-events/retrieving-counters.html
index 9eff15a..9d59cef 100644
--- a/content/docs/counters-and-events/retrieving-counters.html
+++ b/content/docs/counters-and-events/retrieving-counters.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul class="current">
@@ -167,6 +169,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-queries/advanced-query-usage.html
----------------------------------------------------------------------
diff --git a/content/docs/data-queries/advanced-query-usage.html b/content/docs/data-queries/advanced-query-usage.html
index 7c1bfc1..fd64bd1 100644
--- a/content/docs/data-queries/advanced-query-usage.html
+++ b/content/docs/data-queries/advanced-query-usage.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -120,6 +121,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -144,9 +146,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -161,6 +163,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-queries/operators-and-types.html
----------------------------------------------------------------------
diff --git a/content/docs/data-queries/operators-and-types.html b/content/docs/data-queries/operators-and-types.html
index f021697..8065a00 100644
--- a/content/docs/data-queries/operators-and-types.html
+++ b/content/docs/data-queries/operators-and-types.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -121,6 +122,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -145,9 +147,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -162,6 +164,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -318,8 +321,8 @@ type-aware to ensure that query results are as you expect them to be.</p>
<p>For example, if you create an entity with a price property with a value
of 100.00, querying for 100 will return no results, since the API
expected a decimal-delimited float value in your query.</p>
-<p>For a list of property data types for each default entities, see Default
-Data Entity Types.</p>
+<p>For a list of property data types for each default entities, see
+<a class="reference external" href="../rest-endpoints/api-doc.html#models">Default Data Entities</a>s.</p>
<table class="usergrid-table">
<tr>
<td><p>string</p>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-queries/query-parameters.html
----------------------------------------------------------------------
diff --git a/content/docs/data-queries/query-parameters.html b/content/docs/data-queries/query-parameters.html
index bb5c638..6a94a0d 100644
--- a/content/docs/data-queries/query-parameters.html
+++ b/content/docs/data-queries/query-parameters.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -124,6 +125,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -148,9 +150,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -165,6 +167,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -297,7 +300,8 @@ only.</p>
<h2>Location<a class="headerlink" href="#location" title="Permalink to this headline">¶</a></h2>
<p>If you’ve stored location data with your entities, you can query for the
proximity of the geographical locations those entities represent. For
-more information on geolocation, see Geolocation.</p>
+more information on geolocation, see
+<a class="reference external" href="../geolocation/geolocation.html">Geolocation</a>.</p>
<table class="usergrid-table">
<tr>
<td><p>Goal</p>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-queries/querying-your-data.html
----------------------------------------------------------------------
diff --git a/content/docs/data-queries/querying-your-data.html b/content/docs/data-queries/querying-your-data.html
index 6a618a1..8a57ec0 100644
--- a/content/docs/data-queries/querying-your-data.html
+++ b/content/docs/data-queries/querying-your-data.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -125,6 +126,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -149,9 +151,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -166,6 +168,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -295,8 +298,8 @@ entities array. The array will include one JSON-object for each entity
returned for the query. Each returned entity will include a number of
default properties, including the UUID of the entity, the entity type,
and values for properties such as name, username, email, and so on. For
-a complete list of default properties by entity type, see Default Data
-Entity Types.</p>
+a complete list of default properties by entity type, see <a class="reference external" href="../rest-endpoints/api-doc.html#models">Default Data
+Entities</a>.</p>
<p>For example, the following query for all entities of type user where the
name property equals ‘Gladys Kravitz’:</p>
<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where name = ‘Gladys Kravitz’
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-storage/collections.html
----------------------------------------------------------------------
diff --git a/content/docs/data-storage/collections.html b/content/docs/data-storage/collections.html
index ef51089..a6aafc6 100644
--- a/content/docs/data-storage/collections.html
+++ b/content/docs/data-storage/collections.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -143,6 +144,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -167,9 +169,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -184,6 +186,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -253,8 +256,10 @@ empty collections if you wish, but creating an entity of a new type will
automatically create a corresponding collection for you. For example,
creating a new custom “item” entity, creates an “items” collection.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="creating-a-collection">
<h3>Creating a collection<a class="headerlink" href="#creating-a-collection" title="Permalink to this headline">¶</a></h3>
<p>The following example shows how to create an empty collection.
@@ -330,8 +335,10 @@ also use the LIMIT parameter in a query string to increase the number of
results returned. For more information on using cursors, see <a class="reference external" href="../data-queries/query-parameters.html">Query
Parameters</a>.</p>
</p></div><p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="retrieving-sets-of-entities-from-a-collection">
<h3>Retrieving sets of entities from a collection<a class="headerlink" href="#retrieving-sets-of-entities-from-a-collection" title="Permalink to this headline">¶</a></h3>
</div>
@@ -418,8 +425,10 @@ request, which can either specify all entities in the collection or a
subset of entities for the update to be performed on. For more
information on queries, see Querying your data.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="batch-updating-entities-in-a-collection">
<h3>Batch updating entities in a collection<a class="headerlink" href="#batch-updating-entities-in-a-collection" title="Permalink to this headline">¶</a></h3>
</div>
@@ -511,8 +520,10 @@ queries, see Querying your data.</p>
<p>Currently, collections cannot be deleted; however, you can delete all of
the entities from a collection.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="batch-deleting-entities-in-a-collection">
<h3>Batch deleting entities in a collection<a class="headerlink" href="#batch-deleting-entities-in-a-collection" title="Permalink to this headline">¶</a></h3>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-storage/data-store-dbms.html
----------------------------------------------------------------------
diff --git a/content/docs/data-storage/data-store-dbms.html b/content/docs/data-storage/data-store-dbms.html
index f30c742..32f37eb 100644
--- a/content/docs/data-storage/data-store-dbms.html
+++ b/content/docs/data-storage/data-store-dbms.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -226,14 +229,14 @@ databases.</p>
<div class="admonition note"> <p class="first admonition-title"><p>Note</p>
</p> <p class="last"><p>Usergrid is not a relational database. Optimizing for performance on a
non-relational database like Cassandra differs a bit from relational
-databases. For more information, see Optimizing access to your Usergrid
-data store.</p>
+databases. For more information, see <a class="reference external" href="../data-storage/optimizing-access.html">Optimizing access to your Usergrid
+data store</a>.</p>
</p> </div><p>Cassandra is specifically designed to support applications that need
flexibility and high scalability, particularly web and mobile
applications. Usergrid client applications write and read data formatted
as JavaScript Object Notation (JSON). (Usergrid provides SDKs through
which client apps can do much of this work in their native language. For
-more information, see Usergrid SDKs.)</p>
+more information, see <a class="reference external" href="../sdks/tbd.html">Usergrid SDKs</a>.)</p>
<p>With Cassandra as the underlying DBMS, apps benefit from:</p>
<p>Fast writes to the data store. * A distributed architecture that means
no single point of failure. * Flexibility in data model design. You
@@ -244,13 +247,13 @@ the high-level concepts of an RDBMS’s data model both to Cassandra’s and
to the Usergrid, which is backed by Cassandra.</p>
<table class="usergrid-table">
<tr>
- <td></td>
- <td><p>RDBMS</p>
-</td>
- <td><p>Cassandra</p>
-</td>
- <td><p>Usergrid</p>
-</td>
+ <th></th>
+ <th><p>RDBMS</p>
+</th>
+ <th><p>Cassandra</p>
+</th>
+ <th><p>Usergrid</p>
+</th>
</tr>
<tr>
<td><p>Each tuple is modeled as</p>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-storage/entities.html
----------------------------------------------------------------------
diff --git a/content/docs/data-storage/entities.html b/content/docs/data-storage/entities.html
index be4531f..2011fc0 100644
--- a/content/docs/data-storage/entities.html
+++ b/content/docs/data-storage/entities.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -156,6 +157,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -180,9 +182,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -197,6 +199,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -270,8 +273,10 @@ multiple words are keyword-indexed.</p>
entities. If you are using one of the Usergrid SDKs, use one of the
entity type-specific SDK methods to create default data entities.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="creating-a-custom-entity">
<h3>Creating a custom entity<a class="headerlink" href="#creating-a-custom-entity" title="Permalink to this headline">¶</a></h3>
<p>When a new entity is created, Usergrid will automatically create a
@@ -464,7 +469,8 @@ might store the different varieties of milk as sub-properties of a
<p>An array of sub-properties is treated as a single object. This means
that sub-properties cannot be updated atomically. All sub-properties of
a given property must be updated as a set. For more on updating an
-existing sub-property, see Updating Data Entities.</p>
+existing sub-property, see <a class="reference external" href="../data-storage/entities.html#updating-data-entities">Updating Data
+Entities</a>.</p>
<p>Example Request/Response</p>
<div class="highlight-python"><div class="highlight"><pre>Request:
//Note the use of square brackets for specifying multiple nested objects
@@ -514,8 +520,10 @@ Response:
<h2>Retrieving Data Entities<a class="headerlink" href="#retrieving-data-entities" title="Permalink to this headline">¶</a></h2>
<p>This article describes how to retrieve entities from your account.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<p>With the exception of the user entity, all data entities can be
retrieved by using their UUID or a ‘name’ property. The user entity can
be retrieved by UUID or the ‘username’ property. The value for the
@@ -694,8 +702,10 @@ requests</p>
<h2>Updating Data Entities<a class="headerlink" href="#updating-data-entities" title="Permalink to this headline">¶</a></h2>
<p>This article describes how to update entities in your account.</p>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="updating-an-entity">
<h3>Updating an entity<a class="headerlink" href="#updating-an-entity" title="Permalink to this headline">¶</a></h3>
<p>One or more properties can be updated with a single PUT request. For
@@ -865,8 +875,10 @@ sub-properties within it to be overwritten.</p>
<h2>Deleting Data Entities<a class="headerlink" href="#deleting-data-entities" title="Permalink to this headline">¶</a></h2>
<p>This article describes how to delete data entities.</p>
<p><strong>Note</strong>:Although not shown in the API examples below, you need to
-provide a valid access token with each API call. See Authenticating
-users and application clients for details.</p>
+provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
+users and application
+clients</a>
+for details.</p>
<div class="section" id="deleting-an-entity">
<h3>Deleting an entity<a class="headerlink" href="#deleting-an-entity" title="Permalink to this headline">¶</a></h3>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/data-storage/optimizing-access.html
----------------------------------------------------------------------
diff --git a/content/docs/data-storage/optimizing-access.html b/content/docs/data-storage/optimizing-access.html
index 43e215b..3a284b3 100644
--- a/content/docs/data-storage/optimizing-access.html
+++ b/content/docs/data-storage/optimizing-access.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -125,6 +126,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -149,9 +151,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -166,6 +168,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/entity-connections/connecting-entities.html
----------------------------------------------------------------------
diff --git a/content/docs/entity-connections/connecting-entities.html b/content/docs/entity-connections/connecting-entities.html
index d1bcda8..43b4a26 100644
--- a/content/docs/entity-connections/connecting-entities.html
+++ b/content/docs/entity-connections/connecting-entities.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -120,6 +121,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -144,9 +146,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -161,6 +163,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
[06/21] incubator-usergrid git commit: Minor refactoring in API doc
generation.
Posted by sn...@apache.org.
Minor refactoring in API doc generation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/fc52c0e0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/fc52c0e0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/fc52c0e0
Branch: refs/heads/master
Commit: fc52c0e0e036562d4928ebf2e5a83e07c9cfa6aa
Parents: 02fe929
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Aug 7 13:50:56 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Aug 7 13:50:56 2015 -0400
----------------------------------------------------------------------
docs/rest-endpoints/api-docs.html | 2350 +++++++-----------
docs/rest-endpoints/api-docs.md | 57 +-
.../main/groovy/usergrid/ApiDocGenerator.groovy | 43 +-
docs/src/main/resources/file-end-html.mustache | 13 -
.../src/main/resources/file-start-html.mustache | 21 -
docs/src/main/resources/html/file-end.mustache | 13 +
.../src/main/resources/html/file-start.mustache | 21 +
docs/src/main/resources/html/model.mustache | 38 +
docs/src/main/resources/html/operation.mustache | 43 +
.../main/resources/markdown/file-start.mustache | 13 +
docs/src/main/resources/markdown/model.mustache | 21 +
.../main/resources/markdown/operation.mustache | 21 +
docs/src/main/resources/model-html.mustache | 38 -
docs/src/main/resources/model.mustache | 21 -
docs/src/main/resources/operation-html.mustache | 43 -
docs/src/main/resources/operation.mustache | 21 -
docs/update-api-docs.sh | 2 +-
17 files changed, 1130 insertions(+), 1649 deletions(-)
----------------------------------------------------------------------
[12/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/ios.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/ios.html b/content/docs/sdks/ios.html
index e77c1c5..b3b4421 100644
--- a/content/docs/sdks/ios.html
+++ b/content/docs/sdks/ios.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -216,6 +219,128 @@
<div class="section" id="ios-sdk">
<h1>iOS SDK<a class="headerlink" href="#ios-sdk" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="version">
+<h2>Version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
+<p>Current Version: <strong>0.9.2</strong></p>
+<p>Change log:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md">https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md</a></p>
+</div>
+<div class="section" id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
+<p>This open source SDK simplifies writing iOS applications that connect to
+App Services (Usergrid). The repo is located here:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk">https://github.com/apigee/usergrid-ios-sdk</a></p>
+<p>You can download the SDK here:</p>
+<ul class="simple">
+<li>Download as a zip file:
+<a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk/archive/master.zip">https://github.com/apigee/usergrid-ios-sdk/archive/master.zip</a></li>
+<li>Download as a tar.gz file:
+<a class="reference external" href="https://github.com/apigee/usergrid-ios-sdk/archive/master.tar.gz">https://github.com/apigee/usergrid-ios-sdk/archive/master.tar.gz</a></li>
+</ul>
+<p>To find out more about App Services, which is Apigee’s hosted Usergrid
+solution, see:</p>
+<p><a class="reference external" href="http://apigee.com/about/developers">http://apigee.com/about/developers</a></p>
+<p>To view the Apigee App Services documentation, see:</p>
+<p><a class="reference external" href="http://apigee.com/docs/app_services">http://apigee.com/docs/app_services</a></p>
+</div>
+<div class="section" id="installing">
+<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
+<p>Once you have downloaded the SDK, add the UGAPI folder to your project
+by dragging and dropping it into your project.</p>
+<p><strong>Note:</strong> Make sure you check the “Copy items into destination group’s
+folder”, and also make sure the appropriate boxes are checked next to
+“Add to targets”.</p>
+</div>
+<div class="section" id="getting-started">
+<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
+<p>If you haven’t done so, make sure you know your organization name and
+your application name. Your organization name will be the same as the
+username you signed up with.</p>
+<p>Within your organization, you can have multiple application namespaces.
+By default, an application named “Sandbox” has been created for you to
+use for testing, but you can also log into the <a class="reference external" href="http://apigee.com/usergrid">Admin
+Portal</a> and create an application with
+any name you want.</p>
+<p>Once you have your application name, you will want to create a UGClient
+object like so:</p>
+<div class="highlight-python"><div class="highlight"><pre>//configure the org and app
+NSString * orgName = @"ApigeeOrg";
+NSString * appName = @"MessageeApp";
+
+//make new client
+usergridClient = [[UGClient alloc]initWithOrganizationId: orgName withApplicationID: appName];
+</pre></div>
+</div>
+<p>Now use the usergridClient object to invoke other methods that access
+the API. For example, to log a user in:</p>
+<div class="highlight-python"><div class="highlight"><pre>[usergridClient logInUser:username password:password];
+UGUser *user = [usergridClient getLoggedInUser];
+</pre></div>
+</div>
+<p>Or, to create a user:</p>
+<div class="highlight-python"><div class="highlight"><pre>UGClientResponse *response = [usergridClient addUser:@"myusername" email:@"email@email.com" name:@"my name" password:@"mypassword"];
+if (response.transactionState == 0) {
+ //user created!
+}
+</pre></div>
+</div>
+</div>
+<div class="section" id="sample-code">
+<h2>Sample Code<a class="headerlink" href="#sample-code" title="Permalink to this headline">¶</a></h2>
+<p>If you are ready to look at a fully functional app that uses this SDK,
+check out our Messagee application. It is a twitter-type app that
+exercises many parts of the API including: Login / Authentication, GET
+and POST operations, activities (tweets), and social features such as
+following relationships.</p>
+<p>The Messagee Xcode project is located here:</p>
+<p><a class="reference external" href="https://github.com/apigee/usergrid-sample-ios-messagee">https://github.com/apigee/usergrid-sample-ios-messagee</a></p>
+</div>
+<div class="section" id="running-tests">
+<h2>Running Tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h2>
+<p>The iOS SDK unit tests are written with Nu. You’ll need to install the
+language itself to run the tests, and use the Nukefile to create a
+Usergrid.framework. For installation directions go
+<a class="reference external" href="https://github.com/timburks/nu">here</a></p>
+<p>To compile the Usergrid SDK as an Objective-C framework simple type
+<code class="docutils literal"><span class="pre">nuke</span></code> to build the framework and then <code class="docutils literal"><span class="pre">nuke</span> <span class="pre">install</span></code> to install it
+in the /Library/Frameworks path.</p>
+<p>To run the unit tests written for the SDK use the command <code class="docutils literal"><span class="pre">nuke</span> <span class="pre">test</span></code>
+this will run all tests.</p>
+</div>
+<div class="section" id="contributing">
+<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
+<p>We welcome your enhancements!</p>
+<p>Like <a class="reference external" href="https://github.com/apigee/usergrid-node-module">Usergrid</a>, the
+Usergrid Objective-C SDK is open source and licensed under the Apache
+License, Version 2.0.</p>
+<ol class="arabic simple">
+<li>Fork it</li>
+<li>Create your feature branch (<code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">-b</span> <span class="pre">my-new-feature</span></code>)</li>
+<li>Commit your changes (<code class="docutils literal"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-am</span> <span class="pre">'Added</span> <span class="pre">some</span> <span class="pre">feature'</span></code>)</li>
+<li>Push your changes to the upstream branch
+(<code class="docutils literal"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">my-new-feature</span></code>)</li>
+<li>Create new Pull Request (make sure you describe what you did and why
+your mod is needed)</li>
+</ol>
+</div>
+<div class="section" id="more-information">
+<h2>More information<a class="headerlink" href="#more-information" title="Permalink to this headline">¶</a></h2>
+<p>For more information on Apigee App Services, visit
+<a class="reference external" href="http://apigee.com/about/developers">http://apigee.com/about/developers</a>.</p>
+</div>
+<div class="section" id="copyright">
+<h2>Copyright<a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h2>
+<p>Copyright 2013 Apigee Corporation</p>
+<p>Licensed under the Apache License, Version 2.0 (the “License”); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at</p>
+<p><a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
+<p>Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.</p>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/sdk-outline.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/sdk-outline.html b/content/docs/sdks/sdk-outline.html
new file mode 100644
index 0000000..e2a42bb
--- /dev/null
+++ b/content/docs/sdks/sdk-outline.html
@@ -0,0 +1,503 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Usergrid SDK Documentation outline — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Usergrid SDK Documentation outline</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/sdks/sdk-outline.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="usergrid-sdk-documentation-outline">
+<h1>Usergrid SDK Documentation outline<a class="headerlink" href="#usergrid-sdk-documentation-outline" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="getting-started">
+<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="installing-the-sdk">
+<h3>Installing the SDK<a class="headerlink" href="#installing-the-sdk" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="building-from-source">
+<h3>Building from Source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="usergrid-sdk-reference-with-examples">
+<h1>Usergrid SDK Reference with Examples<a class="headerlink" href="#usergrid-sdk-reference-with-examples" title="Permalink to this headline">¶</a></h1>
+<p>The 66 topics listed below are each documented in the Usergrid
+documentation and for each the docs provide an API reference and example
+for each of these clients: curl, iOS, Android, JavaScript, Ruby and
+Node.js.</p>
+<div class="section" id="working-with-collections">
+<h2>Working with Collections<a class="headerlink" href="#working-with-collections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-collections">
+<h3>1. Creating collections<a class="headerlink" href="#creating-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-collections">
+<h3>2. Retrieving collections<a class="headerlink" href="#retrieving-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-collections">
+<h3>3. Updating collections<a class="headerlink" href="#updating-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="deleting-collections">
+<h3>4. Deleting collections<a class="headerlink" href="#deleting-collections" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="working-with-entities">
+<h2>Working with Entities<a class="headerlink" href="#working-with-entities" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-a-custom-entity">
+<h3>5. Creating a custom entity<a class="headerlink" href="#creating-a-custom-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-multiple-custom-entities">
+<h3>6. Creating multiple custom entities<a class="headerlink" href="#creating-multiple-custom-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-entity-with-sub-properties">
+<h3>7. Creating an entity with sub-properties<a class="headerlink" href="#creating-an-entity-with-sub-properties" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-an-entity">
+<h3>8. Retrieving an entity<a class="headerlink" href="#retrieving-an-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-multiple-entities">
+<h3>9. Retrieving multiple entities<a class="headerlink" href="#retrieving-multiple-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-an-entity">
+<h3>10. Updating an entity<a class="headerlink" href="#updating-an-entity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-a-sub-property">
+<h3>11. Updating a sub-property<a class="headerlink" href="#updating-a-sub-property" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="deleting-data-entities">
+<h3>12. Deleting data entities<a class="headerlink" href="#deleting-data-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="data-queries">
+<h2>Data Queries<a class="headerlink" href="#data-queries" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="querying-your-data">
+<h3>13. Querying your data<a class="headerlink" href="#querying-your-data" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="entity-connections">
+<h2>Entity Connections<a class="headerlink" href="#entity-connections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="connecting-users-other-data">
+<h3>14. Connecting users other data<a class="headerlink" href="#connecting-users-other-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-user-connection-data">
+<h3>15. Retrieving user connection data<a class="headerlink" href="#retrieving-user-connection-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="disconnecting-entities">
+<h3>16. Disconnecting entities<a class="headerlink" href="#disconnecting-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="permissions-roles">
+<h2>Permissions & Roles<a class="headerlink" href="#permissions-roles" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="assigning-permissions">
+<h3>17. Assigning permissions<a class="headerlink" href="#assigning-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-permissions">
+<h3>18. Removing permissions<a class="headerlink" href="#removing-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id1">
+<h3>19. Assigning permissions<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id2">
+<h3>20. Removing permissions<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-roles">
+<h3>21. Creating roles<a class="headerlink" href="#creating-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="assigning-roles">
+<h3>22. Assigning roles<a class="headerlink" href="#assigning-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-roles">
+<h3>23. Removing roles<a class="headerlink" href="#removing-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="authentication">
+<h2>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="application-user-authentication-user-login">
+<h3>24. Application user authentication (user login)<a class="headerlink" href="#application-user-authentication-user-login" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="application-client-authentication">
+<h3>25. Application client authentication<a class="headerlink" href="#application-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="admin-user-authentication">
+<h3>26. Admin user authentication<a class="headerlink" href="#admin-user-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="organization-client-authentication">
+<h3>27. Organization client authentication<a class="headerlink" href="#organization-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="revoking-tokens-user-logout">
+<h3>28. Revoking tokens (user logout)<a class="headerlink" href="#revoking-tokens-user-logout" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="working-with-users-groups">
+<h1>Working with Users & Groups<a class="headerlink" href="#working-with-users-groups" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="activities-feeds">
+<h2>Activities & Feeds<a class="headerlink" href="#activities-feeds" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="posting-a-user-activity">
+<h3>37. Posting a user activity<a class="headerlink" href="#posting-a-user-activity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="posting-an-activity-to-a-group">
+<h3>38. Posting an activity to a group<a class="headerlink" href="#posting-an-activity-to-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-activity-for-a-user-s-followers-in-a-group">
+<h3>39. Creating an activity for a user’s followers in a group<a class="headerlink" href="#creating-an-activity-for-a-user-s-followers-in-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-user-s-activity-feed">
+<h3>40. Retrieving a user’s activity feed<a class="headerlink" href="#retrieving-a-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-group-s-activity-feed">
+<h3>41. Retrieving a group’s activity feed<a class="headerlink" href="#retrieving-a-group-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="events-counters">
+<h2>Events & Counters<a class="headerlink" href="#events-counters" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-incrementing-counters">
+<h3>42. Creating & incrementing counters<a class="headerlink" href="#creating-incrementing-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters">
+<h3>43. Retrieving counters<a class="headerlink" href="#retrieving-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters-by-time-interval">
+<h3>44. Retrieving counters by time interval<a class="headerlink" href="#retrieving-counters-by-time-interval" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-orgs-apps">
+<h2>Managing Orgs & Apps<a class="headerlink" href="#managing-orgs-apps" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-organization">
+<h3>46. Creating an organization<a class="headerlink" href="#creating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization">
+<h3>47. Getting an organization<a class="headerlink" href="#getting-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-organization">
+<h3>48. Activating an organization<a class="headerlink" href="#activating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-organization">
+<h3>49. Reactivating an organization<a class="headerlink" href="#reactivating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-organization-client-credentials">
+<h3>50. Generating organization client credentials<a class="headerlink" href="#generating-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-organization-client-credentials">
+<h3>51. Retrieving organization client credentials<a class="headerlink" href="#retrieving-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization-s-activity-feed">
+<h3>52. Getting an organization’s activity feed<a class="headerlink" href="#getting-an-organization-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-applications-in-an-organization">
+<h3>53. Getting the applications in an organization<a class="headerlink" href="#getting-the-applications-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-admin-users-in-an-organization">
+<h3>54. Getting the admin users in an organization<a class="headerlink" href="#getting-the-admin-users-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-an-admin-user-from-an-organization">
+<h3>55. Removing an admin user from an organization<a class="headerlink" href="#removing-an-admin-user-from-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-organization-application">
+<h3>56. Creating an organization application<a class="headerlink" href="#creating-an-organization-application" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-application-credentials">
+<h3>57. Generating application credentials<a class="headerlink" href="#generating-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-application-credentials">
+<h3>58. Getting application credentials<a class="headerlink" href="#getting-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-admin-users">
+<h2>Managing Admin Users<a class="headerlink" href="#managing-admin-users" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-admin-user">
+<h3>59. Creating an admin user<a class="headerlink" href="#creating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-an-admin-user">
+<h3>60. Updating an admin user<a class="headerlink" href="#updating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user">
+<h3>61. Getting an admin user<a class="headerlink" href="#getting-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="setting-an-admin-user-s-password">
+<h3>62. Setting an admin user’s password<a class="headerlink" href="#setting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="resetting-an-admin-user-s-password">
+<h3>63. Resetting an admin user’s password<a class="headerlink" href="#resetting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-admin-user">
+<h3>64. Activating an admin user<a class="headerlink" href="#activating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-admin-user">
+<h3>65. Reactivating an admin user<a class="headerlink" href="#reactivating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user-s-activity-feed">
+<h3>66. Getting an admin user’s activity feed<a class="headerlink" href="#getting-an-admin-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/tbd.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/tbd.html b/content/docs/sdks/tbd.html
index a266bfa..7174209 100644
--- a/content/docs/sdks/tbd.html
+++ b/content/docs/sdks/tbd.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/search.html
----------------------------------------------------------------------
diff --git a/content/docs/search.html b/content/docs/search.html
index bddb739..0c0687e 100644
--- a/content/docs/search.html
+++ b/content/docs/search.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
[20/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/rest-endpoints/api-docs.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/rest-endpoints/api-docs.txt b/content/docs/_sources/rest-endpoints/api-docs.txt
index 93a6e32..51f1909 100644
--- a/content/docs/_sources/rest-endpoints/api-docs.txt
+++ b/content/docs/_sources/rest-endpoints/api-docs.txt
@@ -1,212 +1,44 @@
-## 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)
+<h1>Usergrid API Reference</h1>
-__default__
+Methods are organized by tag. Follow the methods are the [Model Definitions](#models).
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
+<h2>Table of Contents</h2>
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</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)
-Set a user's password or reset the user's existing password.
+<br>
+<br>
-<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).
+## Methods
-<h3>Responses</h3>
-__200__
-
-* Description: An array of complete messages.
-* Schema: [Action](#action)
-
-__default__
+### Access-Tokens
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-### ActivityFeed Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
+<h2 class="usergrid-POST-heading">POST /management/token</h2>
-Retrieve an organization's activity feed.
+Login with Admin-User or Organization credentials.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
+* __login-credentials__ ([LoginCredentials](#logincredentials))
+Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: Object containing access_token.
+* Schema: [AccessTokenReponse](#accesstokenreponse)
__default__
@@ -214,21 +46,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
-Retrieve an admin user's activity feed.
+Login with App-User or Application credentials.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __login-credentials__ ([LoginCredentials](#logincredentials))
+Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of new created Admin user's info.
+* Schema: [AccessTokenReponse](#accesstokenreponse)
__default__
@@ -236,33 +68,8 @@ __default__
* 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__
+### Activities
-* 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>
@@ -343,72 +150,25 @@ __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>
+### Admin-Users
-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>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
-Retrieve the client Id and client secret credentials for an application in an organization.
+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).
-* __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)
+* Description: An array of retrieved Admin user's info.
+* Schema: [User](#user)
__default__
@@ -416,23 +176,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
-Generate the client Id and client secret credentials for an application in an organization.
+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).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __userId-2__ (string)
+One of the user's identification which includes username, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of generated credentials info.
-* Schema: [Credential](#credential)
+* Description: An array of deleted Admin user's info.
+* Schema: [User](#user)
__default__
@@ -440,21 +200,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-POST-heading">POST /management/users</h2>
-Retrieve the credentials for an organization client.
+Create a whole new admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
+* __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 Credential
-* Schema: [Credential](#credential)
+* Description: An array of new created Admin user's info.
+* Schema: [User](#user)
__default__
@@ -462,79 +222,63 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
-Generate whole new credentials for an organization client.
+Initiate the reset of an admin user's password.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Devices Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue</h2>
+<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
-Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.
+Complete the password reset through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
+* __ResetPWMsg__ ([ResetPWMsg](#resetpwmsg))
+Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved device's info.
-* Schema: [Device](#device)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Entity Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
-Retrieve a user's collections or connections through query statement.
+Retrieve details about an admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __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 collections info.
-* Schema: [Entity](#entity)
+* Description: An array of user's details
+* Schema: [User](#user)
__default__
@@ -542,27 +286,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
-Retrieve collection through query statement.
+Update the info of an admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved collection's info.
-* Schema: [Entity](#entity)
+* Description: An array of user's details.
+* Schema: [User](#user)
__default__
@@ -570,27 +308,25 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
-Update collection through query statement.
+Activate an admin user from a link provIded in an email notification.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __userId__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __token__ (string)
+Activation token's query statement. (Specified in query).
+* __confirm_email__ (boolean)
+Query statement of whether send confimation email or not. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of updated collection's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -598,31 +334,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
-Add an entity to a collection through providing all the identifications.
+Update an admin user's password through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __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 added entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -630,31 +358,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
-Remove an entity from a collection through providing all the identifications.
+Reactivate an expired admin user.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __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 deleted entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -662,37 +380,12 @@ __default__
* 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__
+### App-Users
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
-One or more properties can be updated with a single request.
+Retrieve users though query statement.
<h3>Parameters</h3>
@@ -700,19 +393,15 @@ One or more properties can be updated with a single request.
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).
+* __queryStatement__ (string)
+The query statement of the User. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of updated entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of retrieved user's info.
+* Schema: [User](#user)
__default__
@@ -720,9 +409,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
-Delete an entity from the collection.
+Create a user in the users collection through providing all the identifications.
<h3>Parameters</h3>
@@ -730,17 +419,15 @@ Delete an entity from the collection.
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).
+* __CreateUser__ ([CreateUser](#createuser))
+The properties of the user. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of created user's info.
+* Schema: [User](#user)
__default__
@@ -748,9 +435,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</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.
+Retrieve a user through providing all the identifications.
<h3>Parameters</h3>
@@ -758,28 +445,25 @@ When a new entity is created, Usergrid will automatically create a corresponding
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).
+* __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 created custom entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of retrieved user's info.
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Event Methods
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
-Create an event through providing both Id of organization and application.
+Update a user through providing all the identifications.
<h3>Parameters</h3>
@@ -787,26 +471,25 @@ Create an event through providing both Id of organization and application.
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).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created event's info.
-* Schema: [Event](#event)
+* Description: An array of updated user's info.
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Group Methods
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
-Create a new group through providing both Id of organization and application.
+Remove a user through providing all the identifications.
<h3>Parameters</h3>
@@ -814,15 +497,15 @@ Create a new group through providing both Id of organization and application.
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).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created group's info.
-* Schema: [Group](#group)
+* Description: An array of deleted user's info.
+* Schema: [User](#user)
__default__
@@ -830,9 +513,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
-Get a group through through providing all the identifications.
+Set a user's password or reset the user's existing password.
<h3>Parameters</h3>
@@ -840,15 +523,17 @@ Get a group through through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
+* __username__ (string)
+The username of the user. (Specified in path).
+* __ResetPW__ ([ResetPW](#resetpw))
+The user's old and new password. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved group's info.
-* Schema: [Group](#group)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -856,9 +541,12 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
+### Entities-Collections
-Update a group through providing all the identifications.
+
+<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>
@@ -866,40 +554,47 @@ Update a group through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __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).
+* __relation__ (string)
+The relation between user and collections. (Specified in path).
+* __queryStatement__ (string)
+The query statement of the user. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of updated group's info.
-* Schema: [Group](#group)
+* Description: An array of user's collections info.
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Notification Methods
-<h2 class="usergrid-PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
-Cancel sent notifications through providing the Id of the notification.
+Retrieve collection through query statement.
<h3>Parameters</h3>
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
-* __cancelMsg__ ([CancelMSG](#cancelmsg))
-Indicete whether is canceled or not. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __queryStatement__ (string)
+Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of canceled notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of retrieved collection's info.
+* Schema: [Entity](#entity)
__default__
@@ -907,9 +602,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices</h2>
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
-Create notifications for user through targeting by location and providing all the identifications.
+Update collection through query statement.
<h3>Parameters</h3>
@@ -917,21 +612,17 @@ Create notifications for user through targeting by location and providing all th
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notification__ ([CreateNotifications](#createnotifications))
-These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
-* __queryStatement__ ()
-The query statement of the location of the user. (Specified in query).
+* __collectionId__ (string)
+One of the collection's identification which includes name or uuid. (Specified in path).
+* __queryStatement__ (string)
+Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of updated collection's info.
+* Schema: [Entity](#entity)
__default__
@@ -939,9 +630,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices/*/notifications</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
-Create notifications for all devices. This request will target all device entities.
+Add an entity to a collection through providing all the identifications.
<h3>Parameters</h3>
@@ -949,19 +640,21 @@ Create notifications for all devices. This request will target all device entiti
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notification__ ([CreateNotifications](#createnotifications))
-These parameters are used when forming the notification portion of the request. (Specified in body).
-* __scheduleNotification__ ([ScheduleNotification](#schedulenotification))
-To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body).
-* __setExpiration__ ([SetExpiration](#setexpiration))
-If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
+* __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 created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of added entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -969,9 +662,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/devices/{deviceId}/notifications</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
-Create notifications for a single device. This request will target a specific device entity.
+Remove an entity from a collection through providing all the identifications.
<h3>Parameters</h3>
@@ -979,21 +672,21 @@ Create notifications for a single device. This request will target a specific de
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).
+* __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 created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of deleted entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -1001,9 +694,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{path}/notifications</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
-Create notifications for a group. This request will target all users associated with a specific group entity.
+Retrieve an entity through providing Id of application, organization, collection and entity.
<h3>Parameters</h3>
@@ -1011,21 +704,17 @@ Create notifications for a group. This request will target all users associated
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).
+* __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 created notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of retrieved entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -1033,9 +722,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/notifications</h2>
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
-Retrieve one or more notifications through providing all the identifications.
+One or more properties can be updated with a single request.
<h3>Parameters</h3>
@@ -1043,13 +732,19 @@ Retrieve one or more notifications through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __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 retrieved notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of updated entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -1057,9 +752,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/notifications/{notificationId}</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
-Remove unsent notifications through providing all the identifications.
+Delete an entity from the collection.
<h3>Parameters</h3>
@@ -1067,15 +762,17 @@ Remove unsent notifications through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
+* __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 notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of deleted entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -1083,9 +780,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/notifications</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2>
-Create notifications for a user. This request will target a specific user entity.
+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>
@@ -1093,21 +790,17 @@ Create notifications for a user. This request will target a specific user entity
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).
+* __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 notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of created custom entity's info.
+* Schema: [Entity](#entity)
__default__
@@ -1115,9 +808,12 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{receiptId}/*/notifications</h2>
+### Events
-Retrieve notifications associated with one or more receipts through providing all the identifications.
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
+
+Create an event through providing both Id of organization and application.
<h3>Parameters</h3>
@@ -1125,38 +821,44 @@ Retrieve notifications associated with one or more receipts through providing al
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).
+* __CreateEvent__ ([CreateEvent](#createevent))
+The required property of the event. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved notification's info.
-* Schema: [Notification](#notification)
+* Description: An array of created event's info.
+* Schema: [Event](#event)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Organization Methods
-<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+### Groups
-Create an organization through a form post.
+
+<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>
-* __CreateOrg__ ([CreateOrg](#createorg))
-A set of organization properties supplied through a form. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __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 Organization.
-* Schema: [Organization](#organization)
+* Description: An array of created group's info.
+* Schema: [Group](#group)
__default__
@@ -1164,32 +866,37 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
-Retrieve an organization given a specified UUID or username.
+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 created Organization.
-* Schema: [Organization](#organization)
+* Description: An array of user's activity.
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Permission Methods
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
-Remove permissions from a role.
+Add a user to a group through providing all the identifications.
<h3>Parameters</h3>
@@ -1197,28 +904,27 @@ Remove permissions from a role.
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).
+* __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 permission's info.
-* Schema: [Permission](#permission)
+* Description: An array of added user's info.
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Receipt Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/receipts</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
-Retrieve one or more receipts through providing all the identifications.
+Delete user from a group through providing all the identifications.
<h3>Parameters</h3>
@@ -1226,13 +932,17 @@ Retrieve one or more receipts through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __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 retrieved receipt's info.
-* Schema: [Receipt](#receipt)
+* Description: An array of deleted user's info.
+* Schema: [User](#user)
__default__
@@ -1240,9 +950,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{deviceId}/*/receipts</h2>
+<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
-Retrieve receipts associated with one or more devices through providing all the identifications.
+Get a group through through providing all the identifications.
<h3>Parameters</h3>
@@ -1250,15 +960,15 @@ Retrieve receipts associated with one or more devices through providing all the
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).
+* __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 receipt's info.
-* Schema: [Receipt](#receipt)
+* Description: An array of retrieved group's info.
+* Schema: [Group](#group)
__default__
@@ -1266,9 +976,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/receipts</h2>
+<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
-Retrieve receipts for one or more notifications through providing all the identifications."
+Update a group through providing all the identifications.
<h3>Parameters</h3>
@@ -1276,40 +986,40 @@ Retrieve receipts for one or more notifications through providing all the identi
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).
+* __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 receipt's info.
-* Schema: [Receipt](#receipt)
+* Description: An array of updated group's info.
+* Schema: [Group](#group)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Role Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+### Organizations-Applications
-Retrieve the roles in an application through providing all the identifications.
+
+<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+
+Create an organization through a form post.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
+* __CreateOrg__ ([CreateOrg](#createorg))
+A set of organization properties supplied through a form. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved role's info.
-* Schema: [Role](#role)
+* Description: An array of created Organization.
+* Schema: [Organization](#organization)
__default__
@@ -1317,25 +1027,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
-Create a new role through providing all the identifications.
+Retrieve an organization given a specified UUID or username.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __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)
+* Description: An array of created Organization.
+* Schema: [Organization](#organization)
__default__
@@ -1343,36 +1049,35 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
-Remove a role through providing all the identifications.
+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).
-* __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).
+* __token__ (string)
+Activation token. (Specified in query).
+* __confirm_email__ (boolean)
+Send confirmation email or not. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of deleted role's info.
-* Schema: [Role](#role)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### User Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
-Retrieve details about the admin users in an organization.
+Retrieve the applications in an organization through providing both Id of application and organization.
<h3>Parameters</h3>
@@ -1383,8 +1088,8 @@ 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)
+* Description: An array of retrieved application data.
+* Schema: [AppData](#appdata)
__default__
@@ -1392,23 +1097,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
-Remove an admin user from an organization through providing both Id of application and organization.
+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).
-* __userId-2__ (string)
-One of the user's identification which includes username, email address 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 Admin user's info.
-* Schema: [User](#user)
+* Description: An array of retrieved credentials info.
+* Schema: [Credential](#credential)
__default__
@@ -1416,21 +1121,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /management/users</h2>
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
-Create a whole new admin user.
+Generate the client Id and client secret credentials for an application in an organization.
<h3>Parameters</h3>
-* __adminuserproperty__ ([CreateAdminUser](#createadminuser))
-One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [User](#user)
+* Description: An array of generated credentials info.
+* Schema: [Credential](#credential)
__default__
@@ -1438,21 +1145,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
-Retrieve details about an admin user.
+Retrieve the credentials for an organization client.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of user's details
-* Schema: [User](#user)
+* Description: An array of Credential
+* Schema: [Credential](#credential)
__default__
@@ -1460,21 +1167,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
-Update the info of an admin user.
+Generate whole new credentials for an organization client.
<h3>Parameters</h3>
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of user's details.
-* Schema: [User](#user)
+* Description: An array of Credential
+* Schema: [Credential](#credential)
__default__
@@ -1482,27 +1189,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
-Add a user to a group through providing all the identifications.
+Retrieve an organization's activity feed.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of added user's info.
-* Schema: [User](#user)
+* Description: An array of the organization's ActivityFeed.
+* Schema: [ActivityFeed](#activityfeed)
__default__
@@ -1510,27 +1211,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
-Delete user from a group through providing all the identifications.
+Reactivate an expired 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).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -1538,25 +1233,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
-Retrieve the users in a role through providing all the identifications.
+Retrieve an admin user's activity feed.
<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__ (string)
+One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An array of user's activity
+* Schema: [ActivityFeed](#activityfeed)
__default__
@@ -1564,9 +1255,12 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+### Permissions-Roles
-Add a user to a role through providing all the identifications.
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+
+Retrieve the roles in an application through providing all the identifications.
<h3>Parameters</h3>
@@ -1574,17 +1268,13 @@ Add a user to a role through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __roleId__ (string)
-One of the role's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of added user's info.
-* Schema: [User](#user)
+* Description: An array of retrieved role's info.
+* Schema: [Role](#role)
__default__
@@ -1592,9 +1282,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
-Remove a user from a role through providing all the identifications.
+Create a new role through providing all the identifications.
<h3>Parameters</h3>
@@ -1602,17 +1292,15 @@ Remove a user from a role through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __roleId__ (string)
-One of the role's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username 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 deleted user's info.
-* Schema: [User](#user)
+* Description: An array of created role's info.
+* Schema: [Role](#role)
__default__
@@ -1620,9 +1308,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
-Retrieve users though query statement.
+Remove permissions from a role.
<h3>Parameters</h3>
@@ -1630,15 +1318,17 @@ Retrieve users though query statement.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __queryStatement__ ()
-The query statement of the User. (Specified in query).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __grant_url_pattern__ (string)
+The query statement of the url pattern. (Specified in query).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An array of deleted permission's info.
+* Schema: [Permission](#permission)
__default__
@@ -1646,9 +1336,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
-Create a user in the users collection through providing all the identifications.
+Retrieve the users in a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1656,14 +1346,14 @@ Create a user in the users collection through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __CreateUser__ ([CreateUser](#createuser))
-The properties of the user. (Specified in body).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of created user's info.
+* Description: An array of retrieved user's info.
* Schema: [User](#user)
__default__
@@ -1672,9 +1362,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
-Retrieve a user through providing all the identifications.
+Add a user to a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1682,14 +1372,16 @@ Retrieve a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-2__ (string)
-One of the user's identification which includes username, email address or UUID. (Specified in path).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved user's info.
+* Description: An array of added user's info.
* Schema: [User](#user)
__default__
@@ -1698,9 +1390,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
-Update a user through providing all the identifications.
+Remove a user from a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1708,6 +1400,8 @@ Update a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
+* __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).
@@ -1715,7 +1409,7 @@ One of the user's identification which includes username or UUID. (Specified
__200__
-* Description: An array of updated user's info.
+* Description: An array of deleted user's info.
* Schema: [User](#user)
__default__
@@ -1724,9 +1418,9 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
-Remove a user through providing all the identifications.
+Remove a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1734,15 +1428,15 @@ Remove a user through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __userId-3__ (string)
-One of the user's identification which includes username or UUID. (Specified in path).
+* __rolename__ (string)
+The name of the role. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Description: An array of deleted role's info.
+* Schema: [Role](#role)
__default__
@@ -1753,6 +1447,37 @@ __default__
## Models
Properties for 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__
@@ -2638,6 +2363,49 @@ __Properties__
</tr>
</table>
+### 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>
+</table>
+
### Metadata
__Properties__
[02/21] incubator-usergrid git commit: Fixing more missing references.
Posted by sn...@apache.org.
Fixing more missing references.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/fa4c74aa
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/fa4c74aa
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/fa4c74aa
Branch: refs/heads/master
Commit: fa4c74aa2630193dfc15d33dc959d30211419330
Parents: c886d1f
Author: Dave Johnson <sn...@apache.org>
Authored: Thu Aug 6 13:10:32 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Thu Aug 6 13:10:32 2015 -0400
----------------------------------------------------------------------
docs/data-queries/operators-and-types.md | 2 +-
docs/data-queries/query-parameters.md | 2 +-
docs/data-queries/querying-your-data.md | 2 +-
docs/data-storage/collections.md | 8 ++++----
docs/data-storage/data-store-dbms.md | 4 ++--
docs/data-storage/entities.md | 10 +++++-----
docs/entity-connections/retrieving-entities.md | 9 ++++-----
docs/geolocation/geolocation.md | 2 +-
docs/getting-started/creating-a-new-application.md | 6 ++++--
docs/getting-started/creating-account.md | 6 +++---
docs/getting-started/using-a-sandbox-app.md | 2 +-
docs/getting-started/using-the-api.md | 2 +-
docs/index.rst | 2 +-
docs/introduction/data-model.md | 2 +-
docs/orgs-and-apps/application.md | 2 +-
docs/security-and-auth/authenticating-api-requests.md | 6 +++---
.../authenticating-users-and-application-clients.md | 6 +++---
docs/security-and-auth/facebook-sign.md | 2 +-
docs/security-and-auth/user-authentication-types.md | 6 +++---
docs/security-and-auth/using-permissions.md | 2 +-
docs/security-and-auth/using-roles.md | 2 +-
docs/user-management/activity.md | 11 +++++------
22 files changed, 48 insertions(+), 48 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-queries/operators-and-types.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/operators-and-types.md b/docs/data-queries/operators-and-types.md
index c67ccd1..bb42107 100644
--- a/docs/data-queries/operators-and-types.md
+++ b/docs/data-queries/operators-and-types.md
@@ -64,7 +64,7 @@ As you develop queries, remember that entity properties each conform to a partic
For example, if you create an entity with a price property with a value of 100.00, querying for 100 will return no results, since the API expected a decimal-delimited float value in your query.
-For a list of property data types for each default entities, see Default Data Entity Types.
+For a list of property data types for each default entities, see [Default Data Entities](../rest-endpoints/api-doc.html#models)s.
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-queries/query-parameters.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/query-parameters.md b/docs/data-queries/query-parameters.md
index 9f9fc68..944c27b 100644
--- a/docs/data-queries/query-parameters.md
+++ b/docs/data-queries/query-parameters.md
@@ -48,7 +48,7 @@ The following table lists a few examples of the kind of searches you can do in q
### Location
-If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see Geolocation.
+If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see [Geolocation](../geolocation/geolocation.html).
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-queries/querying-your-data.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/querying-your-data.md b/docs/data-queries/querying-your-data.md
index fa10169..2da961d 100644
--- a/docs/data-queries/querying-your-data.md
+++ b/docs/data-queries/querying-your-data.md
@@ -42,7 +42,7 @@ For example, the following request returns the address and phone number of users
When you query your data, the API response is formatted in JavaScript Object Notation (JSON). This is a common format used for parameter and return values in REST web services.
-Data corresponding to the response is captured in the response’s entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see Default Data Entity Types.
+Data corresponding to the response is captured in the response’s entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see [Default Data Entities](../rest-endpoints/api-doc.html#models).
For example, the following query for all entities of type user where the name property equals 'Gladys Kravitz':
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-storage/collections.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/collections.md b/docs/data-storage/collections.md
index c072104..fa8652e 100644
--- a/docs/data-storage/collections.md
+++ b/docs/data-storage/collections.md
@@ -4,7 +4,7 @@
This article describes how to create collections in Advanced Usergrid. All entities are automatically associated with a corresponding collection based on the type property of the entity. You may create empty collections if you wish, but creating an entity of a new type will automatically create a corresponding collection for you. For example, creating a new custom "item" entity, creates an "items" collection.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Creating a collection
@@ -51,7 +51,7 @@ This article describes how to retrieve all of the entities in a collection.
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
By default, the Usergrid API returns 10 entities per request. For collections with more than 10 entities, use the returned 'cursor' property to retrieve the next 10 entities in the result set. You may also use the LIMIT parameter in a query string to increase the number of results returned. For more information on using cursors, see [Query Parameters](../data-queries/query-parameters.html).</p></div>
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Retrieving sets of entities from a collection
@@ -115,7 +115,7 @@ Response:
This article describes how to perform batch updates on all entities in a collection. Batch updates require the use of a query string in the request, which can either specify all entities in the collection or a subset of entities for the update to be performed on. For more information on queries, see Querying your data.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Batch updating entities in a collection
@@ -185,7 +185,7 @@ This article describes how to batch delete entities in a collection. Batch delet
Currently, collections cannot be deleted; however, you can delete all of the entities from a collection.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Batch deleting entities in a collection
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-storage/data-store-dbms.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/data-store-dbms.md b/docs/data-storage/data-store-dbms.md
index 539cca6..0ea09d4 100644
--- a/docs/data-storage/data-store-dbms.md
+++ b/docs/data-storage/data-store-dbms.md
@@ -4,10 +4,10 @@ The Usergrid data store is backed by Cassandra, an open source distributed DBMS.
<!-- workaround a Sphinx bug -->
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
-Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see Optimizing access to your Usergrid data store.</p> </div>
+Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see [Optimizing access to your Usergrid data store](../data-storage/optimizing-access.html).</p> </div>
-Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see Usergrid SDKs.)
+Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see [Usergrid SDKs](../sdks/tbd.html).)
With Cassandra as the underlying DBMS, apps benefit from:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/data-storage/entities.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/entities.md b/docs/data-storage/entities.md
index 5a70b18..be77ebd 100644
--- a/docs/data-storage/entities.md
+++ b/docs/data-storage/entities.md
@@ -5,7 +5,7 @@ This article describes how to create custom data entities and entity properties.
The methods cited in this article should be used to create custom data entities. If you are using one of the Usergrid SDKs, use one of the entity type-specific SDK methods to create default data entities.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Creating a custom entity
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. For example, creating a custom entity of type 'item' will automatically create a collection named 'items' in which all future 'item' entities will be saved.
@@ -144,7 +144,7 @@ Any valid JSON object can be stored in an entity, regardless of the level of com
### Updating sub-properties
An array of sub-properties is treated as a single object. This means that sub-properties cannot be updated atomically. All sub-properties of a given property must be updated as a set.
-For more on updating an existing sub-property, see Updating Data Entities.
+For more on updating an existing sub-property, see [Updating Data Entities](../data-storage/entities.html#updating-data-entities).
Example Request/Response
@@ -193,7 +193,7 @@ Example Request/Response
## Retrieving Data Entities
This article describes how to retrieve entities from your account.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
With the exception of the user entity, all data entities can be retrieved by using their UUID or a 'name' property. The user entity can be retrieved by UUID or the 'username' property. The value for the 'name' or 'username' property must be unique.
@@ -333,7 +333,7 @@ Response:
This article describes how to update entities in your account.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Updating an entity
One or more properties can be updated with a single PUT request. For information on updating sub-properties, see Updating sub-properties below.
@@ -454,7 +454,7 @@ Response:
This article describes how to delete data entities.
-__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Deleting an entity
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/entity-connections/retrieving-entities.md
----------------------------------------------------------------------
diff --git a/docs/entity-connections/retrieving-entities.md b/docs/entity-connections/retrieving-entities.md
index 31eaf9c..6da8577 100644
--- a/docs/entity-connections/retrieving-entities.md
+++ b/docs/entity-connections/retrieving-entities.md
@@ -1,13 +1,12 @@
# Retrieving connections
-Viewing all of an entities connections
To see all of the connection types associated with an entity, simply retrieve the entity.
-All of the connection types the entity has made to other entities will appear in the metadata.connections property.
+All of the connection types the entity has made to other entities will appear in the ``metadata.connections`` property.
-All of the connection types that other entities have made to the entity will appear in the metadata.connecting property.
+All of the connection types that other entities have made to the entity will appear in the ``metadata.connecting`` property.
-For user entities, following/followers connections can be accessed by sending a GET request to the URL in the collections.following and collections.followers properties.
+For user entities, following/followers connections can be accessed by sending a ``GET`` request to the URL in the ``collections.following`` and ``collections.follower``s properties.
Retrieve connected entities by connection type
To get a list of entities a specified entity has connected to with a specific connection type, do the following:
@@ -83,7 +82,7 @@ All of the entities that have made a connection of that type to the specified en
## Retrieve all connecting entities by type
-To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connecting/<relationship>.
+To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to ``connecting/<relationship>``.
All of the entities that have made a connection to the specified entity will be returned in the entities property of the response.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/geolocation/geolocation.md b/docs/geolocation/geolocation.md
index ede4e3c..3da555c 100644
--- a/docs/geolocation/geolocation.md
+++ b/docs/geolocation/geolocation.md
@@ -36,7 +36,7 @@ Location-aware apps require the ability to return content and results based on t
The returned results are sorted from nearest to furthest. Entities with the same location are returned in the order they were created.
-The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see Querying your data.
+The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see [Querying your Data](../data-queries/querying-your-data.html).
For example, here is how you would find all the devices within 8,046 meters (~10 miles) of the center of San Francisco:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/getting-started/creating-a-new-application.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/creating-a-new-application.md b/docs/getting-started/creating-a-new-application.md
index cc5f577..ce5fb7a 100644
--- a/docs/getting-started/creating-a-new-application.md
+++ b/docs/getting-started/creating-a-new-application.md
@@ -8,7 +8,9 @@ To create a new application with the admin portal:
1. In the admin portal, from the dropdown menu at the far top left, select the organization to which you will add the new application.
1. Click the ADD NEW APP button, located at the top of the screen, next to the application drop-down.
1. In the dialog box, enter a new application name, then click the Create button. Your new application will automatically be selected in the applications drop-down menu.
-Applications can also be created programmatically with a POST request to the API. For more, see Application.
+
+Applications can also be created programatically with a ``POST`` request to the API. For more, see [Application](../orgs-and-apps/application.html).
## Securing an application
-If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see Security best practices.
\ No newline at end of file
+If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see [Security Best Practices](../security-and-auth/securing-your-app.html)
+.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/getting-started/creating-account.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/creating-account.md b/docs/getting-started/creating-account.md
index 1440926..f4f542a 100644
--- a/docs/getting-started/creating-account.md
+++ b/docs/getting-started/creating-account.md
@@ -3,7 +3,7 @@ To get started using the Usergrid, you'll need an Usergrid account. (Before read
With an account, you get the following useful things:
-* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see "Using Your Application Sandbox".
+* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see [Using Your Application Sandbox](../getting-started/using-a-sandbox-app.html).
* The ability to create more applications (in addition to the sandbox). You can (and should!) make these as secure as you need to. These are the applications that you'll have behind the apps you make available to your users.
* Access to the Admin Portal. In the portal, you can do the following:
** Create and manage applications.
@@ -11,11 +11,11 @@ With an account, you get the following useful things:
** Manage the data in your app.
** Manage app features, including push notifications, activities, analytics, and so on.
** Try out API calls with a shell command window.
-** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page.
+** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page of the Portal.
## Next steps
Ready to learn and do more?
-* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see SDKs.
+* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see [SDKs](../sdks/tbd.html).
* Review Usergrid features for information on concepts and features.
* Consult the API Reference for usage details.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/getting-started/using-a-sandbox-app.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/using-a-sandbox-app.md b/docs/getting-started/using-a-sandbox-app.md
index 7fb9cd1..75c296f 100644
--- a/docs/getting-started/using-a-sandbox-app.md
+++ b/docs/getting-started/using-a-sandbox-app.md
@@ -2,7 +2,7 @@
## What is the sandbox application?
-When you create a new Usergrid account (see Creating an Usergrid Account) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions.
+When you create a new Usergrid account (see [Creating an Usergrid Account](creating-account.html)) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions.
## Is the sandbox secure?
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/getting-started/using-the-api.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/using-the-api.md b/docs/getting-started/using-the-api.md
index 9a7ba2d..d85f86a 100644
--- a/docs/getting-started/using-the-api.md
+++ b/docs/getting-started/using-the-api.md
@@ -59,7 +59,7 @@ For example, this request retrieves users whose Facebook first name is john:
/users?ql=select * where facebook.first_name ='john'
-For further information about queries, see Queries and parameters.
+For further information about queries, see [Querying your Data](../data-queries/querying-your-data.html)
## Authentication (OAuth)
Usergrid implements the OAuth 2.0 standard for authenticating users, clients and API requests.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index e3fab8f..bcb3092 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,8 +18,8 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Getting Started
- getting-started/creating-a-new-application
getting-started/creating-account
+ getting-started/creating-a-new-application
getting-started/using-a-sandbox-app
getting-started/using-the-api.md
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/introduction/data-model.md
----------------------------------------------------------------------
diff --git a/docs/introduction/data-model.md b/docs/introduction/data-model.md
index 0278b97..111e225 100644
--- a/docs/introduction/data-model.md
+++ b/docs/introduction/data-model.md
@@ -8,7 +8,7 @@ An organization contains one or more applications, and represents administrator-
An organization with the same name as your username is automatically created for you when you sign up. By default, you are assigned as the administrator of this organization.
## Applications
-In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a Sandbox Application for important information regarding the default sandbox application).
+In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a [Sandbox Application](../getting-started/using-a-sandbox-app.html) for important information regarding the default sandbox application).
Each application provides the infrastructure for storing, retrieving, updating and deleting the entities and collections associated with a specific app instance.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/orgs-and-apps/application.md
----------------------------------------------------------------------
diff --git a/docs/orgs-and-apps/application.md b/docs/orgs-and-apps/application.md
index 7495aee..801b9ef 100644
--- a/docs/orgs-and-apps/application.md
+++ b/docs/orgs-and-apps/application.md
@@ -1,5 +1,5 @@
# Application
-You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the "Creating an organization application" section in Organization for details). If you need to create an application programmatically in your app, you can also use the API to do this. You can access application entities using your app name or UUID, prefixed with the organization name or UUID:
+You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the [Creating an Application](../orgs-and-apps/application.html#creating-an-application) section in Organization for details). If you need to create an application programmatically in your app, you can also use the API to do this. You can access application entities using your app name or UUID, prefixed with the organization name or UUID:
https://api.usergrid.com/{org_name|uuid}/{app_name|uuid}
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/authenticating-api-requests.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/authenticating-api-requests.md b/docs/security-and-auth/authenticating-api-requests.md
index af52bf6..d29e4cb 100644
--- a/docs/security-and-auth/authenticating-api-requests.md
+++ b/docs/security-and-auth/authenticating-api-requests.md
@@ -4,7 +4,7 @@ With the exception of the 'sandbox' application that is created with every Userg
This article describes how to use access tokens to access the Usergrid API, and how to manage access tokens, including revoking and changing token time to live.
-For information on generating access tokens/authenticating users and clients, see Authenticating users and application clients.
+For information on generating access tokens/authenticating users and clients, see [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html).
## Authenticating with access tokens
When you obtain an access token, you must provide it with every subsequent API call that you make. There are two ways to provide your access token.
@@ -18,7 +18,7 @@ You can include the token in an HTTP authorization header:
Authorization: Bearer {access_token}
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
-Note: The Usergrid documentation assumes you are providing a valid access token with every API call whether or not it is shown explicitly in the examples. Unless the documentation specifically says that you can access an API endpoint without an access token, you should assume that you must provide it. One application that does not require an access token is the sandbox application. The Guest role has been given full permissions (/** for GET, POST, PUT, and DELETE) for this application. This eliminates the need for a token when making application level calls to the sandbox app. For further information on specifying permissions, see Managing access by defining permission rules.
+Note: The Usergrid documentation assumes you are providing a valid access token with every API call whether or not it is shown explicitly in the examples. Unless the documentation specifically says that you can access an API endpoint without an access token, you should assume that you must provide it. One application that does not require an access token is the sandbox application. The Guest role has been given full permissions (/** for GET, POST, PUT, and DELETE) for this application. This eliminates the need for a token when making application level calls to the sandbox app. For further information on specifying permissions, see [Using Permissions](security-and-auth/using-permissions.html).
</p></div>
## Authenticating with client ID and client secret
@@ -27,7 +27,7 @@ Another option for authenticating your API requests is using either your organiz
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
Warning: For server-side use only
-You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See Security best practices for additional considerations in keeping access to your app and its data secure.
+You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
This can be a convenient way to authenticate API requests, since there is no need to generate and manage an access token, but please note that you should be very cautious when implementing this type of authentication. Organization-level authentication grants full permission to perform any supported call against your organization and every application in it, and application-level authentication grants full permission to perform any supported call against all of the resources in an application. Should your client id and client secret be compromised, a malicious user would gain broad access to your organization or application.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/authenticating-users-and-application-clients.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/authenticating-users-and-application-clients.md b/docs/security-and-auth/authenticating-users-and-application-clients.md
index eaa52f4..e1ada48 100644
--- a/docs/security-and-auth/authenticating-users-and-application-clients.md
+++ b/docs/security-and-auth/authenticating-users-and-application-clients.md
@@ -49,7 +49,7 @@ The results include the access token needed to make subsequent API requests on b
Using your app’s client id and client secret values, your app can connect to the Usergrid application endpoint to request an access token. The client ID and secret for your app can be found in 'Getting Started' section of the API Services admin portal, under 'Server App Credentials'.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html) for additional considerations in keeping access to your app and its data secure.
+Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
@@ -76,7 +76,7 @@ The results include the access token needed to make subsequent API requests on b
If you do require admin user access, your app can connect to the Usergrid management endpoint to request an access token. Your app supplies the username and password of an admin user in the request.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: Authenticating as an admin user grants full access to one or more organizations and all of the applications contained in those organizations. Due to this, be cautious when implementing this type of authentication in client-side code. Instead, consider implementing admin user access in server-side code only. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html) for additional considerations in keeping access to your app and its data secure.
+Warning: Authenticating as an admin user grants full access to one or more organizations and all of the applications contained in those organizations. Due to this, be cautious when implementing this type of authentication in client-side code. Instead, consider implementing admin user access in server-side code only. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
@@ -103,7 +103,7 @@ The results include the access token needed to make subsequent API requests on b
If you do require organization level access, your app can connect to the Usergrid management endpoint to request an access token. Access to an organization requires the client id and client secret credentials. The client ID and secret for your organization can be found on the 'Org Administration' page of the API Services admin console under 'Organization API Credentials'.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html for additional considerations in keeping access to your app and its data secure.
+Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/facebook-sign.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/facebook-sign.md b/docs/security-and-auth/facebook-sign.md
index e2c7411..970cb33 100644
--- a/docs/security-and-auth/facebook-sign.md
+++ b/docs/security-and-auth/facebook-sign.md
@@ -21,7 +21,7 @@ where:
## Facebook login example
The Facebook technical guides for login present detailed information on how to add Facebook login to your app. Instructions are provided for JavaScript, iOS, and Android.
-In brief, here are the steps for JavaScript. You can see these steps implemented in the Facebook login example packaged with the JavaScript SDK for Usergrid (which you can download in ZIP format or tar.gz format). The Facebook login example is in the /examples/facebook directory of the extracted download. The code example snippets shown below are taken from the Facebook login example.
+In brief, here are the steps for JavaScript. You can see these steps implemented in the Facebook login example packaged with the JavaScript SDK for Usergrid (which you can download in ZIP format or tar.gz format). The Facebook login example is in the ``/examples/facebook`` directory of the extracted download. The code example snippets shown below are taken from the Facebook login example.
### Step 1: Create a Facebook app
Create a new app on the Facebook App Dashboard. Enter your app's basic information. Once created, note the app ID shown at the top of the dashboard page.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/user-authentication-types.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/user-authentication-types.md b/docs/security-and-auth/user-authentication-types.md
index 1a14f50..d02e8d3 100644
--- a/docs/security-and-auth/user-authentication-types.md
+++ b/docs/security-and-auth/user-authentication-types.md
@@ -5,7 +5,7 @@ Usergrid supports four levels of authentication, but only one of them is used wh
## Configuring authentication levels
Access permissions can only be configured for the 'application user' – this can be done both programmatically and in the admin portal. The application, organization and admin clients cannot be configured, and can only be accessed programmatically via the API.
-For more about creating and managing roles and permissions for application users, see Managing access by defining permission rules. For a look at how security features fit together, see App Security Overview.
+For more about creating and managing roles and permissions for application users, see [Using Permissions](security-and-auth/using-permissions.html) and [Using Roles](security-and-auth/using-roles.html). For a look at how security features fit together, see [App Security Overview](../security-and-auth/app-security.html).
## User authentication level
@@ -16,14 +16,14 @@ For more about creating and managing roles and permissions for application users
</tr>
<tr>
<td>Application user</td>
- <td>This is the standard authentication type you will use to implement user login for your app. The application user level allows access to your Usergrid application as governed by the permission rules you create and associated with users and user groups. For more on setting permissions see Managing access by defining permission rules. Each Application User is represented by a User entity in your Usergrid application. For more about the User entity, see User.</td>
+ <td>This is the standard authentication type you will use to implement user login for your app. The application user level allows access to your Usergrid application as governed by the permission rules you create and associated with users and user groups. For more on setting permissions see [Using Permissions](security-and-auth/using-permissions.html). Each Application User is represented by a User entity in your Usergrid application. For more about the User entity, see User.</td>
</tr>
</table>
## Admin authentication levels
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: Safe use of admin authentication levels. Never use client ID and client secret, or any hard-coded credentials to authenticate this way from a client-side app, such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. Even when authenticating with username and password, be cautious when using these authentication levels since they grant broad access to your Usergrid account. See "safe mobile access" in Authenticating API requests for additional considerations in keeping access to your app and its data secure.</p></div>
+Warning: Safe use of admin authentication levels. Never use client ID and client secret, or any hard-coded credentials to authenticate this way from a client-side app, such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. Even when authenticating with username and password, be cautious when using these authentication levels since they grant broad access to your Usergrid account. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.</p></div>
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/using-permissions.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/using-permissions.md b/docs/security-and-auth/using-permissions.md
index 600e09a..1454d11 100644
--- a/docs/security-and-auth/using-permissions.md
+++ b/docs/security-and-auth/using-permissions.md
@@ -33,7 +33,7 @@ Complex paths can be defined using [Apache Ant pattern syntax](http://ant.apache
</table>
## Assigning permissions
-Permissions can only be assigned to user, group or role entities. Assigning permissions to roles can be particularly useful, as it allows you to create sets of permissions that represent complex access definitions, which can then be assigned to user and group entities. For more on roles, see Using roles.
+Permissions can only be assigned to user, group or role entities. Assigning permissions to roles can be particularly useful, as it allows you to create sets of permissions that represent complex access definitions, which can then be assigned to user and group entities. For more on roles, see [Using Roles](security-and-auth/using-roles.html).
### Request syntax
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/security-and-auth/using-roles.md
----------------------------------------------------------------------
diff --git a/docs/security-and-auth/using-roles.md b/docs/security-and-auth/using-roles.md
index 6404edb..2a794e3 100644
--- a/docs/security-and-auth/using-roles.md
+++ b/docs/security-and-auth/using-roles.md
@@ -67,7 +67,7 @@ Generally, it is easiest to a create a role for each access type you want to ena
The following shows how to create a new role and assign permissions to it.
### Request syntax
-With cURL requests a role entity is created with a POST request, then permissions must be assigned to it with a separate request. For more on assigning permissions with cURL, see Using permissions.
+With cURL requests a role entity is created with a POST request, then permissions must be assigned to it with a separate request. For more on assigning permissions with cURL, see [Using Permissions](security-and-auth/using-permissions.html).
The following details how to create a new role entity.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa4c74aa/docs/user-management/activity.md
----------------------------------------------------------------------
diff --git a/docs/user-management/activity.md b/docs/user-management/activity.md
index f477be8..4f09c8b 100644
--- a/docs/user-management/activity.md
+++ b/docs/user-management/activity.md
@@ -16,13 +16,13 @@ information about these actions).
When a user creates an activity, it creates a relationship between the
activity and the user who created it. Because this relationship exists,
the activity will appear in the feed of any of the user’s followers.
-Think of the Activities endpoint (/users/{uuid|username}/activities) as
+Think of the Activities endpoint (``/users/{uuid|username}/activities``) as
an "outbox" of news items created by the user. Think of the Feed
-endpoint (/users/{uuid|username}/feed) as an "inbox" of news items meant
+endpoint (``/users/{uuid|username}/feed``) as an "inbox" of news items meant
to be seen or consumed by the user.
A user can also post an activity to a group (located at
-/groups/{uuid|groupname}/activities). This allows you to emulate
+``/groups/{uuid|groupname}/activities``). This allows you to emulate
Facebook-style group functionality, where a limited number of users can
share content on a common "wall". In any of these cases, there is no
need to construct publish/subscribe relationships manually.
@@ -36,10 +36,9 @@ to the user's activity stream for display as well as to the activity
streams of any of the user's followers.
Using Usergrid APIs you can create, retrieve, update, and delete
-activity entities. See You do not have access to view this node for
-descriptions of these APIs.
+activity entities.
-**Note:** Although not shown in the API examples below, you need to
+__Note:__ Although not shown in the API examples below, you need to
provide a valid access token with each API call. See
[Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
[11/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/searchindex.js
----------------------------------------------------------------------
diff --git a/content/docs/searchindex.js b/content/docs/searchindex.js
index 26604b3..f588fac 100644
--- a/content/docs/searchindex.js
+++ b/content/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:46,filenames:["README","asset-and-files/assets","asset-and-files/file-storage-configuration","asset-and-files/folders","asset-and-files/legacy-asset-support","asset-and-files/retrieving-assets","asset-and-files/uploading-assets","counters-and-events/creating-and-incrementing-counters","counters-and-events/events-and-counters","counters-and-events/retrieving-counters","data-queries/advanced-query-usage","data-queries/operators-and-types","data-queries/query-language","data-queries/query-parameters","data-queries/querying-your-data","data-storage/collections","data-storage/data-store-dbms","data-storage/entities","data-storage/optimizing-access","entity-connections/connecting-entities","entity-connections/disconnecting-entities","entity-connections/relationships","entity-connections/retrieving-entities","geolocation/geolocation","geolocation/tbd","getting-started/creating-a-new-application","getting-started/creating-account","getting-started/using-a-sandbox
-app","getting-started/using-the-api","index","installation/ug1-deploy-to-tomcat","installation/ug1-launcher-quick-start","installation/ug2-deploy-to-tomcat","introduction/async-vs-sync","introduction/data-model","introduction/usergrid-features","orgs-and-apps/admin-user","orgs-and-apps/application","orgs-and-apps/managing","orgs-and-apps/organization","push-notifications/tbd","push-notifications/users-devices","reference/contribute-code","reference/presos-and-videos","rest-endpoints/api-docs","sdks/ios","sdks/java","sdks/javascript","sdks/tbd","sdks/usage","security-and-auth/app-security","security-and-auth/authenticating-api-requests","security-and-auth/authenticating-users-and-application-clients","security-and-auth/changing-token-time-live-ttl","security-and-auth/facebook-sign","security-and-auth/revoking-tokens-logout","security-and-auth/securing-your-app","security-and-auth/user-authentication-types","security-and-auth/using-permissions","user-management/activity","user-manage
ment/group","user-management/groups","user-management/messagee-example","user-management/user-connections","user-management/user-management","user-management/working-user-data"],objects:{},objnames:{},objtypes:{},terms:{"005056c00008":65,"00767101f6b4f2cf5d02ed510dbcf0b4":60,"02e81ac5a17b":[3,11,12],"02e81adcf3d0":[6,7,9,15,17,20,22,28,58,59,60],"02e81ae236e9":60,"02e81ae61238":60,"02e81ae640dc":[3,59],"02e81ae66238":60,"02e81aeb2129":60,"02e81aeb26e9":60,"02e9sjwsf3d0":17,"03ae956a":23,"0455fc92de2636fc7a176cc5d298bb78":60,"0abe":15,"0d7cf92a":17,"0d7e":39,"0d7f":39,"0f1ff3650d20":[19,60,65],"10e":[11,12],"10e10":[11,12],"11e0":[9,65],"11e1":[3,28,34,36,39,59,60,65],"11e2":[3,6,7,9,11,12,14,15,17,20,22,28,39,58,59,60],"11e3":[6,15,17,19,20,22,23,28,53,60,65],"1231380a0284":59,"12313b01d5c1":[3,28,34,59],"12313b06ae01":59,"12313b06d112":59,"12313b111c56":39,"12313b122c56":[36,39],"12313d027361":39,"12313d027471":39,"12313d14bde7":60,"12313d1520f1":59,"12313d1c4491":[3,36,39,59],"123
13d1c44914":59,"12313d1c5591":39,"12313d288ee0":39,"12313d288ff0":39,"12313d331ae8":59,"12313f0204b":65,"12313f0204bb":[9,65],"12313f0204bb8":65,"12331b144c65":36,"12331d1c5591":[36,39],"12424d1c4491":36,"174785aa":19,"19a0":17,"1a62":15,"1a9356ba":[15,17],"1bd100b8059e":15,"1c8f60e4":65,"1f3567aa":59,"1px":43,"1st":44,"20adr":65,"20c57d4f41cf51f2db44165eb058b3b2":[12,14],"20employe":60,"20or":17,"20titl":60,"20uuid":17,"20where":[60,65],"22000a1c4e22":60,"22000a1c5a67":[60,65],"2440ca58":59,"2482a1c5":59,"249f":23,"2ac6":3,"2ac8":3,"2d00":59,"2d21":3,"2e1db7299b0a667ed80e674a0ef9d653":6,"2nd":44,"31847b9a":15,"3192ac6a":15,"327b527f":[36,39],"328b526e":36,"328fe64a":17,"335b527f":[36,39],"33dd0563":[36,39],"3400ba10":[3,39,59],"34e26bc9":59,"3500ba10":39,"37f3":59,"38dc":17,"3d1a9356ba":17,"410b213a":6,"411c466c4f2c":[12,14],"417f":[19,60,65],"4353136f":65,"438a1ca1":9,"477d":60,"48c92c73":39,"496ca1d42ce7":15,"49ff":59,"4a1edb70":17,"4d2664c8e0c3":60,"5005a0fa":60,"503f17da":28,"5
0gb":2,"5111c463":59,"5373d7165c2d":53,"53fe3700":15,"563f5d96":59,"58606d0a":[20,22],"58e8":[60,65],"5ae1fa7a":15,"5bb76bca":[15,17],"5bcc47ca":[20,22],"5c0c1789":[3,34],"5de0bb69":39,"5f4a65c16193":17,"5wugd":52,"61c9":59,"62de5d97":28,"62fd53c78ce7":58,"65c8":39,"6640a601":3,"6715d5ef47a6":17,"67cb":60,"698b":60,"699740088e05":7,"6a42":59,"6be0003c809b":15,"6c56ffda":19,"6fbc8157":60,"6ldstnesaaaaakhdvglhmmu86_eoyxsjjqqd1ipz":[36,65],"74d2d7da":60,"78c54a82":65,"7bf47435":3,"7fb8d891":60,"802f":60,"81581bbaf055":[15,17],"8272c9b0":[12,14],"83ceb9965c26":60,"83de":60,"83e9b7ea":17,"84a5":65,"84c0":59,"84df":17,"87b9":39,"884d":65,"89ab":15,"8a2a":17,"8a4c":58,"8ae8a6ea":65,"8bde":[20,22],"8cef":[12,14],"8d05e96f700d":15,"8d5c":28,"8dd1801e534c":19,"8e0cd3866ee20746c99e9a9825f38ad8":3,"8ea8":19,"903f":[15,17],"90f823ba15655b8cc8e3b4d63377576f":60,"917d":17,"924d":[11,12],"92c3":3,"92e2":[12,14],"9501cda1":3,"95c8":[36,39],"96f6":59,"98b9":39,"9953085ea376":6,"99a7":53,"99fd":19,"9c
1b":60,"9ce3":17,"9d3a":7,"9e75":19,"9e92":17,"9f80":23,"9ff6c621a7a4":[15,17],"9ffc":59,"____usergrid":30,"boolean":[11,12,39,41,44],"case":[10,12,18,21,30,33,41,44,59,61,63],"class":[2,32,36,52,55,65],"default":[2,11,12,13,14,15,16,17,23,28,29,30,32],"float":[11,12],"function":[7,33,35,54,57,59,60,61,62,64],"import":[27,28,33,34,35,50],"long":[1,11,12,34,41,61],"new":[7,10,12,15,17,18,21],"null":[7,54],"public":[36,65],"return":[11,12,13,14,15,18,22,23,28,31,33,36,39,41,44,52,53,54,55,58,59,60],"short":[26,59],"static":30,"super":29,"switch":21,"transient":32,"true":[11,12,14,20,22,28,30,31,32,36,39,44,54,60,65],"try":[26,27,31,36,50,54,58],"typeof":54,"var":[10,36,54],"while":[27,30,33,34,35,41,58],a065:59,a0dd:28,a0e5:6,a0f7:59,a166:[6,7,9,15,17,20,22,28,58,60],a24f:15,a407b1e7:[60,65],a51b:17,a554b7fbd57a:28,a668717b:60,a694:[20,22],a6e3:60,a71c:58,a72a:[15,17],a7e008061e10:[20,22],a7f7:[6,7,9,15,17,20,22,28,58,60],abbrevi:[12,14,18,28],abil:[21,23,26,35,63,64],abl:[18,28,30,56
,57,59,64,65],about:[0,11,12,18,26,27,28,29,30,35,36,38,39,44,52,56,57,59,60,61,64,65],abov:[6,7,22,30,31,32,59],ac46:[60,65],accept:[5,52,58],access:[3,15,16,17,18,22,25,26,27],access_token:[31,51,52,53,54],accessid:2,accesstokenttl:53,accomplish:55,accord:52,account:[14,17,18],achiev:63,acknowledg:12,acquaint:59,acquir:29,across:[9,18],act:[14,59,62],action:[3,6,7,8,9,12,14,15,16,17,18,19,20,22,28,29,30,35,36,37,39],activ:[6,11,12,14,20,22,23,26,28,29,30,32,34],activit:36,activityfe:29,actor:[29,36,39],actorproperti:44,actual:18,add:[2,10,12,16,17,18,25,26,27,29],addit:[9,18,26,35,36,44,51,52,57,59,60,63,65],addpermiss:29,address:[12,14,28,30,36,39,41,44,52,65],addrol:29,adjust:[12,13],admin:[25,26,27,29,30,31,32],admin_password:52,admin_usernam:52,admin_users_require_activ:[30,32],admin_users_require_confirm:[30,32],admingmail:36,administr:[30,31,34,35,37,39,41,52,56,57],adminus:[36,39,44],adminuserproperti:44,adminuserupd:29,adomain:65,adopt:[35,42],advantag:35,advertis:23,advis
:56,ae1f:19,aec3:59,afad:59,affect:53,after:[7,11,12,28,31,33,44,52,54,56,62],again:[30,36],against:[12,20,32,37,51,52,56,58],aggreg:9,air:16,alert:[23,33,60,61],alia:65,all:[0,7,9],allow:[8,14,23,28,30,32,34,35,39,41,44,54,57,58,59,60,61,63,64,65],almost:64,along:[12,13,18],alreadi:[17,18,26,30,41,44,54,56,62],also:[2,3,7,8,9,12,13,15,17,18,25,31,32,34,35,36,37,39,41,44,52,54,55,56,58,59,60,61,62,63,65],altern:[14,15,60,61],although:[15,17,36,59,60,65],alwai:34,amazon:2,amazonaw:30,amount:[12,13,57,59],amuramoto:[6,17,53],analysi:35,analyt:26,analyz:[35,51,52,56,57],android:[28,29,33,49,52,54,55],ani:[6,7,9,11,12,14,16,17,18,21,23,32,33,34,35,36,38,44,50,51,52,53,56,57,58,59,60,62,63,64,65],anonym:[41,59,65],anoth:[12,14,18,21,27,51,59,62,63,65],answer:65,ant:58,anuff:43,anyon:[57,59],anyth:30,anytim:59,anywher:13,apachecon:43,apidocgener:0,apige:[28,43,60],apigeemobileconfig:53,apikei:54,apn:44,app1:44,app2:44,app:[3,5,6,7,8,9,12,14,15,16,17,18,19,20,21,22],app_id:[17,44,59,60,65]
,app_nam:[12,37,53,55],app_uuid:[16,18],appdata:29,appear:[22,44,59,62,63],append:[9,10,15,18,23,51,54],appid:[44,54],appl:[35,44],appli:[12,28,32,53,56,58,63,64,65],applic:[3,5,6,7,8,9,12,14,15,16,17,18,19,20,22,23],application_client_secret:52,application_clientid:52,application_info:39,applicationdata:44,applicationid:[36,39,44],applicationnam:[3,6,7,9,12,14,15,16,17,18,19,20,22,28,44,53,58,59,60,65],appnam:[10,52,54],appropri:[34,41,54],approv:[30,32],arbitrari:[28,63],architectur:[16,30],area:[26,27,36,50,65],aren:[16,18],arg:[2,37,39,59,60],argument:2,arm:56,around:[0,18],arrai:[11,12,14,16,17,18,22,28,44],arrang:12,arthur:[19,20,22,63,64],articl:[14,15,17,51],asc:[12,13],ascend:[12,13],ask:[12,14,32],aspect:[8,35],asset1:3,assets_id:3,assign:[7,29,34,35,41,52,56],associ:[6,11,12,15,22,23,25,28,34,35,39,41,44,50,52,53,55,57,60,62,64,65],assum:[18,51],async:29,asynchron:29,atistophan:36,atom:17,attach:[5,6],attack:[50,56],attempt:[39,51],attribut:16,audio:[1,6,35],auth:[30,32,4
1,54],authent:[15,17,27],author:[12,31,38,51,53,54,59,64],author_uuid:18,authorid:[16,18],authorimag:18,authornam:18,authoruuid:18,authrespons:54,auto:[30,32],automat:[6,7,15,17,21,25,26,32,34,35,44,52,54,55,58,59,63],avail:[12,15,17,23,26,28,31,35,52,62,64],avatar:[12,14,28,59,60,65],avoid:[18,62],awai:18,awar:[11,12,23],awssdks3binarystor:2,b0c6:60,b11217fc:7,b1f7:15,b24e:7,b2bd:60,b2e4:17,b31d:53,b36a:[3,34],b379:6,b3u68vghi6fmeekn9wlogtzz0a:37,b3u6aaabmqz:52,b3u6zuz5_u8i:37,b4c6:3,b690:60,b6dd:59,b77ec8addc0d:60,b90c:60,b93d:65,baa:[36,39,50],back:[16,18,31,35,42,62],backend:[14,29,34],bad:[39,52,57],banner:8,bar1234b:65,bar:28,barnei:[21,60,63],base:[0,15,23],batch:[12,13],baz:28,bcc1:9,bcf7:[3,36,39,59],bcf8:[36,39],bd397ea1:58,be04:15,be08a5f9:39,be09a5f9:39,bean:2,bearer:[31,51],beca:39,becaus:[12,16,21,23,27,30,44,52,56,57,59,62],becom:[13,14,23,30,35,59,60,61],bedrock:12,been:[7,18,51,54,55,56,59],bef8:[36,39],befor:[0,2,26,27,32,33,44,54,56,65],begin:[9,12,13,38],behalf:5
2,behav:62,behavior:35,behind:[26,41,54],belong:[31,34,41,59,61],below:[12,15,16,17,18,30,32,36,54,59,60,62,65],beneath:62,benefici:33,benefit:[16,30],best:[13,14],better:[18,52,57],bewar:32,beyond:59,bike:11,bin:32,binari:[1,35,51,52,56,57],binarystor:2,bit:16,block:33,board:62,boat:[11,12],boavijt0oyrkjf:37,bodi:[7,18,36,37,39,44,53,59,60,65],book:[12,13,35],border:43,both:[7,12,16,19,32,33,34,42,44,57,64],bounc:18,bouncer:18,bounci:[16,18],box:[25,27,62,64],bracket:17,bread:[15,17],brief:[33,54],broad:[51,52,57],browser:[30,32,36,54],bucketnam:2,buildcurl:54,built:[12,18,28,30,59],busi:23,button:[8,25,27,36,62,65],button_click:[7,9],c2v7n61dy90mcdg78xixprxfdq:39,c2v7wedxiutzwekwdyslct_lydfvmmn:39,c5e707256e71:17,california:[36,60,61],call:9,callback:[33,54],campaign:35,can:[0,1,2,3,5,6,7,8,9,11,12,13,14,15,16,17,18,19,21,22,23,25,26,27,28,30,31,32,33,34,35,36,37,38,39,41,42,44,50,51,52,53,54,56,57,58,59,60,61,62,63,64,65],cancel:[44,54],cancelmsg:29,cannot:[15,17,28,33,34,57],cap
abl:56,captcha:[36,44,65],captur:[12,14,18,23,35],car:11,carefulli:57,carri:38,cassandra:[16,18,29],cast:43,castl:[16,18],cat:31,catalina:32,catalog:35,categori:[16,36,39,44],caus:[0,17],caution:53,cautiou:[51,52,57],ccc:43,cd0c:[3,36,39,59],cd0d:[36,39],cd789b00:60,cd796d0a:60,cdf1ce04c1c0:[12,14],cdn:35,cede5b7:39,cede5b8:39,cell:0,center:23,central:[0,2],certain:[12,17,18,34,44,55,64],cf3e981c:36,cf4d981c:[36,39],cf9b:9,cfed:[20,22],chain:7,challeng:[28,36,44,65],channel:54,channelurl:54,charact:[13,59,65],charset:[36,65],check:[27,30,31,54,57,58,59],checksum:[3,6],chicago:65,choos:18,circl:[35,59],circumst:55,cite:17,citi:[13,36,44,65],clara:43,classpath:2,claus:12,clean:[0,30,31,32,36],cli:30,click:[8,18,25,27,38,62],client:[10,12,13,15,16,17,18,28,29,30,33,35,36,37,38],client_credenti:[37,52],client_id:[37,39,44,51,52,54],client_secret:[37,39,44,51,52],climb:18,clone:[0,30,32],closer:18,cloud:[2,5,6,35],clue:30,cluster:30,cluster_nam:32,cn0wtdxxkxmqlgzvtmubcp20fulczq:52,code:[
2,12,13,18,28,29,30,31,33,35],coffe:16,colleagu:59,collect:[5,6,12,14],collection_nam:15,collectionid:44,column:[12,16,18],com:[3,5,6,7,9,12,14,15,16,17,18,19,20,21,22,23,28,30,31,32,34,36,37,39,41,52,53,54,55,58,59,60,62,63,64,65],combin:[18,56,65],comma:[12,14,44,54,58],comma_separated_list_of_permission_nam:54,command:[0,26,30,31,32,49,54,60],comment:[35,59],commit:0,committ:42,common:[12,14,56,59,65],commun:62,compani:[38,39,62],compar:[12,14],comparison:12,compil:[51,52,56,57],complet:[14,30,33,34,35],completemsg:44,complex:[17,18,29,35],compliant:35,complic:30,compon:[34,35],compromis:51,concept:[16,26],config:32,confim:44,confirm:[30,32,36,39,44,62],confirm_email:[36,39,44],conflict:62,conform:[11,12],conjunct:[35,64],connect:[0,3,6,12,14,18],connected_collect:[19,20],connected_ent:[19,20],connecting_collect:[19,20],connecting_ent:[19,20],consid:[52,56],consider:[51,52,57],consol:29,constrain:16,constructor:2,consult:26,consum:[35,59],contain:[11,12],containslook:13,containsw
il:13,content_typ:5,context:[2,35],contextu:35,continu:[12,13,33,62],contrast:[18,63],contribut:29,contributor:42,control:[35,53,56,65],conveni:[10,51,60,62],convent:34,convert:12,cooki:54,copi:[0,18,30,62],core:[31,32,35],cores:32,correct:[41,54,62],correspond:[12,14,15,17,28,34,44],cost:35,costli:18,could:[3,12,13,18,21,33,51,52,56,57,60,61,63,64],count:[8,9,12,14,15,16,17,59],counter_nam:[7,9],creat:[1,3,6],createact:29,createadminus:29,createapp:29,createent:[29,33],createev:29,creategroup:29,createnotif:29,createorg:29,createus:29,creation:[1,41,53,61],credenti:[29,30,32],credential:32,criteria:[12,35],cross:59,css:[36,65],cumul:7,curiou:26,curl:[5,6,7,9,10,12,13,14,15,17,19,20,22,23,31,32,36,37,39,52,53,54,55,58,59,60,65],current:[7,15,23,34,44,58,59,65],cursor:12,custom:[10,15],custom_id:10,d0d7d0ba:[12,14],d16344f5a0e1:23,d20976ff:60,d28c:28,d503:[3,34],d7a8:17,d86a:[12,14],d878de4r:53,d87edec7:59,d9693ec3:59,da448955:59,da4a50dc:17,da67:65,da71:65,da83:59,dai:[8,9,53],daili
:9,dashboard:54,data:[1,2],databas:[12,13,16,18,23,29],datacli:[10,52,55],date:[11,12,44],dave:43,david:43,db1e60a0:[19,60,65],dbf5228024a7:[20,22],dbm:[13,14,16,18],dc5d478e9c029853fbd025bed0dc51f8:28,decim:[11,12],decompil:56,dedic:7,defin:[8,12,16,17,27,32,34,35,50,51,52,53,57,58,59,60,64,65],definit:58,degre:53,delet:[12,13,14],delimit:[11,12,44,58,61],deliv:[35,44],deliveri:[35,44],denot:[21,60,63],depend:[28,60,61],deploi:29,deploy:29,desc:[12,13],descend:13,describ:[13,14,15,17,18,23,28,38,41,50,51,52,54,60,62],descript:[1,5,6,7,9,12,13,15,16,17,19,20,22,29,34,36,37,38,39,41,44,52,57,58,59],design:[16,18,23,30,35,59,60,61,62,64],destin:2,destroi:55,detail:[15,17,26,34,35,36,37,38,39,44,52,54,59,60,62,63,65],detect:[6,12,23],determin:[12,23,59,65],dev:[32,54],develop:[11,12,23,27,34,35,44,56,62,64],devic:[6,12,20,22,23,25,28,29,34,35],deviceid:44,dfr4d5m1mjmoeeogvpncm:53,dialog:[25,27,36],did:17,differenti:35,dimens:64,diner:[12,13],dino:[21,28,63],dir:0,direct:[0,18],directli
:[0,37,57],directori:[0,30,31,32,42,54,62],disabl:[27,30,36,39,41,44],discuss:62,displai:[9,12,13,23,41,44,54,59,61,62],displayemail:44,displayemailaddress:[36,39],displaynam:[36,39,44,59],distanc:[12,23],distance_in_met:23,distribut:[16,18,56],div:[36,65],dk88fh4r:22,doctyp:[36,65],doe:[0,1,17,21,28,34,41,44,51,52,53,54,59,60,65],doesn:[16,18,27],dog:[17,21,28,33,60,61,63],dogcreatecallback:33,doge:[60,61],domain:54,don:[30,56,59,65],done:[0,30,35,54,56,57,65],dot:[7,11,12],down:[11,12,25],download:29,drive:[2,35],drop:25,dropdown:25,dskiptest:[30,31,32],dtd:[36,65],due:[13,14,18,52],duplic:18,durat:[3,6,7,9,12,14,15,16,17,18,19,20,22,28,30,36,37,39,53,55,58,59,60,65],dure:56,e13743a7f1db7f4246badd6fd6ff54ff:65,e694:60,e7127751:60,e7d0:59,e8f5:17,e94123890c7a:17,e978:65,e97b:[12,14],each:[0,7,8,9,11,12,14,15,16,17,18,23,27,28,34,36,41,54,57,59,60,65],eas:35,easi:[0,12,35,64],easier:[10,12,13,14,18,27,28,56,60,63],easili:[7,23,34,35,56,64],east:30,easy_instal:0,eb20e5bce407:19,ebc6f
49d1fc4:17,ec39:28,edit:[0,2,29,30],edort1:36,ee912c4b:[11,12],ef0b:17,effb:17,effect:35,effici:[14,18],either:[2,15,19,51,54],elasticsearch:32,elev:56,elimin:[35,51,56],els:[33,54],email:[12,14,28,30,31,32,34,36,39,41,44,52,59,60,62,65],email_address:[28,65],embed:32,embed_cod:43,employe:60,empti:[15,62],emul:[59,60,61],enabl:[23,30,35,41,54,56,59],enclos:[12,14,44],encod:[10,12,13,14,17],end:[9,35],end_tim:9,endpoint:[0,7,20,37,41,44,51,52,54,55,59,65],engag:[23,35],enhanc:[12,23],enough:27,ensur:[11,18,28,35,50,52,56],enter:[25,27,36,54,62,65],entir:[13,44],entit:18,entiti:[0,1,3],entity_nam:17,entity_typ:17,entity_uuid:17,entityid1:44,entityid2:44,entityid:44,entityproperti:44,entitytyp:[36,39,44],entri:[13,54],environ:[26,44,56],equal:[11,12,14,53],equiv:[36,65],equival:12,err:[33,54],error:[7,29,33,39,41],errorcod:44,errormessag:44,essenti:64,establish:[21,44,59,64],etag:[3,6],etc:41,evalu:30,even:[9,12,13,18,30,34,51,52,56,57,63],event:7,everi:[9,10,28,34,51,56,57,60,61],ever
yth:[0,28],exact:[12,23,64],exactli:[12,13],examin:[9,56],exampl:[0,1,2],except:[12,17,51,56],execut:[10,12,13,14,33],exhaust:56,exist:[6,7,17,18,23,30,39,41,44,53,54,59,60],expect:[11,12,23,36,39,64],experi:[12,16,23,35,64],experiment:[27,50],expir:[29,44],expires_in:52,explain:[0,30],explan:33,explicitli:[51,55],expos:31,express:13,extend:[21,63],extens:62,extern:42,extract:[30,31,32,51,52,54,57],f18e8f6fb3bc:65,f315e5aa568a:17,f34f4222:[6,7,9,15,17,28,58,60],f399:59,f3a8061a:17,f3aa:59,f3be262a:17,f3teeg:37,f8zemolceecubwbqvsaaca:52,f_gubelxeecfrgbqvsaaca:52,facebook:[28,29,35],facebookaccesstoken:54,facebooktoken:54,factor:30,fail:44,failur:16,fals:[11,12,30,32,36,39,44],famili:[16,23],familiar:[12,18,26],faq:30,far:25,fast:16,favorit:65,fb_access_token:[41,54],fbasynchinit:54,fbasyncinit:54,fc4d:59,fdd3:39,fe80:36,fe90:[36,39],featur:[18,21,23,26,28,29],feed:[6,12,14,20,22,28,29,35],feel:32,few:[12,13,23,62,64],ffd79647:59,field:[2,12,13,17,35,36,44],fieldset:[36,65],file_loc:6
,filenam:6,files:2,filter:[14,59,60,65],find:[0,12,13,23,30,56,60],fine:[32,35],finish:[44,62],first:[12,13,14,15,18,21,26,28,32,33,36,41,56],first_nam:28,firstnam:[12,13,14,41],fish:31,fit:57,five_minut:9,flexibl:[16,18,29,34],flow:[54,65],fluffi:31,fobnszewobnioerabnoiawegbrn:6,focu:[28,35],folder:2,follow:[0,3,5,6,7,9,10,11,12,13,14,15,16,17,18,20,21,22,23,26,27,28,29,30,31,32,33,34,38,41,50,51,53,54,56,58],foo9876a:65,foo:28,force_refresh:32,ford:[20,22,63,64],forgot:65,fork:42,form:[17,21,34,36,39,44],format:[0,3],fortun:9,forward:[54,60],found:[12,37,51,52],four:[52,57],foursquar:59,fragment:54,framebord:43,framework:62,francisco:[23,36,60,61],fred:[12,13,21,60,63],free:[32,34],friend:[20,23,35,59],from:[0,5,10,12,13,14],full:[13,17,27,35,36,38,51,52,56,57,63],fulli:[28,32],further:[12,28,33,38,41,51,54,56],furthest:[13,23],futur:[17,56],g9qgaaaurv_lfq7uu6ayhjjjn7qcrgovnvu:53,gain:[51,56],game:8,gaufeolxeecfrgbqvsaaca:52,gcm:44,gem:49,gener:[0,7,8,28,29,31,32,34],geo:29,geocoo
rdin:23,geograph:13,geoloc:[12,13],get:[3,5,9,12,13,14,15,16,17],ggkaaqmaggkabge5ffm1aqcadqaq_9ewr_ozeeguwxixowauaqcadqaqablaovoaeeguwxixowauaqa:59,ggkaaqmaggkabge5mlfh7gcadqaqjikhxefqeegw9hixowbregcadqaqjnep6ufqeegw9hixowbrega:59,ggkaaqmaggkabge5xc3r1gcadqaqz02yhp6qeegvybixoxisvgcadqaqz3soh_6qeegvybixoxisvga:39,ggkaaqmaggkabge5xc3r1gcadqaqz02yhp6qeegvybixoxisvgcadqaqz4zbyf6qeegvybixoxisvga:36,ggkaaqmaggkabge7pehcgwcadqaqvj9dljfzeekg9wloguza3acadqaqvkvrctfzeekg9wloguza3aa:59,git:[0,42],github:[30,42],give:[7,12,18,27,28,35,53,58,64],given:[17,18,27,34,39,43,44,51,56],gladi:[12,14],gmail:[32,36,59,65],goal:13,goe:30,gold:31,good:[0,27,56],googl:[35,36,44,59,65],govern:[50,52,57,60],grain:35,grant:[28,51,52,54,56,57],grant_typ:[31,37,52,53],grant_url_pattern:44,granular:[7,9],graph:[29,35],graph_async:32,graph_us:32,gravatar:[12,14,28,59,60,65],great:[35,41,60,61],greater:[11,12,13,53],greatest:57,groovi:0,group:[6,12,14,16,17,20,22,28,29,34],groupid:44,groupnam:[59,60],grouppath:60,g
roupproperti:44,gte:[11,12],guarante:33,guest:[27,51,56,59,65],guid:[10,30,42,54],hacker:[51,52,56,57],half_hour:9,hand:18,handi:26,handl:[25,35,36,64],happen:23,happi:[0,59],happy_cloud:6,hard:[2,57],hava:0,have:[0,1,12,14,16,17,18,22,26,28,34,37,39,41,44,52,53,54,56,57,59,60,61,62,64,65],head:[36,65],header:[5,51],height:[43,59],hello:59,help:[8,12,13,16,34,35,50,52],hemingwai:12,her:[18,36],here:[3,12,14,18,21,23,28,30,31,34,42,54,59,60,62,65],hierarchi:[7,34,38,39,58,60],high:[16,18,50,53],higher:[31,57],highest:[38,39],highlight:18,hike:57,him:31,hold:6,home:23,homepag:7,host:[30,32,51,54],hotmail:39,hour:9,hous:18,howev:[1,9,12,13,14,15,17,32,33,34,41,54,56,59,62],href:[36,39,65],html4:[36,65],html5:[28,29],html:[0,36,44,52,54,62,65],htmldisplayemail:44,htmldisplayemailaddress:[36,39],http:[3,5,6,7,9,12,14,15,16,17,18,19,20,21,22,23],human:[36,65],hundr:[12,13],hurrai:54,hystrix:32,icon:[59,62],idea:56,ident:18,identif:44,identifi:[10,18,34,36,41,65],ifram:43,illustr:[16,50],i
mag:[1,3,5,6,16,35,44,59],imagemodel:29,imagin:[12,14,18,57],immedi:[35,65],immut:34,implement:[28,35,50,51,52,54,57,65],improv:[23,35],inbox:[41,59,61],includ:[7,12,13,14,16,17,18,25,26,27,28,34,35,36,44,51,52,53,54,56,60,65],incorpor:62,incorrect:[28,36],increas:[15,23,35],increment_valu:7,incub:[30,32,42],index:[0,11,12,13,17,32,34,62],index_prefix:32,indic:[12,44,53,59,60],indicet:44,individu:[17,34,53,57],ineffici:[13,14,18],inflat:18,info:[36,44],inform:[5,9,13,14,15,16,17,18],infrastructur:[34,35],ing:59,inher:56,init:54,initi:10,initil:32,inner:18,input:[32,36,65],insecur:56,insert:54,insid:28,instal:[0,10,26,28,29],instanc:[30,31,34,52,55,62],instead:[18,28,32,35,52,56,57],instruct:[0,30,54,62,65],integ:[12,13,44],integr:[23,28,35,54],intend:34,intention:18,interest:[9,35],interfac:[30,62],intern:29,interpret:[28,58],intersect:[11,12],intrins:28,introduct:29,invalid:[41,54],iphon:62,isn:[12,16,26,28,50],iso:[36,65],issu:[0,3],item:[11,12,14,15,17,28,59],items:15,itself:18,j
ane:65,jar:31,java:[0,30,31],javascript:[7,10,12,14,16,28,29,30,33,36],javscript:33,jdk:[30,31,32],jdoe57:34,jenni:18,jim:36,jin:43,jinm:36,john:[28,34,52,59,60,65],johnson:43,join:18,jpeg:[1,3,5,6],jpg:[3,6,16,18],json:[11,12,14,16,17,18,22,28,31,34,36,37,54,59,60,64],json_arrai:17,json_object:17,just:[16,18,19,21,23,27,28,30,59,64],k88dh4f:20,keep:[2,8,10,12,13,14,27,35,51,52,56,57],kei:[15,17,18,28,35,54],keyspac:[30,32],keyword:17,kid:18,kind:[12,13,14,18],know:9,krav:12,kravitz:[12,14],label:36,lack:27,lag:33,languag:11,larg:0,last:[6,12,13,34,39,41],lastnam:[12,13,14,41],latenc:33,later:[18,23,44],latest:[30,31],latitud:[12,13,23],latitude_coordin:23,launch:[9,56],launcher:29,layer:31,lceecubwbqvsaaca:52,learn:[26,27,35,56,62,64],least:30,leav:30,left:[25,59,62],length:[3,6],less:[11,12,16,53,59],let:[9,31,35],letter:65,level:[7,9,16,17,25,26,27,29,31,34,35,37,38,39,50,51],leverag:[35,62],lib:[30,32],librari:49,lightweight:64,like:[0,3,6,9,11,12,16,18,19,20,21,22,27,30,32,33,3
5,36,41,54,56,58,59,61,62,63,64,65],liked_bi:63,limit:[2,12],line:[0,18,30,31,49],linear:[16,30],live:[27,29,51],load:[31,54],localfilebinarystor:2,localhost:[30,31,32],locat:[6,12],log:[7,30,35,41,52,54,55,59,62,65],logic:12,login:29,loginfacebook:54,logout:29,longer:[12,13,56],longitud:[12,13,23],longitude_coordin:23,look:[3,9,11,12,13,18,54,57,59,65],loos:[36,65],love:18,lower:7,lte:[11,12],ltixndg0nduxndpnr2tbqvffqwditufdwfj2ylm1emjxbdbhqunbzffbuuqymvzneexfrwvlrlv3tg9hc1dozxddqwrrqvfiyvdjb0jwrevls1vcd0xvr3nwt0jrqq:12,ltixndg0nduxndpvdjb0jwrevls1vcd0xvr3nwt0jrqq:13,made:[12,22,28,58,63],magic:18,mai:[0,7,10,15,17,27,34,55,56,60],mail:[30,32,34,60],mailer:[30,32],mailto:[36,39],main:[0,2,54],maintain:[18,54],make:[0,10,12,13,14,16,18,21,26,27,28,32,33,34,35,38,41,51,52,54,55,56,59,62,63,64,65],makefil:0,maker:16,malici:[50,51,52,57],manag:[1,6],mandatori:[1,2,41,44,60,61,65],mani:[8,12,13,14,16,18,23,27,34,64],manual:[59,63],map:16,marginheight:43,marginwidth:43,mark:12,massoddb:5
9,match:[12,13,17,58,65],matter:35,mattress:16,maven:[0,30,31,32],max:32,maximum:[12,13,53],mayb:18,mean:[11,16,17,18,27,33,34,50,51,56,63,64],meant:59,meanwhil:33,measur:50,mechan:62,meet:30,member:[12,34,36,38,44,57,59,60,61],meme:[60,61],memori:23,menu:[25,37,62],messag:[7,12,30,32,35,36,44,53,60,62,64],message:[21,29],meta:[36,65],metadata:[3,5,6,7,11,12,14,15,16,17,18,19,20,22,23,28,29,36,39],metadataproperti:44,meter:[12,13,23],method:[7,9,12,13,17,21,22],mfdsadfdsaoabl:59,middl:41,middlenam:41,might:[8,9,10,12,13,14,16,17,18,26,30,34,35,37,56,60],mile:[12,23],milk:[15,17],million:35,millisecond:[34,44,53],mind:[2,10,12,13,14,18,23,27],minim:[18,30,32],minimum:[34,37,39],minu:18,minut:[9,35],mirror:21,mix:28,moab:59,mobil:[16,18,23,27,29,37],model:[1,16],modern:[34,59],modif:[1,41,61],modifi:[1,3,6,7,12,14,15,16,17,18,19,20,22,23,28,34,36,39,41,44,53,59,60,61,65],modul:[7,49],monitor:35,month:[9,35],more:[5,7,9,10,12,13,14,15,16,17,18,23,25,26,27,28,29,30,34,35,39,42,44,50,52,
53,55,56,57,58,59,60,62,63,64,65],morn:9,most:[9,12,13,18,21,26,32,33,34,35,37,56,59,63,64,65],mountain:57,much:[11,16,18,56,62],multi:17,multipl:0,must:[0,11,12,17,18,31,32,34,39,44,51,53,59,60,62,63,65],mustach:0,mvn:[30,31,32],my_app:[16,18,41,54],my_org:[16,18,41,54],myadmin:31,myapp:[12,14,31],myasset:3,mycollect:[11,12],myfirstorg:31,mygroup:[59,60],mynewapp:[60,65],mynewgroup:60,mynewpassword:36,myorg:[12,14,60],mypassword:31,myself:[18,30,32],myuser:31,name:[1,2,3,5,6,7,9,11,12,13,14,15,16,17,18,19,20,21,22,23,25,27,28,30,31,32,34,36,37,39,41,44,51,53,54,56,58,59,60,61,62,65],narrow:11,nativ:[0,16],natur:[13,14],navig:[30,31,32],nearbi:23,nearest:[13,23],nearli:18,necessari:[18,35],need:[0,2,3,9,10,12,13,14,15,16,17,18,25,26,28,30,32,34,35,36,37,38,39,41,44,51,52,54,55,56,57,59,60,62,63,64,65],neg:7,nest:[17,34],net:[28,43,49],network:35,never:[27,29,37,51,52,53],new_password:[36,65],new_review_uuid:18,newli:[58,59],newpassword:[36,44,65],next:[12,13,15,25],node:[28,30,32,52
,55,59],nodej:32,non:[16,18],normal:[5,17,18],nosql:[13,14,16],notat:[11,12,14,16],note__:65,notic:[6,18,22,54,59],notif:[23,26,29,30,32,34],notifi:[29,34],notificationid:44,notify_sysadmin_of_new_admin_us:[30,32],notify_sysadmin_of_new_organ:[30,32],notitf:44,now:[21,30,31,32,54,62],number:[7,8,12,13,14,15,16,34,35,44,56,59,65],oauth2:44,ob5ko:53,object:[1,6,10,11,12,14,16,17,28,29,34,35,36,37,39],objectproperti:44,objecttyp:[36,39,44],objectuuid:44,obtain:[41,51,53,54,56],occur:[8,23],occurr:[12,13],octal:[11,12],off:[30,54],offer:[23,27,28,35,56,63,64],offici:62,often:[9,11,12,18,34,35,59],old:[36,44,65],old_password:[36,65],oldpassword:[36,65],omit:[12,14],onc:[0,12,13,18,30,33,54,56,65],ongo:[35,59],onli:[6,10,12,13,14,18,21,25,27,28,30,33,34,37,50,51,52,53,56,57,58,59,60,63,65],onlin:59,oop:54,open:[16,18,27,29,32],optim:[13,14,16,18],option:[6,10,30,32,34,51,54],order:[3,12],orderl:13,org:[2,3,5,6,7,9,14,15,17,19,20,21,22,23,28,30,31,32,36,37,39,44,51,52,53,55,58,59,60,63,64,
65],org_client_secret:52,org_clientid:52,org_id:[17,44,59,60,65],org_nam:[12,37,39,53,55],org_uuid:[37,39],organ:[0,3,5,6,7,9,12,14,15,16,17,18,19,20,22,25,27,28,29,30,31,32],organizationnam:53,organizations_require_activ:[30,32],orgid:44,orgnam:[10,44,52,54],orguuid:44,origin:60,originali:61,oscar:31,our:[0,10,12,13,14,21,30,31,32,42,64],out:[12,13],outbox:59,outgo:32,outlin:6,output:54,over:[9,53],overrid:[32,53],overview:[13,14,29,34,35],overwritten:17,own:[8,27,35,44,54,58,59,60,61,65],owner:[1,3,39,44,59,60],packag:[30,54,62],page:[26,27,31,36,52,54],pair:[12,15,17],param:[3,6,7,9,12,14,15,16,17,18,19,20,22,28,53,58,59,60,65],paramet:[5,6,7,9,10,12],pars:54,part:[10,12,13,14,18,23,28],partial:[13,34],particular:[11,12,18,59],particularli:[16,18,58,59,63],partit:26,pass:[12,13,37],passiv:64,password:[28,29,30,31,32],path:[1,3,6,7,12,14,15,16,17,18,19,20,22,23,27,28,29,30,32,36,39,44,54],path_to_imag:18,pathnam:54,pattern:[44,58],payload:44,peak:9,peopl:[8,34,59,60,61,62],per:[15
,16,54],perceiv:33,perform:[5,6,15,16,18,20,33,35,36,38,41,51,52,57,58,59,61,65],period:[8,9,23],perl:49,permiss:[6,12,14,20,22,27,28,29],permissiondata:44,persist:[28,31,32],person:[18,23,36,39,62],perspect:34,pertin:38,pet:31,phone:[12,14,49],phone_numb:[12,14],photo:[23,64],php:49,physic:[12,23],pictur:[5,6,12,14,23,28,41,44,60,65],pinterest:59,pip:0,place:[16,17,18,30,34,52,65],plai:[8,26],plain:5,plan:18,platform:35,pleas:[11,36,51,53,63],plenti:0,plural:[15,17,34,44],png:18,point:[11,12,13,16,23,32,33,35,54,62],polici:[42,56],pop:62,popul:[21,60,62,64],popular:[35,62],port:[30,31,32],portal:[25,26,27,30],portion:44,pose:53,posit:[12,13,23],possibl:[18,56,63],post:[3,6,7,8,12,15,17,18,19,20,21,25,27,28,29,31,36,37,38,39,44,51,52,53,56,58],postal:[12,13],potenti:[12,13],power:[23,31,34,35,43,52,57,63],practic:[13,14],preced:[12,14,18],precis:59,predefin:34,prefer:[12,13,28,30],prefix:37,prepar:56,present:[18,29],preserv:60,prevent:[13,14],preview:0,previou:[59,62],previous:62,pr
ice:[11,12,15,17],primari:[18,41],primarili:1,prior:56,privaci:59,privat:35,privileg:39,probabl:[0,18,30,33],process:[31,34,36,64],product:[16,18,25,27,29,30,34,44,50],product_uuid:[16,18],productid:18,productimag:18,productnam:18,productuuid:18,profil:[23,35,41,54,64],program:33,programmat:[25,37,57],project:[0,31,38,39,42,62],prompt:[30,54],prone:59,proof:[36,65],properit:23,properli:[31,33],properti:[1,2,5,6,7,10,11],properties____:30,property_1:[15,17],property_2:[15,17],property_nam:[12,13],propti:36,protect:[50,52],protocol:[30,32,54,56],prototyp:54,provid:[7,9,12,13,15,16,17,23,25,28,32,34,35,36,37,39,41,44,51,52,54,56,57,59,60,62,65],provis:[41,54],proxim:[13,23],pure:28,purpos:[11,27,30,34,37,64],push:[0,23,26,29],put:[6,12,14,15,17],pw123:30,pwhere:32,python:0,qualifi:28,quantiti:11,query_stat:[12,14],query_str:[60,65],querystat:44,queue:44,quick:29,quicker:28,quickli:[13,14,18,34,35,64],quitwait:[30,32],quot:[14,44],quotat:12,radiu:12,rail:49,raleigh:43,rang:9,rate:18,rat
her:[6,18,19,20,35],raw:0,rdbm:[16,18],reach:[11,12],reactiv:29,read:[10,12,13,14,16,18,26,42,44,59],readabl:18,readi:[12,13,26,32,62],readm:[0,42],real:44,reason:60,recaptcha:[36,65],recaptcha_challeng:44,recaptcha_challenge_field:36,recaptcha_respons:44,recaptcha_response_field:36,recaptchaopt:36,receipt:[29,34],receiptid:44,receiv:[12,13,33,41,61,62,65],reciproc:63,recommend:[30,56],record:[34,35],recurs:58,redirect:[30,32,54],redirect_root:[30,32],redirect_uri:54,reduc:[14,18],redund:18,ref:44,regard:[7,34],regardless:17,regionnam:2,regist:[35,50,57,62,64,65],rel:[1,36,65],relat:[6,12,16],relationship:[18,19,20],relev:[23,35,44,54,56,64],reli:18,rememb:[11,12,54,62],remind:18,remot:[12,23],remov:[27,29,30,36],renam:34,repeat:62,replac:[2,18,21,54,62],replic:30,replication_factor:[30,32],repo:[30,32,42],report:8,reposloc:2,repres:[13,16,25,28,34,35,36,39,57,58,59,60,65],represent:[12,13,17,28,34],request:3,requir:[0,7,15,19,20,23,27,29],resembl:12,resend:44,reserv:34,resetpw:[29,
30,32,36],resetpwmsg:29,resolut:9,resourc:[0,2,28,38,41,44,51,54,57,58],resource_path:[44,58],respect:51,respons:3,response_typ:54,restaur:[12,13,23],restkit:62,restrict:56,restructuredtext:0,result:11,review_entity_json:18,review_uuid:18,reviewed_product_uuid:18,reviewedbi:18,reviewedin:18,revok:[29,51,53],revoketoken:55,rich:[35,64],right:[18,28,33,59,62,64],rigid:34,risk:53,rock:[11,12],rockadero:[12,23],rocki:57,role:[6,11,12,14,20,22,25,27,28,29,34],roleid:44,rolenam:[6,12,14,20,22,28,41,44,60,61,65],roleproperti:44,root:[0,30,31,32,56],rout:[35,59],row:16,rubi:[28,49],rule:[27,35,50,51,52,56,57,58,60,65],run:[0,8,29],safe:[52,57],sai:[9,51,52,59],said:12,sake:32,same:[6,7,13,18,20,22,23,32,34,35,57,59,60,61,62],sampl:[21,59,60,62,65],san:[23,36,60,61],sandbox:[6,17,26],santa:43,save:[6,17],scalabl:[16,18,30],scale:18,scatter:18,scene:[41,54],schedul:44,schedulenotif:29,schema:[16,34,44],scope:[18,31,52,54,57],screen:[25,43],script:[0,36,57,65],scroll:43,sdk:[7,10,16,17,26],sea
rch:[9,12,13,35],second:[7,33,36,53,62],secondari:18,secret:[29,37,44],secretkei:2,section:[28,37,51,52,60,62,65],see:[3,5,9,10,11,12,13,14,15,16,17,21,22,23,25,26,27,28,30,31,34,35,36,37,38,39,42,50,51,52,53,54,56,57,58,59,60,62,63,65],seen:59,segment:58,select:[11,12,13,14,18,25,27,28,60,62,65],self:54,send:[2,5,10,12,13,14,22,23,31,35,36,39,41,44,54,62,64],sens:[18,35],sensit:[27,50],sent:[10,12,14,28,36,37,39,44,51,52,58,62,65],separ:[7,12,14,18,34,54],seri:0,serv:[56,57],server:[12,13,27,30,33,35,37,51,52,54,55,56,57,60,62],servic:[2,12,14,23,27,28,31,35,36,38,39,41,44,50,52,54,59,60,62,65],session:[54,56],set:[0,5,6,7,9],setexpir:29,settoken:54,setup:29,sever:[2,28],share:[31,39,59,64],shell:26,shortcut:12,shorthand:[12,13],should:[0,3,12,13,14,17,18,19,20,26,27,30,32,42,44,50,51,52,53,56,57,62],show:[14,15,18,62],shown:[10,12,13,14,15,17,22,36,51,54,59,60,65],side:[35,37,51,52,54,56,57,62],sign:[29,30,32,34,35],similar:[18,21,59,62],simpl:[0,16,18,21,27,30,34,35,62,64],simple
strategi:[30,32],simpli:[15,22,28,35,59,62],simplifi:[18,35],sinc:[11,13,33,51,57],singl:[9,14,16,17,18,30,34,35,44,60],singular:34,six_dai:9,skim:17,sku:[16,17],slash:[60,61],slate:12,slideshar:43,slideshow:43,slightli:16,slower:11,small:30,smith:[12,13],smtp:[30,32],snippet:54,social:[23,29],softwar:32,sojre5ywlkq7jrdcka:52,solid:43,solut:34,solv:35,some:[0,2,8,10,13,18,28,31,33,34,56,59,60,62],somegroup:60,someon:9,somepassword:[30,53],somesubgroup:60,someth:[3,18,30],sometim:[0,16],someus:[28,30,53,55,60,65],sourc:[16,18,29],space:18,span:[9,18],sparingli:57,special:[0,23,58,63],specif:[8,11,12,13,16,17,18],specifi:[7,12,13,14,15,17,19,20,22,23,28,30,38,39,44,51,52,53,58,59,60,62,65],split:9,sql:[11,12,18,35],squar:17,src:[0,2,36,43,65],stack:[2,29,30,31],stage:32,standalon:31,standard:[23,28,56,57,65],start:[9,12,13,14,16,18,26,28,29],start_tim:9,startup:31,state:[28,36,44,54],statement:[12,14,33,44],statist:8,statu:[14,30,31,32,36,39,44,54,64],steventraut:[60,65],still:[26,56]
,stock:[15,17,30],stop:[12,13],store:[2,6,11,12,13,14],str:59,strateg:18,strategi:[30,32],stream:23,streamlin:[18,62],street:12,string:[1,10,11,12,13,14,15,17,18,34,36,37,39,41,44,51,54,59,60,61],stringifi:54,strong:36,stronger:23,structur:[12,18,21,28,31,38,63],struggl:59,style:[35,36,43,50,59,62,65],stylesheet:[36,65],sub_properti:17,subgroup:60,submit:[13,14,36,42,58,65],subscrib:[21,59,60,61],subscript:[60,61,63],subsequ:[41,51,52,54],subset:[15,18],substitut:59,subtract:[11,12],succe:[41,54,58],success:[30,33,56],sudo:0,suggest:[23,27],suit:[52,57],summit:43,sungju:43,superadmin:30,superus:[30,32],suppli:[36,39,44,52],support:[0,9,11],suppos:17,sure:[12,25,27,32,50,56,62],swagger:0,symbol:65,sync:29,synchron:29,sysadmin:[30,32],system:[0,1,16,30,32,34,41,42,53,59,60,62,65],tag:54,take:[7,12,13,18,32,33,35,50,52,56],taken:[12,23,54],tale:[11,13],talk:[43,56,62],tar:54,target:[0,30,31,32,35,44],team:[38,39,62],technic:54,techniqu:[13,18],temp:2,templat:0,temporari:2,tempt:18,tend
:[60,61],test12345:[36,39],test1234:65,test123:[36,39],test:[6,12,13,27,30,32,39,56,57,60,62],testadmin:52,testadminpw:52,testapp1:[37,39],testapp2:39,tester123:39,tester:44,testorg:[37,39],testpw:52,text:[5,11],text_field:36,than:[0,6,7,9,11,12,13,14,15,18,19,20,30,35,53,56],thank:35,thei:[0,12,13,14,17,18,21,23,34,39,50,51,52,56,57,59,60,61,65],them:[0,7,10,11,12,13,14,18,27,28,35,52,54,57,59],theme:[18,36],themselv:65,thereaft:50,thi:[0,2,3,7,9,10,11,12,13,14,15,16,17,18,21,23,25,26,28,30,31,32,33,34,35,36,37,41,42,44,50,51,52,53,54,55,56,57,59,60,61,62,63,64,65],thing:[8,11,12,26,27,43,50,60,61,65],think:59,those:[12,13,18,42,50,51,52,56,57,59,65],though:[12,13,18,44],thousand:16,threadpool:32,three:[7,12,13,30,57,62],through:[16,18,21,25,35,37,38,39,41,44,50,54,56,57,59,60,65],thu:12,thumb:27,tier:31,time:[7,8],timeout:32,timestamp:[1,3,6,7,9,11,12,14,15,16,17,18,19,20,22,28,30,34,36,37,39,41,44,53,55,58,59,60,61,65],titl:[11,13,18,36,39,44,60,61,65],tld:[30,32],tmp:2,toctre:0,
todai:[12,23],togeth:[0,57],token:[10,15,17,27,28,29,31,36,37,38,39,41,44],token_to_revok:55,tom:58,tomcat:29,too:0,tool:[10,12,13,14,35],top:[25,31,54,62],topic:[13,52,60,61,65],topolog:30,track:[7,8,41],trail:57,transfer:28,transform:0,transit:[36,65],transport:[30,32],treat:[17,29],trend:35,trial:28,truli:35,tsefia:36,ttl:29,ttl_in_millisecond:53,tupl:16,turn:54,tutori:26,tweet:[21,35,59],twitter:[21,35,59,62],two:[12,13,14,21,31,33,34,36,51,62,63,64],type:[1,3,5,6,7],typic:[11,12,28,34,65],udpat:0,uffff:[11,12],ugc:49,under:[27,30,52,55,56,62],underli:16,understand:34,unencod:[10,12,13,14],unexpect:44,unfamiliar:16,unfortun:0,unicod:[11,12],union:[11,12],uniqu:[1,12,17,34,41,44,54,60,61,62,65],univers:34,unix:[1,7,41,44,61],unless:[0,41,51,54,57,62],unlik:[12,16,17,34],unnecesari:56,unreleas:32,unsecur:56,unsent:44,until:33,untrust:56,untrustworthi:29,upcom:23,upon:28,upward:7,uri:[3,6,7,9,10,12,14,15,16,17,18,19,20,22,28],url:[10,12,13,14,15,17,18,22],usag:9,usegrid:[28,29],use
r:[6,8,11,12,13,14,15,17,18,19,20,21,22,23,25,26,27,28,29],user_uuid:18,user_uuid_or_usernam:55,usergrid_appl:32,usergriddatacli:[52,55],usergridsdk:54,userid:44,usernam:[12,13,14,17,19,20,22,28,30,31,32,34,36,39,41,44,50,52,53,56,57,58,59,60,62,63,65],username_or_email:65,usual:30,utc:[34,44],util:[31,34,35],uuid:[1,3,5,6,7,11,12,14,15,16,17,18,19,20,22,23,28,34,36,37,39,41,44,53,54,58,59,60,61,65],uuid_for_selected_review:18,val:54,valid:[2,15,17,34,36,37,39,41,51,53,54,56,58,59,60,61,65],valu:[2,7,9,11],valuabl:35,value_1:[15,17],value_2:[15,17],vari:9,variabl:58,varieti:[17,28,38,65],variou:56,verb:[18,21,36,39,44,59],veri:[0,12,13,14,26,34,51,59],verifi:50,version:[30,32,62],versu:59,via:[0,30,34,36,39,57,58,60,61,64],video:[1,6,29,35],view:[9,12,18,22,30,32,57,59],virtual:21,visit:30,visitor:57,w3c:[36,65],wai:[7,12,13,14,16],wait:[12,13,33],walk:21,wall:59,want:[0,2,6,7,12,13],war:29,warn:[27,51,52,57],watch:30,web:[12,14,16,18,30,31,32,37,41,52,54,56,57,64],webapp:[30,31],we
ek:9,welcom:[30,32],well:[23,28,30,35,55,56,59,62,63,64,65],went:30,were:[12,13,14,23,60,61],what:[18,23,26],whatev:27,whatsoev:50,when:[0,6,10,12,13,14,17,18,19,21,23,27,28,29,30,32,33,34,35,44,50,51,52],whenev:54,where:[0,3,11,12,13,14,18,21,23,26,27,28,32,34,41,54,56,59,65],whether:[12,41,44,51,64],which:[0,9,12,13,15,16,17,18,20,25,30,33,34,36,38,41,44,50,51,52,53,54,56,57,58,59,60,61,63,65],who:[18,21,35,42,44,50,52,56,59],whole:[12,17,44],whose:[12,13,14,22,28,65],why:30,wide:[57,65],width:[43,44,59],wildcard:[13,58],window:[26,49,54,62],wireless:[12,23],wish:[15,34,65],within:[7,12,13,17,23,30,34,39,53,57,59,62],without:[12,13,51,65],won:59,word:[12,13,15,16,17,18,21,59],work:[0,13,14,16,18,23,27,29,30,32,33,35,55,56],workflow:42,world:59,would:[5,9,10,12,13,18,22,23,30,36,51,53,54,56,57,58,59,60,61,63,65],wouldn:18,write:[12,16,18,50,62],written:[0,16,18,30,42],wrong:[21,30],wrote:18,www:[12,14,28,36,43,54,59,60,65],xfbml:54,xml:2,xxxx:12,xxxxxxxx:12,xxxxxxxxxxxx:12,yaml:0,y
ear:59,yet:[12,13,60],yhixpqk1cq:37,you:[0,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17],your:[0,2,5,6,7,8,9,10,11,12,13],your_app_id:54,your_domain:54,your_redirect_url:54,your_response_typ:54,your_state_valu:54,yourapp:10,yourappnam:54,yourdomain:28,yourorg:10,yourorgnam:54,ywmt4nqe8q9geelyjhixpsio4aaaato5fqfcg0ced2h9nwmdmrorknnreeqydof:36,ywq6aaabmqz_xuyyeerokkjnzn7yqxxlpgml69fvaa:52,yxa65gylqja8ayysay8ox3vg5arzp48:37,yxa6aaabmq0d4mep_ugbza0:52,yxa7ygil:37,yxb7nad7em0meej989xixprxekq:52,yxb7nautv9krhhmr8ycw0qbozh2pxef:52,yxu6aaabmq0hdy4:52,zip:54},titles:["Apache Usergrid Documentation","Assets","File storage configuration","Folders","<no title>","Retrieving assets","Uploading assets","Creating & incrementing counters","Counters & events","Retrieving counters","Advanced query usage","Query operators & data types","Query Language","Query parameters & clauses","Querying your data","Collections","The Usergrid Data Store","Entities","Data Store Best Practices","Connect
ing entities","Disconnecting entities","Relationships","Retrieving connections","Geolocating your Entities","COMING SOON...","Creating a new application","Creating an Usergrid Account","Using a Sandbox Application","Using the API","Apache Usergrid Documentation","Usegrid 1: Deploying to Tomcat","Usegrid 1: Launcher Quick-start","Usergrid 2: Deploy to Tomcat","Async vs. sync calls","Usergrid Data model","Usergrid Features","Admin user$","Application","Organization & application management","Organization","COMING IN USERGRID 2","Users & Devices","How to Contribute Code & Docs","Presentations & Videos","Methods","iOS SDK","Java SDK","JavaScript/HTML5 SDK","COMING SOON...","SDKs & Tools","Security & token authentication","Authenticating API requests","Authenticating users & app clients","Changing token expiration (time-to-live)","Facebook sign in","Revoking tokens (logout)","Security best practices","Authentication levels","Using permissions","Activity","Work
ing with group data","Groups","App Example - Messagee","Social Graph Connections","User management & social graph","Working with User Data"],titleterms:{"default":[34,53,56],"new":[25,27],"return":65,"super":30,access:[28,51,56],account:[26,62],acquir:56,action:44,activ:[35,36,39,59,64],activityfe:44,actor:44,add:[30,54],addpermiss:44,addrol:44,admin:[36,39,52,55,57],adminuserupd:44,advanc:10,all:[10,21,22],android:62,apach:[0,29,43],api:[0,10,28,31,51],app:[23,43,52,54,56,62],appdata:44,applic:[25,27,34,35,37,38,39,52],asset:[1,3,5,6,35],assign:58,async:33,asynchron:33,attach:10,authent:[28,35,50,51,52,57],backend:43,base:28,basic:[12,14],batch:15,best:[18,56],between:[0,21],build:[0,30,31,32,43],call:[10,33],cancelmsg:44,cassandra:[30,43],chang:[0,53,65],claus:13,client:[39,51,52,56,62],code:42,collect:[15,28,34,44,61],come:[24,40,48],complet:36,complex:58,comput:18,configur:[2,30,57],connect:[19,21,22,63,64],consol:30,construct:28,contain:13,content:[0,12],contribut:[42,43],c
ounter:[7,8,9],creat:[7,15,17,21,25,26,27,36,37,39,53,54,59,60,62,63,65],createact:44,createadminus:44,createapp:44,createent:44,createev:44,creategroup:44,createnotif:44,createorg:44,createus:44,credenti:[37,39,44],cursor:13,custom:[17,30],data:[5,11,12,14,16,17,18,23,34,35,60,65],databas:30,deal:0,decrement:7,delet:[15,17,21,60,65],denorm:18,deploi:[30,32],deploy:32,descript:60,devic:[41,44],dialog:54,differ:0,disconnect:20,displai:65,doc:[0,42],document:[0,29,42],download2:31,download:[30,31],edit:56,enrich:23,entiti:[5,15,17,19,20,21,22,23,28,34,35,44],error:44,event:[8,44],exampl:[5,6,7,9,15,17,30,32,36,37,39,52,53,54,55,58,59,60,62,65],expir:53,facebook:[41,54],featur:35,feed:[36,39,59,64],file:[0,2,30,32,35],flexibl:35,folder:3,follow:[59,63],form:65,format:[12,28],from:[15,39,60],gener:[37,39,61],geoloc:[23,35],geoqueri:12,get:[18,21,30,31,36,37,39,65],graph:[63,64],group:[35,44,59,60,61,64],handl:65,hierarch:7,how:[0,42,43],html5:[47,62],http:[28,31,56],imagemodel:44,increm
ent:7,inform:21,initi:36,instal:30,intern:43,interv:9,invok:54,issu:28,itself:32,java:[32,46],javascript:[47,54,62],languag:12,larg:12,launcher:31,let:65,level:[52,57],limit:13,link:3,list:3,live:53,local:[2,32],locat:[13,23],login:[30,35,52,54],logout:55,manag:[12,35,38,64],markdown:0,message:62,metadata:44,method:[28,44],mobil:[43,56],model:[18,34,44],multipl:[12,14,17],never:56,next:26,note:0,notif:[35,44],notifi:44,oauth:[28,54],object:44,open:43,oper:[11,12],order:13,organ:[34,38,39,44,52],other:[0,21,63],out:18,overview:43,paramet:[13,60],parti:35,password:[36,65],path:58,permiss:[35,44,56,58],portal:32,post:59,practic:[18,56],pre:18,prerequisit:0,present:43,product:56,properti:[12,14,17,30,32,34,41,61],publish:0,push:35,put:18,queri:[10,11,12,13,14,18,23,28,35],quick:31,reactiv:[36,39],receipt:44,refer:0,registr:35,relat:18,relationship:[21,35,41],relationshop:41,remov:[39,58,60],request:[5,6,7,9,14,15,17,19,20,22,28,36,37,39,51,52,53,55,58,59,60,65],requir:[30,31,32],reset:[
7,36,65],resetpw:44,resetpwmsg:44,respons:[6,7,9,12,14,15,17,28,36,37,39,52,53,58,59,60,65],rest:[0,65],result:[12,18],retriev:[3,5,9,12,14,15,17,18,22,39,59,60,65],review:[18,56],revok:55,role:[35,44,56],rst:0,run:[30,31,32],sandbox:[27,56],save:23,schedulenotif:44,sdk:[28,32,45,46,47,49,52,54,62],secret:51,secur:[25,27,50,56],set:[12,15,36,41,44,61],setexpir:44,setup:[30,54],sign:[41,54],social:[35,63,64],soon:[24,48],sort:12,sourc:43,specif:21,sphinx:0,stack:32,start:[30,31],step:[26,54,62,65],storag:[2,35],store:[16,18],stream:35,sub:17,support:[12,28],sync:33,synchron:33,syntax:[5,6,7,9,12,14,15,17,19,20,22,52,53,55,58,60,65],tabl:0,text:12,third:35,time:[9,53],token:[50,51,53,55,56],tomcat:[30,32],tool:49,treat:56,ttl:53,type:[11,12,21,22],untrustworthi:56,updat:[0,6,15,17,36,65],upload:6,uri:[36,37,39,59,60,65],url:[28,39],usag:[10,14],usegrid:[30,31],user:[30,35,36,39,41,44,52,55,57,59,60,62,64,65],usergrid:[0,16,26,29,30,32,34,35,40,43,62,65],valu:[12,14],video:43,wai:[18,5
6],want:18,war:30,websit:[0,42],what:27,when:53,work:[60,65],you:18,your:[14,18,23,56]}})
\ No newline at end of file
+Search.setIndex({envversion:46,filenames:["README","assets-and-files/file-storage-configuration","assets-and-files/folders","assets-and-files/legacy-asset-support","assets-and-files/retrieving-assets","assets-and-files/uploading-assets","counters-and-events/creating-and-incrementing-counters","counters-and-events/events-and-counters","counters-and-events/retrieving-counters","data-queries/advanced-query-usage","data-queries/operators-and-types","data-queries/query-parameters","data-queries/querying-your-data","data-storage/collections","data-storage/data-store-dbms","data-storage/entities","data-storage/optimizing-access","entity-connections/connecting-entities","entity-connections/disconnecting-entities","entity-connections/retrieving-entities","geolocation/geolocation","getting-started/creating-a-new-application","getting-started/creating-account","getting-started/using-a-sandbox-app","getting-started/using-the-api","index","installation/ug1-deploy-to-tomcat","installation/ug1-lau
ncher-quick-start","installation/ug2-deploy-to-tomcat","introduction/async-vs-sync","introduction/data-model","introduction/overview","introduction/usergrid-features","orgs-and-apps/admin-user","orgs-and-apps/application","orgs-and-apps/managing","orgs-and-apps/organization","push-notifications/tbd","push-notifications/users-devices","reference/contribute-code","reference/presos-and-videos","rest-endpoints/api-docs","sdks/ios","sdks/ios-new","sdks/sdk-outline","sdks/tbd","security-and-auth/app-security","security-and-auth/authenticating-api-requests","security-and-auth/authenticating-users-and-application-clients","security-and-auth/changing-token-time-live-ttl","security-and-auth/facebook-sign","security-and-auth/revoking-tokens-logout","security-and-auth/securing-your-app","security-and-auth/user-authentication-types","security-and-auth/using-permissions","security-and-auth/using-roles","user-management/activity","user-management/group","user-management/groups","user-management/me
ssagee-example","user-management/user-connections","user-management/user-management","user-management/working-user-data"],objects:{},objnames:{},objtypes:{},terms:{"005056c00008":62,"00767101f6b4f2cf5d02ed510dbcf0b4":57,"02e81ac5a17b":[2,10],"02e81adcf3d0":[5,6,8,13,15,18,19,24,43,54,55,56,57],"02e81ae236e9":57,"02e81ae61238":57,"02e81ae640dc":[2,56],"02e81ae66238":57,"02e81aeb2129":57,"02e81aeb26e9":57,"02e9sjwsf3d0":[15,43],"03ae956a":20,"0455fc92de2636fc7a176cc5d298bb78":57,"08fe":43,"0abe":[13,43],"0d7cf92a":[15,43],"0d7e":36,"0d7f":36,"0f1ff3650d20":[17,57,62],"10e":10,"10e10":10,"11e0":[8,62],"11e1":[2,24,30,33,36,56,57,62],"11e2":[2,5,6,8,10,12,13,15,18,19,24,36,43,54,55,56,57],"11e3":[5,13,15,17,18,19,20,24,43,49,55,57,62],"1231380a0284":56,"12313b01d5c1":[2,24,30,56],"12313b06ae01":56,"12313b06d112":56,"12313b111c56":36,"12313b122c56":[33,36],"12313d027361":36,"12313d027471":36,"12313d14bde7":57,"12313d1520f1":56,"12313d1c4491":[2,33,36,56],"12313d1c44914":56,"12313d1c5591"
:36,"12313d288ee0":36,"12313d288ff0":36,"12313d331ae8":56,"12313f0204b":62,"12313f0204bb":[8,62],"12313f0204bb8":62,"12331b144c65":33,"12331d1c5591":[33,36],"12424d1c4491":33,"174785aa":17,"19a0":[15,43],"1a62":[13,43],"1a9356ba":[13,15,43],"1bd100b8059e":[13,43],"1c8f60e4":62,"1f3567aa":56,"1px":40,"1st":41,"20adr":62,"20c57d4f41cf51f2db44165eb058b3b2":12,"20employe":57,"20or":15,"20titl":57,"20uuid":15,"20where":[57,62],"22000a1c4e22":57,"22000a1c5a67":[57,62],"2440ca58":56,"2482a1c5":56,"249f":20,"2ac6":2,"2ac8":2,"2d00":56,"2d21":2,"2e1db7299b0a667ed80e674a0ef9d653":5,"2nd":41,"31847b9a":[13,43],"3192ac6a":[13,43],"327b527f":[33,36],"328b526e":33,"328fe64a":[15,43],"335b527f":[33,36],"33dd0563":[33,36],"3400ba10":[2,36,56],"348388de":55,"34e26bc9":56,"3500ba10":36,"37f3":56,"382d0991":55,"38dc":15,"3c1e":55,"3d1a9356ba":15,"410b213a":[5,55],"411c466c4f2c":12,"417f":[17,57,62],"4353136f":62,"438a1ca1":8,"477d":57,"48c92c73":36,"496ca1d42ce7":[13,43],"49ff":56,"4a1edb70":[15,43],"
4d2664c8e0c3":57,"5005a0fa":57,"503f17da":24,"50gb":1,"5111c463":56,"5373d7165c2d":49,"53fe3700":[13,43],"563f5d96":56,"58606d0a":[18,19],"58e8":[57,62],"5ae1fa7a":[13,43],"5bb76bca":[13,15,43],"5bcc47ca":[18,19],"5bd5fa5f701f":43,"5c0c1789":[2,30],"5de0bb69":36,"5f4a65c16193":[15,43],"5wugd":48,"61c9":56,"62de5d97":24,"62fd53c78ce7":54,"65c8":36,"6640a601":2,"6715d5ef47a6":[15,43],"67cb":57,"698b":57,"699740088e05":6,"6a42":56,"6b07e44495ef":55,"6be0003c809b":[13,43],"6c56ffda":17,"6fbc8157":57,"6ldstnesaaaaakhdvglhmmu86_eoyxsjjqqd1ipz":[33,62],"74bb":55,"74d2d7da":57,"78c54a82":62,"7bf47435":2,"7fb8d891":57,"802f":57,"81581bbaf055":[13,15,43],"8272c9b0":12,"83ceb9965c26":57,"83de":57,"83e9b7ea":[15,43],"84a5":62,"84c0":56,"84df":[15,43],"87b9":36,"884d":62,"89ab":[13,43],"8a2a":[15,43],"8a4c":54,"8ae8a6ea":62,"8bde":[18,19],"8cef":12,"8d05e96f700d":[13,43],"8d5c":24,"8dd1801e534c":17,"8e0cd3866ee20746c99e9a9825f38ad8":2,"8ea8":17,"903f":[13,15,43],"90f823ba15655b8cc8e3b4d63377576f
":57,"917d":[15,43],"924d":10,"92c3":2,"92e2":12,"9501cda1":2,"95c8":[33,36],"96f6":56,"98b9":36,"9953085ea376":[5,55],"999e12039f87":43,"99a7":49,"99fd":17,"9c1b":57,"9ce3":[15,43],"9d3a":6,"9de5":55,"9e75":17,"9e92":[15,43],"9efc8ad529d8":55,"9f80":20,"9ff6c621a7a4":[13,15,43],"9ffc":56,"____usergrid":26,"boolean":[10,36,38,41],"case":[9,16,26,29,38,41,43,56,58,60],"catch":43,"class":[1,28,33,48,51,62],"default":[1,10,11,12,13,14,15,20,24,25,26,28],"export":43,"float":10,"function":[6,29,32,42,50,53,56,57,58,59,61],"import":[23,24,29,30,32,46],"long":[10,30,38,58],"new":[6,9,13,15,16],"null":[6,50],"public":[33,62],"return":[10,11,12,13,16,19,20,24,27,29,33,36,38,41,48,49,50,51,54,56,57],"short":[22,56],"static":26,"super":25,"transient":28,"true":[10,12,18,19,24,26,27,28,33,36,41,50,55,57,62],"try":[22,23,27,33,43,46,50,54],"typeof":50,"var":[9,33,50],"while":[23,26,29,30,32,38,54,55],a065:56,a0dd:24,a0e5:[5,55],a0f7:56,a166:[5,6,8,13,15,18,19,24,43,54,55,57],a24f:[13,43],a407b1e
7:[57,62],a51b:[15,43],a554b7fbd57a:24,a5c5:55,a668717b:57,a694:[18,19],a6e3:57,a71c:54,a72a:[13,15,43],a7e008061e10:[18,19],a7f7:[5,6,8,13,15,18,19,24,43,54,55,57],a9c1:43,abbrevi:[12,16,24],abil:[20,22,32,60,61],abl:[16,24,26,52,53,56,61,62],about:[0,10,16,22,23,24,25,26,32,33,35,36,41,42,48,52,53,56,57,58,61,62],abov:[5,6,19,26,27,28,55,56],ac46:[57,62],accept:[4,48,54],access:[2,13,14,15,16,19,21,22,23],access_token:[27,41,47,48,49,50],accessid:1,accesstokenrepons:41,accesstokenrespons:25,accesstokenttl:49,accomplish:51,accord:48,account:[12,15,16],achiev:60,acquaint:56,acquir:25,across:[8,16],act:[12,56,59],action:[2,5,6,7,8,12,13,14,15,16,17,18,19,24,25,26,32,33,34,36],activ:[5,10,12,18,19,20,22,24,25,26,28,30],activit:33,activityfe:25,actor:[25,33,36],actorproperti:41,actual:16,add:[1,9,14,15,16,21,22,23,25],addit:[8,16,22,32,33,41,47,48,53,56,57,60,62],addobject:43,addpermiss:25,address:[12,24,26,33,36,38,41,48,62],addrol:25,addus:42,adjust:[11,55],admin:[21,22,23,25,26,27,2
8],admin_password:48,admin_usernam:48,admin_users_require_activ:[26,28],admin_users_require_confirm:[26,28],admingmail:33,administr:[26,27,30,32,34,36,38,48,52,53,55],adminus:[33,36,41],adminuserproperti:41,adminuserupd:25,adomain:62,adopt:[32,39],advantag:32,advertis:20,advis:52,ae1f:17,aec3:56,afad:56,affect:49,after:[6,10,24,27,29,48,50,52,55,59],again:[26,33],against:[18,28,34,47,48,52,54],aggreg:8,agre:42,air:14,alert:[20,29,57,58],alia:[55,62],all:[0,6,8],alloc:[42,43],allow:[7,12,20,24,26,28,30,32,36,38,41,50,53,54,55,56,57,58,60,61,62],almost:61,along:[11,16],alreadi:[15,16,22,26,38,41,43,50,52,59],also:[1,2,6,7,8,11,13,15,16,21,27,28,30,32,33,34,36,38,41,42,48,50,51,52,54,56,57,58,59,60,62],alter:55,altern:[12,13,57,58],although:[13,15,33,56,57,62],alwai:30,amazon:1,amazonaw:26,amount:[11,53,56],amuramoto:[5,15,43,49],analysi:32,analyt:22,analyz:[32,47,48,52,53],android:[24,25,29,31,43,44,48,50,51],ani:[5,6,8,10,12,14,15,16,20,28,29,30,32,33,35,41,42,46,47,48,49,52,53,54,55
,56,57,59,60,61,62],anonym:[38,56,62],anoth:[12,16,23,47,56,59,60,62],answer:62,ant:54,anuff:40,anyon:[53,56],anyth:26,anytim:56,anywher:11,apachecon:40,apidocgener:0,apige:[24,40,42,43,57],apigeecli:43,apigeeclientrespons:43,apigeecollect:43,apigeemobileconfig:49,apigeeorg:42,apikei:50,apirequest:43,apn:41,app1:41,app2:41,app:[2,4,5,6,7,8,12,13,14,15,16,17,18,19],app_id:[15,41,56,57,62],app_nam:[34,49,51],app_servic:42,app_uuid:[14,16],appdata:25,appdeleg:43,appear:[19,41,56,59,60],append:[8,9,13,16,20,47,50],appid:[41,50],appl:[32,41],appli:[24,28,49,52,54,55,60,61,62],applic:[2,4,5,6,7,8,12,13,14,15,16,17,18,19,20],application_client_secret:48,application_clientid:48,application_info:36,applicationdata:41,applicationid:[33,36,41],applicationnam:[2,5,6,8,12,13,14,15,16,17,18,19,24,41,43,49,54,55,56,57,62],appnam:[9,42,48,50],appropri:[30,38,42,50],approv:[26,28],arbitrari:[24,60],architectur:[14,26],archiv:42,area:[22,23,33,46,62],aren:[14,16],arg:[1,34,36,56,57],argument:1,arm:52
,around:[0,16],arrai:[10,12,14,15,16,19,24,41,43],arthur:[17,18,19,60,61],articl:[12,13,15,47,55],asc:11,ascend:11,ask:[12,28],aspect:[7,32],asset1:2,asset:1,assets_id:2,assign:[6,25,30,32,38],associ:[5,10,13,19,20,21,24,30,32,36,38,43,46,48,49,51,53,55,57,59,61,62],assum:[16,47],async:25,asynchron:25,atistophan:33,atom:15,attach:[4,5],attack:[46,52],attempt:[36,41,47],attribut:14,audienc:31,audio:[5,32],auth:[26,28,38,50],authent:[13,15,23],author:[27,35,47,49,50,56,61],author_uuid:16,authorid:[14,16],authorimag:16,authornam:16,authoruuid:16,authrespons:50,auto:[26,28],automat:[5,6,13,15,21,22,28,30,32,41,48,50,51,54,55,56,60],avail:[13,15,20,22,24,27,32,43,48,59,61],avatar:[12,24,56,57,62],avoid:[16,59],awai:16,awar:[10,20],awssdks3binarystor:1,b0c6:57,b11217fc:6,b1f7:[13,43],b24e:6,b2bd:57,b2e4:15,b31d:49,b36a:[2,30],b379:[5,55],b3aad0a4:43,b3u68vghi6fmeekn9wlogtzz0a:34,b3u6aaabmqz:48,b3u6zuz5_u8i:34,b4c6:2,b690:57,b6dd:56,b77ec8addc0d:57,b90c:57,b93d:62,baa:[33,36,46],back:[14,1
6,27,31,32,39,59],backend:[12,25,30],bad:[36,48,53],banner:7,bar1234b:62,bar:[24,31],barnei:[57,60],base:[0,13,20],basi:42,batch:11,baz:24,bcc1:8,bcf7:[2,33,36,56],bcf8:[33,36],bd397ea1:54,be04:[13,43],be08a5f9:36,be09a5f9:36,bean:1,bearer:[27,47],beca:36,becaus:[14,20,23,26,41,48,52,53,56,59],becom:[11,12,20,26,32,56,57,58],been:[6,16,42,47,50,51,52,56],bef8:[33,36],befor:[0,1,22,23,28,29,50,52,55,62],begin:[8,11,35],behalf:48,behav:59,behavior:32,behind:[22,38,50],belong:[27,30,38,56,58],below:[13,14,15,16,26,28,33,43,44,50,56,57,59,62],beneath:59,benefici:29,benefit:[14,26],besid:55,best:[11,12],better:[16,48,53],bewar:28,beyond:56,bike:10,bin:28,binari:[32,47,48,52,53],binarystor:1,bit:14,blank:55,blob:42,block:29,blog:55,board:59,boat:10,boavijt0oyrkjf:34,bodi:[6,16,33,34,36,41,49,56,57,62],book:[11,32,43],border:40,both:[6,14,17,28,29,30,39,41,53,61],bounc:16,bouncer:16,bounci:[14,16],box:[21,23,42,55,59,61],bracket:15,branch:42,bread:[13,15,43],brief:[29,50],broad:[47,48,53],
brows:31,browser:[26,28,33,50],bucketnam:1,bug:31,buildcurl:50,built:[16,24,26,56],busi:20,button:[7,21,23,33,55,59,62],button_click:[6,8],c2v7n61dy90mcdg78xixprxfdq:36,c2v7wedxiutzwekwdyslct_lydfvmmn:36,c5e707256e71:[15,43],california:[33,57,58],call:8,callback:[29,50],campaign:32,can:[0,1,2,4,5,6,7,8,10,11,12,13,14,15,16,17,19,20,21,22,23,24,26,27,28,29,30,32,33,34,35,36,38,39,41,42,46,47,48,49,50,52,53,54,55,56,57,58,59,60,61,62],cancel:[41,50],cancelmsg:25,cannot:[13,15,24,29,30,53],capabl:52,captcha:[33,41,62],captur:[12,16,20,32],car:10,carefulli:53,carri:35,cassandra:[14,16,25],cast:40,castl:[14,16],cat:27,catalina:28,catalog:32,categori:[14,33,36,41],caus:[0,15],caution:49,cautiou:[47,48,53],ccc:40,cd0c:[2,33,36,56],cd0d:[33,36],cd789b00:57,cd796d0a:57,cdf1ce04c1c0:12,cdn:32,cede5b7:36,cede5b8:36,cell:0,center:20,central:[0,1],certain:[15,16,30,51,61],cf3e981c:33,cf4d981c:[33,36],cf9b:8,cfed:[18,19],chain:6,challeng:[24,33,41,62],chang:[0,1,25,26,28,30,42,47],changelog:42,ch
annel:50,channelurl:50,charact:[11,56,62],charset:[33,62],check:[23,26,27,42,50,53,54,55,56],checkbox:55,checkout:42,checksum:[2,5],chicago:62,choos:16,circl:[32,56],circumst:51,cite:15,citi:[11,33,41,62],clara:40,classpath:1,clean:[0,26,27,28,33],cli:26,click:[7,16,21,23,35,55,59],client:[9,11,13,14,15,16,24,25,26,29,32,33,34,35],client_credenti:[34,41,48],client_id:[34,36,41,47,48,50],client_secret:[34,36,41,47,48],climb:16,clone:[0,26,28],closer:16,cloud:[1,4,5,32],clue:26,cluster:26,cluster_nam:28,cn0wtdxxkxmqlgzvtmubcp20fulczq:48,code:[1,11,16,24,25,26,27,29,31,32],coffe:14,colleagu:56,colleciton:43,collect:[4,5,12],collection_nam:13,collectionid:41,column:[14,16],com:[2,4,5,6,8,12,13,14,15,16,17,18,19,20,24,26,27,28,30,33,34,36,38,42,43,48,49,50,51,54,55,56,57,59,60,61,62],combin:[16,52,62],come:[23,25,26,28],comma:[12,41,43,50,54],comma_separated_list_of_permission_nam:50,command:[0,22,26,27,28,42,50,57],comment:[32,56],commit:[0,42],committ:39,common:[12,52,56,62],commonli:5
5,commun:59,compani:[35,36,59],compar:12,comparison:55,compil:[42,47,48,52,53],complet:[12,25,26,29,30,32],completemsg:41,complex:[15,16,25,32],complianc:42,compliant:32,complic:26,compon:[30,32],compromis:47,concept:[14,22],condit:42,config:28,confim:41,confirm:[26,28,33,36,41,59],confirm_email:[33,36,41],conflict:59,conform:10,conjunct:[32,61],connect:[0,2,5,12,16],connected_collect:[17,18],connected_ent:[17,18],connecting_collect:[17,18],connecting_ent:[17,18],consid:[48,52,55],consider:[47,48,53],consol:25,constrain:14,constructor:1,consult:22,consum:[32,56],contain:10,containslook:11,containswil:11,content_typ:4,context:[1,32],contextu:32,continu:[11,29,59],contrast:[16,60],contribut:[25,31],contributor:[31,39],control:[32,49,52,55,62],conveni:[9,47,57,59],convent:30,cooki:50,copi:[0,16,26,42,59],core:[27,28,32],cores:28,corpor:42,correct:[38,50,59],correspond:[12,13,15,24,30,41,43],cost:32,costli:16,could:[2,11,16,29,47,48,52,53,57,58,60,61],count:[7,8,12,13,14,15,43,56],count
er_nam:[6,8],coupl:31,creat:[2,5],createact:25,createadminus:25,createapp:25,createcollect:43,createent:[25,29],createev:25,creategroup:25,createnotif:25,createorg:25,createus:25,creation:[38,49,58],credenti:[25,26,28],credential:28,criteria:32,cross:56,css:[33,62],cumul:6,curiou:22,curl:[4,5,6,8,9,11,12,13,15,17,18,19,20,27,28,33,34,36,43,44,48,49,50,51,54,55,56,57,62],current:[6,13,20,30,31,41,42,54,56,62],custom:[9,13],custom_id:9,d0d7d0ba:12,d16344f5a0e1:20,d20976ff:57,d28c:24,d503:[2,30],d7a8:[15,43],d86a:12,d878de4r:49,d87edec7:56,d9693ec3:56,da448955:56,da4a50dc:15,da67:62,da71:62,da83:56,dai:[7,8,49],daili:8,dashboard:50,data:1,databas:[11,14,16,20,25],datacli:[9,43,48,51],date:10,dave:40,david:40,db1e60a0:[17,57,62],dbf5228024a7:[18,19],dbm:[11,12,14,16],dc5d478e9c029853fbd025bed0dc51f8:24,decim:10,decompil:52,dedic:6,defin:[7,14,15,23,28,30,43,46,48,49,54,55,56,57,61,62],definit:[41,54],degre:49,deleg:43,delet:[11,12],deletecollect:43,deleteent:43,delimit:[10,41,54,58],del
iv:[32,41],deliveri:[32,41],denot:[57,60],depend:[24,57,58],deploi:25,deploy:25,desc:11,descend:11,describ:[11,12,13,15,16,20,24,35,38,42,46,47,48,50,55,57,59],descript:[4,5,6,8,11,13,14,15,17,18,19,25,30,33,34,35,36,38,41,43,48,53,54,55,56],design:[14,16,20,26,32,56,57,58,59,61],destin:[1,42],destroi:51,detail:[13,15,22,30,32,33,34,35,36,41,48,50,55,56,57,60,62],detect:[5,20],determin:[20,56,62],dev:[28,50],develop:[10,20,23,30,31,32,41,42,52,59,61],devic:[5,18,19,20,21,24,25,30,32],dfr4d5m1mjmoeeogvpncm:49,dialog:[21,23,33],did:[15,42],differenti:32,dimens:61,diner:11,dino:[24,60],dir:0,direct:[0,16,42],directli:[0,34,53],directori:[0,26,27,28,39,50,59],disabl:[23,26,33,36,38,41],displai:[8,11,20,38,41,50,55,56,58,59],displayemail:41,displayemailaddress:[33,36],displaynam:[33,36,41,56],distanc:20,distance_in_met:20,distinctli:31,distribut:[14,16,42,52],div:[33,62],dk88fh4r:19,doctyp:[33,62],doe:[0,15,24,30,38,41,43,47,48,49,50,56,57,62],doesn:[14,16,23],dog:[15,24,29,57,58,60],dog
createcallback:29,doge:[57,58],domain:50,don:[26,52,56,62],done:[0,26,32,41,42,50,52,53,62],dot:[6,10],down:[10,21,31,55],download:25,drag:42,drive:[1,32],drop:[21,42,55],dropdown:21,dskiptest:[26,27,28],dtd:[33,62],due:[11,12,16,48],duplic:16,durat:[2,5,6,8,12,13,14,15,16,17,18,19,24,26,33,34,36,43,49,51,54,55,56,57,62],dure:[52,55],duti:55,e13743a7f1db7f4246badd6fd6ff54ff:62,e694:57,e7127751:57,e7d0:56,e8f5:[15,43],e94123890c7a:[15,43],e978:62,e97b:12,each:[0,6,7,8,10,12,13,14,15,16,20,23,24,30,33,38,43,44,50,53,55,56,57,62],eas:32,easi:[0,32,61],easier:[9,11,12,16,23,24,52,57,60],easiest:55,easili:[6,20,30,32,52,61],east:26,easy_instal:0,eb20e5bce407:17,ebc6f49d1fc4:[15,43],ec39:24,edit:[0,1,25,26],edort1:33,ee912c4b:10,ef0b:[15,43],effb:[15,43],effect:32,effici:[12,16],either:[1,13,17,41,42,47,50,55],elasticsearch:28,elev:52,elimin:[32,47,52],els:[29,50],email:[12,24,26,27,28,30,33,36,38,41,42,48,56,57,59,62],email_address:[24,62],embed:28,embed_cod:40,employe:57,empti:[13,43,59
],emul:[56,57,58],enabl:[20,26,32,38,50,52,55,56],enclos:[12,41],encod:[9,11,12,15],end:[8,32,43],end_tim:8,endpoint:[0,6,18,34,38,41,43,47,48,50,51,56,62],engag:[20,32],engin:31,enhanc:[20,42],enough:23,ensur:[10,16,24,32,46,48,52],enter:[21,23,33,50,55,59,62],entir:[11,41],entit:16,entiti:[0,2],entity_nam:15,entity_typ:[15,43],entity_uuid:15,entityid1:41,entityid2:41,entityid:[41,43,55],entityproperti:41,entitytyp:[33,36,41,55],entri:[11,50],environ:[22,41,52],equal:[10,12,49],equiv:[33,62],err:[29,50],error:[6,25,29,36,38],errorcod:41,errormessag:41,escap:43,essenti:61,establish:[41,56,61],etag:[2,5],etc:[31,38],evalu:26,even:[8,11,16,26,30,47,48,52,53,60],event:6,everi:[8,9,24,30,47,52,53,55,57,58],everyth:[0,24],exact:[20,61],exactli:11,examin:[8,52],exampl:[0,1],except:[15,42,47,52],execut:[9,11,12,29],exercis:42,exhaust:52,exist:[5,6,15,16,20,26,36,38,41,43,49,50,56,57],expect:[10,20,33,36,43,61],experi:[14,20,32,61],experiment:[23,46],expir:[25,41],expires_in:[41,48],explain
:[0,26],explan:29,explicitli:[47,51,55],expos:27,express:[11,42],extend:60,extens:59,extern:39,extract:[26,27,28,47,48,50,53],f18e8f6fb3bc:62,f315e5aa568a:[15,43],f322:43,f34f4222:[5,6,8,13,15,24,43,54,55,57],f399:56,f3a8061a:[15,43],f3aa:56,f3be262a:[15,43],f3teeg:34,f42752aa:43,f8zemolceecubwbqvsaaca:48,f_gubelxeecfrgbqvsaaca:48,facebook:[24,25,32],facebookaccesstoken:50,facebooktoken:50,factor:26,fail:[41,43],failur:14,fals:[10,26,28,33,36,41],famili:[14,20],familiar:[16,22],faq:26,far:21,fast:14,favorit:62,fb_access_token:[38,50],fbasynchinit:50,fbasyncinit:50,fc4d:56,fdd3:36,fe80:33,fe90:[33,36],featur:[16,20,22,24,25],feed:[5,12,18,19,24,25,32],feel:28,few:[11,20,59,61],ffd79647:56,field:[1,11,15,32,33,41,55],fieldset:[33,62],file_loc:5,filenam:5,files:1,filter:[12,56,57,62],find:[0,11,20,26,42,52,57],fine:[28,32],finish:[41,59],first:[0,11,12,13,16,22,24,28,29,33,38,43,52,55],first_nam:24,firstnam:[11,12,38],fish:27,fit:53,five_minut:8,flexibl:[14,16,25,30],flow:[50,62],fluff
i:27,fobnszewobnioerabnoiawegbrn:[5,55],focu:[24,32],folder:1,follow:[0,2,4,5,6,8,9,10,11,12,13,14,15,16,18,19,20,22,23,24,25,26,27,28,29,30,35,38,41,42],foo9876a:62,foo:24,force_refresh:28,ford:[18,19,60,61],forgot:62,fork:[39,42],forkei:43,form:[15,30,33,36,41,43],format:[0,2,12,13,14,15,20],fortun:8,forward:[50,57],found:[34,47,48],four:[48,53],foursquar:56,fragment:50,framebord:40,framework:[42,59],francisco:[20,33,57,58],fred:[11,57,60],free:[28,30],friend:[18,20,32,55,56],from:[0,4,9,11,12],full:[11,15,23,32,33,35,47,48,52,53,55,60],fulli:[24,28,42,43],further:[24,29,35,38,47,50,52],furthest:[11,20],futur:[15,52],g9qgaaaurv_lfq7uu6ayhjjjn7qcrgovnvu:49,gain:[47,52],game:7,gaufeolxeecfrgbqvsaaca:48,gcm:41,gener:[0,6,7,24,25,27,28,30],geo:25,geocoordin:20,geograph:11,geoloc:11,get:[2,4,8,11,12,13,14,15],getcollect:43,getent:43,getloggedinus:42,ggkaaqmaggkabge5ffm1aqcadqaq_9ewr_ozeeguwxixowauaqcadqaqablaovoaeeguwxixowauaqa:56,ggkaaqmaggkabge5mlfh7gcadqaqjikhxefqeegw9hixowbregcadqa
qjnep6ufqeegw9hixowbrega:56,ggkaaqmaggkabge5xc3r1gcadqaqz02yhp6qeegvybixoxisvgcadqaqz3soh_6qeegvybixoxisvga:36,ggkaaqmaggkabge5xc3r1gcadqaqz02yhp6qeegvybixoxisvgcadqaqz4zbyf6qeegvybixoxisvga:33,ggkaaqmaggkabge7pehcgwcadqaqvj9dljfzeekg9wloguza3acadqaqvkvrctfzeekg9wloguza3aa:56,git:[0,39,42],github:[26,31,39,42],give:[6,16,23,24,31,32,49,54,55,61],given:[15,16,23,30,36,40,41,47,52],gladi:12,gmail:[28,33,56,62],goal:11,goe:26,gold:27,good:[0,23,52],googl:[32,33,41,56,62],govern:[42,46,48,53,57],grain:32,grant:[24,41,47,48,50,52,53,55],grant_typ:[27,34,41,48,49],grant_url_pattern:41,granular:[6,8],graph:[25,32],graph_async:28,graph_us:28,gravatar:[12,24,56,57,62],great:[32,38,55,57,58],greater:[10,11,49],greatest:53,groovi:0,group:[5,12,14,15,18,19,24,25,30],groupid:41,groupnam:[56,57],grouppath:57,groupproperti:41,gte:10,guarante:29,guest:[23,47,52,55,56,62],guid:[9,26,39,43,50],hacker:[47,48,52,53],half_hour:8,hand:16,handi:22,handl:[21,32,33,61],happen:20,happi:[0,56],happy_cloud:5,h
ard:[1,53],hava:0,have:[0,12,14,15,16,19,22,24,30,31,34,36,38,41,42,48,49,50,52,53,55,56,57,58,59,61,62],haven:42,head:[33,62],header:[4,47],height:[40,56],hello:56,help:[7,11,14,30,32,46,48],her:[16,33],here:[2,12,16,20,24,26,27,30,39,42,50,56,57,59,62],hierarchi:[6,30,35,36,54,57],high:[14,16,46,49],higher:[27,53],highest:[35,36],highlight:16,hike:53,him:27,hold:[5,43],home:20,homepag:6,host:[26,28,42,47,50],hotmail:36,hour:8,hous:16,howev:[8,11,12,13,15,28,29,30,38,50,52,55,56,59],href:[33,36,62],html4:[33,62],html5:[24,25],html:[0,33,41,50,59,62],htmldisplayemail:41,htmldisplayemailaddress:[33,36],http:[2,4,5,6,8,12,13,14,15,16,17,18,19,20],human:[33,62],hundr:11,hurrai:50,hystrix:28,icon:[56,59],idea:52,ident:16,identif:41,identifi:[9,16,30,33,38,43,62],ifram:40,illustr:[14,46],imag:[2,4,5,14,32,41,56],imagemodel:25,imagin:[12,16,53],immedi:[32,55,62],immut:30,implement:[24,32,46,47,48,50,53,62],impli:42,implicit:55,improv:[20,31,32],inact:55,inbox:[38,56,58],includ:[6,11,12,14
,15,16,21,22,23,24,30,32,33,41,42,43,47,48,49,50,52,55,57,62],incorpor:59,incorrect:[24,33],increas:[13,20,32],increment_valu:6,incub:[26,28,39],index:[0,10,11,15,28,30,59],index_prefix:28,indic:[41,49,56,57],individu:[15,30,49,53],ineffici:[11,12,16],inflat:16,info:[33,41],inform:[4,8,11,12,13,14,15,16,20,22,24,26,30,32,33,35,38,39],infrastructur:[30,32],ing:56,inher:52,init:[43,50],initi:9,initil:28,initwithobject:43,initwithorganizationid:42,inner:16,input:[28,33,62],insecur:52,insert:50,insid:24,instal:[0,9,22,24,25],instanc:[26,27,30,43,48,51,59],instead:[16,24,28,32,48,52,53],instruct:[0,26,50,59,62],integ:[11,41],integr:[20,24,32,50],intend:30,intention:16,interest:[8,32],interfac:[26,59],intern:25,interpret:[24,54],intersect:10,intrins:24,introduct:25,invalid:[38,50],invok:42,iphon:59,isn:[14,22,24,46],iso:[33,62],issu:[0,2],item:[10,12,13,15,24,42,43,56],items:13,itself:16,jane:62,jar:27,java:[0,26,27],javascript:[6,9,12,14,24,25,26,29,31,33,42,43,44,48],javscript:29,jdk:[2
6,27,28],jdoe57:30,jenni:16,jim:33,jin:40,jinm:33,job:55,john:[24,30,48,56,57,62],johnson:40,join:16,jpeg:[2,4,5],jpg:[2,5,14,16],json:[10,12,14,15,16,19,24,27,30,33,34,43,50,56,57,61],json_arrai:15,json_object:15,just:[14,16,17,20,23,24,26,56,61],k88dh4f:18,keep:[1,7,9,11,12,23,32,47,48,52,53],kei:[13,15,16,24,32,43,50],keyspac:[26,28],keyword:15,kid:16,kind:[11,12,16,42],know:[8,42],kravitz:12,label:33,lack:23,lag:29,languag:[10,14,15,24,42],larg:[0,11,56],last:[5,11,30,36,38],lastnam:[11,12,38],latenc:29,later:[16,20],latest:[26,27],latitud:[11,20],latitude_coordin:20,launch:[8,52],launcher:25,law:42,layer:27,lceecubwbqvsaaca:48,learn:[22,23,32,52,59,61],least:26,leav:[26,55],left:[21,31,55,56,59],length:[2,5],less:[10,14,49,56],let:[8,27,32,55],letter:62,level:[6,8,14,15,21,22,23,25,27,30,32,34,35,36,46,47],leverag:[32,59],lib:[26,28],librari:42,licens:42,lightweight:61,like:[0,2,5,8,10,14,16,17,18,19,23,26,28,29,32,33,38,42,50,52,54,55,56,58,59,60,61,62],liked_bi:60,limit:1,lin
e:[0,16,26,27],linear:[14,26],live:[23,25,47],load:[27,50],localfilebinarystor:1,localhost:[26,27,28],locat:5,log:[6,26,32,38,42,48,50,51,55,56,59,62],login:25,logincredenti:25,loginfacebook:50,loginus:42,logout:25,longer:[11,52],longitud:[11,20],longitude_coordin:20,look:[2,8,10,11,16,42,50,53,56,62],loos:[33,62],love:16,lower:6,lte:10,ltixndg0nduxndpvdjb0jwrevls1vcd0xvr3nwt0jrqq:11,made:[19,24,54,60],magic:16,mai:[0,6,9,13,15,23,30,41,42,51,52,55,57],mail:[26,28,30,57],mailer:[26,28],mailto:[33,36],main:[0,1,50],maintain:[16,50],mainten:31,make:[0,9,11,12,14,16,22,23,24,28,29,30,32,35,38,42,47,48,50,51,52,56,59,60,61,62],makefil:0,maker:14,malici:[46,47,48,53],manag:[5,11,12,22,23,25,26,27,28,30,31],mandatori:[1,38,41,57,58,62],mani:[7,11,12,14,16,20,23,30,42,55,61],manual:[56,60],map:14,marginheight:40,marginwidth:40,massoddb:56,master:42,match:[11,15,43,54,62],matter:32,mattress:14,maven:[0,26,27,28],max:28,maximum:[11,49],mayb:16,mean:[10,14,15,16,23,29,30,46,47,52,60,61],meant
:56,meanwhil:29,measur:46,mechan:59,meet:26,member:[30,33,35,41,53,56,57,58],meme:[57,58],memori:20,menu:[21,34,55,59],messag:[6,26,28,32,33,41,49,57,59,61],message:[25,42],messageeapp:42,meta:[33,62],metadata:[2,4,5,6,10,12,13,14,15,16,17,18,19,20,24,25,33,36],metadataproperti:41,meter:[11,20],method:[6,8,11,15,19],mfdsadfdsaoabl:56,middl:38,middlenam:38,might:[7,8,9,11,12,14,15,16,22,26,30,32,34,52,55,57],mile:20,milk:[13,15,43],million:32,millisecond:[30,41,49],mind:[1,9,11,12,16,20,23],minim:[16,26,28],minimum:[30,34,36],minu:16,minut:[8,32],mix:24,moab:56,mobil:[14,16,20,23,25,34],mod:42,model:14,modern:[30,56],modif:[38,58],modifi:[2,5,6,12,13,14,15,16,17,18,19,20,24,30,33,36,38,41,43,49,55,56,57,58,62],modul:6,monitor:32,month:[8,32],more:[4,6,8,9,11,12,13,14,15,16,20,21,22,23,24,25,26,30,32,36,39,41],morn:8,most:[8,11,16,22,28,29,30,31,32,34,52,56,60,61,62],mountain:53,much:[10,14,16,52,59],multi:[15,43],multipl:[0,11],must:[0,10,15,16,27,28,30,36,41,43,47,49,55,56,57,59,60,
62],mustach:0,mvn:[26,27,28],my_app:[14,16,38,50],my_org:[14,16,38,50],myadmin:27,myapp:[12,27],myasset:2,mycollect:10,myfirstorg:27,mygroup:[56,57],mynewapp:[57,62],mynewgroup:57,mynewpassword:33,myorg:[12,57],mypassword:[27,42],myself:[16,26,28],myuser:27,myusernam:42,name:[1,2,4,5,6,8,10,11,12,13,14,15,16,17,18,19,20,21,23,24,26,27,28,30,33,34,36,38,41,42,43,47,49,50,52,54,55,56,57,58,59,62],namespac:42,narrow:[10,55],nativ:[0,14],natur:[11,12],navig:[26,27,28],nearbi:20,nearest:[11,20],nearli:16,necessari:[16,32,55],need:[0,1,2,8,9,11,12,13,14,15,16,21,22,24,26,28,30,31,32,33,34,35,36,38,42,47,48,50,51,52,53,55,56,57,59,60,61,62],neg:6,nest:[15,30,43],net:[24,40],network:32,never:[23,25,34,47,48,49],new_password:[33,62],new_review_uuid:16,newent:43,newli:[54,56],newpassword:[33,41,62],next:[11,13,21],nil:43,node:[24,26,28,43,44,48,51],nodej:28,non:[14,16],none:55,normal:[4,15,16],nosql:[11,12,14],notat:[10,12,14],note__:62,notic:[5,16,19,50,56],notif:[20,22,25,26,28,30],notifi:[
25,30],notify_sysadmin_of_new_admin_us:[26,28],notify_sysadmin_of_new_organ:[26,28],notitf:41,now:[26,27,28,42,50,59],nsarrai:43,nsdictionari:43,nsexcept:43,nsmutablearrai:43,nsmutabledictionari:43,nsstring:[42,43],nuke:42,nukefil:42,number:[6,7,11,12,13,14,30,32,41,52,55,56,62],oauth2:41,ob5ko:49,object:[5,9,10,12,14,15,24,25,30,32,33,34,36],objectproperti:41,objecttyp:[33,36,41],objectuuid:41,obtain:[38,42,47,49,50,52],occur:[7,20],occurr:11,octal:10,off:[26,50],offer:[20,23,24,32,52,60,61],offici:59,often:[8,10,16,30,32,56],old:[33,41,62],old_password:[33,62],oldpassword:[33,62],omit:12,onc:[0,11,16,26,29,42,50,52,55,62],ongo:[32,56],onli:[5,9,11,12,16,21,23,24,26,29,30,34,41,46,47,48,49,52,53,54,56,57,60,62],onlin:56,oop:50,opdata:43,open:[14,16,23,25,28,31],optim:[11,12,14,16],option:[5,9,26,28,30,43,47,50],order:2,orderl:11,org:[1,2,4,5,6,8,12,13,15,17,18,19,20,24,26,27,28,33,34,36,41,42],org_client_secret:48,org_clientid:48,org_id:[15,41,56,57,62],org_nam:[34,36,49,51],org_uu
id:[34,36],organ:[0,2,4,5,6,8,12,13,14,15,16,17,18,19,21,23,24,25,26,27,28],organizationnam:49,organizations_require_activ:[26,28],orgid:41,orgnam:[9,41,42,48,50],orguuid:41,origin:[42,57],originali:58,oscar:27,our:[0,9,11,12,26,27,28,31,39,42,43,61],out:11,outbox:56,outgo:28,outlin:5,output:50,over:[8,49],overrid:[28,49],overview:[11,12,25,30],overwritten:15,own:[7,23,32,41,50,54,56,57,58,62],owner:[2,36,41,56,57],packag:[26,50,59],page:[22,23,27,33,48,50],pair:[13,15,43],pane:55,param:[2,5,6,8,12,13,14,15,16,17,18,19,24,43,49,54,55,56,57,62],paramet:[4,5,6,8,9],pars:50,part:[9,11,12,16,20,24,42],partial:[11,30],particular:[10,16,56],particularli:[14,16,54,56,60],partit:22,pass:[11,34],passiv:61,password:[24,25,26,27,28],path:[2,5,6,12,13,14,15,16,17,18,19,20,23,24,25,26,28,33,36,41,42,43,50],path_to_imag:16,pathnam:50,pattern:[41,54],payload:41,peak:8,peopl:[7,30,56,57,58,59],per:[13,14,50,55],perceiv:29,perform:[4,5,13,14,16,18,29,32,33,35,38,47,48,53,54,56,58,62],period:[7,8,20,
55],permiss:[5,12,18,19,23,24,25],permissiondata:41,persist:[24,27,28],person:[16,20,31,33,36,59],perspect:30,pertin:35,pet:27,phone:12,phone_numb:12,photo:[20,61],physic:20,pictur:[4,5,12,20,24,38,41,57,62],pinterest:56,pip:0,place:[14,15,16,26,30,43,48,62],plai:[7,22],plain:4,plan:16,platform:32,pleas:[10,33,47,49,55,60],plenti:0,plural:[13,15,30,41],png:16,point:[10,11,14,20,28,29,32,50,59],polici:[39,52],pop:59,popul:[57,59,61],popular:[32,59],popup:55,port:[26,27,28],portal:[21,22,23,26],portion:41,pose:49,posit:[11,20],possibl:[16,52,60],post:[2,5,6,7,13,15,16,17,18,21,23,24,25,27,33,34,35,36,41,42],postal:11,potenti:11,power:[20,27,30,32,40,48,53,60],practic:[11,12],preced:[12,16],precis:56,predefin:30,prefer:[11,24,26],prefix:34,prepar:52,present:[16,25],preserv:57,prevent:[11,12],preview:0,previou:[56,59],previous:59,price:[10,13,15,43],primari:[16,38],prior:52,privaci:56,privat:32,privileg:36,probabl:[0,16,26,29],process:[27,30,33,61],product:[14,16,21,23,25,26,30,41,46],p
roduct_uuid:[14,16],productid:16,productimag:16,productnam:16,productuuid:16,profil:[20,32,38,50,61],program:29,programat:21,programmat:[34,53],project:[0,27,35,36,39,42,59],prompt:[26,50],prone:56,proof:[33,62],prop:43,properit:20,properli:[27,29],properti:[1,4,5,6,9,10,11],properties____:26,property_1:[13,15],property_2:[13,15],property_nam:11,props1:43,props2:43,propti:33,protect:[46,48],protocol:[26,28,50,52],prototyp:50,provid:[6,8,11,13,14,15,20,21,24,28,30,32,33,34,36,38,41,43,44,47,48,50,52,53,55,56,57,59,62],provis:[38,50],proxim:[11,20],pull:[31,42],pure:24,purpos:[10,23,26,30,34,55,61],push:[0,20,22,25],put:[5,12,13,15],pw123:26,pwhere:28,python:0,qualifi:24,quantiti:10,query_stat:12,query_str:[57,62],querystat:41,querystr:43,quick:25,quicker:24,quickli:[11,12,16,30,32,61],quitwait:[26,28],quot:[12,41,43],raleigh:40,rang:8,rate:16,rather:[5,16,17,18,32],raw:0,rdbm:[14,16],reach:10,reactiv:25,read:[9,11,12,14,16,22,39,41,56],readabl:16,readi:[11,22,28,42,59],readm:[0,39],r
eal:41,reason:57,recaptcha:[33,62],recaptcha_challeng:41,recaptcha_challenge_field:33,recaptcha_respons:41,recaptcha_response_field:33,recaptchaopt:33,receipt:[25,30],receiv:[11,29,38,58,59,62],reciproc:60,recommend:[26,43,52],record:[30,32],recurs:54,redefin:55,redirect:[26,28,50],redirect_root:[26,28],redirect_uri:50,reduc:[12,16],redund:16,ref:41,regard:[6,30],regardless:15,regionnam:1,regist:[32,46,53,55,59,61,62],rel:[33,62],relat:[5,14],relationship:[16,17,18,19],relev:[20,32,41,50,52,61],reli:16,rememb:[10,50,59],remind:16,remot:20,remov:[23,25,26,33],removeent:43,renam:30,repeat:59,replac:[1,16,50,59],replic:26,replication_factor:[26,28],repo:[26,28,39,42],report:[7,31],reposloc:1,repres:[11,14,21,24,30,32,33,36,53,54,56,57,62],represent:[11,15,24,30],request:2,requir:[0,6,13,17,18,20,23,25],reserv:30,resetpw:[25,26,28,33],resetpwmsg:25,resolut:8,resourc:[0,1,24,35,38,41,47,50,53,54,55],resource_path:[41,54],respect:47,respons:2,response_typ:50,restaur:[11,20],restkit:59,res
trict:[52,55],restructuredtext:0,result:[10,11,13],review_entity_json:16,review_uuid:16,reviewed_product_uuid:16,reviewedbi:16,reviewedin:16,revok:25,revoketoken:51,rich:[32,61],right:[16,24,29,55,56,59,61],rigid:30,risk:49,rock:10,rockadero:20,rocki:53,role:[5,10,12,18,19,21,23,24,25,30],roleid:41,rolenam:[5,12,18,19,24,38,41,55,57,58,62],roleproperti:41,root:[0,26,27,28,52],rout:[32,56],row:14,rubi:[24,43,44],rule:[23,46,48,52,53,54,55,57,62],run:[0,7,25],safe:53,sai:[8,47,48,56],sake:28,same:[5,6,11,16,18,19,20,28,30,32,42,53,55,56,57,58,59],san:[20,33,57,58],sandbox:[5,15,22],santa:40,save:[5,15],scalabl:[14,16,26],scale:16,scatter:16,scene:[38,50],schedul:41,schedulenotif:25,schema:[14,30,41,55],scope:[16,27,48,50,53],screen:[21,40],script:[0,33,53,62],scroll:40,sdk:[6,9,14,15,22],search:[8,11,32],second:[6,29,33,49,55,59],secondari:16,secret:[25,34,41],secretkei:1,section:[24,34,47,48,57,59,62],see:[2,4,8,9,10,11,12,13,14,15,19,20,21,22,23,24,26,27,30,32,33,34,35,36,39,42,43,4
6,47,48,49,50,52,53,54,55,56,57,59,60,62],seen:56,segment:54,select:[10,11,12,16,21,23,24,55,57,59,62],self:50,send:[1,4,9,11,12,19,20,27,32,33,36,38,41,50,55,59,61],sens:[16,32],sensit:[23,46],sent:[9,12,24,33,34,36,41,43,47,48,54,59,62],separ:[6,12,16,30,43,50,55],seri:0,serv:[52,53,55],server:[11,23,26,29,32,34,47,48,50,51,52,53,57,59],servic:[1,12,20,23,24,27,32,33,35,36,38,41,42,43,46,48,50,56,57,59,62],session:[50,52],set:[0,4,5,6,8,11,12],setexpir:25,setobject:43,settoken:50,setup:25,sever:[1,24],share:[27,36,56,61],sharedappl:43,shell:22,shorthand:11,should:[0,2,11,12,15,16,17,18,22,23,26,28,39,41,43,46,47,48,49,52,53,55,59],show:[12,13,16,43,55,59],shown:[9,11,12,13,15,19,33,47,50,56,57,62],side:[31,32,34,47,48,50,52,53,59],sidebar:55,sign:[25,26,28,30,32],similar:[16,56,59],simpl:[0,14,16,23,26,30,32,42,59,61],simplestrategi:[26,28],simpli:[13,19,24,32,55,56,59],simplifi:[16,32,42],sinc:[10,11,29,47,53],singl:[8,12,14,15,16,26,30,32,41,57],singular:30,six_dai:8,skim:[15,43
],sku:[14,15,43],slash:[57,58],slate:55,slideshar:40,slideshow:40,slightli:14,slower:10,small:26,smith:11,smtp:[26,28],snippet:50,social:[20,25],softwar:[28,42],sojre5ywlkq7jrdcka:48,solid:40,solut:[30,42],solv:32,some:[0,1,7,9,11,16,24,27,29,30,42,52,55,56,57,59],somegroup:57,someon:[8,55],somepassword:[26,49],somesubgroup:57,someth:[2,16,26],sometim:[0,14],someus:[24,26,49,51,55,57,62],soon:25,sort:[11,20,24],sourc:[0,14,16,25,31],space:16,span:[8,16],sparingli:53,special:[0,20,54,55,60],specif:[7,10,11,14,15,16,19,24,30,32,41,42,43,47,51,53,54,55,56,57,62],specifi:[6,11,12,13,15,17,18,19,20,24,26,35,36,41,43,47,48,49,54,56,57,59,62],split:8,sql:[10,16,32],squar:15,src:[0,1,33,40,62],stack:[1,25,26,27],stage:28,standalon:27,standard:[20,24,52,53,62],start:[8,11,12,14,16,22,24,25],start_tim:8,startup:27,state:[24,33,41,50],statement:[12,29,41],statist:7,statu:[12,26,27,28,33,36,41,50,61],steventraut:[57,62],still:[22,52],stock:[13,15,26,43],stop:11,store:[1,5,10,11,12],str:56,strat
eg:16,strategi:[26,28],stream:20,streamlin:[16,59],string:[9,10,11,12,13,15,16,30,33,34,36,38,41,43,47,50,56,57,58],stringifi:50,strong:33,stronger:20,structur:[16,24,27,35,60],struggl:56,style:[32,33,40,46,56,59,62],stylesheet:[33,62],sub_properti:15,subgroup:57,submit:[11,12,33,39,54,62],subproperti:43,subproperty1:43,subproperty2:43,subscrib:[56,57,58],subscript:[57,58,60],subsequ:[38,41,47,48,50],subset:[13,16],substitut:56,subtract:10,succe:[38,50,54],success:[26,29,43,52],sudo:0,suggest:[20,23,31],suit:[48,53,55],summit:40,sungju:40,superadmin:26,superus:[26,28],suppli:[33,36,41,48],support:[0,8,10,14,16,20,22],suppos:15,sure:[21,23,28,42,46,52,59],swagger:0,symbol:62,sync:25,synchron:25,sysadmin:[26,28],system:[0,14,26,28,30,38,39,49,56,57,59,62],tab:55,tag:[41,50],take:[6,11,16,28,29,32,46,48,52],taken:[20,50],tale:[10,11],talk:[40,52,59],tar:[42,50],target:[0,26,27,28,32,42],task:55,team:[35,36,59],technic:50,techniqu:[11,16],temp:1,templat:0,temporari:1,tempt:16,tend:[57,5
8],test12345:[33,36],test1234:62,test123:[33,36],test:[5,11,23,26,28,36],testadmin:48,testadminpw:48,testapp1:[34,36],testapp2:36,tester123:36,tester:41,testorg:[34,36],testpw:48,text:[4,10,11,32,33,56,59,62],text_field:33,than:[0,5,6,8,10,11,12,13,16,17,18,26,32,49,52],thank:32,thei:[0,11,12,15,16,20,30,36,46,47,48,52,53,55,56,57,58,62],them:[0,6,9,10,11,12,16,23,24,32,48,50,53,55,56],theme:[16,33],themselv:62,thereaft:46,thi:[0,1,2,6,8,9,10,11,12,13,14,15,16,20,21,22,24,26,27,28,29,30,31,32,33,34,38,39,41,42,43,46,47,48,49,50,51,52,53,55,56,57,58,59,60,61,62],thing:[7,10,22,23,31,40,46,57,58,62],think:56,those:[11,16,39,46,47,48,52,53,56,62],though:[11,16,41],thousand:14,threadpool:28,three:[6,11,26,53,55,59],through:[14,16,21,32,34,35,36,38,41,46,50,52,53,56,57,62],thumb:23,tier:27,time:[6,7],timeout:28,timestamp:[2,5,6,8,10,12,13,14,15,16,17,18,19,24,26,30,33,34,36,38,41,43,49,51,54,55,56,57,58,62],titl:[10,11,16,33,36,41,55,57,58,62],tld:[26,28],tmp:1,toctre:0,todai:20,togeth:[
0,53],token:[9,13,15,23,24,25,27,33,34,35,36,38],token_to_revok:51,tom:54,tomcat:25,too:0,tool:[9,11,12,32,61],top:[21,27,50,59],topic:[11,31,43,44,48,57,58,62],topolog:26,track:[6,7,38],trail:53,transactionst:42,transfer:24,transform:0,transit:[33,62],transport:[26,28],treat:[15,25],trend:32,trial:24,truli:32,tsefia:33,ttl:25,ttl_in_millisecond:49,tupl:14,turn:50,tutori:22,tweet:[32,42,56],twitter:[32,42,56,59],two:[11,12,27,29,30,33,43,47,59,60,61],type:[2,4,5,6],typic:[10,24,30,62],udpat:0,uffff:10,ugapi:42,ugclient:42,ugclientrespons:42,ugus:42,uiapplic:43,unauthent:55,under:[23,26,42,48,51,52,55,59],underli:14,understand:30,unencod:[9,11,12],unexpect:41,unfamiliar:14,unfortun:0,unicod:10,union:10,uniqu:[15,30,38,41,50,57,58,59,62],unit:42,univers:30,unix:[6,38,58],unless:[0,38,42,47,50,53,59],unlik:[14,15,30],unnecesari:52,unregist:55,unreleas:28,unsecur:52,until:[29,41,55],untrust:52,untrustworthi:25,unus:55,upcom:20,updatecollect:43,updatedent:43,updateent:43,upon:24,upstream
:42,upward:6,uri:[2,5,6,8,9,12,13,14,15,16,17,18,19,24],url:[9,11,12,13,15,16,19],usag:8,usegrid:[24,25],user:[5,7,10,11,12,13,15,16,17,18,19,20,21,22,23,24,25],user_uuid:16,user_uuid_or_usernam:51,usergrid_appl:28,usergridcli:42,usergriddatacli:[48,51],usergridsdk:50,userid:41,usernam:[11,12,15,17,18,19,24,26,27,28,30,33,36,38,41,42,46,48,49,52,53,54,55,56,57,59,60,62],username_or_email:62,usual:26,utc:[30,41],util:[27,30,32],uuid:[2,4,5,6,10,12,13,14,15,16,17,18,19,20,24,30,33,34,36,38,41,43,49,50,54,55,56,57,58,62],uuid_for_selected_review:16,val:50,valid:[1,13,15,30,33,34,36,38,47,49,50,52,54,55,56,57,58,62],valu:[1,6,8,10,11],valuabl:32,value_1:[13,15],value_2:[13,15],vari:8,variabl:54,varieti:[15,24,35,43,62],variety_1:43,variety_2:43,variety_3:43,variety_list:43,variou:52,verb:[16,33,36,41,56],veri:[0,11,12,22,30,47,56],verifi:46,version:[26,28],versu:56,via:[0,26,30,31,33,36,53,54,57,58,61],video:[5,25,32],view:[8,16,26,28,42,53],visit:[26,42],visitor:53,w3c:[33,62],wai:[6,1
1,12,14],wait:[11,29],wall:56,want:[0,1,5,6,11],war:25,warn:[23,47,48,53,55],warranti:42,watch:26,web:[12,14,16,26,27,28,34,38,48,50,52,53,61],webapp:[26,27],week:8,welcom:[26,28,31,42],well:[20,24,26,32,51,52,56,59,60,61,62],went:26,were:[11,12,20,57,58],what:[16,20,22],whatev:23,whatsoev:46,when:[0,5,9,11,12,15,16,17,20,23,24,25,26,28,29,30,32,41,46,47,48],whenev:50,where:[0,2,10,11,12,16,20,22,23,24,28,30,38,50,52,56,62],whether:[38,41,47,61],which:[0,8,11,13,14,15,16,18,21,26,29,30,33,35,38,41,42,46,47,48,49,50,52,53,54,56,57,58,60,62],who:[16,31,32,39,41,46,48,52,55,56],whole:[15,41,43],whose:[11,12,19,24,55,62],why:[26,42],wide:[53,62],width:[40,41,56],wildcard:[11,54],window:[22,50,59],wireless:20,wish:[13,30,62],withapplicationid:42,within:[6,11,15,20,26,30,36,42,49,53,56,59],without:[11,42,47,55,62],won:56,word:[11,13,14,15,16,56],work:[0,11,12,14,16,20,23,25,26,28,29,31,32],workflow:39,world:56,would:[4,8,9,11,16,19,20,26,33,47,49,50,52,53,54,56,57,58,60,62],wouldn:16,writ
e:[14,16,42,46,59],written:[0,14,16,26,31,39,42],wrong:26,wrote:16,www:[12,24,33,40,42,50,56,57,62],xcode:42,xfbml:50,xml:1,yaml:0,year:56,yet:[11,57],yhixpqk1cq:34,you:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15],your:[0,1,4,5,6,7,8,9,10,11],your_app_id:50,your_domain:50,your_redirect_url:50,your_response_typ:50,your_state_valu:50,yourapp:9,yourappnam:50,yourdomain:24,yourorg:9,yourorgnam:50,ywmt4nqe8q9geelyjhixpsio4aaaato5fqfcg0ced2h9nwmdmrorknnreeqydof:33,ywq6aaabmqz_xuyyeerokkjnzn7yqxxlpgml69fvaa:48,yxa65gylqja8ayysay8ox3vg5arzp48:34,yxa6aaabmq0d4mep_ugbza0:48,yxa7ygil:34,yxb7nad7em0meej989xixprxekq:48,yxb7nautv9krhhmr8ycw0qbozh2pxef:48,yxu6aaabmq0hdy4:48,zip:[42,50]},titles:["Apache Usergrid Documentation","File storage configuration","Folders","<no title>","Retrieving assets","Uploading assets","Creating & incrementing counters","Counters & events","Retrieving counters","Advanced query usage","Query operators & data types","Query parameters & clauses","Querying
your data","Collections","The Usergrid Data Store","Entities","Data Store Best Practices","Connecting entities","Disconnecting entities","Retrieving connections","Geolocating your Entities","Creating a new application","Creating an Usergrid Account","Using a Sandbox Application","Using the API","Apache Usergrid Documentation","Usegrid 1: Deploying to Tomcat","Usegrid 1: Launcher Quick-start","Usergrid 2: Deploy to Tomcat","Async vs. sync calls","Usergrid Data model","Documentation Overview","Usergrid Features","Admin user","Application","Organization & application management","Organization","COMING IN USERGRID 2","Users & Devices","How to Contribute Code & Docs","Presentations & Videos","Methods","iOS SDK","Usergrid iOS SDK","Usergrid SDK Documentation outline","COMING SOON...","Security & token authentication","Authenticating API requests","Authenticating users & app clients","Changing token expiration (time-to-live)","Facebook sign in","Revoking tokens (log
out)","Security best practices","Authentication levels","Using permissions","Using roles","Activity","Working with group data","Groups","App Example - Messagee","Social Graph Connections","User management & social graph","Working with User Data"],titleterms:{"default":[30,49,52,55],"new":[21,23],"return":62,"super":26,access:[24,41,47,52],accesstokenrespons:41,account:[22,59],acquir:52,action:41,activ:[32,33,36,41,43,44,56,61],activityfe:41,actor:41,add:[26,50],addpermiss:41,addrol:41,admin:[33,36,41,43,44,48,51,53,55],adminuserupd:41,advanc:9,all:[9,19],android:59,apach:[0,25,40],api:[0,9,24,27,47],app:[20,40,41,43,44,48,50,52,59],appdata:41,applic:[21,23,30,32,34,35,36,41,43,44,48],asset:[2,4,5,32],assign:[43,44,54,55],async:29,asynchron:29,attach:9,authent:[24,32,43,44,46,47,48,53],backend:40,base:24,basic:12,batch:13,best:[16,52],between:0,build:[0,26,27,28,40,43,44],call:[9,29],cancelmsg:41,cassandra:[26,40],chang:[49,62],claus:11,client:[36,43,44,47,48,52,59],code:[39,42],
collect:[13,24,30,41,43,44,58],come:[32,37,45],complet:33,complex:54,comput:16,configur:[1,26,53],connect:[17,19,43,44,60,61],consol:26,construct:24,contain:11,content:0,contribut:[39,40,42],copyright:42,counter:[6,7,8,43,44],creat:[6,13,15,21,22,23,33,34,36,43,44,49,50,55,56,57,59,60,62],createact:41,createadminus:41,createapp:41,createent:41,createev:41,creategroup:41,createnotif:41,createorg:41,createus:41,credenti:[34,36,41,43,44],cursor:11,custom:[15,26,43,44],data:[4,10,12,14,15,16,20,30,32,43,44,57,62],databas:26,deal:0,decrement:6,delet:[13,15,43,44,57,62],denorm:16,deploi:[26,28],deploy:28,descript:57,devic:[38,41],dialog:50,differ:0,disconnect:[18,43,44],displai:62,doc:[0,39],document:[0,25,31,39,44],download2:27,download:[26,27],edit:52,enrich:20,entiti:[4,13,15,17,18,19,20,24,30,32,41,43,44],error:41,event:[7,41,43,44],exampl:[4,5,6,8,13,15,26,28,33,34,36,43,44,48,49,50,51,54,55,56,57,59,62],expir:49,facebook:[38,50],featur:32,feed:[33,36,43,44,56,61],file:[0,1,26,28,32]
,flexibl:32,folder:2,follow:[43,44,56,60],form:62,format:24,from:[13,36,43,44,57],gener:[34,36,43,44,58],geoloc:[20,32],get:[16,26,27,33,34,36,42,43,44,62],graph:[60,61],group:[32,41,43,44,56,57,58,61],handl:62,hierarch:6,how:[0,39,40],html5:59,http:[24,27,52],imagemodel:41,incremen
<TRUNCATED>
[03/21] incubator-usergrid git commit: Added sdk-outline.md with
possible outline for Client SDK docs.
Posted by sn...@apache.org.
Added sdk-outline.md with possible outline for Client SDK docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/02fe9293
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/02fe9293
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/02fe9293
Branch: refs/heads/master
Commit: 02fe92936766f35fa23bd6b97c6f7c743710d253
Parents: fa4c74a
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Aug 7 13:50:11 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Aug 7 13:50:11 2015 -0400
----------------------------------------------------------------------
docs/sdks/ios-new.md | 982 +++++++++++++++++++++++++++++++++++
docs/sdks/java.md | 1 -
docs/sdks/javascript.md | 3 -
docs/sdks/sdk-outline.md | 111 ++++
docs/sdks/usage.md | 16 -
sdks/android/README.md | 3 +-
sdks/html5-javascript/README.md | 2 +
sdks/ios/README.md | 3 +-
sdks/nodejs/readme.md | 2 +
sdks/ruby/README.md | 2 +-
10 files changed, 1101 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/docs/sdks/ios-new.md
----------------------------------------------------------------------
diff --git a/docs/sdks/ios-new.md b/docs/sdks/ios-new.md
new file mode 100644
index 0000000..0f5b3fe
--- /dev/null
+++ b/docs/sdks/ios-new.md
@@ -0,0 +1,982 @@
+# Usergrid iOS SDK
+
+## Getting Started
+
+### Installing the SDK
+### Building from Source
+
+# Usergrid SDK Reference with Examples
+
+The 66 topics listed below are each documented in the Usergrid documentation and
+for each the docs provide an API reference and example for each of these clients:
+curl, iOS, Android, JavaScript, Ruby and Node.js.
+
+## Working with Collections
+
+### 1. Creating collections
+
+SDK Method
+
+ (ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+
+Parameters
+
+Parameter Description
+--------- -----------
+url A fully-formed url in the following format: https://api.usergrid.com/<org>/<app>/<collection>
+op The HTTP method - in this case, 'POST'
+opData No data is being sent, so the value is nil
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)createCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items";
+ NSString *op = @"POST";
+ NSString *opData = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ ],
+ "timestamp" : 1378857079220,
+ "duration" : 31,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+### 2. Retrieving collections
+
+SDK Method
+
+ (ApigeeCollection*)getCollection:(NSString*)type
+
+Parameters
+
+Parameter Description
+--------- -----------
+type The entity type associated with the collection to be retrieved
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getCollection {
+
+ //specify the entity type that corresponds to the collection to be retrieved
+ NSString *type = @"item";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //Call getCollection: to initiate the API GET request
+ ApigeeCollection *collection = [appDelegate.dataClient getCollection:@"book"];
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ }, {
+ "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
+ "type" : "item",
+ "name" : "bread",
+ "created" : 1378423379867,
+ "modified" : 1378423379867,
+ "metadata" : {
+ "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
+ },
+ "name" : "bread",
+ "price" : "2.50"
+ } ],
+ "timestamp" : 1378426821261,
+ "duration" : 35,
+ "organization" : "your-org",
+ "applicationName" : "your-app",
+ "count" : 2
+ }
+
+### 3. Updating collections
+
+SDK Method
+(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+Properties
+Parameter Description
+url A fully-formed request url in the following format:
+https://api.usergrid.com/<org>/<app>/<collection>/?ql=
+Note that you must include an empty '?ql=' query string at the end of the URL
+
+op The HTTP method - in this case, 'PUT'
+opData A JSON-formatted string that contains the entity properties to be updated
+Example Request/Response
+Show Code
+Request:
+-(NSString*)updateCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql";
+ NSString *op = @"PUT";
+ NSString *opData = @"{\"availability\":\"in-stock\"}"; //we escape the quotes
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call apiRequest to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "31847b9a-1a62-11e3-be04-8d05e96f700d",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "availability" : "in-stock"
+ "created" : 1378849479113,
+ "modified" : 1378849567301,
+ "name" : "milk",
+ }, {
+ "uuid" : "3192ac6a-1a62-11e3-a24f-496ca1d42ce7",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "4.00",
+ "availability" : "in-stock"
+ "created" : 1378849479206,
+ "modified" : 1378849567351,
+ "name" : "bread",
+ } ],
+ "timestamp" : 1378849567280,
+ "duration" : 207,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+### 4. Deleting collections
+
+SDK Method
+(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+Properties
+Parameter Description
+url A fully-formed url in the following format:
+https://api.usergrid.com/<org>/<app>/<collection>/?ql=
+Note that you must include an empty '?ql=' query string at the end of the URL
+
+op The HTTP method - in this case, 'DELETE'
+opData No data is being sent, so the value is nil
+Example Request/Response
+The following example will delete the first 5 entities in a collection.
+
+Show Code
+Request:
+-(NSString*)deleteCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql='limit=5'";
+ NSString *op = @"DELETE";
+ NSString *opData = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "53fe3700-0abe-11e3-b1f7-1bd100b8059e",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "created" : 1377129832047,
+ "modified" : 1377129832047,
+ "metadata" : {
+ "path" : "/items/53fe3700-0abe-11e3-b1f7-1bd100b8059e"
+ },
+ "name" : "milk"
+ }, {
+ "uuid" : "5ae1fa7a-0abe-11e3-89ab-6be0003c809b",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "4.00",
+ "created" : 1377129843607,
+ "modified" : 1377129843607,
+ "metadata" : {
+ "path" : "/items/5ae1fa7a-0abe-11e3-89ab-6be0003c809b"
+ },
+ "name" : "bread"
+ } ],
+ "timestamp" : 1378848117272,
+ "duration" : 12275,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+## Working with Entities
+
+### 5. Creating a custom entity
+
+SDK Method
+(ApigeeClientResponse *)createEntity:(NSDictionary *)newEntity
+Parameters
+Parameter Description
+newEntity NSDictionary object that contains the entity properties
+Example Request/Response
+Show Code
+Request:
+-(NSString*)newEntity {
+
+ //create an entity object
+ NSMutableDictionary *entity = [[NSMutableDictionary alloc] init ];
+
+ //Set entity properties
+ [entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+ [entity setObject:@"milk" forKey:@"name"];
+ [entity setObject:@"3.25" forKey:@"price"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+ {
+ "action" : "post",
+ "application" : "4a1edb70-d7a8-11e2-9ce3-f315e5aa568a",
+ "params" : { },
+ "path" : "/items", "uri" : "http://api.usergrid.com/my-org/my-app/items",
+ "entities" : [ {
+ "uuid" : "83e9b7ea-e8f5-11e2-84df-e94123890c7a",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1373415195230,
+ "modified" : 1373415195230,
+ "metadata" : {
+
+ "path" : "/items/83e9b7ea-e8f5-11e2-84df-e94123890c7a"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1373415195225,
+ "duration" : 635,
+ "organization" : "my-org",
+ "applicationName" : "my-app"
+ }
+
+
+### 6. Creating multiple custom entities
+
+Request Syntax
+curl -X POST https://api.usergrid.com/<org>/<app>/<entity_type>/ -d '[{<entity>}, {<entity>}, ...]'
+Parameters
+Parameter Description
+org Organization UUID or name
+app Application UUID or name
+entity_type Custom entity type to create. API Services will create a corresponding collection if one does not already exist. To add an entity to an existing collections, use the collection name or colleciton UUID in place of the entity type.
+entity Comma-separated list of entity objects to create. Each object should be formatted as a comma-separated list of entity properties, formatted as key-value pairs in the format <property>:<value>
+Example Request/Response
+Show Code
+Request:
+curl -X POST "https://api.usergrid.com/your-org/your-app/item" -d '[{"name":"milk", "price":"3.25"}, {"name":"bread", "price":"2.50"}]'
+Response:
+{
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e9sjwsf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "f3a8061a-ef0b-11e2-9e92-5f4a65c16193",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "created" : 1374084538609,
+ "modified" : 1374084538609,
+ "metadata" : {
+ "path" : "/multis/f3a8061a-ef0b-11e2-9e92-5f4a65c16193"
+ },
+ "name" : "milk"
+ }, {
+ "uuid" : "f3be262a-ef0b-11e2-a51b-6715d5ef47a6",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "2.50",
+ "created" : 1374084538754,
+ "modified" : 1374084538754,
+ "metadata" : {
+ "path" : "/items/f3be262a-ef0b-11e2-a51b-6715d5ef47a6"
+ },
+ "name" : "bread"
+ } ],
+ "timestamp" : 1374084538584,
+ "duration" : 388,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+### 7. Creating an entity with sub-properties
+
+SDK Method
+(ApigeeClientResponse *)createEntity:(NSDictionary *)newEntity
+Parameters
+Parameter Description
+newEntity NSMutableDictionary object that contains the entity properties
+Example Request/Response
+Show Code
+Request:
+-(NSString*)newEntity {
+
+ //Initialize an object for the new entity to be created
+ NSMutableDictionary *entity = [ [NSMutableDictionary alloc] init ];
+
+ //Initialize an object for each nested variety object
+ NSMutableDictionary *variety_1 = [ [NSMutableDictionary alloc] init ];
+ NSMutableDictionary *variety_2 = [ [NSMutableDictionary alloc] init ];
+ NSMutableDictionary *variety_3 = [ [NSMutableDictionary alloc] init ];
+
+ //Initialize an array to hold the nested variety objects
+ NSMutableArray *variety_list = [ [NSMutableArray alloc] init];
+
+ [variety_1 setObject:@"1%" forKey:@"name"];
+ [variety_1 setObject:@"3.25" forKey:@"price"];
+ [variety_1 setObject:@"0393847575533445" forKey:@"sku"];
+
+ [variety_2 setObject:@"whole" forKey:@"name"];
+ [variety_2 setObject:@"3.85" forKey:@"price"];
+ [variety_2 setObject:@"0393394956788445" forKey:@"sku"];
+
+ [variety_3 setObject:@"skim" forKey:@"name"];
+ [variety_3 setObject:@"4.00" forKey:@"price"];
+ [variety_3 setObject:@"0390299933488445" forKey:@"sku"];
+
+ //Add the variety objects to the array
+ [variety_list addObject:variety_1];
+ [variety_list addObject:variety_2];
+ [variety_list addObject:variety_3];
+
+ //Set the item entity properties
+ [entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+ [entity setObject:@"milk" forKey:@"name"];
+
+ //Set the variety_list array as the value of the 'varieties' property
+ [entity setObject:variety_list forKey:@"varieties"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "0d7cf92a-effb-11e2-917d-c5e707256e71",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1374187231666,
+ "modified" : 1374187231666,
+ "metadata" : {
+ "path" : "/items/0d7cf92a-effb-11e2-917d-c5e707256e71"
+ },
+ "name" : "milk",
+ "varieties" : [ {
+ "name" : "1%",
+ "price" : "3.25",
+ "SKU" : "0393847575533445"
+ }, {
+ "name" : "whole",
+ "price" : "3.85",
+ "SKU" : "0393394956788445"
+ }, {
+ "name" : "skim",
+ "price" : "4.00",
+ "SKU" : "0390299933488445"
+ } ]
+ } ],
+ "timestamp" : 1374187450826,
+ "duration" : 50,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+
+### 8. Retrieving an entity
+
+SDK Method
+
+ (ApigeeClientResponse *)getEntities: (NSString *)endpoint query:(NSString *)query
+
+Properties
+
+Parameter Description
+--------- -----------
+endpoint The collection and entity identifier of the entity to be retrieved.
+query An optional query string. Requests for a specific entity should set the value to nil
+
+Endpoint exported in the following format: <collection>/<entity_UUID_or_name>
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getEntity {
+
+ //specify the entity collection and UUID or name to be retrieved
+ NSString *endpoint = @"items/b3aad0a4-f322-11e2-a9c1-999e12039f87";
+
+ NSString *query = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call getEntities to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:endpoint queryString:query];
+
+ @try {
+ //success
+ }
+
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/amuramoto/sandbox/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378405025763,
+ "duration" : 31,
+ "organization" : "amuramoto",
+ "applicationName" : "sandbox"
+ }
+
+### 9. Retrieving multiple entities
+
+SDK Method
+
+ (ApigeeClientResponse *)getEntities: (NSString *)type queryString:(NSString *)queryString
+
+Properties
+
+Parameter Description
+--------- -----------
+type The entity type being retrieved
+queryString A query string of entity properties to be matched for the entities to be retrieved.
+
+Query string is expected in the following format: <property>=<value> OR <property>=<value> OR ...
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getEntity {
+
+ //specify the entity type to be retrieved
+ NSString *type = @"item";
+
+ //specify the uuid of the entity to be retrieved in a query string
+ NSString *query = @"uuid = b3aad0a4-f322-11e2-a9c1-999e12039f87 or name = 'bread'";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:type queryString:query];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ }, {
+ "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
+ "type" : "item",
+ "name" : "bread",
+ "created" : 1378423379867,
+ "modified" : 1378423379867,
+ "metadata" : {
+ "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
+ },
+ "name" : "bread",
+ "price" : "2.50"
+ } ],
+ "timestamp" : 1378423793729,
+ "duration" : 63,
+ "organization" : "your-org",
+ "applicationName" : "your-app",
+ "count" : 2
+ }
+
+
+### 10. Updating an entity
+
+SDK Method
+
+ (ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+
+Parameters
+
+Parameter Description
+--------- -----------
+entityID UUID of the entity to be updated
+updatedEntity NSMutableDictionary containing the properties to be updated
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Create an entity object
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set entity properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:@"in-stock" forKey:@"availability"];
+ [updatedEntity setObject:@"4.00" forKey:@"price"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call updateEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378505705077,
+ "availability" : "in-stock",
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "4.00"
+ } ],
+ "timestamp" : 1378505705050,
+ "duration" : 87,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### 11. Updating a sub-property
+
+SDK Method
+
+ (ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+
+Parameters
+
+Parameter Description
+--------- -----------
+entityID UUID of the entity to be updated
+updatedEntity Entity object containing the properties to be updated
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Define our two sub-properties to include in the update
+ NSMutableDictionary *subproperty1 = [ [NSMutableDictionary alloc] init];
+ NSMutableDictionary *subproperty2 = [ [NSMutableDictionary alloc] init];
+ [subproperty1 setObject:@"1%" forKey:@"name"];
+ [subproperty1 setObject:@"3.25" forKey:@"price"];
+ [subproperty2 setObject:@"whole" forKey:@"name"];
+ [subproperty2 setObject:@"4.00" forKey:@"price"];
+
+ //Put our sub-properties into an NSArray
+ NSArray *subproperties = [ [NSArray alloc] initWithObjects:props1,props2, nil];
+
+ //Create an NSMutableDictionary to hold our updates
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set the properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:props forKey:@"varieties"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378761459069,
+ "availability" : "in-stock",
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "varieties" : [ {
+ "name" : "1%",
+ "price" : "3.25"
+ }, {
+ "name" : "whole",
+ "price" : "4.00"
+ } ]
+ } ],
+ "timestamp" : 1378761459047,
+ "duration" : 62,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### 12. Deleting data entities
+
+SDK Method
+
+ (ApigeeClientResponse *)removeEntity: (NSString *)type entityID:(NSString *)entityID
+
+Properties
+
+Parameter Description
+--------- -----------
+type The entity type being deleted
+entityID The UUID or name of the entity to be removed
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)deleteEntity {
+
+ //specify the entity type to be deleted
+ NSString *type = @"item";
+
+ //specify the uuid or name of the entity to be deleted
+ NSString *entityId = @"milk";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call removeEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient removeEntity:type entityID:entityId];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+ }
+
+Response:
+
+ {
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766158500,
+ "modified" : 1378766158500,
+ "metadata" : {
+ "path" : "/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378766172016,
+ "duration" : 324,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+## Data Queries
+
+### 13. Querying your data
+
+## Entity Connections
+
+### 14. Connecting users other data
+### 15. Retrieving user connection data
+### 16. Disconnecting entities
+
+## Permissions & Roles
+
+### 17. Assigning permissions
+### 18. Removing permissions
+### 19. Assigning permissions
+### 20. Removing permissions
+### 21. Creating roles
+### 22. Assigning roles
+### 23. Removing roles
+
+## Authentication
+
+### 24. Application user authentication (user login)
+### 25. Application client authentication
+### 26. Admin user authentication
+### 27. Organization client authentication
+### 28. Revoking tokens (user logout)
+
+# Working with Users & Groups
+
+### 29. Creating users
+### 30. Retrieving user data
+### 31. Setting or updating password
+### 32. Creating groups
+### 33. Retrieving group data
+### 34. Retrieving a group's users
+### 35. Adding users groups
+### 36. Deleting user group
+
+## Activities & Feeds
+
+### 37. Posting a user activity
+### 38. Posting an activity to a group
+### 39. Creating an activity for a user's followers in a group
+### 40. Retrieving a user's activity feed
+### 41. Retrieving a group's activity feed
+
+## Events & Counters
+
+### 42. Creating & incrementing counters
+### 43. Retrieving counters
+### 44. Retrieving counters by time interval
+
+## Managing Orgs & Apps
+
+### 46. Creating an organization
+### 47. Getting an organization
+### 48. Activating an organization
+### 49. Reactivating an organization
+### 50. Generating organization client credentials
+### 51. Retrieving organization client credentials
+### 52. Getting an organization's activity feed
+### 53. Getting the applications in an organization
+### 54. Getting the admin users in an organization
+### 55. Removing an admin user from an organization
+### 56. Creating an organization application
+### 57. Generating application credentials
+### 58. Getting application credentials
+
+## Managing Admin Users
+
+### 59. Creating an admin user
+### 60. Updating an admin user
+### 61. Getting an admin user
+### 62. Setting an admin user's password
+### 63. Resetting an admin user's password
+### 64. Activating an admin user
+### 65. Reactivating an admin user
+### 66. Getting an admin user's activity feed
+
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/docs/sdks/java.md
----------------------------------------------------------------------
diff --git a/docs/sdks/java.md b/docs/sdks/java.md
deleted file mode 100644
index a2a5086..0000000
--- a/docs/sdks/java.md
+++ /dev/null
@@ -1 +0,0 @@
-# Java SDK
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/docs/sdks/javascript.md
----------------------------------------------------------------------
diff --git a/docs/sdks/javascript.md b/docs/sdks/javascript.md
deleted file mode 100644
index 685d42d..0000000
--- a/docs/sdks/javascript.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# JavaScript/HTML5 SDK
-
-
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/docs/sdks/sdk-outline.md
----------------------------------------------------------------------
diff --git a/docs/sdks/sdk-outline.md b/docs/sdks/sdk-outline.md
new file mode 100644
index 0000000..48bd3fc
--- /dev/null
+++ b/docs/sdks/sdk-outline.md
@@ -0,0 +1,111 @@
+# Usergrid SDK Documentation outline
+
+## Getting Started
+
+### Installing the SDK
+### Building from Source
+
+# Usergrid SDK Reference with Examples
+
+The 66 topics listed below are each documented in the Usergrid documentation and
+for each the docs provide an API reference and example for each of these clients:
+curl, iOS, Android, JavaScript, Ruby and Node.js.
+
+## Working with Collections
+
+### 1. Creating collections
+### 2. Retrieving collections
+### 3. Updating collections
+### 4. Deleting collections
+
+## Working with Entities
+
+### 5. Creating a custom entity
+### 6. Creating multiple custom entities
+### 7. Creating an entity with sub-properties
+### 8. Retrieving an entity
+### 9. Retrieving multiple entities
+### 10. Updating an entity
+### 11. Updating a sub-property
+### 12. Deleting data entities
+
+## Data Queries
+
+### 13. Querying your data
+
+## Entity Connections
+
+### 14. Connecting users other data
+### 15. Retrieving user connection data
+### 16. Disconnecting entities
+
+## Permissions & Roles
+
+### 17. Assigning permissions
+### 18. Removing permissions
+### 19. Assigning permissions
+### 20. Removing permissions
+### 21. Creating roles
+### 22. Assigning roles
+### 23. Removing roles
+
+## Authentication
+
+### 24. Application user authentication (user login)
+### 25. Application client authentication
+### 26. Admin user authentication
+### 27. Organization client authentication
+### 28. Revoking tokens (user logout)
+
+# Working with Users & Groups
+
+### 29. Creating users
+### 30. Retrieving user data
+### 31. Setting or updating password
+### 32. Creating groups
+### 33. Retrieving group data
+### 34. Retrieving a group's users
+### 35. Adding users groups
+### 36. Deleting user group
+
+## Activities & Feeds
+
+### 37. Posting a user activity
+### 38. Posting an activity to a group
+### 39. Creating an activity for a user's followers in a group
+### 40. Retrieving a user's activity feed
+### 41. Retrieving a group's activity feed
+
+## Events & Counters
+
+### 42. Creating & incrementing counters
+### 43. Retrieving counters
+### 44. Retrieving counters by time interval
+
+## Managing Orgs & Apps
+
+### 46. Creating an organization
+### 47. Getting an organization
+### 48. Activating an organization
+### 49. Reactivating an organization
+### 50. Generating organization client credentials
+### 51. Retrieving organization client credentials
+### 52. Getting an organization's activity feed
+### 53. Getting the applications in an organization
+### 54. Getting the admin users in an organization
+### 55. Removing an admin user from an organization
+### 56. Creating an organization application
+### 57. Generating application credentials
+### 58. Getting application credentials
+
+## Managing Admin Users
+
+### 59. Creating an admin user
+### 60. Updating an admin user
+### 61. Getting an admin user
+### 62. Setting an admin user's password
+### 63. Resetting an admin user's password
+### 64. Activating an admin user
+### 65. Reactivating an admin user
+### 66. Getting an admin user's activity feed
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/docs/sdks/usage.md
----------------------------------------------------------------------
diff --git a/docs/sdks/usage.md b/docs/sdks/usage.md
deleted file mode 100644
index 2d2f139..0000000
--- a/docs/sdks/usage.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# 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/02fe9293/sdks/android/README.md
----------------------------------------------------------------------
diff --git a/sdks/android/README.md b/sdks/android/README.md
index 4fe667a..0218763 100755
--- a/sdks/android/README.md
+++ b/sdks/android/README.md
@@ -1,5 +1,4 @@
-Usergrid Android SDK Overview
-=======================
+# Android SDK
Installing the SDK
--------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/sdks/html5-javascript/README.md
----------------------------------------------------------------------
diff --git a/sdks/html5-javascript/README.md b/sdks/html5-javascript/README.md
index 2b87573..bebc955 100755
--- a/sdks/html5-javascript/README.md
+++ b/sdks/html5-javascript/README.md
@@ -1,3 +1,5 @@
+# HTML5-JavaScript SDK
+
##Quickstart
Detailed instructions follow but if you just want a quick example of how to get started with this SDK, here’s a minimal HTML5 file that shows you how to include & initialize the SDK, as well as how to read & write data from Usergrid with it.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/sdks/ios/README.md
----------------------------------------------------------------------
diff --git a/sdks/ios/README.md b/sdks/ios/README.md
index 2377222..b0ba069 100644
--- a/sdks/ios/README.md
+++ b/sdks/ios/README.md
@@ -1,3 +1,5 @@
+# iOS SDK
+
##Version
Current Version: **0.9.2**
@@ -6,7 +8,6 @@ Change log:
<https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md>
-
##Overview
This open source SDK simplifies writing iOS applications that connect to App Services (Usergrid). The repo is located here:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/sdks/nodejs/readme.md
----------------------------------------------------------------------
diff --git a/sdks/nodejs/readme.md b/sdks/nodejs/readme.md
index f3342ee..b394551 100755
--- a/sdks/nodejs/readme.md
+++ b/sdks/nodejs/readme.md
@@ -1,3 +1,5 @@
+# Node.js SDK
+
##Version
Current Version: **0.10.8**
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/02fe9293/sdks/ruby/README.md
----------------------------------------------------------------------
diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md
index d719a49..2f6c594 100644
--- a/sdks/ruby/README.md
+++ b/sdks/ruby/README.md
@@ -1,4 +1,4 @@
-# Usergrid_iron
+# Ruby SDK
Usergrid_iron enables simple, low-level Ruby access to Apigee's App Services (aka Usergrid)
REST API with minimal dependencies.
[13/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/sdks/ios-new.html
----------------------------------------------------------------------
diff --git a/content/docs/sdks/ios-new.html b/content/docs/sdks/ios-new.html
new file mode 100644
index 0000000..5408d11
--- /dev/null
+++ b/content/docs/sdks/ios-new.html
@@ -0,0 +1,1310 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Usergrid iOS SDK — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Usergrid iOS SDK</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/sdks/ios-new.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="usergrid-ios-sdk">
+<h1>Usergrid iOS SDK<a class="headerlink" href="#usergrid-ios-sdk" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="getting-started">
+<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="installing-the-sdk">
+<h3>Installing the SDK<a class="headerlink" href="#installing-the-sdk" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="building-from-source">
+<h3>Building from Source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="usergrid-sdk-reference-with-examples">
+<h1>Usergrid SDK Reference with Examples<a class="headerlink" href="#usergrid-sdk-reference-with-examples" title="Permalink to this headline">¶</a></h1>
+<p>The 66 topics listed below are each documented in the Usergrid
+documentation and for each the docs provide an API reference and example
+for each of these clients: curl, iOS, Android, JavaScript, Ruby and
+Node.js.</p>
+<div class="section" id="working-with-collections">
+<h2>Working with Collections<a class="headerlink" href="#working-with-collections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-collections">
+<h3>1. Creating collections<a class="headerlink" href="#creating-collections" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="85%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>url</td>
+<td>A fully-formed url in the following format: <a class="reference external" href="https://api.usergrid.com///">https://api.usergrid.com///</a></td>
+</tr>
+<tr class="row-odd"><td>op</td>
+<td>The HTTP method - in this case, ‘POST’</td>
+</tr>
+<tr class="row-even"><td>opData</td>
+<td>No data is being sent, so the value is nil</td>
+</tr>
+</tbody>
+</table>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)createCollection {
+
+NSString *url = @"https://api.usergrid.com/your-org/your-app/items";
+NSString *op = @"POST";
+NSString *opData = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"post"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378857079220</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">31</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="retrieving-collections">
+<h3>2. Retrieving collections<a class="headerlink" href="#retrieving-collections" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeCollection*)getCollection:(NSString*)type
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="84%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>type</td>
+<td>The entity type associated with the collection to be retrieved</td>
+</tr>
+</tbody>
+</table>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)getCollection {
+
+ //specify the entity type that corresponds to the collection to be retrieved
+ NSString *type = @"item";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //Call getCollection: to initiate the API GET request
+ ApigeeCollection *collection = [appDelegate.dataClient getCollection:@"book"];
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"3.25"</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"1a9356ba-1682-11e3-a72a-81581bbaf055"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"bread"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378423379867</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378423379867</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/1a9356ba-1682-11e3-a72a-81581bbaf055"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"bread"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"2.50"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378426821261</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span><span class="p">,</span>
+ <span class="s">"count"</span> <span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="updating-collections">
+<h3>3. Updating collections<a class="headerlink" href="#updating-collections" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method (ApigeeClientResponse <a href="#id1"><span class="problematic" id="id2">*</span></a>)apiRequest: (NSString <a href="#id3"><span class="problematic" id="id4">*</span></a>)url
+operation:(NSString <a href="#id5"><span class="problematic" id="id6">*</span></a>)op <a class="reference external" href="data:(NSString">data:(NSString</a> <a href="#id7"><span class="problematic" id="id8">*</span></a>)opData Properties Parameter
+Description url A fully-formed request url in the following format:
+<a class="reference external" href="https://api.usergrid.com////?ql=">https://api.usergrid.com////?ql=</a> Note that you must include an empty
+‘?ql=’ query string at the end of the URL</p>
+<p>op The HTTP method - in this case, ‘PUT’ opData A JSON-formatted string
+that contains the entity properties to be updated Example
+Request/Response Show Code Request: -(NSString*)updateCollection {</p>
+<div class="highlight-python"><div class="highlight"><pre>NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql";
+NSString *op = @"PUT";
+NSString *opData = @"{\"availability\":\"in-stock\"}"; //we escape the quotes
+
+//we recommend you call ApigeeClient from your AppDelegate.
+//for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+//create an instance of AppDelegate
+AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+//call apiRequest to initiate the API call
+ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+</pre></div>
+</div>
+<p>}</p>
+<p>Response: { “action” : “put”, “application” :
+“f34f4222-a166-11e2-a7f7-02e81adcf3d0”, “params” : { “ql” : [ “” ] },
+“path” : “/items”, “uri” :
+“<a class="reference external" href="http://api.usergrid.com/your-org/your-app/items">http://api.usergrid.com/your-org/your-app/items</a>”, “entities” : [ {
+“uuid” : “31847b9a-1a62-11e3-be04-8d05e96f700d”, “type” : “item”, “name”
+: “milk”, “price” : “3.25”, “availability” : “in-stock” “created” :
+1378849479113, “modified” : 1378849567301, “name” : “milk”, }, { “uuid”
+: “3192ac6a-1a62-11e3-a24f-496ca1d42ce7”, “type” : “item”, “name” :
+“bread”, “price” : “4.00”, “availability” : “in-stock” “created” :
+1378849479206, “modified” : 1378849567351, “name” : “bread”, } ],
+“timestamp” : 1378849567280, “duration” : 207, “organization” :
+“your-org”, “applicationName” : “your-app” }</p>
+</div>
+<div class="section" id="deleting-collections">
+<h3>4. Deleting collections<a class="headerlink" href="#deleting-collections" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method (ApigeeClientResponse <a href="#id9"><span class="problematic" id="id10">*</span></a>)apiRequest: (NSString <a href="#id11"><span class="problematic" id="id12">*</span></a>)url
+operation:(NSString <a href="#id13"><span class="problematic" id="id14">*</span></a>)op <a class="reference external" href="data:(NSString">data:(NSString</a> <a href="#id15"><span class="problematic" id="id16">*</span></a>)opData Properties Parameter
+Description url A fully-formed url in the following format:
+<a class="reference external" href="https://api.usergrid.com////?ql=">https://api.usergrid.com////?ql=</a> Note that you must include an empty
+‘?ql=’ query string at the end of the URL</p>
+<p>op The HTTP method - in this case, ‘DELETE’ opData No data is being
+sent, so the value is nil Example Request/Response The following example
+will delete the first 5 entities in a collection.</p>
+<p>Show Code Request: -(NSString*)deleteCollection {</p>
+<div class="highlight-python"><div class="highlight"><pre>NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql='limit=5'";
+NSString *op = @"DELETE";
+NSString *opData = nil;
+
+//we recommend you call ApigeeClient from your AppDelegate.
+//for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+//create an instance of AppDelegate
+AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+//call createEntity to initiate the API call
+ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+</pre></div>
+</div>
+<p>}</p>
+<p>Response: { “action” : “delete”, “application” :
+“f34f4222-a166-11e2-a7f7-02e81adcf3d0”, “params” : { “ql” : [ “” ] },
+“path” : “/items”, “uri” :
+“<a class="reference external" href="http://api.usergrid.com/your-org/your-app/items">http://api.usergrid.com/your-org/your-app/items</a>”, “entities” : [ {
+“uuid” : “53fe3700-0abe-11e3-b1f7-1bd100b8059e”, “type” : “item”, “name”
+: “milk”, “price” : “3.25”, “created” : 1377129832047, “modified” :
+1377129832047, “metadata” : { “path” :
+“/items/53fe3700-0abe-11e3-b1f7-1bd100b8059e” }, “name” : “milk” }, {
+“uuid” : “5ae1fa7a-0abe-11e3-89ab-6be0003c809b”, “type” : “item”, “name”
+: “bread”, “price” : “4.00”, “created” : 1377129843607, “modified” :
+1377129843607, “metadata” : { “path” :
+“/items/5ae1fa7a-0abe-11e3-89ab-6be0003c809b” }, “name” : “bread” } ],
+“timestamp” : 1378848117272, “duration” : 12275, “organization” :
+“your-org”, “applicationName” : “your-app” }</p>
+</div>
+</div>
+<div class="section" id="working-with-entities">
+<h2>Working with Entities<a class="headerlink" href="#working-with-entities" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-a-custom-entity">
+<h3>5. Creating a custom entity<a class="headerlink" href="#creating-a-custom-entity" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method (ApigeeClientResponse <a href="#id17"><span class="problematic" id="id18">*</span></a>)createEntity:(NSDictionary
+<a href="#id19"><span class="problematic" id="id20">*</span></a>)newEntity Parameters Parameter Description newEntity NSDictionary
+object that contains the entity properties Example Request/Response Show
+Code Request: -(NSString*)newEntity {</p>
+<div class="highlight-python"><div class="highlight"><pre>//create an entity object
+NSMutableDictionary *entity = [[NSMutableDictionary alloc] init ];
+
+//Set entity properties
+[entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+[entity setObject:@"milk" forKey:@"name"];
+[entity setObject:@"3.25" forKey:@"price"];
+
+//we recommend you call ApigeeClient from your AppDelegate.
+//for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+//create an instance of AppDelegate
+AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+//call createEntity to initiate the API call
+ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+</pre></div>
+</div>
+<p>}</p>
+<p>Response: { “action” : “post”, “application” :
+“4a1edb70-d7a8-11e2-9ce3-f315e5aa568a”, “params” : { }, “path” :
+“/items”, “uri” : “<a class="reference external" href="http://api.usergrid.com/my-org/my-app/items">http://api.usergrid.com/my-org/my-app/items</a>”,
+“entities” : [ { “uuid” : “83e9b7ea-e8f5-11e2-84df-e94123890c7a”, “type”
+: “item”, “name” : “milk”, “created” : 1373415195230, “modified” :
+1373415195230, “metadata” : {</p>
+<div class="highlight-python"><div class="highlight"><pre> "path" : "/items/83e9b7ea-e8f5-11e2-84df-e94123890c7a"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1373415195225,
+ "duration" : 635,
+ "organization" : "my-org",
+ "applicationName" : "my-app"
+}
+</pre></div>
+</div>
+</div>
+<div class="section" id="creating-multiple-custom-entities">
+<h3>6. Creating multiple custom entities<a class="headerlink" href="#creating-multiple-custom-entities" title="Permalink to this headline">¶</a></h3>
+<p>Request Syntax curl -X POST <a class="reference external" href="https://api.usergrid.com////">https://api.usergrid.com////</a> -d ‘[{}, {},
+...]’ Parameters Parameter Description org Organization UUID or name app
+Application UUID or name entity_type Custom entity type to create. API
+Services will create a corresponding collection if one does not already
+exist. To add an entity to an existing collections, use the collection
+name or colleciton UUID in place of the entity type. entity
+Comma-separated list of entity objects to create. Each object should be
+formatted as a comma-separated list of entity properties, formatted as
+key-value pairs in the format : Example Request/Response Show Code
+Request: curl -X POST “<a class="reference external" href="https://api.usergrid.com/your-org/your-app/item">https://api.usergrid.com/your-org/your-app/item</a>”
+-d ‘[{“name”:”milk”, “price”:”3.25”}, {“name”:”bread”, “price”:”2.50”}]’
+Response: { “action” : “post”, “application” :
+“f34f4222-a166-11e2-a7f7-02e9sjwsf3d0”, “params” : { }, “path” :
+“/items”, “uri” : “<a class="reference external" href="http://api.usergrid.com/your-org/your-app/items">http://api.usergrid.com/your-org/your-app/items</a>”,
+“entities” : [ { “uuid” : “f3a8061a-ef0b-11e2-9e92-5f4a65c16193”, “type”
+: “item”, “name” : “milk”, “price” : “3.25”, “created” : 1374084538609,
+“modified” : 1374084538609, “metadata” : { “path” :
+“/multis/f3a8061a-ef0b-11e2-9e92-5f4a65c16193” }, “name” : “milk” }, {
+“uuid” : “f3be262a-ef0b-11e2-a51b-6715d5ef47a6”, “type” : “item”, “name”
+: “bread”, “price” : “2.50”, “created” : 1374084538754, “modified” :
+1374084538754, “metadata” : { “path” :
+“/items/f3be262a-ef0b-11e2-a51b-6715d5ef47a6” }, “name” : “bread” } ],
+“timestamp” : 1374084538584, “duration” : 388, “organization” :
+“your-org”, “applicationName” : “your-app” }</p>
+</div>
+<div class="section" id="creating-an-entity-with-sub-properties">
+<h3>7. Creating an entity with sub-properties<a class="headerlink" href="#creating-an-entity-with-sub-properties" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method (ApigeeClientResponse <a href="#id21"><span class="problematic" id="id22">*</span></a>)createEntity:(NSDictionary
+<a href="#id23"><span class="problematic" id="id24">*</span></a>)newEntity Parameters Parameter Description newEntity
+NSMutableDictionary object that contains the entity properties Example
+Request/Response Show Code Request: -(NSString*)newEntity {</p>
+<div class="highlight-python"><div class="highlight"><pre>//Initialize an object for the new entity to be created
+NSMutableDictionary *entity = [ [NSMutableDictionary alloc] init ];
+
+//Initialize an object for each nested variety object
+NSMutableDictionary *variety_1 = [ [NSMutableDictionary alloc] init ];
+NSMutableDictionary *variety_2 = [ [NSMutableDictionary alloc] init ];
+NSMutableDictionary *variety_3 = [ [NSMutableDictionary alloc] init ];
+
+//Initialize an array to hold the nested variety objects
+NSMutableArray *variety_list = [ [NSMutableArray alloc] init];
+
+[variety_1 setObject:@"1%" forKey:@"name"];
+[variety_1 setObject:@"3.25" forKey:@"price"];
+[variety_1 setObject:@"0393847575533445" forKey:@"sku"];
+
+[variety_2 setObject:@"whole" forKey:@"name"];
+[variety_2 setObject:@"3.85" forKey:@"price"];
+[variety_2 setObject:@"0393394956788445" forKey:@"sku"];
+
+[variety_3 setObject:@"skim" forKey:@"name"];
+[variety_3 setObject:@"4.00" forKey:@"price"];
+[variety_3 setObject:@"0390299933488445" forKey:@"sku"];
+
+//Add the variety objects to the array
+[variety_list addObject:variety_1];
+[variety_list addObject:variety_2];
+[variety_list addObject:variety_3];
+
+//Set the item entity properties
+[entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+[entity setObject:@"milk" forKey:@"name"];
+
+//Set the variety_list array as the value of the 'varieties' property
+[entity setObject:variety_list forKey:@"varieties"];
+
+//we recommend you call ApigeeClient from your AppDelegate.
+//for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+//create an instance of AppDelegate
+AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+//call createEntity to initiate the API call
+ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+</pre></div>
+</div>
+<p>}</p>
+<p>Response: { “action” : “post”, “application” :
+“f34f4222-a166-11e2-a7f7-02e81adcf3d0”, “params” : { }, “path” :
+“/items”, “uri” : “<a class="reference external" href="http://api.usergrid.com/your-org/your-app/items">http://api.usergrid.com/your-org/your-app/items</a>”,
+“entities” : [ { “uuid” : “0d7cf92a-effb-11e2-917d-c5e707256e71”, “type”
+: “item”, “name” : “milk”, “created” : 1374187231666, “modified” :
+1374187231666, “metadata” : { “path” :
+“/items/0d7cf92a-effb-11e2-917d-c5e707256e71” }, “name” : “milk”,
+“varieties” : [ { “name” : “1%”, “price” : “3.25”, “SKU” :
+“0393847575533445” }, { “name” : “whole”, “price” : “3.85”, “SKU” :
+“0393394956788445” }, { “name” : “skim”, “price” : “4.00”, “SKU” :
+“0390299933488445” } ] } ], “timestamp” : 1374187450826, “duration” :
+50, “organization” : “your-org”, “applicationName” : “your-app” }</p>
+</div>
+<div class="section" id="retrieving-an-entity">
+<h3>8. Retrieving an entity<a class="headerlink" href="#retrieving-an-entity" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)getEntities: (NSString *)endpoint query:(NSString *)query
+</pre></div>
+</div>
+<p>Properties</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="87%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>endpoint</td>
+<td>The collection and entity identifier of the entity to be retrieved.</td>
+</tr>
+<tr class="row-odd"><td>query</td>
+<td>An optional query string. Requests for a specific entity should set the value to nil</td>
+</tr>
+</tbody>
+</table>
+<p>Endpoint exported in the following format: /</p>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)getEntity {
+
+ //specify the entity collection and UUID or name to be retrieved
+ NSString *endpoint = @"items/b3aad0a4-f322-11e2-a9c1-999e12039f87";
+
+ NSString *query = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call getEntities to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:endpoint queryString:query];
+
+ @try {
+ //success
+ }
+
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/amuramoto/sandbox/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"3.25"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378405025763</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">31</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"amuramoto"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"sandbox"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="retrieving-multiple-entities">
+<h3>9. Retrieving multiple entities<a class="headerlink" href="#retrieving-multiple-entities" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)getEntities: (NSString *)type queryString:(NSString *)queryString
+</pre></div>
+</div>
+<p>Properties</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="85%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>type</td>
+<td>The entity type being retrieved</td>
+</tr>
+<tr class="row-odd"><td>queryString</td>
+<td>A query string of entity properties to be matched for the entities to be retrieved.</td>
+</tr>
+</tbody>
+</table>
+<p>Query string is expected in the following format: = OR = OR ...</p>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)getEntity {
+
+//specify the entity type to be retrieved
+NSString *type = @"item";
+
+//specify the uuid of the entity to be retrieved in a query string
+NSString *query = @"uuid = b3aad0a4-f322-11e2-a9c1-999e12039f87 or name = 'bread'";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:type queryString:query];
+
+@try {
+ //success
+}
+@catch (NSException * e) {
+ //fail
+}
+
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"get"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"ql"</span> <span class="p">:</span> <span class="p">[</span> <span class="s">"name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055"</span> <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"3.25"</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"1a9356ba-1682-11e3-a72a-81581bbaf055"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"bread"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378423379867</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378423379867</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/1a9356ba-1682-11e3-a72a-81581bbaf055"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"bread"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"2.50"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378423793729</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">63</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span><span class="p">,</span>
+ <span class="s">"count"</span> <span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="updating-an-entity">
+<h3>10. Updating an entity<a class="headerlink" href="#updating-an-entity" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>entityID</td>
+<td>UUID of the entity to be updated</td>
+</tr>
+<tr class="row-odd"><td>updatedEntity</td>
+<td>NSMutableDictionary containing the properties to be updated</td>
+</tr>
+</tbody>
+</table>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Create an entity object
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set entity properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:@"in-stock" forKey:@"availability"];
+ [updatedEntity setObject:@"4.00" forKey:@"price"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call updateEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"put"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378505705077</span><span class="p">,</span>
+ <span class="s">"availability"</span> <span class="p">:</span> <span class="s">"in-stock"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"4.00"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378505705050</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">87</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="updating-a-sub-property">
+<h3>11. Updating a sub-property<a class="headerlink" href="#updating-a-sub-property" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+</pre></div>
+</div>
+<p>Parameters</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>entityID</td>
+<td>UUID of the entity to be updated</td>
+</tr>
+<tr class="row-odd"><td>updatedEntity</td>
+<td>Entity object containing the properties to be updated</td>
+</tr>
+</tbody>
+</table>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Define our two sub-properties to include in the update
+ NSMutableDictionary *subproperty1 = [ [NSMutableDictionary alloc] init];
+ NSMutableDictionary *subproperty2 = [ [NSMutableDictionary alloc] init];
+ [subproperty1 setObject:@"1%" forKey:@"name"];
+ [subproperty1 setObject:@"3.25" forKey:@"price"];
+ [subproperty2 setObject:@"whole" forKey:@"name"];
+ [subproperty2 setObject:@"4.00" forKey:@"price"];
+
+ //Put our sub-properties into an NSArray
+ NSArray *subproperties = [ [NSArray alloc] initWithObjects:props1,props2, nil];
+
+ //Create an NSMutableDictionary to hold our updates
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set the properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:props forKey:@"varieties"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"put"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378405020796</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378761459069</span><span class="p">,</span>
+ <span class="s">"availability"</span> <span class="p">:</span> <span class="s">"in-stock"</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"</span><span class="p">,</span>
+ <span class="s">"varieties"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"1%"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"3.25"</span>
+ <span class="p">},</span> <span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"whole"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"4.00"</span>
+ <span class="p">}</span> <span class="p">]</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378761459047</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">62</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="deleting-data-entities">
+<h3>12. Deleting data entities<a class="headerlink" href="#deleting-data-entities" title="Permalink to this headline">¶</a></h3>
+<p>SDK Method</p>
+<div class="highlight-python"><div class="highlight"><pre>(ApigeeClientResponse *)removeEntity: (NSString *)type entityID:(NSString *)entityID
+</pre></div>
+</div>
+<p>Properties</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>type</td>
+<td>The entity type being deleted</td>
+</tr>
+<tr class="row-odd"><td>entityID</td>
+<td>The UUID or name of the entity to be removed</td>
+</tr>
+</tbody>
+</table>
+<p>Example Request/Response</p>
+<p>Request:</p>
+<div class="highlight-python"><div class="highlight"><pre>-(NSString*)deleteEntity {
+
+ //specify the entity type to be deleted
+ NSString *type = @"item";
+
+ //specify the uuid or name of the entity to be deleted
+ NSString *entityId = @"milk";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call removeEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient removeEntity:type entityID:entityId];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+}
+</pre></div>
+</div>
+<p>Response:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"delete"</span><span class="p">,</span>
+ <span class="s">"application"</span> <span class="p">:</span> <span class="s">"f34f4222-a166-11e2-a7f7-02e81adcf3d0"</span><span class="p">,</span>
+ <span class="s">"params"</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items"</span><span class="p">,</span>
+ <span class="s">"uri"</span> <span class="p">:</span> <span class="s">"http://api.usergrid.com/your-org/your-app/items"</span><span class="p">,</span>
+ <span class="s">"entities"</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+ <span class="s">"uuid"</span> <span class="p">:</span> <span class="s">"328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"</span><span class="p">,</span>
+ <span class="s">"type"</span> <span class="p">:</span> <span class="s">"item"</span><span class="p">,</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"created"</span> <span class="p">:</span> <span class="mi">1378766158500</span><span class="p">,</span>
+ <span class="s">"modified"</span> <span class="p">:</span> <span class="mi">1378766158500</span><span class="p">,</span>
+ <span class="s">"metadata"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"path"</span> <span class="p">:</span> <span class="s">"/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"</span>
+ <span class="p">},</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"milk"</span><span class="p">,</span>
+ <span class="s">"price"</span> <span class="p">:</span> <span class="s">"3.25"</span>
+ <span class="p">}</span> <span class="p">],</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1378766172016</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">324</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"your-org"</span><span class="p">,</span>
+ <span class="s">"applicationName"</span> <span class="p">:</span> <span class="s">"your-app"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="data-queries">
+<h2>Data Queries<a class="headerlink" href="#data-queries" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="querying-your-data">
+<h3>13. Querying your data<a class="headerlink" href="#querying-your-data" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="entity-connections">
+<h2>Entity Connections<a class="headerlink" href="#entity-connections" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="connecting-users-other-data">
+<h3>14. Connecting users other data<a class="headerlink" href="#connecting-users-other-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-user-connection-data">
+<h3>15. Retrieving user connection data<a class="headerlink" href="#retrieving-user-connection-data" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="disconnecting-entities">
+<h3>16. Disconnecting entities<a class="headerlink" href="#disconnecting-entities" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="permissions-roles">
+<h2>Permissions & Roles<a class="headerlink" href="#permissions-roles" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="assigning-permissions">
+<h3>17. Assigning permissions<a class="headerlink" href="#assigning-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-permissions">
+<h3>18. Removing permissions<a class="headerlink" href="#removing-permissions" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id25">
+<h3>19. Assigning permissions<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="id26">
+<h3>20. Removing permissions<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-roles">
+<h3>21. Creating roles<a class="headerlink" href="#creating-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="assigning-roles">
+<h3>22. Assigning roles<a class="headerlink" href="#assigning-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-roles">
+<h3>23. Removing roles<a class="headerlink" href="#removing-roles" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="authentication">
+<h2>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="application-user-authentication-user-login">
+<h3>24. Application user authentication (user login)<a class="headerlink" href="#application-user-authentication-user-login" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="application-client-authentication">
+<h3>25. Application client authentication<a class="headerlink" href="#application-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="admin-user-authentication">
+<h3>26. Admin user authentication<a class="headerlink" href="#admin-user-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="organization-client-authentication">
+<h3>27. Organization client authentication<a class="headerlink" href="#organization-client-authentication" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="revoking-tokens-user-logout">
+<h3>28. Revoking tokens (user logout)<a class="headerlink" href="#revoking-tokens-user-logout" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+<div class="section" id="working-with-users-groups">
+<h1>Working with Users & Groups<a class="headerlink" href="#working-with-users-groups" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="activities-feeds">
+<h2>Activities & Feeds<a class="headerlink" href="#activities-feeds" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="posting-a-user-activity">
+<h3>37. Posting a user activity<a class="headerlink" href="#posting-a-user-activity" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="posting-an-activity-to-a-group">
+<h3>38. Posting an activity to a group<a class="headerlink" href="#posting-an-activity-to-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-activity-for-a-user-s-followers-in-a-group">
+<h3>39. Creating an activity for a user’s followers in a group<a class="headerlink" href="#creating-an-activity-for-a-user-s-followers-in-a-group" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-user-s-activity-feed">
+<h3>40. Retrieving a user’s activity feed<a class="headerlink" href="#retrieving-a-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-a-group-s-activity-feed">
+<h3>41. Retrieving a group’s activity feed<a class="headerlink" href="#retrieving-a-group-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="events-counters">
+<h2>Events & Counters<a class="headerlink" href="#events-counters" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-incrementing-counters">
+<h3>42. Creating & incrementing counters<a class="headerlink" href="#creating-incrementing-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters">
+<h3>43. Retrieving counters<a class="headerlink" href="#retrieving-counters" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-counters-by-time-interval">
+<h3>44. Retrieving counters by time interval<a class="headerlink" href="#retrieving-counters-by-time-interval" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-orgs-apps">
+<h2>Managing Orgs & Apps<a class="headerlink" href="#managing-orgs-apps" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-organization">
+<h3>46. Creating an organization<a class="headerlink" href="#creating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization">
+<h3>47. Getting an organization<a class="headerlink" href="#getting-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-organization">
+<h3>48. Activating an organization<a class="headerlink" href="#activating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-organization">
+<h3>49. Reactivating an organization<a class="headerlink" href="#reactivating-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-organization-client-credentials">
+<h3>50. Generating organization client credentials<a class="headerlink" href="#generating-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="retrieving-organization-client-credentials">
+<h3>51. Retrieving organization client credentials<a class="headerlink" href="#retrieving-organization-client-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-organization-s-activity-feed">
+<h3>52. Getting an organization’s activity feed<a class="headerlink" href="#getting-an-organization-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-applications-in-an-organization">
+<h3>53. Getting the applications in an organization<a class="headerlink" href="#getting-the-applications-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-the-admin-users-in-an-organization">
+<h3>54. Getting the admin users in an organization<a class="headerlink" href="#getting-the-admin-users-in-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="removing-an-admin-user-from-an-organization">
+<h3>55. Removing an admin user from an organization<a class="headerlink" href="#removing-an-admin-user-from-an-organization" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="creating-an-organization-application">
+<h3>56. Creating an organization application<a class="headerlink" href="#creating-an-organization-application" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="generating-application-credentials">
+<h3>57. Generating application credentials<a class="headerlink" href="#generating-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-application-credentials">
+<h3>58. Getting application credentials<a class="headerlink" href="#getting-application-credentials" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+<div class="section" id="managing-admin-users">
+<h2>Managing Admin Users<a class="headerlink" href="#managing-admin-users" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="creating-an-admin-user">
+<h3>59. Creating an admin user<a class="headerlink" href="#creating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="updating-an-admin-user">
+<h3>60. Updating an admin user<a class="headerlink" href="#updating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user">
+<h3>61. Getting an admin user<a class="headerlink" href="#getting-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="setting-an-admin-user-s-password">
+<h3>62. Setting an admin user’s password<a class="headerlink" href="#setting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="resetting-an-admin-user-s-password">
+<h3>63. Resetting an admin user’s password<a class="headerlink" href="#resetting-an-admin-user-s-password" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="activating-an-admin-user">
+<h3>64. Activating an admin user<a class="headerlink" href="#activating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="reactivating-an-admin-user">
+<h3>65. Reactivating an admin user<a class="headerlink" href="#reactivating-an-admin-user" title="Permalink to this headline">¶</a></h3>
+</div>
+<div class="section" id="getting-an-admin-user-s-activity-feed">
+<h3>66. Getting an admin user’s activity feed<a class="headerlink" href="#getting-an-admin-user-s-activity-feed" title="Permalink to this headline">¶</a></h3>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
[10/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/app-security.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/app-security.html b/content/docs/security-and-auth/app-security.html
index 247cf84..b0c6a1c 100644
--- a/content/docs/security-and-auth/app-security.html
+++ b/content/docs/security-and-auth/app-security.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -141,9 +143,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -158,6 +160,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/authenticating-api-requests.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/authenticating-api-requests.html b/content/docs/security-and-auth/authenticating-api-requests.html
index e5afa55..9a7ca6a 100644
--- a/content/docs/security-and-auth/authenticating-api-requests.html
+++ b/content/docs/security-and-auth/authenticating-api-requests.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -145,9 +147,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -162,6 +164,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -232,7 +235,8 @@ access.</p>
API, and how to manage access tokens, including revoking and changing
token time to live.</p>
<p>For information on generating access tokens/authenticating users and
-clients, see Authenticating users and application clients.</p>
+clients, see <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users and application
+clients</a>.</p>
<div class="section" id="authenticating-with-access-tokens">
<h2>Authenticating with access tokens<a class="headerlink" href="#authenticating-with-access-tokens" title="Permalink to this headline">¶</a></h2>
<p>When you obtain an access token, you must provide it with every
@@ -258,7 +262,7 @@ token is the sandbox application. The Guest role has been given full
permissions (/** for GET, POST, PUT, and DELETE) for this application.
This eliminates the need for a token when making application level calls
to the sandbox app. For further information on specifying permissions,
-see Managing access by defining permission rules.</p>
+see <a class="reference external" href="security-and-auth/using-permissions.html">Using Permissions</a>.</p>
</p></div></div>
<div class="section" id="authenticating-with-client-id-and-client-secret">
<h2>Authenticating with client ID and client secret<a class="headerlink" href="#authenticating-with-client-id-and-client-secret" title="Permalink to this headline">¶</a></h2>
@@ -275,9 +279,10 @@ Started’ section of the admin portal.</p>
Warning: For server-side use only You should never authenticate this<p>way from a client-side app such as a mobile app. A hacker could analyze
your app and extract the credentials for malicious use even if those
-credentials are compiled and in binary format. See Security best
-practices for additional considerations in keeping access to your app
-and its data secure.</p>
+credentials are compiled and in binary format. See <a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> for
+additional considerations in keeping access to your app and its data
+secure.</p>
</p></div><p>This can be a convenient way to authenticate API requests, since there
is no need to generate and manage an access token, but please note that
you should be very cautious when implementing this type of
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/authenticating-users-and-application-clients.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/authenticating-users-and-application-clients.html b/content/docs/security-and-auth/authenticating-users-and-application-clients.html
index 7e1348f..83a62b4 100644
--- a/content/docs/security-and-auth/authenticating-users-and-application-clients.html
+++ b/content/docs/security-and-auth/authenticating-users-and-application-clients.html
@@ -32,7 +32,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
<link rel="next" title="Authentication levels" href="user-authentication-types.html"/>
- <link rel="prev" title="Using permissions" href="using-permissions.html"/>
+ <link rel="prev" title="Using roles" href="using-roles.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Authenticating users & app clients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#authentication-levels">Authentication levels</a></li>
<li class="toctree-l2"><a class="reference internal" href="#application-user-authentication-user-login">Application user authentication (user login)</a><ul>
@@ -171,9 +173,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -188,6 +190,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -338,9 +341,10 @@ Credentials’.</p>
Warning: You should never authenticate this way from a client-side app<p>such as a mobile app. A hacker could analyze your app and extract the
credentials for malicious use even if those credentials are compiled and
-in binary format. See “safe mobile access” in <a class="reference external" href="authenticating-api-requests.html">Authenticating API
-requests</a> for additional
-considerations in keeping access to your app and its data secure.</p>
+in binary format. See <a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> for
+additional considerations in keeping access to your app and its data
+secure.</p>
</p></div><div class="section" id="id1">
<h3>Request syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/<orgName>/<appName>/token" -d '{"grant_type":"client_credentials", "client_id":<application_clientID>, "client_secret":"<application_client_secret>"}'
@@ -380,8 +384,8 @@ supplies the username and password of an admin user in the request.</p>
Warning: Authenticating as an admin user grants full access to one or<p>more organizations and all of the applications contained in those
organizations. Due to this, be cautious when implementing this type of
authentication in client-side code. Instead, consider implementing admin
-user access in server-side code only. See “safe mobile access” in
-<a class="reference external" href="authenticating-api-requests.html">Authenticating API requests</a> for
+user access in server-side code only. See <a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> for
additional considerations in keeping access to your app and its data
secure.</p>
</p></div><div class="section" id="id4">
@@ -425,9 +429,10 @@ Administration’ page of the API Services admin console under
Warning: You should never authenticate this way from a client-side app<p>such as a mobile app. A hacker could analyze your app and extract the
credentials for malicious use even if those credentials are compiled and
-in binary format. See “safe mobile access” in [Authenticating API
-requests](authenticating-api-requests.html for additional considerations
-in keeping access to your app and its data secure.</p>
+in binary format. See <a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> for
+additional considerations in keeping access to your app and its data
+secure.</p>
</p></div><div class="section" id="id7">
<h3>Request syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST "https://api.usergrid.com/management/token" -d '{"grant_type":"client_credentials", "client_id":<org_clientID>, "client_secret":<org_client_secret>}'
@@ -467,7 +472,7 @@ requests to the organization:</p>
<a href="user-authentication-types.html" class="btn btn-neutral float-right" title="Authentication levels" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="using-permissions.html" class="btn btn-neutral" title="Using permissions" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="using-roles.html" class="btn btn-neutral" title="Using roles" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/changing-token-time-live-ttl.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/changing-token-time-live-ttl.html b/content/docs/security-and-auth/changing-token-time-live-ttl.html
index bacf227..042b995 100644
--- a/content/docs/security-and-auth/changing-token-time-live-ttl.html
+++ b/content/docs/security-and-auth/changing-token-time-live-ttl.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Changing token expiration (time-to-live)</a><ul>
@@ -151,9 +153,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -168,6 +170,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/facebook-sign.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/facebook-sign.html b/content/docs/security-and-auth/facebook-sign.html
index 69ca5a2..1256eca 100644
--- a/content/docs/security-and-auth/facebook-sign.html
+++ b/content/docs/security-and-auth/facebook-sign.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -150,9 +152,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -167,6 +169,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -267,7 +270,7 @@ JavaScript, iOS, and Android.</p>
<p>In brief, here are the steps for JavaScript. You can see these steps
implemented in the Facebook login example packaged with the JavaScript
SDK for Usergrid (which you can download in ZIP format or tar.gz
-format). The Facebook login example is in the /examples/facebook
+format). The Facebook login example is in the <code class="docutils literal"><span class="pre">/examples/facebook</span></code>
directory of the extracted download. The code example snippets shown
below are taken from the Facebook login example.</p>
<div class="section" id="step-1-create-a-facebook-app">
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/revoking-tokens-logout.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/revoking-tokens-logout.html b/content/docs/security-and-auth/revoking-tokens-logout.html
index f9b899a..3767655 100644
--- a/content/docs/security-and-auth/revoking-tokens-logout.html
+++ b/content/docs/security-and-auth/revoking-tokens-logout.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -149,9 +151,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -166,6 +168,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/securing-your-app.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/securing-your-app.html b/content/docs/security-and-auth/securing-your-app.html
index f0638cf..d9339c3 100644
--- a/content/docs/security-and-auth/securing-your-app.html
+++ b/content/docs/security-and-auth/securing-your-app.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -149,9 +151,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -166,6 +168,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/user-authentication-types.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/user-authentication-types.html b/content/docs/security-and-auth/user-authentication-types.html
index 7e8f76d..1954753 100644
--- a/content/docs/security-and-auth/user-authentication-types.html
+++ b/content/docs/security-and-auth/user-authentication-types.html
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -117,6 +118,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Authentication levels</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuring-authentication-levels">Configuring authentication levels</a></li>
@@ -146,9 +148,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -163,6 +165,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -238,8 +241,11 @@ this can be done both programmatically and in the admin portal. The
application, organization and admin clients cannot be configured, and
can only be accessed programmatically via the API.</p>
<p>For more about creating and managing roles and permissions for
-application users, see Managing access by defining permission rules. For
-a look at how security features fit together, see App Security Overview.</p>
+application users, see <a class="reference external" href="security-and-auth/using-permissions.html">Using
+Permissions</a> and <a class="reference external" href="security-and-auth/using-roles.html">Using
+Roles</a>. For a look at how
+security features fit together, see <a class="reference external" href="../security-and-auth/app-security.html">App Security
+Overview</a>.</p>
</div>
<div class="section" id="user-authentication-level">
<h2>User authentication level<a class="headerlink" href="#user-authentication-level" title="Permalink to this headline">¶</a></h2>
@@ -257,9 +263,9 @@ a look at how security features fit together, see App Security Overview.</p>
login for your app. The application user level allows access to your
Usergrid application as governed by the permission rules you create and
associated with users and user groups. For more on setting permissions
-see Managing access by defining permission rules. Each Application User
-is represented by a User entity in your Usergrid application. For more
-about the User entity, see User.</p>
+see <a class="reference external" href="security-and-auth/using-permissions.html">Using Permissions</a>.
+Each Application User is represented by a User entity in your Usergrid
+application. For more about the User entity, see User.</p>
</td>
</tr>
</table></div>
@@ -274,9 +280,11 @@ way from a client-side app, such as a mobile app. A hacker could analyze
your app and extract the credentials for malicious use even if those
credentials are compiled and in binary format. Even when authenticating
with username and password, be cautious when using these authentication
-levels since they grant broad access to your Usergrid account. See “safe
-mobile access” in Authenticating API requests for additional
-considerations in keeping access to your app and its data secure.</p>
+levels since they grant broad access to your Usergrid account. See
+<a class="reference external" href="../security-and-auth/securing-your-app.html">Security Best
+Practices</a> for
+additional considerations in keeping access to your app and its data
+secure.</p>
</p></div>
<table class="usergrid-table">
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/security-and-auth/using-permissions.html
----------------------------------------------------------------------
diff --git a/content/docs/security-and-auth/using-permissions.html b/content/docs/security-and-auth/using-permissions.html
index 9151f01..0b06bbd 100644
--- a/content/docs/security-and-auth/using-permissions.html
+++ b/content/docs/security-and-auth/using-permissions.html
@@ -31,7 +31,7 @@
<link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
- <link rel="next" title="Authenticating users & app clients" href="authenticating-users-and-application-clients.html"/>
+ <link rel="next" title="Using roles" href="using-roles.html"/>
<link rel="prev" title="Security & token authentication" href="app-security.html"/>
@@ -82,14 +82,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -133,6 +134,7 @@
</li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -157,9 +159,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -174,6 +176,7 @@
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -305,7 +308,7 @@ assigning the permission only to that user entity.</p>
Assigning permissions to roles can be particularly useful, as it allows
you to create sets of permissions that represent complex access
definitions, which can then be assigned to user and group entities. For
-more on roles, see Using roles.</p>
+more on roles, see <a class="reference external" href="security-and-auth/using-roles.html">Using Roles</a>.</p>
<div class="section" id="request-syntax">
<h3>Request syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST https://api.usergrid.com/<org>/<app>/<collection>/<entity>/permissions -d '{"permission":<permissions>}'
@@ -314,8 +317,8 @@ more on roles, see Using roles.</p>
<p>Parameters</p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
-<col width="89%" />
+<col width="9%" />
+<col width="91%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -336,7 +339,7 @@ more on roles, see Using roles.</p>
<td>The UUID of the entity to assign the permissions to. For users, username and for groups, name are also accepted.</td>
</tr>
<tr class="row-even"><td>permissions</td>
-<td>The permissions to assign to the entity. See Permissions syntax for format.</td>
+<td>The permissions to assign to the entity. See <a class="reference external" href="security-and-auth/using-permissions.html#permissions-syntax">Permissions syntax</a> for format.</td>
</tr>
</tbody>
</table>
@@ -446,7 +449,7 @@ the response:</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="authenticating-users-and-application-clients.html" class="btn btn-neutral float-right" title="Authenticating users & app clients" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="using-roles.html" class="btn btn-neutral float-right" title="Using roles" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="app-security.html" class="btn btn-neutral" title="Security & token authentication" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
[19/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/sdks/ios-new.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/ios-new.txt b/content/docs/_sources/sdks/ios-new.txt
new file mode 100644
index 0000000..0f5b3fe
--- /dev/null
+++ b/content/docs/_sources/sdks/ios-new.txt
@@ -0,0 +1,982 @@
+# Usergrid iOS SDK
+
+## Getting Started
+
+### Installing the SDK
+### Building from Source
+
+# Usergrid SDK Reference with Examples
+
+The 66 topics listed below are each documented in the Usergrid documentation and
+for each the docs provide an API reference and example for each of these clients:
+curl, iOS, Android, JavaScript, Ruby and Node.js.
+
+## Working with Collections
+
+### 1. Creating collections
+
+SDK Method
+
+ (ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+
+Parameters
+
+Parameter Description
+--------- -----------
+url A fully-formed url in the following format: https://api.usergrid.com/<org>/<app>/<collection>
+op The HTTP method - in this case, 'POST'
+opData No data is being sent, so the value is nil
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)createCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items";
+ NSString *op = @"POST";
+ NSString *opData = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ ],
+ "timestamp" : 1378857079220,
+ "duration" : 31,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+### 2. Retrieving collections
+
+SDK Method
+
+ (ApigeeCollection*)getCollection:(NSString*)type
+
+Parameters
+
+Parameter Description
+--------- -----------
+type The entity type associated with the collection to be retrieved
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getCollection {
+
+ //specify the entity type that corresponds to the collection to be retrieved
+ NSString *type = @"item";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //Call getCollection: to initiate the API GET request
+ ApigeeCollection *collection = [appDelegate.dataClient getCollection:@"book"];
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ }, {
+ "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
+ "type" : "item",
+ "name" : "bread",
+ "created" : 1378423379867,
+ "modified" : 1378423379867,
+ "metadata" : {
+ "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
+ },
+ "name" : "bread",
+ "price" : "2.50"
+ } ],
+ "timestamp" : 1378426821261,
+ "duration" : 35,
+ "organization" : "your-org",
+ "applicationName" : "your-app",
+ "count" : 2
+ }
+
+### 3. Updating collections
+
+SDK Method
+(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+Properties
+Parameter Description
+url A fully-formed request url in the following format:
+https://api.usergrid.com/<org>/<app>/<collection>/?ql=
+Note that you must include an empty '?ql=' query string at the end of the URL
+
+op The HTTP method - in this case, 'PUT'
+opData A JSON-formatted string that contains the entity properties to be updated
+Example Request/Response
+Show Code
+Request:
+-(NSString*)updateCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql";
+ NSString *op = @"PUT";
+ NSString *opData = @"{\"availability\":\"in-stock\"}"; //we escape the quotes
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call apiRequest to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "31847b9a-1a62-11e3-be04-8d05e96f700d",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "availability" : "in-stock"
+ "created" : 1378849479113,
+ "modified" : 1378849567301,
+ "name" : "milk",
+ }, {
+ "uuid" : "3192ac6a-1a62-11e3-a24f-496ca1d42ce7",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "4.00",
+ "availability" : "in-stock"
+ "created" : 1378849479206,
+ "modified" : 1378849567351,
+ "name" : "bread",
+ } ],
+ "timestamp" : 1378849567280,
+ "duration" : 207,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+### 4. Deleting collections
+
+SDK Method
+(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData
+Properties
+Parameter Description
+url A fully-formed url in the following format:
+https://api.usergrid.com/<org>/<app>/<collection>/?ql=
+Note that you must include an empty '?ql=' query string at the end of the URL
+
+op The HTTP method - in this case, 'DELETE'
+opData No data is being sent, so the value is nil
+Example Request/Response
+The following example will delete the first 5 entities in a collection.
+
+Show Code
+Request:
+-(NSString*)deleteCollection {
+
+ NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql='limit=5'";
+ NSString *op = @"DELETE";
+ NSString *opData = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "53fe3700-0abe-11e3-b1f7-1bd100b8059e",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "created" : 1377129832047,
+ "modified" : 1377129832047,
+ "metadata" : {
+ "path" : "/items/53fe3700-0abe-11e3-b1f7-1bd100b8059e"
+ },
+ "name" : "milk"
+ }, {
+ "uuid" : "5ae1fa7a-0abe-11e3-89ab-6be0003c809b",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "4.00",
+ "created" : 1377129843607,
+ "modified" : 1377129843607,
+ "metadata" : {
+ "path" : "/items/5ae1fa7a-0abe-11e3-89ab-6be0003c809b"
+ },
+ "name" : "bread"
+ } ],
+ "timestamp" : 1378848117272,
+ "duration" : 12275,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+## Working with Entities
+
+### 5. Creating a custom entity
+
+SDK Method
+(ApigeeClientResponse *)createEntity:(NSDictionary *)newEntity
+Parameters
+Parameter Description
+newEntity NSDictionary object that contains the entity properties
+Example Request/Response
+Show Code
+Request:
+-(NSString*)newEntity {
+
+ //create an entity object
+ NSMutableDictionary *entity = [[NSMutableDictionary alloc] init ];
+
+ //Set entity properties
+ [entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+ [entity setObject:@"milk" forKey:@"name"];
+ [entity setObject:@"3.25" forKey:@"price"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+ {
+ "action" : "post",
+ "application" : "4a1edb70-d7a8-11e2-9ce3-f315e5aa568a",
+ "params" : { },
+ "path" : "/items", "uri" : "http://api.usergrid.com/my-org/my-app/items",
+ "entities" : [ {
+ "uuid" : "83e9b7ea-e8f5-11e2-84df-e94123890c7a",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1373415195230,
+ "modified" : 1373415195230,
+ "metadata" : {
+
+ "path" : "/items/83e9b7ea-e8f5-11e2-84df-e94123890c7a"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1373415195225,
+ "duration" : 635,
+ "organization" : "my-org",
+ "applicationName" : "my-app"
+ }
+
+
+### 6. Creating multiple custom entities
+
+Request Syntax
+curl -X POST https://api.usergrid.com/<org>/<app>/<entity_type>/ -d '[{<entity>}, {<entity>}, ...]'
+Parameters
+Parameter Description
+org Organization UUID or name
+app Application UUID or name
+entity_type Custom entity type to create. API Services will create a corresponding collection if one does not already exist. To add an entity to an existing collections, use the collection name or colleciton UUID in place of the entity type.
+entity Comma-separated list of entity objects to create. Each object should be formatted as a comma-separated list of entity properties, formatted as key-value pairs in the format <property>:<value>
+Example Request/Response
+Show Code
+Request:
+curl -X POST "https://api.usergrid.com/your-org/your-app/item" -d '[{"name":"milk", "price":"3.25"}, {"name":"bread", "price":"2.50"}]'
+Response:
+{
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e9sjwsf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "f3a8061a-ef0b-11e2-9e92-5f4a65c16193",
+ "type" : "item",
+ "name" : "milk",
+ "price" : "3.25",
+ "created" : 1374084538609,
+ "modified" : 1374084538609,
+ "metadata" : {
+ "path" : "/multis/f3a8061a-ef0b-11e2-9e92-5f4a65c16193"
+ },
+ "name" : "milk"
+ }, {
+ "uuid" : "f3be262a-ef0b-11e2-a51b-6715d5ef47a6",
+ "type" : "item",
+ "name" : "bread",
+ "price" : "2.50",
+ "created" : 1374084538754,
+ "modified" : 1374084538754,
+ "metadata" : {
+ "path" : "/items/f3be262a-ef0b-11e2-a51b-6715d5ef47a6"
+ },
+ "name" : "bread"
+ } ],
+ "timestamp" : 1374084538584,
+ "duration" : 388,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+### 7. Creating an entity with sub-properties
+
+SDK Method
+(ApigeeClientResponse *)createEntity:(NSDictionary *)newEntity
+Parameters
+Parameter Description
+newEntity NSMutableDictionary object that contains the entity properties
+Example Request/Response
+Show Code
+Request:
+-(NSString*)newEntity {
+
+ //Initialize an object for the new entity to be created
+ NSMutableDictionary *entity = [ [NSMutableDictionary alloc] init ];
+
+ //Initialize an object for each nested variety object
+ NSMutableDictionary *variety_1 = [ [NSMutableDictionary alloc] init ];
+ NSMutableDictionary *variety_2 = [ [NSMutableDictionary alloc] init ];
+ NSMutableDictionary *variety_3 = [ [NSMutableDictionary alloc] init ];
+
+ //Initialize an array to hold the nested variety objects
+ NSMutableArray *variety_list = [ [NSMutableArray alloc] init];
+
+ [variety_1 setObject:@"1%" forKey:@"name"];
+ [variety_1 setObject:@"3.25" forKey:@"price"];
+ [variety_1 setObject:@"0393847575533445" forKey:@"sku"];
+
+ [variety_2 setObject:@"whole" forKey:@"name"];
+ [variety_2 setObject:@"3.85" forKey:@"price"];
+ [variety_2 setObject:@"0393394956788445" forKey:@"sku"];
+
+ [variety_3 setObject:@"skim" forKey:@"name"];
+ [variety_3 setObject:@"4.00" forKey:@"price"];
+ [variety_3 setObject:@"0390299933488445" forKey:@"sku"];
+
+ //Add the variety objects to the array
+ [variety_list addObject:variety_1];
+ [variety_list addObject:variety_2];
+ [variety_list addObject:variety_3];
+
+ //Set the item entity properties
+ [entity setObject:@"item" forKey:@"type"]; //Required. New entity type to create
+ [entity setObject:@"milk" forKey:@"name"];
+
+ //Set the variety_list array as the value of the 'varieties' property
+ [entity setObject:variety_list forKey:@"varieties"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient createEntity:entity];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+Response:
+{
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "0d7cf92a-effb-11e2-917d-c5e707256e71",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1374187231666,
+ "modified" : 1374187231666,
+ "metadata" : {
+ "path" : "/items/0d7cf92a-effb-11e2-917d-c5e707256e71"
+ },
+ "name" : "milk",
+ "varieties" : [ {
+ "name" : "1%",
+ "price" : "3.25",
+ "SKU" : "0393847575533445"
+ }, {
+ "name" : "whole",
+ "price" : "3.85",
+ "SKU" : "0393394956788445"
+ }, {
+ "name" : "skim",
+ "price" : "4.00",
+ "SKU" : "0390299933488445"
+ } ]
+ } ],
+ "timestamp" : 1374187450826,
+ "duration" : 50,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+
+
+### 8. Retrieving an entity
+
+SDK Method
+
+ (ApigeeClientResponse *)getEntities: (NSString *)endpoint query:(NSString *)query
+
+Properties
+
+Parameter Description
+--------- -----------
+endpoint The collection and entity identifier of the entity to be retrieved.
+query An optional query string. Requests for a specific entity should set the value to nil
+
+Endpoint exported in the following format: <collection>/<entity_UUID_or_name>
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getEntity {
+
+ //specify the entity collection and UUID or name to be retrieved
+ NSString *endpoint = @"items/b3aad0a4-f322-11e2-a9c1-999e12039f87";
+
+ NSString *query = nil;
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call getEntities to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:endpoint queryString:query];
+
+ @try {
+ //success
+ }
+
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/amuramoto/sandbox/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378405025763,
+ "duration" : 31,
+ "organization" : "amuramoto",
+ "applicationName" : "sandbox"
+ }
+
+### 9. Retrieving multiple entities
+
+SDK Method
+
+ (ApigeeClientResponse *)getEntities: (NSString *)type queryString:(NSString *)queryString
+
+Properties
+
+Parameter Description
+--------- -----------
+type The entity type being retrieved
+queryString A query string of entity properties to be matched for the entities to be retrieved.
+
+Query string is expected in the following format: <property>=<value> OR <property>=<value> OR ...
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)getEntity {
+
+ //specify the entity type to be retrieved
+ NSString *type = @"item";
+
+ //specify the uuid of the entity to be retrieved in a query string
+ NSString *query = @"uuid = b3aad0a4-f322-11e2-a9c1-999e12039f87 or name = 'bread'";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient getEntities:type queryString:query];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "get",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : {
+ "ql" : [ "name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055" ]
+ },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378405020796,
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ }, {
+ "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
+ "type" : "item",
+ "name" : "bread",
+ "created" : 1378423379867,
+ "modified" : 1378423379867,
+ "metadata" : {
+ "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
+ },
+ "name" : "bread",
+ "price" : "2.50"
+ } ],
+ "timestamp" : 1378423793729,
+ "duration" : 63,
+ "organization" : "your-org",
+ "applicationName" : "your-app",
+ "count" : 2
+ }
+
+
+### 10. Updating an entity
+
+SDK Method
+
+ (ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+
+Parameters
+
+Parameter Description
+--------- -----------
+entityID UUID of the entity to be updated
+updatedEntity NSMutableDictionary containing the properties to be updated
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Create an entity object
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set entity properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:@"in-stock" forKey:@"availability"];
+ [updatedEntity setObject:@"4.00" forKey:@"price"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call updateEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378505705077,
+ "availability" : "in-stock",
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "price" : "4.00"
+ } ],
+ "timestamp" : 1378505705050,
+ "duration" : 87,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### 11. Updating a sub-property
+
+SDK Method
+
+ (ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity
+
+Parameters
+
+Parameter Description
+--------- -----------
+entityID UUID of the entity to be updated
+updatedEntity Entity object containing the properties to be updated
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)updateEntity {
+
+ //UUID of the entity to be updated
+ NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
+
+ //Define our two sub-properties to include in the update
+ NSMutableDictionary *subproperty1 = [ [NSMutableDictionary alloc] init];
+ NSMutableDictionary *subproperty2 = [ [NSMutableDictionary alloc] init];
+ [subproperty1 setObject:@"1%" forKey:@"name"];
+ [subproperty1 setObject:@"3.25" forKey:@"price"];
+ [subproperty2 setObject:@"whole" forKey:@"name"];
+ [subproperty2 setObject:@"4.00" forKey:@"price"];
+
+ //Put our sub-properties into an NSArray
+ NSArray *subproperties = [ [NSArray alloc] initWithObjects:props1,props2, nil];
+
+ //Create an NSMutableDictionary to hold our updates
+ NSMutableDictionary *updatedEntity = [ [NSMutableDictionary alloc] init ];
+
+ //Set the properties to be updated
+ [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
+ [updatedEntity setObject:props forKey:@"varieties"];
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[ [UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient updateEntity:entityID entity:updatedEntity];
+
+ @try {
+
+ //success
+
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+ }
+
+Response:
+
+ {
+ "action" : "put",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378405020796,
+ "modified" : 1378761459069,
+ "availability" : "in-stock",
+ "metadata" : {
+ "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
+ },
+ "name" : "milk",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4",
+ "varieties" : [ {
+ "name" : "1%",
+ "price" : "3.25"
+ }, {
+ "name" : "whole",
+ "price" : "4.00"
+ } ]
+ } ],
+ "timestamp" : 1378761459047,
+ "duration" : 62,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### 12. Deleting data entities
+
+SDK Method
+
+ (ApigeeClientResponse *)removeEntity: (NSString *)type entityID:(NSString *)entityID
+
+Properties
+
+Parameter Description
+--------- -----------
+type The entity type being deleted
+entityID The UUID or name of the entity to be removed
+
+Example Request/Response
+
+Request:
+
+ -(NSString*)deleteEntity {
+
+ //specify the entity type to be deleted
+ NSString *type = @"item";
+
+ //specify the uuid or name of the entity to be deleted
+ NSString *entityId = @"milk";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call removeEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient removeEntity:type entityID:entityId];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+ }
+
+Response:
+
+ {
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766158500,
+ "modified" : 1378766158500,
+ "metadata" : {
+ "path" : "/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378766172016,
+ "duration" : 324,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+## Data Queries
+
+### 13. Querying your data
+
+## Entity Connections
+
+### 14. Connecting users other data
+### 15. Retrieving user connection data
+### 16. Disconnecting entities
+
+## Permissions & Roles
+
+### 17. Assigning permissions
+### 18. Removing permissions
+### 19. Assigning permissions
+### 20. Removing permissions
+### 21. Creating roles
+### 22. Assigning roles
+### 23. Removing roles
+
+## Authentication
+
+### 24. Application user authentication (user login)
+### 25. Application client authentication
+### 26. Admin user authentication
+### 27. Organization client authentication
+### 28. Revoking tokens (user logout)
+
+# Working with Users & Groups
+
+### 29. Creating users
+### 30. Retrieving user data
+### 31. Setting or updating password
+### 32. Creating groups
+### 33. Retrieving group data
+### 34. Retrieving a group's users
+### 35. Adding users groups
+### 36. Deleting user group
+
+## Activities & Feeds
+
+### 37. Posting a user activity
+### 38. Posting an activity to a group
+### 39. Creating an activity for a user's followers in a group
+### 40. Retrieving a user's activity feed
+### 41. Retrieving a group's activity feed
+
+## Events & Counters
+
+### 42. Creating & incrementing counters
+### 43. Retrieving counters
+### 44. Retrieving counters by time interval
+
+## Managing Orgs & Apps
+
+### 46. Creating an organization
+### 47. Getting an organization
+### 48. Activating an organization
+### 49. Reactivating an organization
+### 50. Generating organization client credentials
+### 51. Retrieving organization client credentials
+### 52. Getting an organization's activity feed
+### 53. Getting the applications in an organization
+### 54. Getting the admin users in an organization
+### 55. Removing an admin user from an organization
+### 56. Creating an organization application
+### 57. Generating application credentials
+### 58. Getting application credentials
+
+## Managing Admin Users
+
+### 59. Creating an admin user
+### 60. Updating an admin user
+### 61. Getting an admin user
+### 62. Setting an admin user's password
+### 63. Resetting an admin user's password
+### 64. Activating an admin user
+### 65. Reactivating an admin user
+### 66. Getting an admin user's activity feed
+
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/sdks/ios.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/ios.txt b/content/docs/_sources/sdks/ios.txt
index 328b09a..b0ba069 100644
--- a/content/docs/_sources/sdks/ios.txt
+++ b/content/docs/_sources/sdks/ios.txt
@@ -1 +1,107 @@
-# iOS SDK
\ No newline at end of file
+# iOS SDK
+
+##Version
+
+Current Version: **0.9.2**
+
+Change log:
+
+<https://github.com/apigee/usergrid-javascript-sdk/blob/master/changelog.md>
+
+##Overview
+This open source SDK simplifies writing iOS applications that connect to App Services (Usergrid). The repo is located here:
+
+<https://github.com/apigee/usergrid-ios-sdk>
+
+You can download the SDK here:
+
+* Download as a zip file: <https://github.com/apigee/usergrid-ios-sdk/archive/master.zip>
+* Download as a tar.gz file: <https://github.com/apigee/usergrid-ios-sdk/archive/master.tar.gz>
+
+
+To find out more about App Services, which is Apigee's hosted Usergrid solution, see:
+
+<http://apigee.com/about/developers>
+
+To view the Apigee App Services documentation, see:
+
+<http://apigee.com/docs/app_services>
+
+
+##Installing
+Once you have downloaded the SDK, add the UGAPI folder to your project by dragging and dropping it into your project.
+
+**Note:** Make sure you check the "Copy items into destination group's folder", and also make sure the appropriate boxes are checked next to "Add to targets".
+
+
+##Getting started
+If you haven't done so, make sure you know your organization name and your application name. Your organization name will be the same as the username you signed up with.
+
+Within your organization, you can have multiple application namespaces. By default, an application named "Sandbox" has been created for you to use for testing, but you can also log into the [Admin Portal](http://apigee.com/usergrid) and create an application with any name you want.
+
+Once you have your application name, you will want to create a UGClient object like so:
+
+ //configure the org and app
+ NSString * orgName = @"ApigeeOrg";
+ NSString * appName = @"MessageeApp";
+
+ //make new client
+ usergridClient = [[UGClient alloc]initWithOrganizationId: orgName withApplicationID: appName];
+
+Now use the usergridClient object to invoke other methods that access the API. For example, to log a user in:
+
+ [usergridClient logInUser:username password:password];
+ UGUser *user = [usergridClient getLoggedInUser];
+
+Or, to create a user:
+
+ UGClientResponse *response = [usergridClient addUser:@"myusername" email:@"email@email.com" name:@"my name" password:@"mypassword"];
+ if (response.transactionState == 0) {
+ //user created!
+ }
+
+
+##Sample Code
+If you are ready to look at a fully functional app that uses this SDK, check out our Messagee application. It is a twitter-type app that exercises many parts of the API including: Login / Authentication, GET and POST operations, activities (tweets), and social features such as following relationships.
+
+The Messagee Xcode project is located here:
+
+<https://github.com/apigee/usergrid-sample-ios-messagee>
+
+##Running Tests
+
+The iOS SDK unit tests are written with Nu. You'll need to install the language itself to run the tests, and use the Nukefile to create a Usergrid.framework. For installation directions go [here](https://github.com/timburks/nu)
+
+To compile the Usergrid SDK as an Objective-C framework simple type `nuke` to build the framework and then `nuke install` to install it in the /Library/Frameworks path.
+
+To run the unit tests written for the SDK use the command `nuke test` this will run all tests.
+
+## Contributing
+We welcome your enhancements!
+
+Like [Usergrid](https://github.com/apigee/usergrid-node-module), the Usergrid Objective-C SDK is open source and licensed under the Apache License, Version 2.0.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push your changes to the upstream branch (`git push origin my-new-feature`)
+5. Create new Pull Request (make sure you describe what you did and why your mod is needed)
+
+##More information
+For more information on Apigee App Services, visit <http://apigee.com/about/developers>.
+
+
+## Copyright
+Copyright 2013 Apigee Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/sdks/sdk-outline.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/sdks/sdk-outline.txt b/content/docs/_sources/sdks/sdk-outline.txt
new file mode 100644
index 0000000..48bd3fc
--- /dev/null
+++ b/content/docs/_sources/sdks/sdk-outline.txt
@@ -0,0 +1,111 @@
+# Usergrid SDK Documentation outline
+
+## Getting Started
+
+### Installing the SDK
+### Building from Source
+
+# Usergrid SDK Reference with Examples
+
+The 66 topics listed below are each documented in the Usergrid documentation and
+for each the docs provide an API reference and example for each of these clients:
+curl, iOS, Android, JavaScript, Ruby and Node.js.
+
+## Working with Collections
+
+### 1. Creating collections
+### 2. Retrieving collections
+### 3. Updating collections
+### 4. Deleting collections
+
+## Working with Entities
+
+### 5. Creating a custom entity
+### 6. Creating multiple custom entities
+### 7. Creating an entity with sub-properties
+### 8. Retrieving an entity
+### 9. Retrieving multiple entities
+### 10. Updating an entity
+### 11. Updating a sub-property
+### 12. Deleting data entities
+
+## Data Queries
+
+### 13. Querying your data
+
+## Entity Connections
+
+### 14. Connecting users other data
+### 15. Retrieving user connection data
+### 16. Disconnecting entities
+
+## Permissions & Roles
+
+### 17. Assigning permissions
+### 18. Removing permissions
+### 19. Assigning permissions
+### 20. Removing permissions
+### 21. Creating roles
+### 22. Assigning roles
+### 23. Removing roles
+
+## Authentication
+
+### 24. Application user authentication (user login)
+### 25. Application client authentication
+### 26. Admin user authentication
+### 27. Organization client authentication
+### 28. Revoking tokens (user logout)
+
+# Working with Users & Groups
+
+### 29. Creating users
+### 30. Retrieving user data
+### 31. Setting or updating password
+### 32. Creating groups
+### 33. Retrieving group data
+### 34. Retrieving a group's users
+### 35. Adding users groups
+### 36. Deleting user group
+
+## Activities & Feeds
+
+### 37. Posting a user activity
+### 38. Posting an activity to a group
+### 39. Creating an activity for a user's followers in a group
+### 40. Retrieving a user's activity feed
+### 41. Retrieving a group's activity feed
+
+## Events & Counters
+
+### 42. Creating & incrementing counters
+### 43. Retrieving counters
+### 44. Retrieving counters by time interval
+
+## Managing Orgs & Apps
+
+### 46. Creating an organization
+### 47. Getting an organization
+### 48. Activating an organization
+### 49. Reactivating an organization
+### 50. Generating organization client credentials
+### 51. Retrieving organization client credentials
+### 52. Getting an organization's activity feed
+### 53. Getting the applications in an organization
+### 54. Getting the admin users in an organization
+### 55. Removing an admin user from an organization
+### 56. Creating an organization application
+### 57. Generating application credentials
+### 58. Getting application credentials
+
+## Managing Admin Users
+
+### 59. Creating an admin user
+### 60. Updating an admin user
+### 61. Getting an admin user
+### 62. Setting an admin user's password
+### 63. Resetting an admin user's password
+### 64. Activating an admin user
+### 65. Reactivating an admin user
+### 66. Getting an admin user's activity feed
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/authenticating-api-requests.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/authenticating-api-requests.txt b/content/docs/_sources/security-and-auth/authenticating-api-requests.txt
index af52bf6..d29e4cb 100644
--- a/content/docs/_sources/security-and-auth/authenticating-api-requests.txt
+++ b/content/docs/_sources/security-and-auth/authenticating-api-requests.txt
@@ -4,7 +4,7 @@ With the exception of the 'sandbox' application that is created with every Userg
This article describes how to use access tokens to access the Usergrid API, and how to manage access tokens, including revoking and changing token time to live.
-For information on generating access tokens/authenticating users and clients, see Authenticating users and application clients.
+For information on generating access tokens/authenticating users and clients, see [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html).
## Authenticating with access tokens
When you obtain an access token, you must provide it with every subsequent API call that you make. There are two ways to provide your access token.
@@ -18,7 +18,7 @@ You can include the token in an HTTP authorization header:
Authorization: Bearer {access_token}
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
-Note: The Usergrid documentation assumes you are providing a valid access token with every API call whether or not it is shown explicitly in the examples. Unless the documentation specifically says that you can access an API endpoint without an access token, you should assume that you must provide it. One application that does not require an access token is the sandbox application. The Guest role has been given full permissions (/** for GET, POST, PUT, and DELETE) for this application. This eliminates the need for a token when making application level calls to the sandbox app. For further information on specifying permissions, see Managing access by defining permission rules.
+Note: The Usergrid documentation assumes you are providing a valid access token with every API call whether or not it is shown explicitly in the examples. Unless the documentation specifically says that you can access an API endpoint without an access token, you should assume that you must provide it. One application that does not require an access token is the sandbox application. The Guest role has been given full permissions (/** for GET, POST, PUT, and DELETE) for this application. This eliminates the need for a token when making application level calls to the sandbox app. For further information on specifying permissions, see [Using Permissions](security-and-auth/using-permissions.html).
</p></div>
## Authenticating with client ID and client secret
@@ -27,7 +27,7 @@ Another option for authenticating your API requests is using either your organiz
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
Warning: For server-side use only
-You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See Security best practices for additional considerations in keeping access to your app and its data secure.
+You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
This can be a convenient way to authenticate API requests, since there is no need to generate and manage an access token, but please note that you should be very cautious when implementing this type of authentication. Organization-level authentication grants full permission to perform any supported call against your organization and every application in it, and application-level authentication grants full permission to perform any supported call against all of the resources in an application. Should your client id and client secret be compromised, a malicious user would gain broad access to your organization or application.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/authenticating-users-and-application-clients.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/authenticating-users-and-application-clients.txt b/content/docs/_sources/security-and-auth/authenticating-users-and-application-clients.txt
index eaa52f4..e1ada48 100644
--- a/content/docs/_sources/security-and-auth/authenticating-users-and-application-clients.txt
+++ b/content/docs/_sources/security-and-auth/authenticating-users-and-application-clients.txt
@@ -49,7 +49,7 @@ The results include the access token needed to make subsequent API requests on b
Using your app’s client id and client secret values, your app can connect to the Usergrid application endpoint to request an access token. The client ID and secret for your app can be found in 'Getting Started' section of the API Services admin portal, under 'Server App Credentials'.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html) for additional considerations in keeping access to your app and its data secure.
+Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
@@ -76,7 +76,7 @@ The results include the access token needed to make subsequent API requests on b
If you do require admin user access, your app can connect to the Usergrid management endpoint to request an access token. Your app supplies the username and password of an admin user in the request.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: Authenticating as an admin user grants full access to one or more organizations and all of the applications contained in those organizations. Due to this, be cautious when implementing this type of authentication in client-side code. Instead, consider implementing admin user access in server-side code only. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html) for additional considerations in keeping access to your app and its data secure.
+Warning: Authenticating as an admin user grants full access to one or more organizations and all of the applications contained in those organizations. Due to this, be cautious when implementing this type of authentication in client-side code. Instead, consider implementing admin user access in server-side code only. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
@@ -103,7 +103,7 @@ The results include the access token needed to make subsequent API requests on b
If you do require organization level access, your app can connect to the Usergrid management endpoint to request an access token. Access to an organization requires the client id and client secret credentials. The client ID and secret for your organization can be found on the 'Org Administration' page of the API Services admin console under 'Organization API Credentials'.
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See "safe mobile access" in [Authenticating API requests](authenticating-api-requests.html for additional considerations in keeping access to your app and its data secure.
+Warning: You should never authenticate this way from a client-side app such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.
</p></div>
### Request syntax
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/facebook-sign.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/facebook-sign.txt b/content/docs/_sources/security-and-auth/facebook-sign.txt
index e2c7411..970cb33 100644
--- a/content/docs/_sources/security-and-auth/facebook-sign.txt
+++ b/content/docs/_sources/security-and-auth/facebook-sign.txt
@@ -21,7 +21,7 @@ where:
## Facebook login example
The Facebook technical guides for login present detailed information on how to add Facebook login to your app. Instructions are provided for JavaScript, iOS, and Android.
-In brief, here are the steps for JavaScript. You can see these steps implemented in the Facebook login example packaged with the JavaScript SDK for Usergrid (which you can download in ZIP format or tar.gz format). The Facebook login example is in the /examples/facebook directory of the extracted download. The code example snippets shown below are taken from the Facebook login example.
+In brief, here are the steps for JavaScript. You can see these steps implemented in the Facebook login example packaged with the JavaScript SDK for Usergrid (which you can download in ZIP format or tar.gz format). The Facebook login example is in the ``/examples/facebook`` directory of the extracted download. The code example snippets shown below are taken from the Facebook login example.
### Step 1: Create a Facebook app
Create a new app on the Facebook App Dashboard. Enter your app's basic information. Once created, note the app ID shown at the top of the dashboard page.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/user-authentication-types.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/user-authentication-types.txt b/content/docs/_sources/security-and-auth/user-authentication-types.txt
index 1a14f50..d02e8d3 100644
--- a/content/docs/_sources/security-and-auth/user-authentication-types.txt
+++ b/content/docs/_sources/security-and-auth/user-authentication-types.txt
@@ -5,7 +5,7 @@ Usergrid supports four levels of authentication, but only one of them is used wh
## Configuring authentication levels
Access permissions can only be configured for the 'application user' – this can be done both programmatically and in the admin portal. The application, organization and admin clients cannot be configured, and can only be accessed programmatically via the API.
-For more about creating and managing roles and permissions for application users, see Managing access by defining permission rules. For a look at how security features fit together, see App Security Overview.
+For more about creating and managing roles and permissions for application users, see [Using Permissions](security-and-auth/using-permissions.html) and [Using Roles](security-and-auth/using-roles.html). For a look at how security features fit together, see [App Security Overview](../security-and-auth/app-security.html).
## User authentication level
@@ -16,14 +16,14 @@ For more about creating and managing roles and permissions for application users
</tr>
<tr>
<td>Application user</td>
- <td>This is the standard authentication type you will use to implement user login for your app. The application user level allows access to your Usergrid application as governed by the permission rules you create and associated with users and user groups. For more on setting permissions see Managing access by defining permission rules. Each Application User is represented by a User entity in your Usergrid application. For more about the User entity, see User.</td>
+ <td>This is the standard authentication type you will use to implement user login for your app. The application user level allows access to your Usergrid application as governed by the permission rules you create and associated with users and user groups. For more on setting permissions see [Using Permissions](security-and-auth/using-permissions.html). Each Application User is represented by a User entity in your Usergrid application. For more about the User entity, see User.</td>
</tr>
</table>
## Admin authentication levels
<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
-Warning: Safe use of admin authentication levels. Never use client ID and client secret, or any hard-coded credentials to authenticate this way from a client-side app, such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. Even when authenticating with username and password, be cautious when using these authentication levels since they grant broad access to your Usergrid account. See "safe mobile access" in Authenticating API requests for additional considerations in keeping access to your app and its data secure.</p></div>
+Warning: Safe use of admin authentication levels. Never use client ID and client secret, or any hard-coded credentials to authenticate this way from a client-side app, such as a mobile app. A hacker could analyze your app and extract the credentials for malicious use even if those credentials are compiled and in binary format. Even when authenticating with username and password, be cautious when using these authentication levels since they grant broad access to your Usergrid account. See [Security Best Practices](../security-and-auth/securing-your-app.html) for additional considerations in keeping access to your app and its data secure.</p></div>
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/using-permissions.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/using-permissions.txt b/content/docs/_sources/security-and-auth/using-permissions.txt
index 34ec664..1454d11 100644
--- a/content/docs/_sources/security-and-auth/using-permissions.txt
+++ b/content/docs/_sources/security-and-auth/using-permissions.txt
@@ -33,7 +33,7 @@ Complex paths can be defined using [Apache Ant pattern syntax](http://ant.apache
</table>
## Assigning permissions
-Permissions can only be assigned to user, group or role entities. Assigning permissions to roles can be particularly useful, as it allows you to create sets of permissions that represent complex access definitions, which can then be assigned to user and group entities. For more on roles, see Using roles.
+Permissions can only be assigned to user, group or role entities. Assigning permissions to roles can be particularly useful, as it allows you to create sets of permissions that represent complex access definitions, which can then be assigned to user and group entities. For more on roles, see [Using Roles](security-and-auth/using-roles.html).
### Request syntax
@@ -47,7 +47,7 @@ org Organization UUID or organization name
app Application UUID or application name
collection The collection of the entity that the permissions are to be assigned to.
entity The UUID of the entity to assign the permissions to. For users, username and for groups, name are also accepted.
-permissions The permissions to assign to the entity. See Permissions syntax for format.
+permissions The permissions to assign to the entity. See [Permissions syntax](security-and-auth/using-permissions.html#permissions-syntax) for format.
For collections, Valid values are users and groups.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/security-and-auth/using-roles.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/security-and-auth/using-roles.txt b/content/docs/_sources/security-and-auth/using-roles.txt
new file mode 100644
index 0000000..2a794e3
--- /dev/null
+++ b/content/docs/_sources/security-and-auth/using-roles.txt
@@ -0,0 +1,304 @@
+# Using roles
+Roles are named sets of one or more permissions, and are useful for defining specific access levels to resources in your Usergrid data store. Multiple roles can be assigned to a user or group, giving you a great deal of flexibility in how access to resources are defined.
+
+For example, in a blogging app you might create a 'reviewer' role that allows GET and PUT access to an articles collection to allow the user to retrieve and update articles, but not allow them to create new articles.
+
+## Default roles
+While you can create as many custom roles as you want per application, all Usegrid applications include three default roles. These roles each serve a special purpose and should not be deleted; however, you can and should adjust the permissions assigned to these roles to suit the needs of you app.
+
+The following table describes each pre-defined role, and the permissions that are assigned to them by default.
+
+<table class="usergrid-table">
+<tr>
+ <th>Role</th>
+ <th class="usergrid-30"> Permissions</th>
+ <th>Description</th>
+</tr>
+<tr>
+ <td>Guest</td>
+ <td>
+
+* post: /devices
+* post: /users
+* put: /devices/*
+
+ </td>
+ <td>
+
+ Assigned to all unauthenticated requests. Includes a basic set of permissions that are commonly needed by unregistered or unauthenticated users.
+ <p>Grants permission for a user to create a user account and for their device to be registered.
+
+ </td>
+</tr>
+<tr>
+ <td>Default</td>
+ <td>
+
+* get, post, put, delete: /**
+
+ </td>
+ <td>
+
+Default for authenticated users. Assigns the associated permissions to all users whose requests are authenticated with a valid access token.
+
+<div class="admonition warning"> <p class="first admonition-title">WARNING</p> <p class="last">
+By default, __grants full access for all resources in your application__. A first task in securing your application should be to restrict access by redefining this role to narrow the access it provides. Remove the default full permission rule and add restrictive permission rules for a production deployment.
+</p></div>
+
+ </td>
+</tr>
+<tr>
+ <td>Administrator</td>
+ <td>None</td>
+ <td>
+
+Unused until you associate it with users or groups. By default, includes no permissions that provide access. Grants no access. Consider this a blank slate. Add permission rules and associate this role with users and groups as needed.
+<div class="admonition note"> <p class="first admonition-title">NOTE</p> <p class="last">
+The Administrator role is <i>not</i> the same as an organization administrator, that is, someone who authenticates as an Admin User. The Admin User is an implicit user created when you create an organization. After authenticating, the Admin User has full access to all of the administration features of the Usergrid API. By comparison, the Administrator role is simply a role (initially without permissions) that can be assigned to any user.
+</p></div>
+
+ </td>
+</tr>
+</table>
+
+## Creating roles
+Generally, it is easiest to a create a role for each access type you want to enable in your app. You may, however, assign multiple roles to any user or group entity, so you have the flexibility to define any schema for applying roles that you like.
+
+The following shows how to create a new role and assign permissions to it.
+
+### Request syntax
+With cURL requests a role entity is created with a POST request, then permissions must be assigned to it with a separate request. For more on assigning permissions with cURL, see [Using Permissions](security-and-auth/using-permissions.html).
+
+The following details how to create a new role entity.
+
+ curl -X POST https://api.usergrid.com/<org>/<app>/roles -d '{"name":<roleName>}'
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+roleName The name of the role to be created
+
+### Example request
+
+ curl -X POST "https://api.usergrid.com/my-org/my-app/roles/ -d '{"name":"manager"}'
+
+### Example response
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/roles",
+ "uri" : "https://api.usergrid.com/your-org/your-app/roles",
+ "entities" : [ {
+ "uuid" : "382d0991-74bb-3548-8166-6b07e44495ef",
+ "type" : "role",
+ "name" : "manager",
+ "created" : 1402612783104,
+ "modified" : 1402612783104,
+ "roleName" : "manager",
+ "title" : "manager",
+ "inactivity" : 0,
+ "metadata" : {
+ "path" : "/roles/382d0991-74bb-3548-8166-6b07e44495ef",
+ "sets" : {
+ "permissions" : "/roles/382d0991-74bb-3548-8166-6b07e44495ef/permissions"
+ },
+ "collections" : {
+ "groups" : "/roles/382d0991-74bb-3548-8166-6b07e44495ef/groups",
+ "users" : "/roles/382d0991-74bb-3548-8166-6b07e44495ef/users"
+ }
+ }
+ } ],
+ "timestamp" : 1402612783102,
+ "duration" : 30,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### Creating Roles in the Admin Portal
+
+1. In the left sidebar of the Usergrid portal, click Users > Roles. This displays the roles defined for the application.
+Click the '+' button.
+2. In the dialog box, provide a 'title' and 'role name.' A title is an alias for the role name.
+3. Click 'Create'. The role will be created, but will not have any permissions assigned to it.
+4. Click the role you created in the list.
+5. Click the 'Add permissions' button.
+6. In the dialog box, click the check boxes for the HTTP methods you want to grant permissions for, and enter the resource path in the 'Path' field.
+7. The 'Inactivity' field lets you control automatic user logout during periods of inactivity. Set a number of seconds of inactivity before users assigned to this role are automatically logged out.
+
+## Assigning roles
+Once you have created some roles, you will need to explicitly assign them to a user or group entity. The permissions associated with that role will be granted to the entity immediately for any requests they send that are authenticated by a valid access token. Please note that assigning a role to a group will grant the associated permissions to every user in that group.
+
+The following shows how to assign a role to an entity.
+
+### Request syntax
+
+ curl -X POST https://api.usergrid.com/<org>/<app>/roles/<roleName>/<entityType>/<entityID>
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+roleName The name of the role to be created
+entityType The type of the entity the role is being assigned to. 'Group' and 'user' are valid values.
+entityID The UUID of the entity the role is being assigned to.
+
+For groups, the 'name' property can be used. For users, the 'username' property can be used.
+
+### Example request
+
+ curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/users/someUser
+
+
+### Example response
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "uri" : "https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "entities" : [ {
+ "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376",
+ "type" : "user",
+ "name" : "someUser",
+ "created" : 1395681911491,
+ "modified" : 1399070010291,
+ "username" : "someUser",
+ "activated" : true,
+ "file" : "fobnszewobnioerabnoiawegbrn\n",
+ "metadata" : {
+ "connecting" : {
+ "friends" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends",
+ "likes" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"
+ },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376",
+ "sets" : {
+ "rolenames" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "permissions" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"
+ },
+ "connections" : {
+ "completed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed",
+ "follows" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"
+ },
+ "collections" : {
+ "activities" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities",
+ "devices" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices",
+ "feed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed",
+ "groups" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups",
+ "roles" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "following" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following",
+ "followers" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1402965083889,
+ "duration" : 41,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+
+### Assigning Roles in the Admin Portal
+
+The easiest way to assign roles to user or group entities is to use the 'Users' tab of the Usergrid admin portal, by doing the following:
+
+1. In the left sidebar of the admin portal, click Users > Users or Users > Groups to display either the list of users or groups in your application.
+2. In the list, click the name of the user or group entity you want to assign roles to to display its details in the right pane.
+3. Click the 'Roles & Permissions' tab above the right pane.
+4. Click the 'Add Role' button.
+5. In the popup, select a role from the drop down menu.
+6. Click the 'Add' button.
+
+
+## Removing roles
+At times it may be necessary to remove a role from a user or group entity, for example if a user changes jobs, or the duties of a group are altered. Please note that removing a role from a group will remove the associated permissions from every user in that group.
+
+The following shows how to remove a role from an entity.
+
+### Request syntax
+
+ curl -X DELETE https://api.usergrid.com/<org>/<app>/roles/<roleName>/<entityType>/<entityID>
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+roleName The name of the role to be created
+entityType The type of the entity the role is being removed from. 'Group' and 'user' are valid values.
+entityID The UUID of the entity the role is being removed from.
+
+For groups, the 'name' property can be used. For users, the 'username' property can be used.
+
+### Example request
+
+ curl -X DELETE https://api.usergrid.com/my-org/my-app/roles/manager/users/someUser
+
+
+### Example response
+
+ {
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "uri" : "https://api.usergrid.com/your-org/your-app/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users",
+ "entities" : [ {
+ "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376",
+ "type" : "user",
+ "name" : "someUser",
+ "created" : 1395681911491,
+ "modified" : 1399070010291,
+ "username" : "someUser",
+ "activated" : true,
+ "metadata" : {
+ "connecting" : {
+ "friends" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/friends",
+ "likes" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"
+ },
+ "path" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376",
+ "sets" : {
+ "rolenames" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "permissions" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"
+ },
+ "connections" : {
+ "completed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/completed",
+ "follows" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"
+ },
+ "collections" : {
+ "activities" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/activities",
+ "devices" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/devices",
+ "feed" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/feed",
+ "groups" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/groups",
+ "roles" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "following" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/following",
+ "followers" : "/roles/348388de-a5c5-3c1e-9de5-9efc8ad529d8/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1403214283808,
+ "duration" : 358,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+### Removing Roles in the Admin Portal
+
+The easiest way to remove roles from user or group entities is to use the 'Users' tab of the Usergrid admin portal, by doing the following:
+
+1. In the left sidebar of the Usergrid admin portal, click Users > Users or Users > Groups to display either the list of users or groups in your application.
+2. In the list, click the name of the user or group entity you want to remove roles from to display its details in the right pane.
+3. Click the 'Roles & Permissions' tab above the right pane.
+4. Click the role you created in the list.
+5. Under 'Roles', click the checkbox beside the role you want to remove from the entity.
+6. Click the 'Leave roles' button.
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/user-management/activity.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/user-management/activity.txt b/content/docs/_sources/user-management/activity.txt
index 2703ab8..4f09c8b 100644
--- a/content/docs/_sources/user-management/activity.txt
+++ b/content/docs/_sources/user-management/activity.txt
@@ -16,13 +16,13 @@ information about these actions).
When a user creates an activity, it creates a relationship between the
activity and the user who created it. Because this relationship exists,
the activity will appear in the feed of any of the user’s followers.
-Think of the Activities endpoint (/users/{uuid|username}/activities) as
+Think of the Activities endpoint (``/users/{uuid|username}/activities``) as
an "outbox" of news items created by the user. Think of the Feed
-endpoint (/users/{uuid|username}/feed) as an "inbox" of news items meant
+endpoint (``/users/{uuid|username}/feed``) as an "inbox" of news items meant
to be seen or consumed by the user.
A user can also post an activity to a group (located at
-/groups/{uuid|groupname}/activities). This allows you to emulate
+``/groups/{uuid|groupname}/activities``). This allows you to emulate
Facebook-style group functionality, where a limited number of users can
share content on a common "wall". In any of these cases, there is no
need to construct publish/subscribe relationships manually.
@@ -36,10 +36,9 @@ to the user's activity stream for display as well as to the activity
streams of any of the user's followers.
Using Usergrid APIs you can create, retrieve, update, and delete
-activity entities. See You do not have access to view this node for
-descriptions of these APIs.
+activity entities.
-**Note:** Although not shown in the API examples below, you need to
+__Note:__ Although not shown in the API examples below, you need to
provide a valid access token with each API call. See
[Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
@@ -131,13 +130,13 @@ The ``/users/me`` endpoint is accessible only if you provide an access token wit
When you create an activity it creates a relationship between the activity and the user who created it. In other words, the newly created activity above belongs to john.doe. Another way of saying this is the user "owns" the activity. And because this relationship exists, the activity will appear in the feed of any of the user’s followers (in this example, anyone who is following john.doe). However, it will not appear in the feed of people the user follows. The activity is accessible at the ``/activities`` endpoint to users who have the permission to read that endpoint.
-Notice the properties specified in the request body in the previous example are actor, verb, and content. The actor, verb, and content properties are built into the Activity entity (see Default Data Entity Types). The actor property specifies properties of the entity that performs the action (here, user john.doe). The gravatar URL is used to create an icon for the activity. And because an Activity is simply an API Services data entity, you can also create custom properties.
+Notice the properties specified in the request body in the previous example are actor, verb, and content. The actor, verb, and content properties are built into the Activity entity (see [Activity entity properties](../rest-endpoints/api-doc.html#activity) ). The actor property specifies properties of the entity that performs the action (here, user john.doe). The gravatar URL is used to create an icon for the activity. And because an Activity is simply an API Services data entity, you can also create custom properties.
The verb parameter is descriptive. You can use it to indicate what type of activity is posted, for example, an image versus text. The value post is defined in the JSON Activity Streams specification as “the act of authoring an object and then publishing it online.“
## Posting an activity to a group
-Use the POST method to post 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.
+Use the POST method to post 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.
### Request URI
@@ -223,7 +222,7 @@ When you create an activity for a user’s followers in a group:
The activity is accessible at the ``/activities`` endpoint to users who have the permission to read that endpoint. The activity will not be cross-posted to the group’s activity endpoint (``/groups/{uuid|groupname}/activities``)
A relationship is automatically created between the activity entity that was just created and the user within that group (``/groups/{uuid|groupname}/users/{uuid|username}``)
-The user within the group (``/groups/{uuid|groupname}/users/{uuid|username}```) becomes the owner of the activity (through the owner property in the activity).
+The user within the group (``/groups/{uuid|groupname}/users/{uuid|username}``) becomes the owner of the activity (through the owner property in the activity).
### Request URI
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/user-management/group.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/user-management/group.txt b/content/docs/_sources/user-management/group.txt
index 4f76cb6..a48606b 100644
--- a/content/docs/_sources/user-management/group.txt
+++ b/content/docs/_sources/user-management/group.txt
@@ -10,7 +10,7 @@ See the [Group Model section of the API Reference](../rest-endpoints/api-docs.ht
## Creating groups
-A group entity represents an application group of users. You can create, retrieve, update, delete, and query group entities. See User entity properties for a list of the system-defined properties for group entities. In addition, you can create group properties specific to your application.
+A group entity represents an application group of users. You can create, retrieve, update, delete, and query group entities. See [User entity properties](../rest-endpoints/api-doc.html#user) for a list of the system-defined properties for group entities. In addition, you can create group properties specific to your application.
### Request Syntax
@@ -39,7 +39,7 @@ The ``path`` property is required and must be unique, it may include forward sla
### Example
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Request
@@ -104,7 +104,7 @@ Parameter Description
org_id | uuid Organization UUID or organization name
app_id | uuid Application UUID or application name
groupPath | uuid Group UUID or group path, which must be unique.
-query_string A data store query. For more on queries, see Data queries.
+query_string A data store query. For more on queries, see [Data queries](../data-queries/querying-your-data.html).
### Request
@@ -225,11 +225,9 @@ For more information and code samples, see [Deleting Data Entities](../data-stor
## Adding a user to a group
-See all application entities
-
You can add users to groups from client code using cURL commands or one of the SDKs, as described here.
-When setting up your application on the server, you might find it easier and more convenient to create and populate groups with the admin portal. There, you can create groups, create roles, and define permission rules that govern user access to data and services in your application. For more information, see Security & token authentication.
+When setting up your application on the server, you might find it easier and more convenient to create and populate groups with the admin portal. There, you can create groups, create roles, and define permission rules that govern user access to data and services in your application. For more information, see [Security & Token Authentication](../security-and-auth/app-security.html).
Use the POST method to add a user to a group. If the named group does not yet exist, an error message is returned.
@@ -252,7 +250,7 @@ arg uuid | string username UUID or username of user
### Example
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Request
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/user-management/messagee-example.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/user-management/messagee-example.txt b/content/docs/_sources/user-management/messagee-example.txt
index eb3e560..1401d8c 100644
--- a/content/docs/_sources/user-management/messagee-example.txt
+++ b/content/docs/_sources/user-management/messagee-example.txt
@@ -8,7 +8,7 @@ There are three client versions of Messagee:
* [An Android client version](https://github.com/apigee/usergrid-sample-android-messagee)
* [An HTML5 client](https://github.com/apigee/usergrid-sample-html5-messagee)
-The sections below describe how to create a new app, enter some test users, and run the app. You also learn how to use the Usergrid admin portal, a user interface that streamlines data and application management in the Usergrid system. The portal is also a reference application that shows how to incorporate Usergrid APIs with JavaScript. For a more detailed discussion of the portal's functionality, see Admin portal.
+The sections below describe how to create a new app, enter some test users, and run the app. You also learn how to use the Usergrid admin portal, a user interface that streamlines data and application management in the Usergrid system. The portal is also a reference application that shows how to incorporate Usergrid APIs with JavaScript.
## Creating a user account in Usergrid
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/user-management/working-user-data.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/user-management/working-user-data.txt b/content/docs/_sources/user-management/working-user-data.txt
index a7603fd..5e2b63d 100644
--- a/content/docs/_sources/user-management/working-user-data.txt
+++ b/content/docs/_sources/user-management/working-user-data.txt
@@ -1,7 +1,7 @@
# Working with User Data
You can store and manage user data as User entities. With user data in your application, you can add support for a wide variety of features common to mobile apps. For example, you can:
-* Control access to data by defining permission rules. (See Security & token authentication for more.)
+* Control access to data by defining permission rules. (See [Security & token authentication](../security-and-auth/app-security.html) for more.)
* Present content specific to each user, such as their list of favorites.
* Support social features, such as letting users "follow" one another, for example.
@@ -9,7 +9,7 @@ In mobile applications, data about users is typically added by users themselves
## Creating users
-A user entity represents an application user. Using API Services you can create, retrieve, update, delete, and query user entities. See User entity properties for a list of the system-defined properties for user entities. In addition, you can create user properties specific to your application.
+A user entity represents an application user. Using API Services you can create, retrieve, update, delete, and query user entities. See [User entity properties](../rest-endpoints/api-doc.html#user) for a list of the system-defined properties for user entities. In addition, you can create user properties specific to your application.
### Request Syntax
@@ -38,13 +38,13 @@ The username is mandatory and must be unique. Here's an example:
"password" : "test1234"
}
-Although the password parameter is not mandatory, if you don't specify it, the user will not be able to log in using username and password credentials. If a password is not specified for the user, and you're an Admin, you can set a password for the user (see Setting a password).
+Although the password parameter is not mandatory, if you don't specify it, the user will not be able to log in using username and password credentials. If a password is not specified for the user, and you're an Admin, you can set a password for the user (see [Changing a User Password](#changing-a-user-password)).
__ Note__: The username can contain any combination of characters, including those that represent letters, numbers, and symbols.
### Example
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Request
@@ -96,7 +96,7 @@ __Note__: Although not shown in the API examples below, you need to provide a va
You can retrieve data about users through cURL or one of the SDKs. Each provides a way to filter the list of users by data associated with the user, such as username or UUID, or other properties in the user entity.
-See User entity properties for a list of the system-defined properties for user entities. In addition, you can create user properties specific to your application.
+See [User entity properties](../rest-endpoints/api-doc.html#user) for a list of the system-defined properties for user entities. In addition, you can create user properties specific to your application.
### Request Syntax
@@ -116,7 +116,7 @@ uuid | org_id Organization UUID or organization name
uuid | app_id Application UUID or application name
user identifier User UUID, username, or email address.
-The alias ``/users/me`` can be used in place of the current user’s uuid, username, or email address. Note: The ``/users/me`` endpoint is accessible only if you provide an access token with the request (see Authenticating users and application clients). If you make an anonymous ("guest") call, the system will not be able to determine which user to return as /users/me.
+The alias ``/users/me`` can be used in place of the current user’s uuid, username, or email address. Note: The ``/users/me`` endpoint is accessible only if you provide an access token with the request (see [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html)). If you make an anonymous ("guest") call, the system will not be able to determine which user to return as ``/users/me``.
__Note__: The username can contain any combination of characters, including those that represent letters, numbers, and symbols.
[21/21] incubator-usergrid git commit: Update website with latest
docs.
Posted by sn...@apache.org.
Update website with latest docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/7662bc94
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/7662bc94
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/7662bc94
Branch: refs/heads/master
Commit: 7662bc9415122b81d456959d96c2c9284e250d0e
Parents: 6b14418
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Aug 7 17:05:31 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Aug 7 17:05:31 2015 -0400
----------------------------------------------------------------------
content/docs/README.html | 22 +-
content/docs/_sources/README.txt | 11 +-
.../file-storage-configuration.txt | 39 +
.../docs/_sources/assets-and-files/folders.txt | 85 ++
.../assets-and-files/legacy-asset-support.txt | 0
.../assets-and-files/retrieving-assets.txt | 27 +
.../assets-and-files/uploading-assets.txt | 86 ++
.../data-queries/operators-and-types.txt | 2 +-
.../_sources/data-queries/query-parameters.txt | 2 +-
.../data-queries/querying-your-data.txt | 2 +-
.../docs/_sources/data-storage/collections.txt | 8 +-
.../_sources/data-storage/data-store-dbms.txt | 12 +-
content/docs/_sources/data-storage/entities.txt | 10 +-
.../entity-connections/retrieving-entities.txt | 9 +-
.../docs/_sources/geolocation/geolocation.txt | 2 +-
.../creating-a-new-application.txt | 6 +-
.../getting-started/creating-account.txt | 6 +-
.../getting-started/using-a-sandbox-app.txt | 2 +-
.../_sources/getting-started/using-the-api.txt | 2 +-
content/docs/_sources/index.txt | 14 +-
.../docs/_sources/introduction/data-model.txt | 30 +-
content/docs/_sources/introduction/overview.txt | 17 +
.../_sources/introduction/usergrid-features.txt | 28 +-
.../docs/_sources/orgs-and-apps/admin-user.txt | 2 +-
.../docs/_sources/orgs-and-apps/application.txt | 2 +-
.../docs/_sources/rest-endpoints/api-docs.txt | 1162 +++++++---------
content/docs/_sources/sdks/ios-new.txt | 982 +++++++++++++
content/docs/_sources/sdks/ios.txt | 108 +-
content/docs/_sources/sdks/sdk-outline.txt | 111 ++
.../authenticating-api-requests.txt | 6 +-
...enticating-users-and-application-clients.txt | 6 +-
.../security-and-auth/facebook-sign.txt | 2 +-
.../user-authentication-types.txt | 6 +-
.../security-and-auth/using-permissions.txt | 4 +-
.../_sources/security-and-auth/using-roles.txt | 304 ++++
.../docs/_sources/user-management/activity.txt | 17 +-
content/docs/_sources/user-management/group.txt | 12 +-
.../user-management/messagee-example.txt | 2 +-
.../user-management/working-user-data.txt | 12 +-
content/docs/_static/css/theme.css | 168 +--
.../file-storage-configuration.html | 322 +++++
content/docs/assets-and-files/folders.html | 391 ++++++
.../assets-and-files/legacy-asset-support.html | 280 ++++
.../assets-and-files/retrieving-assets.html | 359 +++++
.../docs/assets-and-files/uploading-assets.html | 419 ++++++
.../creating-and-incrementing-counters.html | 11 +-
.../events-and-counters.html | 15 +-
.../retrieving-counters.html | 11 +-
.../docs/data-queries/advanced-query-usage.html | 11 +-
.../docs/data-queries/operators-and-types.html | 15 +-
content/docs/data-queries/query-parameters.html | 14 +-
.../docs/data-queries/querying-your-data.html | 15 +-
content/docs/data-storage/collections.html | 35 +-
content/docs/data-storage/data-store-dbms.html | 31 +-
content/docs/data-storage/entities.html | 38 +-
.../docs/data-storage/optimizing-access.html | 11 +-
.../entity-connections/connecting-entities.html | 11 +-
.../disconnecting-entities.html | 11 +-
.../entity-connections/retrieving-entities.html | 25 +-
content/docs/genindex.html | 11 +-
content/docs/geolocation/geolocation.html | 17 +-
.../creating-a-new-application.html | 29 +-
.../docs/getting-started/creating-account.html | 28 +-
.../getting-started/using-a-sandbox-app.html | 26 +-
content/docs/getting-started/using-the-api.html | 14 +-
content/docs/index.html | 91 +-
.../docs/installation/ug1-deploy-to-tomcat.html | 11 +-
.../installation/ug1-launcher-quick-start.html | 11 +-
.../docs/installation/ug2-deploy-to-tomcat.html | 11 +-
content/docs/introduction/async-vs-sync.html | 15 +-
content/docs/introduction/data-model.html | 41 +-
content/docs/introduction/overview.html | 320 +++++
.../docs/introduction/usergrid-features.html | 78 +-
content/docs/objects.inv | Bin 663 -> 666 bytes
content/docs/orgs-and-apps/admin-user.html | 91 +-
content/docs/orgs-and-apps/application.html | 26 +-
content/docs/orgs-and-apps/managing.html | 11 +-
content/docs/orgs-and-apps/organization.html | 11 +-
content/docs/push-notifications/tbd.html | 11 +-
.../docs/push-notifications/users-devices.html | 11 +-
content/docs/reference/contribute-code.html | 11 +-
content/docs/reference/presos-and-videos.html | 11 +-
content/docs/rest-endpoints/api-docs.html | 1226 +++++++---------
content/docs/sdks/ios-new.html | 1310 ++++++++++++++++++
content/docs/sdks/ios.html | 133 +-
content/docs/sdks/sdk-outline.html | 503 +++++++
content/docs/sdks/tbd.html | 11 +-
content/docs/search.html | 11 +-
content/docs/searchindex.js | 2 +-
.../docs/security-and-auth/app-security.html | 11 +-
.../authenticating-api-requests.html | 23 +-
...nticating-users-and-application-clients.html | 33 +-
.../changing-token-time-live-ttl.html | 11 +-
.../docs/security-and-auth/facebook-sign.html | 13 +-
.../revoking-tokens-logout.html | 11 +-
.../security-and-auth/securing-your-app.html | 11 +-
.../user-authentication-types.html | 32 +-
.../security-and-auth/using-permissions.html | 23 +-
content/docs/security-and-auth/using-roles.html | 740 ++++++++++
content/docs/user-management/activity.html | 50 +-
content/docs/user-management/group.html | 38 +-
content/docs/user-management/groups.html | 11 +-
.../docs/user-management/messagee-example.html | 15 +-
.../docs/user-management/user-connections.html | 11 +-
.../docs/user-management/user-management.html | 11 +-
.../docs/user-management/working-user-data.html | 46 +-
docs/rest-endpoints/api-docs.html | 588 ++++----
docs/src/main/resources/html/model.mustache | 2 +-
108 files changed, 8686 insertions(+), 2429 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/README.html
----------------------------------------------------------------------
diff --git a/content/docs/README.html b/content/docs/README.html
index 7abe7ff..1a6ca49 100644
--- a/content/docs/README.html
+++ b/content/docs/README.html
@@ -80,14 +80,15 @@
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
</ul>
@@ -115,6 +116,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
@@ -139,9 +141,9 @@
</ul>
<p class="caption"><span class="caption-text">Assets & Files</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters & Events</span></p>
<ul>
@@ -156,6 +158,7 @@
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
@@ -230,9 +233,6 @@ $ sudo easy_install pip
</pre></div>
</div>
</div>
-<div class="section" id="how-to-change-update-the-usergrid-documentation">
-<h2>How to change/update the Usergrid documentation<a class="headerlink" href="#how-to-change-update-the-usergrid-documentation" title="Permalink to this headline">¶</a></h2>
-</div>
<div class="section" id="how-to-build-the-usergrid-documentation-using-sphinx">
<h2>How to build the Usergrid documentation using Sphinx<a class="headerlink" href="#how-to-build-the-usergrid-documentation-using-sphinx" title="Permalink to this headline">¶</a></h2>
<p>Sphinx runs via a Makefile in this, the docs directory. So, cd to this
@@ -275,6 +275,12 @@ examples of that around too.</p>
</div>
<div class="section" id="how-to-publish-the-usergrid-docs-to-usergrid-website">
<h2>How to publish the Usergrid docs to Usergrid website<a class="headerlink" href="#how-to-publish-the-usergrid-docs-to-usergrid-website" title="Permalink to this headline">¶</a></h2>
+<p>First you generate the HTML for the docs from the Markdown and reST
+sources like so:</p>
+<div class="highlight-python"><div class="highlight"><pre>cd $usergrid/docs
+make clean html
+</pre></div>
+</div>
<p>To update the Usergrid website you must copy the udpated docs files from
<code class="docutils literal"><span class="pre">target/html</span></code> directory to the website directory at the root of the
Usergrid project, i.e. <code class="docutils literal"><span class="pre">${usergrid-project-dir}/website/docs</span></code>.</p>
@@ -299,7 +305,7 @@ need to edit the Groovy script that does the generation:
will have to Git Clone Mustache.java before you can run the generation
script.</p>
<p>This is the command to run the generation:</p>
-<div class="highlight-python"><div class="highlight"><pre>groovy src/main/groovy/usergrid.ApiDocGenerator.groovy
+<div class="highlight-python"><div class="highlight"><pre>groovy src/main/groovy/usergrid/ApiDocGenerator.groovy
</pre></div>
</div>
<p>The script will update the file <code class="docutils literal"><span class="pre">rest-endpoints/api-docs.md</span></code> and when
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/README.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/README.txt b/content/docs/_sources/README.txt
index 58ccf3b..2f7888c 100644
--- a/content/docs/_sources/README.txt
+++ b/content/docs/_sources/README.txt
@@ -9,10 +9,6 @@ Sphinx requires Python and pip. Once you have Python, you can install sphinx and
$ sudo easy_install sphinx
$ sudo easy_install pip
-## How to change/update the Usergrid documentation
-
-
-
## How to build the Usergrid documentation using Sphinx
Sphinx runs via a Makefile in this, the docs directory. So, cd to this directory and make html:
@@ -40,6 +36,11 @@ A note about tables. Markdown and reST do not have very good table support. Simp
## How to publish the Usergrid docs to Usergrid website
+First you generate the HTML for the docs from the Markdown and reST sources like so:
+
+ cd $usergrid/docs
+ make clean html
+
To update the Usergrid website you must copy the udpated docs files from ``target/html`` directory to the website directory at the root of the Usergrid project, i.e. ``${usergrid-project-dir}/website/docs``.
You can do this by running the script ``update-website.sh``.
@@ -64,6 +65,6 @@ __NOTE__: Mustache.hava is not in Maven Central so unfortunately, you will have
This is the command to run the generation:
- groovy src/main/groovy/usergrid.ApiDocGenerator.groovy
+ groovy src/main/groovy/usergrid/ApiDocGenerator.groovy
The script will update the file ``rest-endpoints/api-docs.md`` and when you are happy with your update you should commit and push that file with Git.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/file-storage-configuration.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/assets-and-files/file-storage-configuration.txt b/content/docs/_sources/assets-and-files/file-storage-configuration.txt
new file mode 100644
index 0000000..c56265a
--- /dev/null
+++ b/content/docs/_sources/assets-and-files/file-storage-configuration.txt
@@ -0,0 +1,39 @@
+# File storage configuration
+
+Usergrid can store your assets either on your hard drive or in the Amazon S3 cloud.
+
+Local storage configuration
+---
+
+By default assets are stored in the temporary folder /tmp/usergrid
+This can be changed by editing this file /stack/rest/src/main/resources/usergrid-rest-context.xml and replacing {usergrid.temp.files} by the wanted destination
+```xml
+<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.LocalFileBinaryStore">
+ <property name="reposLocation" value="${usergrid.temp.files}"/>
+</bean>
+```
+
+AwS S3 configuration
+---
+
+To use your AWS S3 storage you need to change the binaryStore classpath and add several constructor arguments in /stack/rest/src/main/resources/usergrid-rest-context.xml
+
+Some examples :
+```xml
+<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore">
+ <constructor-arg name="accessId" value="x" />
+ <constructor-arg name="secretKey" value="xx" />
+ <constructor-arg name="bucketName" value="x" />
+ <constructor-arg name="regionName" value="eu-central-1" />
+</bean>
+```
+the regionName field is not mandatory, this code is also valid
+```xml
+<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore">
+ <constructor-arg name="accessId" value="x" />
+ <constructor-arg name="secretKey" value="xx" />
+ <constructor-arg name="bucketName" value="x" />
+</bean>
+```
+
+The filesize is limited to 50GB but you need to keep in mind that the file has to be stored on the hard drive before being sended to Amazon.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/folders.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/assets-and-files/folders.txt b/content/docs/_sources/assets-and-files/folders.txt
new file mode 100644
index 0000000..7c425be
--- /dev/null
+++ b/content/docs/_sources/assets-and-files/folders.txt
@@ -0,0 +1,85 @@
+# Folders
+
+## Linking a folder to an asset
+In order to access the asset for the image in the folder, you need to link the folder to the asset. You can do that by issuing a POST request in the following format:
+
+ POST /{org-uuid}/{app-uuid}/folders/{folder-uuid}/assets/{assets_id}
+
+where ``{folder-uuid}`` is the UUID of the folder, and ``{assets-uuid}`` is the UUID of the assets entity.
+
+Here’s how you could link the folder and the asset you created for the my-image.jpg image:
+
+ POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b
+
+In the response, you should see the assets entity for the image added to the folder:
+
+ {
+ "action": "post",
+ "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491",
+ "params": {},
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "entities": [
+ {
+ "uuid": "9501cda1-2d21-11e2-b4c6-02e81ac5a17b",
+ "type": "asset",
+ "name": "my-image.jpg",
+ "created": 1352763303163,
+ "modified": 1352763303163,
+ "metadata": {
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b"
+ },
+ "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1",
+ "path": "/myassets/asset1"
+ }
+ ],
+ "timestamp": 1352830448045,
+ "duration": 54,
+ "organization": "my-org”,
+ "applicationName": "my-app"
+ }
+
+## Retrieve list of folder assets
+You can also request a list of the linked contents of the folder like this:
+
+ GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets
+
+The response should look something like this:
+
+ {
+ "action": "get",
+ "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491",
+ "params": {
+ "_": [
+ "1352830364891"
+ ]
+ },
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets",
+ "entities": [
+ {
+ "uuid": "7bf47435-2ac8-11e2-b4c6-02e81ac5a17b",
+ "type": "asset",
+ "name": "my-image.jpg",
+ "created": 1352505133598,
+ "modified": 1352507245108,
+ "checksum": "8e0cd3866ee20746c99e9a9825f38ad8",
+ "content-length": 11853,
+ "content-type": "image/jpeg",
+ "etag": "\"8e0cd3866ee20746c99e9a9825f38ad8\"",
+ "metadata": {
+ "connecting": {
+ "assets": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets"
+ },
+ "connection": "assets",
+ "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b"
+ },
+ "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1",
+ "path": "my-image"
+ }
+ ],
+ "timestamp": 1352830363797,
+ "duration": 57,
+ "organization": "my-org",
+ "applicationName": "my-app"
+ }
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/legacy-asset-support.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/assets-and-files/legacy-asset-support.txt b/content/docs/_sources/assets-and-files/legacy-asset-support.txt
new file mode 100644
index 0000000..e69de29
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/retrieving-assets.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/assets-and-files/retrieving-assets.txt b/content/docs/_sources/assets-and-files/retrieving-assets.txt
new file mode 100644
index 0000000..9313ae8
--- /dev/null
+++ b/content/docs/_sources/assets-and-files/retrieving-assets.txt
@@ -0,0 +1,27 @@
+# Retrieving assets
+
+## Retrieving asset data
+
+To retrieve the asset from an entity, send a ``GET`` request with the ``Accept`` header set to the content type of the asset. The content type can be retrieved from the ``file-metadata.content-type`` property of the entity the asset is attached to.
+
+### Request syntax
+
+ curl -X GET -H 'Accept: <content_type>' 'https://api.usergrid.com/<org>/<app>/<collection>/<entity>
+
+Parameters
+
+Parameter Description
+--------- -----------
+content_type The content type of the attached asset. For example, text/plain, image/jpeg.
+org Organization UUID or organization name
+app Application UUID or application name
+collection Name or UUID of the collection of the entity the asset is attached to.
+entity Name or UUID of the entity the asset is attached to.
+
+### Example request
+The following request will retrieve the data for a jpeg file attached to an entity named 'cloud' in the 'pictures' collection:
+
+ curl -X GET -H 'Accept: image/jpeg' 'https://api.usergrid.com/your-org/your-app/pictures/cloud
+
+## Retrieving an asset entity
+To retrieve the entity that an asset is attached to, perform a ``GET`` request as you normally would to retrieve an entity. For more information, see [Retrieving Data Entities](../data-storage/entities.html#retrieving-data-entities).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/uploading-assets.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/assets-and-files/uploading-assets.txt b/content/docs/_sources/assets-and-files/uploading-assets.txt
new file mode 100644
index 0000000..c5b836f
--- /dev/null
+++ b/content/docs/_sources/assets-and-files/uploading-assets.txt
@@ -0,0 +1,86 @@
+# Uploading assets
+
+With Usergrid, you can store and retrieve files and assets that hold data objects such as images, video, and audio content.
+
+Usergrid manages these objects as Asset entities. Optionally, you can use Folder entities to organize related assets.
+
+## Uploading assets
+Assets can be any file type and can be attached to any entity. When an asset is uploaded, Usergrid will automatically detect the file metadata for the asset and save it in the associated entity as a ``file-metadata`` property. Only 1 asset can be attached to an entity.
+
+To attach an asset to an entity, do the following:
+
+### Request syntax
+
+ curl -X POST -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity>
+
+Parameters
+
+Parameter Description
+--------- -----------
+filename A filename to associate with the asset.
+file_location The location of the asset to be uploaded.
+org Organization UUID or organization name
+app Application UUID or application name
+collection Name or UUID of the collection of the entity you want to attach the asset to.
+entity Name or UUID of an existing entity you want to attach the asset to.
+
+### Example request
+
+ curl -X POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/'
+
+### Example response
+
+Notice the ``file-metadata`` property in the response.
+
+ {
+ "action" : "post",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/users",
+ "uri" : "https://api.usergrid.com/amuramoto/sandbox/pictures",
+ "entities" : [ {
+ "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376",
+ "type" : "user",
+ "name" : "test",
+ "created" : 1395681911491,
+ "modified" : 1399069838919,
+ "name" : "clouds",
+ "file" : "fobnszewobnioerabnoiawegbrn\n",
+ "file-metadata" : {
+ "content-type" : "image/jpeg",
+ "etag" : "\"2e1db7299b0a667ed80e674a0ef9d653\"",
+ "last-modified" : 1399070010115,
+ "content-length" : 28,
+ "checksum" : "2e1db7299b0a667ed80e674a0ef9d653"
+ },
+ "metadata" : {
+ "connecting" : {
+ "likes" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes"
+ },
+ "path" : "/users/410b213a-b379-11e3-a0e5-9953085ea376",
+ "sets" : {
+ "rolenames" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "permissions" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions"
+ },
+ "connections" : {
+ "follows" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/follows"
+ },
+ "collections" : {
+ "activities" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/activities",
+ "devices" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/devices",
+ "feed" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/feed",
+ "groups" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/groups",
+ "roles" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles",
+ "following" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/following",
+ "followers" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1399070009986,
+ "duration" : 441,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+## Updating assets
+To update the data for an asset, perform the same request outlined above in 'Uploading assets' as a ``PUT`` request rather than a ``POST``.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/operators-and-types.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-queries/operators-and-types.txt b/content/docs/_sources/data-queries/operators-and-types.txt
index c67ccd1..bb42107 100644
--- a/content/docs/_sources/data-queries/operators-and-types.txt
+++ b/content/docs/_sources/data-queries/operators-and-types.txt
@@ -64,7 +64,7 @@ As you develop queries, remember that entity properties each conform to a partic
For example, if you create an entity with a price property with a value of 100.00, querying for 100 will return no results, since the API expected a decimal-delimited float value in your query.
-For a list of property data types for each default entities, see Default Data Entity Types.
+For a list of property data types for each default entities, see [Default Data Entities](../rest-endpoints/api-doc.html#models)s.
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/query-parameters.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-queries/query-parameters.txt b/content/docs/_sources/data-queries/query-parameters.txt
index 9f9fc68..944c27b 100644
--- a/content/docs/_sources/data-queries/query-parameters.txt
+++ b/content/docs/_sources/data-queries/query-parameters.txt
@@ -48,7 +48,7 @@ The following table lists a few examples of the kind of searches you can do in q
### Location
-If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see Geolocation.
+If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see [Geolocation](../geolocation/geolocation.html).
<table class="usergrid-table">
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/querying-your-data.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-queries/querying-your-data.txt b/content/docs/_sources/data-queries/querying-your-data.txt
index fa10169..2da961d 100644
--- a/content/docs/_sources/data-queries/querying-your-data.txt
+++ b/content/docs/_sources/data-queries/querying-your-data.txt
@@ -42,7 +42,7 @@ For example, the following request returns the address and phone number of users
When you query your data, the API response is formatted in JavaScript Object Notation (JSON). This is a common format used for parameter and return values in REST web services.
-Data corresponding to the response is captured in the response’s entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see Default Data Entity Types.
+Data corresponding to the response is captured in the response’s entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see [Default Data Entities](../rest-endpoints/api-doc.html#models).
For example, the following query for all entities of type user where the name property equals 'Gladys Kravitz':
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/collections.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-storage/collections.txt b/content/docs/_sources/data-storage/collections.txt
index c072104..fa8652e 100644
--- a/content/docs/_sources/data-storage/collections.txt
+++ b/content/docs/_sources/data-storage/collections.txt
@@ -4,7 +4,7 @@
This article describes how to create collections in Advanced Usergrid. All entities are automatically associated with a corresponding collection based on the type property of the entity. You may create empty collections if you wish, but creating an entity of a new type will automatically create a corresponding collection for you. For example, creating a new custom "item" entity, creates an "items" collection.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Creating a collection
@@ -51,7 +51,7 @@ This article describes how to retrieve all of the entities in a collection.
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
By default, the Usergrid API returns 10 entities per request. For collections with more than 10 entities, use the returned 'cursor' property to retrieve the next 10 entities in the result set. You may also use the LIMIT parameter in a query string to increase the number of results returned. For more information on using cursors, see [Query Parameters](../data-queries/query-parameters.html).</p></div>
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Retrieving sets of entities from a collection
@@ -115,7 +115,7 @@ Response:
This article describes how to perform batch updates on all entities in a collection. Batch updates require the use of a query string in the request, which can either specify all entities in the collection or a subset of entities for the update to be performed on. For more information on queries, see Querying your data.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Batch updating entities in a collection
@@ -185,7 +185,7 @@ This article describes how to batch delete entities in a collection. Batch delet
Currently, collections cannot be deleted; however, you can delete all of the entities from a collection.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Batch deleting entities in a collection
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/data-store-dbms.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-storage/data-store-dbms.txt b/content/docs/_sources/data-storage/data-store-dbms.txt
index 539cca6..56fbbdb 100644
--- a/content/docs/_sources/data-storage/data-store-dbms.txt
+++ b/content/docs/_sources/data-storage/data-store-dbms.txt
@@ -4,10 +4,10 @@ The Usergrid data store is backed by Cassandra, an open source distributed DBMS.
<!-- workaround a Sphinx bug -->
<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
-Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see Optimizing access to your Usergrid data store.</p> </div>
+Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see [Optimizing access to your Usergrid data store](../data-storage/optimizing-access.html).</p> </div>
-Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see Usergrid SDKs.)
+Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see [Usergrid SDKs](../sdks/tbd.html).)
With Cassandra as the underlying DBMS, apps benefit from:
@@ -20,10 +20,10 @@ If you have experience with relational databases and are unfamiliar with "NoSQL"
<table class="usergrid-table">
<tr>
- <td></td>
- <td>RDBMS</td>
- <td>Cassandra</td>
- <td>Usergrid</td>
+ <th></th>
+ <th>RDBMS</th>
+ <th>Cassandra</th>
+ <th>Usergrid</th>
</tr>
<tr>
<td>Each tuple is modeled as</td>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/entities.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/data-storage/entities.txt b/content/docs/_sources/data-storage/entities.txt
index 5a70b18..be77ebd 100644
--- a/content/docs/_sources/data-storage/entities.txt
+++ b/content/docs/_sources/data-storage/entities.txt
@@ -5,7 +5,7 @@ This article describes how to create custom data entities and entity properties.
The methods cited in this article should be used to create custom data entities. If you are using one of the Usergrid SDKs, use one of the entity type-specific SDK methods to create default data entities.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Creating a custom entity
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. For example, creating a custom entity of type 'item' will automatically create a collection named 'items' in which all future 'item' entities will be saved.
@@ -144,7 +144,7 @@ Any valid JSON object can be stored in an entity, regardless of the level of com
### Updating sub-properties
An array of sub-properties is treated as a single object. This means that sub-properties cannot be updated atomically. All sub-properties of a given property must be updated as a set.
-For more on updating an existing sub-property, see Updating Data Entities.
+For more on updating an existing sub-property, see [Updating Data Entities](../data-storage/entities.html#updating-data-entities).
Example Request/Response
@@ -193,7 +193,7 @@ Example Request/Response
## Retrieving Data Entities
This article describes how to retrieve entities from your account.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
With the exception of the user entity, all data entities can be retrieved by using their UUID or a 'name' property. The user entity can be retrieved by UUID or the 'username' property. The value for the 'name' or 'username' property must be unique.
@@ -333,7 +333,7 @@ Response:
This article describes how to update entities in your account.
-__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Updating an entity
One or more properties can be updated with a single PUT request. For information on updating sub-properties, see Updating sub-properties below.
@@ -454,7 +454,7 @@ Response:
This article describes how to delete data entities.
-__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
+__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details.
### Deleting an entity
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/entity-connections/retrieving-entities.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/entity-connections/retrieving-entities.txt b/content/docs/_sources/entity-connections/retrieving-entities.txt
index 31eaf9c..6da8577 100644
--- a/content/docs/_sources/entity-connections/retrieving-entities.txt
+++ b/content/docs/_sources/entity-connections/retrieving-entities.txt
@@ -1,13 +1,12 @@
# Retrieving connections
-Viewing all of an entities connections
To see all of the connection types associated with an entity, simply retrieve the entity.
-All of the connection types the entity has made to other entities will appear in the metadata.connections property.
+All of the connection types the entity has made to other entities will appear in the ``metadata.connections`` property.
-All of the connection types that other entities have made to the entity will appear in the metadata.connecting property.
+All of the connection types that other entities have made to the entity will appear in the ``metadata.connecting`` property.
-For user entities, following/followers connections can be accessed by sending a GET request to the URL in the collections.following and collections.followers properties.
+For user entities, following/followers connections can be accessed by sending a ``GET`` request to the URL in the ``collections.following`` and ``collections.follower``s properties.
Retrieve connected entities by connection type
To get a list of entities a specified entity has connected to with a specific connection type, do the following:
@@ -83,7 +82,7 @@ All of the entities that have made a connection of that type to the specified en
## Retrieve all connecting entities by type
-To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connecting/<relationship>.
+To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to ``connecting/<relationship>``.
All of the entities that have made a connection to the specified entity will be returned in the entities property of the response.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/geolocation/geolocation.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/geolocation/geolocation.txt b/content/docs/_sources/geolocation/geolocation.txt
index ede4e3c..3da555c 100644
--- a/content/docs/_sources/geolocation/geolocation.txt
+++ b/content/docs/_sources/geolocation/geolocation.txt
@@ -36,7 +36,7 @@ Location-aware apps require the ability to return content and results based on t
The returned results are sorted from nearest to furthest. Entities with the same location are returned in the order they were created.
-The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see Querying your data.
+The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see [Querying your Data](../data-queries/querying-your-data.html).
For example, here is how you would find all the devices within 8,046 meters (~10 miles) of the center of San Francisco:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/creating-a-new-application.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/getting-started/creating-a-new-application.txt b/content/docs/_sources/getting-started/creating-a-new-application.txt
index cc5f577..ce5fb7a 100644
--- a/content/docs/_sources/getting-started/creating-a-new-application.txt
+++ b/content/docs/_sources/getting-started/creating-a-new-application.txt
@@ -8,7 +8,9 @@ To create a new application with the admin portal:
1. In the admin portal, from the dropdown menu at the far top left, select the organization to which you will add the new application.
1. Click the ADD NEW APP button, located at the top of the screen, next to the application drop-down.
1. In the dialog box, enter a new application name, then click the Create button. Your new application will automatically be selected in the applications drop-down menu.
-Applications can also be created programmatically with a POST request to the API. For more, see Application.
+
+Applications can also be created programatically with a ``POST`` request to the API. For more, see [Application](../orgs-and-apps/application.html).
## Securing an application
-If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see Security best practices.
\ No newline at end of file
+If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see [Security Best Practices](../security-and-auth/securing-your-app.html)
+.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/creating-account.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/getting-started/creating-account.txt b/content/docs/_sources/getting-started/creating-account.txt
index 1440926..f4f542a 100644
--- a/content/docs/_sources/getting-started/creating-account.txt
+++ b/content/docs/_sources/getting-started/creating-account.txt
@@ -3,7 +3,7 @@ To get started using the Usergrid, you'll need an Usergrid account. (Before read
With an account, you get the following useful things:
-* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see "Using Your Application Sandbox".
+* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see [Using Your Application Sandbox](../getting-started/using-a-sandbox-app.html).
* The ability to create more applications (in addition to the sandbox). You can (and should!) make these as secure as you need to. These are the applications that you'll have behind the apps you make available to your users.
* Access to the Admin Portal. In the portal, you can do the following:
** Create and manage applications.
@@ -11,11 +11,11 @@ With an account, you get the following useful things:
** Manage the data in your app.
** Manage app features, including push notifications, activities, analytics, and so on.
** Try out API calls with a shell command window.
-** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page.
+** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page of the Portal.
## Next steps
Ready to learn and do more?
-* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see SDKs.
+* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see [SDKs](../sdks/tbd.html).
* Review Usergrid features for information on concepts and features.
* Consult the API Reference for usage details.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/using-a-sandbox-app.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/getting-started/using-a-sandbox-app.txt b/content/docs/_sources/getting-started/using-a-sandbox-app.txt
index 7fb9cd1..75c296f 100644
--- a/content/docs/_sources/getting-started/using-a-sandbox-app.txt
+++ b/content/docs/_sources/getting-started/using-a-sandbox-app.txt
@@ -2,7 +2,7 @@
## What is the sandbox application?
-When you create a new Usergrid account (see Creating an Usergrid Account) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions.
+When you create a new Usergrid account (see [Creating an Usergrid Account](creating-account.html)) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions.
## Is the sandbox secure?
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/using-the-api.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/getting-started/using-the-api.txt b/content/docs/_sources/getting-started/using-the-api.txt
index 9a7ba2d..d85f86a 100644
--- a/content/docs/_sources/getting-started/using-the-api.txt
+++ b/content/docs/_sources/getting-started/using-the-api.txt
@@ -59,7 +59,7 @@ For example, this request retrieves users whose Facebook first name is john:
/users?ql=select * where facebook.first_name ='john'
-For further information about queries, see Queries and parameters.
+For further information about queries, see [Querying your Data](../data-queries/querying-your-data.html)
## Authentication (OAuth)
Usergrid implements the OAuth 2.0 standard for authenticating users, clients and API requests.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/index.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/index.txt b/content/docs/_sources/index.txt
index e25eebc..1afd267 100644
--- a/content/docs/_sources/index.txt
+++ b/content/docs/_sources/index.txt
@@ -8,6 +8,7 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Introduction
+ introduction/overview.md
introduction/usergrid-features
introduction/data-model
introduction/async-vs-sync
@@ -18,8 +19,8 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Getting Started
- getting-started/creating-a-new-application
getting-started/creating-account
+ getting-started/creating-a-new-application
getting-started/using-a-sandbox-app
getting-started/using-the-api.md
@@ -63,6 +64,7 @@ Apache Usergrid Documentation
security-and-auth/app-security
security-and-auth/using-permissions
+ security-and-auth/using-roles
security-and-auth/authenticating-users-and-application-clients
security-and-auth/user-authentication-types
security-and-auth/changing-token-time-live-ttl
@@ -98,9 +100,9 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Assets & Files
- asset-and-files/uploading-assets.md
- asset-and-files/retrieving-assets.md
- asset-and-files/folders.md
+ assets-and-files/uploading-assets.md
+ assets-and-files/retrieving-assets.md
+ assets-and-files/folders.md
.. _counters-and-events:
@@ -121,7 +123,7 @@ Apache Usergrid Documentation
orgs-and-apps/managing
orgs-and-apps/organization
orgs-and-apps/application
- orgs-and-apps/adminuser
+ orgs-and-apps/admin-user
.. _rest-endpoints:
@@ -138,7 +140,7 @@ Apache Usergrid Documentation
:caption: Client SDKs
sdks/tbd
-
+
.. _installation:
.. toctree::
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/data-model.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/introduction/data-model.txt b/content/docs/_sources/introduction/data-model.txt
index 0278b97..41421bd 100644
--- a/content/docs/_sources/introduction/data-model.txt
+++ b/content/docs/_sources/introduction/data-model.txt
@@ -8,7 +8,7 @@ An organization contains one or more applications, and represents administrator-
An organization with the same name as your username is automatically created for you when you sign up. By default, you are assigned as the administrator of this organization.
## Applications
-In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a Sandbox Application for important information regarding the default sandbox application).
+In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a [Sandbox Application](../getting-started/using-a-sandbox-app.html) for important information regarding the default sandbox application).
Each application provides the infrastructure for storing, retrieving, updating and deleting the entities and collections associated with a specific app instance.
@@ -33,20 +33,20 @@ Here is a simple example of an entity:
}
## Default entities
-The following entity types are predefined in Usergrid. For more details, see Default Data Entity Types.
-
-* user
-* group
-* role
-* application
-* activity
-* device
-* asset
-* folder
-* event
-* notifier
-* notification
-* receipt
+The following entity types are predefined in Usergrid. For more details, see the [API Reference](../rest-endpoints/api-docs.html)
+
+* [user](../rest-endpoints/api-docs.html#user)
+* [group](../rest-endpoints/api-docs.html#group)
+* [role](../rest-endpoints/api-docs.html#role)
+* [application](../rest-endpoints/api-docs.html#application)
+* [activity](../rest-endpoints/api-docs.html#activity)
+* [device](../rest-endpoints/api-docs.html#device)
+* [asset](../rest-endpoints/api-docs.html#asset)
+* [folder](../rest-endpoints/api-docs.html#folder)
+* [event](../rest-endpoints/api-docs.html#event)
+* [notifier](../rest-endpoints/api-docs.html#notifier)
+* [notification](../rest-endpoints/api-docs.html#notification)
+* [receipt](../rest-endpoints/api-docs.html#recept)
## Properties
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/overview.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/introduction/overview.txt b/content/docs/_sources/introduction/overview.txt
new file mode 100644
index 0000000..e9c6968
--- /dev/null
+++ b/content/docs/_sources/introduction/overview.txt
@@ -0,0 +1,17 @@
+# Documentation Overview
+
+The Usergrid documentation is written for a couple of distinctly different audiences:
+
+* __Application Developer__: this is you if you are a Javascript, iOS, Android, Java or other developer who wants to build an app that uses the Usergrid APIs for data storage, user management, authentication, etc. __Most of our docs are written for application developers__ so browse the left side-bar and work your way down the topics list.
+
+
+* __Deployment/Operations Engineer__: this is for you if you are the person who will be installing Usergrid, setting up the required Cassandra database and other things that Usergrid needs. Currently, we have limited docs for installation, deployment and maintenance of Usergrid:
+ * [Deploying to Tomcat](../ug1-deploy-to-tomacat): How to build and deploy Usergrid to Tomcat and Cassandra.
+ * [Launcher Quick Start](../ug1-launcher-quick-start): How to build and run Usergrid via the Usergrid Launcher.
+
+
+* __Open Source Contributor__: How to "give back" and contribute to Usergrid. Usergrid welcomes code and documentation contributions, GitHub pull-requests, bug reports and suggestions for improvement.
+ * [How to Contribute Code & Docs](../reference/contribute-code):
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/usergrid-features.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/introduction/usergrid-features.txt b/content/docs/_sources/introduction/usergrid-features.txt
index 5e57071..1a2f0d6 100644
--- a/content/docs/_sources/introduction/usergrid-features.txt
+++ b/content/docs/_sources/introduction/usergrid-features.txt
@@ -10,21 +10,21 @@ With Usergrid, developers can set up their own cloud-based data platform in minu
At the core of Usergrid is a flexible platform that can store any type of application data, from simple records like a catalog of books to complex associations like user relationships. No matter what type of data drives your app, you can store it as collections of data entities and immediately perform complex queries or full-text searches on any field. You can also create custom entities with custom properties, giving you the ability to store data and context in a way that makes sense for your app.
-To learn more about entities and collections, see Usergrid Data model.
+To learn more about entities and collections, see [Usergrid Data model](data-model.html).
-For a complete list of the default data entities available, see Default Data Entity Types.
+For a complete list of the default data entities available, see [Models](../rest-endpoint/api-docs.html#models).
### Files & assets
Images, video, and audio are key components of a great app experience. With Usergrid, you can upload and retrieve binary objects from the same data store as the rest of your application data, eliminating the need to set up content delivery networks (CDNs) and easing implementation. We handle all the back-end details that keep your content quickly accessible.
-To learn more about files and asset storage, see Uploading files and assets .
+To learn more about files and asset storage, see [Uploading files and assets](../assets-and-files/uploading-assets.html).
## Flexible data querying
One of Usergrid' most powerful features is the ability to perform SQL-style queries and full-text searches on data entities, as well as their properties. This lets you quickly retrieve specific data entities based on multiple criteria, then utilize that data to power social features, target push notifications, perform user analysis, and more.
-Learn more about querying app data, see Data query overview.
+Learn more about querying app data, see [Data query overview](../data-queries/querying-your-data.html).
## Social
@@ -32,13 +32,13 @@ Learn more about querying app data, see Data query overview.
You can create relationships between data entities to help build features, improve user experience, and contextualize data. For example, you might associate a user with their devices to capture valuable geolocation data, create relationships between users to build social graphs, or implement popular features such as activity streams.
-To learn more about entity relationships, see Entity connections.
+To learn more about entity relationships, see [Entity connections](../entity-connections/connecting-entities.html).
### Activity streams
A key aspect of social networking apps is the ability to provide and publish data streams of user actions, such as ongoing lists of comments, activities, and tweets. Usergrid simplifies management and routing of these data streams by providing an activity entity that is specifically designed to automatically create a relationship between activities and the user who created them.
-To learn more about activities and activity feeds, see Activity feeds.
+To learn more about activities and activity feeds, see [Activity feeds](../user-management/activity.html).
## User management
@@ -46,7 +46,7 @@ To learn more about activities and activity feeds, see Activity feeds.
You can easily add and manage users by providing the core services necessary to handle secure registration and log in, including OAuth 2.0-compliant client authentication. In addition, any number of default or custom data entities and properties can be associated with a user entity to create complete user profiles.
-To learn more about user management, see User.
+To learn more about user management, see [User Management](../user-management/user-management.html).
To learn more about authentication, see Authenticating users and application clients.
@@ -54,28 +54,28 @@ To learn more about authentication, see Authenticating users and application cli
Applications often require the ability to configure fine-grain control of user access to data, features and functionality. Usergrid solves the implementation details of user access with roles and permissions. Simply create roles that represent user types or access levels, such as Administrator, then assign the necessary permissions to that role. With a single API call, you can then associate your roles with any user or group of users.
-To learn more about user roles and permissions, see Managing access by defining permission rules.
+To learn more about user roles and permissions, see [Using Permissions](../security-and-auth/securing-your-app.html).
### Groups
Groups are a flexible way to organize your users based on any number of criteria. For example, you might group users based on interests or location to more effectively deliver relevant content, target offers, or customize campaigns. You can also take advantage of the groups entity to enable group-based social networking activities, such as allowing your users to create private information feeds or circles of friends.
-To learn more about groups, see Working with group data.
+To learn more about groups, see [Working with group data](../user-management/groups.html).
### Third-party authentication
In addition to supporting user management and OAuth-based login for your app, Usergrid also makes it easy to integrate third-party authentication through such popular services as Facebook, Twitter and other OAuth-enabled accounts. Providing third-party sign-in can improve user experience, while increasing adoption, giving you access to valuable information from social networks and services.
-To learn more about using third-party sign-in, see Facebook sign in.
+To learn more about using third-party sign-in, see [Facebook sign in](../security-and-auth/facebook-sign.html).
## Geolocation
The device entity allows you to capture geolocation data from your users' GPS-enabled devices to more effectively target campaigns, push notifications, offers and more. Geolocation also gives you an important data point for contextualizing and analyzing trends and user behavior.
-To learn more about geolocation, see Geolocation.
+To learn more about geolocation, see [Geolocation](../geolocation/geolocation.html).
-## Push notifications
+## Push notifications (Coming soon...)
-Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement.
+__(Coming Usergrid 2.0)__ Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement.
-To learn more about push notifications, see Push notifications overview.
+To learn more about push notifications, see [Push notifications overview](../push-notifications/tbd.html).
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/orgs-and-apps/admin-user.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/orgs-and-apps/admin-user.txt b/content/docs/_sources/orgs-and-apps/admin-user.txt
index 87b96f9..6b1b7d3 100644
--- a/content/docs/_sources/orgs-and-apps/admin-user.txt
+++ b/content/docs/_sources/orgs-and-apps/admin-user.txt
@@ -1,4 +1,4 @@
-# Admin user$
+# Admin user
An admin user has full access to perform any operation on all organization accounts of which the admin user is a member. Using the API Services BaaS API, you can create, update, or retrieve an admin user. You can also set or reset an admin user's password, activite or reactivate an admin user, and get an admin user's activity feed.
In addition, you can add, retrieve, or remove an admin user from an organization. For information on these organization-related operations, see [Organization](organization.html).
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/orgs-and-apps/application.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/orgs-and-apps/application.txt b/content/docs/_sources/orgs-and-apps/application.txt
index 7495aee..801b9ef 100644
--- a/content/docs/_sources/orgs-and-apps/application.txt
+++ b/content/docs/_sources/orgs-and-apps/application.txt
@@ -1,5 +1,5 @@
# Application
-You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the "Creating an organization application" section in Organization for details). If you need to create an application programmatically in your app, you can also use the API to do this. You can access application entities using your app name or UUID, prefixed with the organization name or UUID:
+You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the [Creating an Application](../orgs-and-apps/application.html#creating-an-application) section in Organization for details). If you need to create an application programmatically in your app, you can also use the API to do this. You can access application entities using your app name or UUID, prefixed with the organization name or UUID:
https://api.usergrid.com/{org_name|uuid}/{app_name|uuid}
[04/21] incubator-usergrid git commit: Minor refactoring in API doc
generation.
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/rest-endpoints/api-docs.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.md b/docs/rest-endpoints/api-docs.md
index fa39d59..51f1909 100644
--- a/docs/rest-endpoints/api-docs.md
+++ b/docs/rest-endpoints/api-docs.md
@@ -1,5 +1,28 @@
+<h1>Usergrid API Reference</h1>
+
+Methods are organized by tag. Follow the methods are the [Model Definitions](#models).
+
+<h2>Table of Contents</h2>
+
+* [Access-Tokens](#access-tokens)
+* [Activities](#activities)
+* [Admin-Users](#admin-users)
+* [App-Users](#app-users)
+* [Entities-Collections](#entities-collections)
+* [Events](#events)
+* [Groups](#groups)
+* [Organizations-Applications](#organizations-applications)
+* [Permissions-Roles](#permissions-roles)
+
+<br>
+<br>
+
+
## Methods
-### Access-Tokens Methods
+
+
+### Access-Tokens
+
<h2 class="usergrid-POST-heading">POST /management/token</h2>
@@ -44,7 +67,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Activities Methods
+
+### Activities
+
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2>
@@ -125,7 +150,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Admin-Users Methods
+
+### Admin-Users
+
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
@@ -352,7 +379,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### App-Users Methods
+
+### App-Users
+
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
@@ -511,7 +540,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Entities-Collections Methods
+
+### Entities-Collections
+
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
@@ -776,7 +807,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Events Methods
+
+### Events
+
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
@@ -803,7 +836,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Groups Methods
+
+### Groups
+
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
@@ -966,7 +1001,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Organizations-Applications Methods
+
+### Organizations-Applications
+
<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
@@ -1217,7 +1254,9 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Permissions-Roles Methods
+
+### Permissions-Roles
+
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
----------------------------------------------------------------------
diff --git a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
index 4952ebf..efc99e9 100644
--- a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
+++ b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
@@ -17,6 +17,9 @@ import com.github.mustachejava.*
import org.apache.commons.lang3.RandomStringUtils;
+/**
+ * Generates Usergrid API docs from Swagger in Markdown format.
+ */
public class ApiDocGenerator {
def parser = new SwaggerParser();
@@ -41,9 +44,11 @@ public class ApiDocGenerator {
public ApiDocGenerator() {
writer = new OutputStreamWriter(new FileOutputStream("rest-endpoints/api-docs.md"));
operationTemplate = mf.compile(
- new FileReader("${mustacheBase}/operation.mustache"), "operation");
+ new FileReader("${mustacheBase}/markdown/operation.mustache"), "operation");
modelTemplate = mf.compile(
- new FileReader("${mustacheBase}/model.mustache"), "model");
+ new FileReader("${mustacheBase}/markdown/model.mustache"), "model");
+ fileStartTemplate = mf.compile(
+ new FileReader("${mustacheBase}/markdown/file-start.mustache"), "file-start");
}
public static void main( String[] args ) {
@@ -207,15 +212,29 @@ public class ApiDocGenerator {
}
def generateFileStart() {
- // no op
+ def scope = [:];
+ def tags = [];
+ allTags.each{ tag ->
+ def atag = [:];
+ atag.name = tag;
+ atag.link = tag.toLowerCase();
+ tags.add(atag);
+ };
+ scope.tags = tags;
+ fileStartTemplate.execute(writer, scope);
+ writer.flush();
}
def generateMethodsSectionTitle() {
+ writer.println "";
writer.println "## Methods";
+ writer.println "";
}
def generateMethodsTitle(String tag) {
- writer.println "### ${tag} Methods";
+ writer.println "";
+ writer.println "### ${tag}";
+ writer.println "";
}
def generateModelsTitle() {
@@ -224,24 +243,28 @@ public class ApiDocGenerator {
}
def generateFileEnd() {
- // no op
+ writer.println "";
+ writer.println "Generated from the Usergrid Swagger definition.";
+ writer.println "";
}
}
-
+/**
+ * Generates Usergrid API docs from Swagger in HTML format.
+ */
class HtmlApiDocGenerator extends ApiDocGenerator {
public HtmlApiDocGenerator() {
writer = new OutputStreamWriter(
new FileOutputStream("rest-endpoints/api-docs.html"));
operationTemplate = mf.compile(
- new FileReader("${mustacheBase}/operation-html.mustache"), "operation");
+ new FileReader("${mustacheBase}/html/operation.mustache"), "operation");
modelTemplate = mf.compile(
- new FileReader("${mustacheBase}/model-html.mustache"), "operation");
+ new FileReader("${mustacheBase}/html/model.mustache"), "operation");
fileStartTemplate = mf.compile(
- new FileReader("${mustacheBase}/file-start-html.mustache"), "file-start");
+ new FileReader("${mustacheBase}/html/file-start.mustache"), "file-start");
fileEndTemplate = mf.compile(
- new FileReader("${mustacheBase}/file-end-html.mustache"), "file-end");
+ new FileReader("${mustacheBase}/html/file-end.mustache"), "file-end");
}
def generateFileStart() {
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/file-end-html.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/file-end-html.mustache b/docs/src/main/resources/file-end-html.mustache
deleted file mode 100644
index 28d75b5..0000000
--- a/docs/src/main/resources/file-end-html.mustache
+++ /dev/null
@@ -1,13 +0,0 @@
-
- </div>
- <div class="col-md-1"></div>
-</div>
-
-<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
-
-<!-- Latest compiled and minified JavaScript -->
-<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
-
-</body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/file-start-html.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/file-start-html.mustache b/docs/src/main/resources/file-start-html.mustache
deleted file mode 100644
index 642bf42..0000000
--- a/docs/src/main/resources/file-start-html.mustache
+++ /dev/null
@@ -1,21 +0,0 @@
-<html>
-<head>
- <title>{{title}}</title>
-
- <!-- Latest compiled and minified CSS -->
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
-
- <!-- Optional theme -->
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
-
- <link rel="stylesheet" href="api-docs.css">
-
-</head>
-<body>
-
-<div class="row">
- <div class="col-md-1"></div>
- <div class="col-md-10">
-
- <h1>{{title}}</h1>
- <p>Generated from Swagger.</p>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/html/file-end.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/file-end.mustache b/docs/src/main/resources/html/file-end.mustache
new file mode 100644
index 0000000..28d75b5
--- /dev/null
+++ b/docs/src/main/resources/html/file-end.mustache
@@ -0,0 +1,13 @@
+
+ </div>
+ <div class="col-md-1"></div>
+</div>
+
+<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+
+<!-- Latest compiled and minified JavaScript -->
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/html/file-start.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/file-start.mustache b/docs/src/main/resources/html/file-start.mustache
new file mode 100644
index 0000000..642bf42
--- /dev/null
+++ b/docs/src/main/resources/html/file-start.mustache
@@ -0,0 +1,21 @@
+<html>
+<head>
+ <title>{{title}}</title>
+
+ <!-- Latest compiled and minified CSS -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
+
+ <!-- Optional theme -->
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
+
+ <link rel="stylesheet" href="api-docs.css">
+
+</head>
+<body>
+
+<div class="row">
+ <div class="col-md-1"></div>
+ <div class="col-md-10">
+
+ <h1>{{title}}</h1>
+ <p>Generated from Swagger.</p>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/html/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/model.mustache b/docs/src/main/resources/html/model.mustache
new file mode 100644
index 0000000..8672641
--- /dev/null
+++ b/docs/src/main/resources/html/model.mustache
@@ -0,0 +1,38 @@
+
+<div>
+ <a name="{{name}}"/>
+</div>
+
+<div class="panel panel-default">
+
+ <div class="panel-heading">
+ <h2 class="panel-title model-heading">{{name}}
+ <a data-toggle="collapse" data-target="#collapse-{{modelid}}"
+ href="#collapse-{{modelid}}" class="collapsed collapse-button"> </a>
+ </h2>
+ </div>
+
+ <div id="collapse-{{modelid}}" class="panel-body collapse">
+
+ <h3>Properties</h3>
+
+ <table width="80%" class="table table-striped">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ {{#properties}}
+ <tr>
+ <td>{{name}}</td>
+ <td>{{type}}</td>
+ <td>{{description}}</td>
+ <td>{{required}}</td>
+ </tr>
+ {{/properties}}
+ </table>
+
+ </div>
+
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/html/operation.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/operation.mustache b/docs/src/main/resources/html/operation.mustache
new file mode 100644
index 0000000..6e15b1f
--- /dev/null
+++ b/docs/src/main/resources/html/operation.mustache
@@ -0,0 +1,43 @@
+
+<div class="panel panel-default">
+
+ <div class="panel-heading {{method}}">
+ <h2 class="panel-title {{method}}-heading">{{method}} {{url}}
+ <a data-toggle="collapse" data-target="#collapse-{{opid}}"
+ href="#collapse-{{opid}}" class="collapsed collapse-button"> </a>
+ </h2>
+ </div>
+
+ <div id="collapse-{{opid}}" class="panel-body collapse">
+
+ <p>{{description}}</p>
+
+ <h3>Parameters</h3>
+
+ <ul>
+ {{#parameters}}
+ <li>
+ <b>{{name}}</b> ({{#type}}{{type}}{{/type}}{{#schemaRef}}
+ <a href="#{{schemaAnchor}}">{{schemaRef}}</a>{{/schemaRef}}) <br>
+ {{description}} (Specified in {{in}}).
+ </li>
+ {{/parameters}}
+ </ul>
+
+ <h3>Responses</h3>
+
+ <ul>
+ {{#responses}}
+ <li>
+ <b>{{#status}}{{status}}{{/status}}{{^status}}Default{{/status}}</b>
+ <ul>
+ <li>Description: {{description}}</li>
+ <li>Schema: [<a href="#{{schemaAnchor}}">{{schema}}</a>]</li>
+ </ul>
+ </li>
+ {{/responses}}
+ </ul>
+
+ </div>
+ <!--<div class="panel-footer"></div>-->
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/markdown/file-start.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/markdown/file-start.mustache b/docs/src/main/resources/markdown/file-start.mustache
new file mode 100644
index 0000000..a43daa7
--- /dev/null
+++ b/docs/src/main/resources/markdown/file-start.mustache
@@ -0,0 +1,13 @@
+<h1>Usergrid API Reference</h1>
+
+Methods are organized by tag. Follow the methods are the [Model Definitions](#models).
+
+<h2>Table of Contents</h2>
+
+{{#tags}}
+* [{{name}}](#{{link}})
+{{/tags}}
+
+<br>
+<br>
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/markdown/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/markdown/model.mustache b/docs/src/main/resources/markdown/model.mustache
new file mode 100644
index 0000000..b58788b
--- /dev/null
+++ b/docs/src/main/resources/markdown/model.mustache
@@ -0,0 +1,21 @@
+
+### {{name}}
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ {{#properties}}
+ <tr>
+ <td>{{name}}</td>
+ <td>{{type}}</td>
+ <td>{{description}}</td>
+ <td>{{required}}</td>
+ </tr>
+ {{/properties}}
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/markdown/operation.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/markdown/operation.mustache b/docs/src/main/resources/markdown/operation.mustache
new file mode 100644
index 0000000..cce0524
--- /dev/null
+++ b/docs/src/main/resources/markdown/operation.mustache
@@ -0,0 +1,21 @@
+
+<h2 class="usergrid-{{method}}-heading">{{method}} {{url}}</h2>
+
+{{description}}
+
+<h3>Parameters</h3>
+
+{{#parameters}}
+* __{{name}}__ ({{#type}}{{type}}{{/type}}{{#schemaRef}}[{{schemaRef}}](#{{schemaAnchor}}){{/schemaRef}})
+{{description}} (Specified in {{in}}).
+{{/parameters}}
+
+<h3>Responses</h3>
+
+{{#responses}}
+__{{#status}}{{status}}{{/status}}{{^status}}Default{{/status}}__
+
+* Description: {{description}}
+* Schema: [{{schema}}](#{{schemaAnchor}})
+
+{{/responses}}
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/model-html.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/model-html.mustache b/docs/src/main/resources/model-html.mustache
deleted file mode 100644
index 8672641..0000000
--- a/docs/src/main/resources/model-html.mustache
+++ /dev/null
@@ -1,38 +0,0 @@
-
-<div>
- <a name="{{name}}"/>
-</div>
-
-<div class="panel panel-default">
-
- <div class="panel-heading">
- <h2 class="panel-title model-heading">{{name}}
- <a data-toggle="collapse" data-target="#collapse-{{modelid}}"
- href="#collapse-{{modelid}}" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-{{modelid}}" class="panel-body collapse">
-
- <h3>Properties</h3>
-
- <table width="80%" class="table table-striped">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- {{#properties}}
- <tr>
- <td>{{name}}</td>
- <td>{{type}}</td>
- <td>{{description}}</td>
- <td>{{required}}</td>
- </tr>
- {{/properties}}
- </table>
-
- </div>
-
-</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/model.mustache b/docs/src/main/resources/model.mustache
deleted file mode 100644
index b58788b..0000000
--- a/docs/src/main/resources/model.mustache
+++ /dev/null
@@ -1,21 +0,0 @@
-
-### {{name}}
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- {{#properties}}
- <tr>
- <td>{{name}}</td>
- <td>{{type}}</td>
- <td>{{description}}</td>
- <td>{{required}}</td>
- </tr>
- {{/properties}}
-</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/operation-html.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/operation-html.mustache b/docs/src/main/resources/operation-html.mustache
deleted file mode 100644
index 6e15b1f..0000000
--- a/docs/src/main/resources/operation-html.mustache
+++ /dev/null
@@ -1,43 +0,0 @@
-
-<div class="panel panel-default">
-
- <div class="panel-heading {{method}}">
- <h2 class="panel-title {{method}}-heading">{{method}} {{url}}
- <a data-toggle="collapse" data-target="#collapse-{{opid}}"
- href="#collapse-{{opid}}" class="collapsed collapse-button"> </a>
- </h2>
- </div>
-
- <div id="collapse-{{opid}}" class="panel-body collapse">
-
- <p>{{description}}</p>
-
- <h3>Parameters</h3>
-
- <ul>
- {{#parameters}}
- <li>
- <b>{{name}}</b> ({{#type}}{{type}}{{/type}}{{#schemaRef}}
- <a href="#{{schemaAnchor}}">{{schemaRef}}</a>{{/schemaRef}}) <br>
- {{description}} (Specified in {{in}}).
- </li>
- {{/parameters}}
- </ul>
-
- <h3>Responses</h3>
-
- <ul>
- {{#responses}}
- <li>
- <b>{{#status}}{{status}}{{/status}}{{^status}}Default{{/status}}</b>
- <ul>
- <li>Description: {{description}}</li>
- <li>Schema: [<a href="#{{schemaAnchor}}">{{schema}}</a>]</li>
- </ul>
- </li>
- {{/responses}}
- </ul>
-
- </div>
- <!--<div class="panel-footer"></div>-->
-</div>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/src/main/resources/operation.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/operation.mustache b/docs/src/main/resources/operation.mustache
deleted file mode 100644
index cce0524..0000000
--- a/docs/src/main/resources/operation.mustache
+++ /dev/null
@@ -1,21 +0,0 @@
-
-<h2 class="usergrid-{{method}}-heading">{{method}} {{url}}</h2>
-
-{{description}}
-
-<h3>Parameters</h3>
-
-{{#parameters}}
-* __{{name}}__ ({{#type}}{{type}}{{/type}}{{#schemaRef}}[{{schemaRef}}](#{{schemaAnchor}}){{/schemaRef}})
-{{description}} (Specified in {{in}}).
-{{/parameters}}
-
-<h3>Responses</h3>
-
-{{#responses}}
-__{{#status}}{{status}}{{/status}}{{^status}}Default{{/status}}__
-
-* Description: {{description}}
-* Schema: [{{schema}}](#{{schemaAnchor}})
-
-{{/responses}}
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fc52c0e0/docs/update-api-docs.sh
----------------------------------------------------------------------
diff --git a/docs/update-api-docs.sh b/docs/update-api-docs.sh
index 0885773..d11db0b 100755
--- a/docs/update-api-docs.sh
+++ b/docs/update-api-docs.sh
@@ -1,4 +1,4 @@
#!/usr/bin/env bash
# Updating API Docs requires Mustache.java
-groovy src/main/groovy/ApiDocGenerator.groovy
+groovy src/main/groovy/usergrid/ApiDocGenerator.groovy