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/12 19:14:38 UTC
[43/60] [abbrv] incubator-usergrid git commit: Adding in missing
section references, still more work to do on this.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/rest-endpoints/api-docs.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.md b/docs/rest-endpoints/api-docs.md
index 93a6e32..fa39d59 100644
--- a/docs/rest-endpoints/api-docs.md
+++ b/docs/rest-endpoints/api-docs.md
@@ -1,161 +1,21 @@
## Methods
-### Action Methods
+### Access-Tokens 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>
+<h2 class="usergrid-POST-heading">POST /management/token</h2>
-* __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.
+Login with Admin-User or Organization 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 complete messages.
-* Schema: [Action](#action)
+* Description: Object containing access_token.
+* Schema: [AccessTokenReponse](#accesstokenreponse)
__default__
@@ -163,106 +23,28 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
-Set a user's password or reset the user's existing password.
+Login with App-User or Application credentials.
<h3>Parameters</h3>
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __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).
+* __login-credentials__ ([LoginCredentials](#logincredentials))
+Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of complete messages.
-* Schema: [Action](#action)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-### ActivityFeed Methods
-
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
-
-Retrieve an organization's activity feed.
-
-<h3>Parameters</h3>
-
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#activityfeed)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-
-<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
-
-Retrieve an admin user's activity feed.
-
-<h3>Parameters</h3>
-
-* __userId__ (string)
-One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of user's activity
-* Schema: [ActivityFeed](#activityfeed)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
-
-Create an activity to a specific group. In this case the activity is created in the activities collection and is accessible at the /activities endpoint to users who have the permission to read that endpoint. In addition, a relationship is established between the activity and the group, and because of that, the activity will appear in the group’s feed. The group 'owns' the activity. Also, the activity will be published in the feed of all users that are members of the group.
-
-<h3>Parameters</h3>
-
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __groupId__ (string)
-One of the group's identification which includes name or uuid. (Specified in path).
-* __CreateActivity__ ([CreateActivity](#createactivity))
-One or more sets of activity properties. (Specified in body).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description: An array of new created Admin user's info.
+* Schema: [AccessTokenReponse](#accesstokenreponse)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
+### Activities Methods
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2>
@@ -343,96 +125,23 @@ __default__
* Description: Unexpected error.
* Schema: [Error](#error)
-### AppData Methods
+### Admin-Users Methods
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
-
-Retrieve the applications in an organization through providing both Id of application and organization.
-
-<h3>Parameters</h3>
-
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of retrieved application data.
-* Schema: [AppData](#appdata)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-
-<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
-
-Remove an application from an organization through providing both Id of application and organization.
-
-<h3>Parameters</h3>
-
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of deleted application info.
-* Schema: [AppData](#appdata)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-### Credential Methods
-
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
-
-Retrieve the client Id and client secret credentials for an application in an organization.
-
-<h3>Parameters</h3>
-
-* __orgId__ (string)
-One of the organization's identification which includes name or uuid. (Specified in path).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-
-<h3>Responses</h3>
-
-__200__
-
-* Description: An array of retrieved credentials info.
-* Schema: [Credential](#credential)
-
-__default__
-
-* Description: Unexpected error.
-* Schema: [Error](#error)
-
-
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
-Generate 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 generated credentials info.
-* Schema: [Credential](#credential)
+* Description: An array of retrieved Admin user's info.
+* Schema: [User](#user)
__default__
@@ -440,21 +149,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
-Retrieve the credentials for an organization client.
+Remove an admin user from an organization through providing both Id of application and organization.
<h3>Parameters</h3>
* __orgId__ (string)
One of the organization's identification which includes name or uuid. (Specified in path).
+* __userId-2__ (string)
+One of the user's identification which includes username, email address or UUID. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Description: An array of deleted Admin user's info.
+* Schema: [User](#user)
__default__
@@ -462,79 +173,63 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
+<h2 class="usergrid-POST-heading">POST /management/users</h2>
-Generate whole new 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__
* Description: Unexpected error.
* Schema: [Error](#error)
-### Devices Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue</h2>
+<h2 class="usergrid-GET-heading">GET /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.
+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).
-* __appId__ (string)
-One of the application's identification which includes name or uuid. (Specified in path).
-* __notificationId__ (string)
-One of the notification's identification which includes name or uuid. (Specified in path).
<h3>Responses</h3>
__200__
-* Description: An array of retrieved device's info.
-* Schema: [Device](#device)
+* 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-POST-heading">POST /management/users/resetpw</h2>
-Retrieve a user's collections or connections through query statement.
+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).
-* __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).
+* __ResetPWMsg__ ([ResetPWMsg](#resetpwmsg))
+Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of user's collections info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -542,27 +237,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
-Retrieve collection 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).
-* __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 +259,21 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
-Update 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 updated collection's info.
-* Schema: [Entity](#entity)
+* Description: An array of user's details.
+* Schema: [User](#user)
__default__
@@ -598,31 +281,25 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
-Add an entity to a collection through providing all the identifications.
+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).
-* __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).
+* __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 added entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -630,31 +307,23 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
-Remove an entity from 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 deleted entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
@@ -662,37 +331,32 @@ __default__
* Schema: [Error](#error)
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
-Retrieve an entity through providing Id of application, organization, collection and entity.
+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).
-* __entityId__ (string)
-One of the entity'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 entity's info.
-* Schema: [Entity](#entity)
+* Description: An array of complete messages.
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
* Schema: [Error](#error)
+### App-Users Methods
-<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 +364,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 +380,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 +390,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 +406,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 +416,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 +442,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 +468,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 +484,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,25 +494,28 @@ 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__
* Description: Unexpected error.
* Schema: [Error](#error)
+### Entities-Collections Methods
-<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
-Update a group through providing all the identifications.
+Retrieve a user's collections or connections through query statement.
<h3>Parameters</h3>
@@ -866,40 +523,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 +571,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 +581,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 +599,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 +609,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 +631,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 +641,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 +663,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 +673,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 +691,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 +701,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 +721,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 +731,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 +749,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,31 +759,28 @@ 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__
* Description: Unexpected error.
* Schema: [Error](#error)
+### Events Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{receiptId}/*/notifications</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
-Retrieve notifications associated with one or more receipts through providing all the identifications.
+Create an event through providing both Id of organization and application.
<h3>Parameters</h3>
@@ -1125,38 +788,42 @@ 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
+### Groups Methods
-<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
-Create an organization through a form post.
+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 +831,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 +869,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 +897,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 +915,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 +925,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 +941,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 +951,38 @@ 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
+### Organizations-Applications Methods
-<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
-Retrieve the roles in an application through providing all the identifications.
+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 +990,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 +1012,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 +1051,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 +1060,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 +1084,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 +1108,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 +1130,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 +1152,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 +1174,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,35 +1196,32 @@ __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__
* Description: Unexpected error.
* Schema: [Error](#error)
+### Permissions-Roles Methods
-<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
-Add a user to a role through providing all the identifications.
+Retrieve the roles in an application through providing all the identifications.
<h3>Parameters</h3>
@@ -1574,17 +1229,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 +1243,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 +1253,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 +1269,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 +1279,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 +1297,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 +1307,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 +1323,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 +1333,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 +1351,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 +1361,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 +1370,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 +1379,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 +1389,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 +1408,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 +2324,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__
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/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 34ec664..600e09a 100644
--- a/docs/security-and-auth/using-permissions.md
+++ b/docs/security-and-auth/using-permissions.md
@@ -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/c4116fa2/docs/user-management/activity.md
----------------------------------------------------------------------
diff --git a/docs/user-management/activity.md b/docs/user-management/activity.md
index 2703ab8..f477be8 100644
--- a/docs/user-management/activity.md
+++ b/docs/user-management/activity.md
@@ -131,13 +131,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 +223,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/c4116fa2/docs/user-management/group.md
----------------------------------------------------------------------
diff --git a/docs/user-management/group.md b/docs/user-management/group.md
index 4f76cb6..a48606b 100644
--- a/docs/user-management/group.md
+++ b/docs/user-management/group.md
@@ -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/c4116fa2/docs/user-management/messagee-example.md
----------------------------------------------------------------------
diff --git a/docs/user-management/messagee-example.md b/docs/user-management/messagee-example.md
index eb3e560..1401d8c 100644
--- a/docs/user-management/messagee-example.md
+++ b/docs/user-management/messagee-example.md
@@ -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/c4116fa2/docs/user-management/working-user-data.md
----------------------------------------------------------------------
diff --git a/docs/user-management/working-user-data.md b/docs/user-management/working-user-data.md
index a7603fd..5e2b63d 100644
--- a/docs/user-management/working-user-data.md
+++ b/docs/user-management/working-user-data.md
@@ -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.