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:07:03 UTC
[26/29] incubator-usergrid git commit: Update website with latest
docs.
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__