http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/rest-endpoints/api-docs.md ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/api-docs.md b/docs/rest-endpoints/api-docs.md index 15de49f..176465f 100644 --- a/docs/rest-endpoints/api-docs.md +++ b/docs/rest-endpoints/api-docs.md @@ -1,45 +1,25 @@ +## Methods +## Action Methods> -# Methods - -## Organization Methods - -<h2 class="usergrid-POST-heading">POST /management/orgs</h2> - -Create an organization through a form post. - -<h3>Parameters</h3> - -* __CreateOrg__ ([CreateOrg](#createorg)) -A set of organization properties supplied through a form. (Specified in body). - -<h3>Responses</h3> - -__200__ - -* Description: An array of created Organization. -* Schema: [Organization](#organization) - -__default__ - -* Description: Unexpected error. -* Schema: [Error](#error) - - -<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2> -Retrieve an organization given a specified UUID or username. +Activate an organization from a link provIded in an email notification. <h3>Parameters</h3> -* __orgId__ ((string)) +* __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 created Organization. -* Schema: [Organization](#organization) +* Description: An array of complete messages. +* Schema: [Action](#action) __default__ @@ -47,20 +27,14 @@ __default__ * Schema: [Error](#error) -## Action Methods - -<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2> -Activate an organization from a link provIded in an email notification. +Reactivate an expired organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __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> @@ -75,14 +49,12 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2> +<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2> -Reactivate an expired organization. +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> @@ -125,7 +97,7 @@ Activate an admin user from a link provIded in an email notification. <h3>Parameters</h3> -* __userId__ ((string)) +* __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). @@ -151,7 +123,7 @@ Update an admin user's password through getting the newpassword and the old <h3>Parameters</h3> -* __userId__ ((string)) +* __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). @@ -175,7 +147,7 @@ Reactivate an expired admin user. <h3>Parameters</h3> -* __userId__ ((string)) +* __userId__ (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path). <h3>Responses</h3> @@ -197,11 +169,11 @@ Set a user's password or reset the user's existing password. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __username__ ((string)) +* __username__ (string) The username of the user. (Specified in path). * __ResetPW__ ([ResetPW](#resetpw)) The user's old and new password. (Specified in body). @@ -218,24 +190,23 @@ __default__ * Description: Unexpected error. * Schema: [Error](#error) +## ActivityFeed Methods> -## AppData Methods - -<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2> -Retrieve the applications in an organization through providing both Id of application and organization. +Retrieve an organization's activity feed. <h3>Parameters</h3> -* __orgId__ ((string)) +* __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) +* Description: An array of the organization's ActivityFeed. +* Schema: [ActivityFeed](#activityfeed) __default__ @@ -243,23 +214,21 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2> +<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2> -Remove an application from an organization through providing both Id of application and organization. +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). +* __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 application info. -* Schema: [AppData](#appdata) +* Description: An array of user's activity +* Schema: [ActivityFeed](#activityfeed) __default__ @@ -267,25 +236,27 @@ __default__ * Schema: [Error](#error) -## Credential Methods - -<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2> +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2> -Generate the client Id and client secret credentials for an application in an organization. +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)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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 generated credentials info. -* Schema: [Credential](#credential) +* Description: An array of user's activity. +* Schema: [ActivityFeed](#activityfeed) __default__ @@ -293,21 +264,25 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2> -Generate whole new credentials for an organization client. +Get a group's feed through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __groupId__ (string) +One of the group's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of Credential -* Schema: [Credential](#credential) +* Description: An array of group's activity. +* Schema: [ActivityFeed](#activityfeed) __default__ @@ -315,22 +290,26 @@ __default__ * Schema: [Error](#error) -## ActivityFeed Methods - -<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2> +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2> -Retrieve an organization's activity feed. +Create an activity in the activities collection. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). +* __CreateActivity__ ([CreateActivity](#createactivity)) +One or more sets of activity properties. (Specified in body). <h3>Responses</h3> __200__ -* Description: An array of the organization's ActivityFeed. +* Description: An array of user's activity. * Schema: [ActivityFeed](#activityfeed) __default__ @@ -339,20 +318,24 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2> -Retrieve an admin user's activity feed. +Retrieve a user's feed through providing all the identifications. <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). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of user's activity +* Description: An array of user's activity feed. * Schema: [ActivityFeed](#activityfeed) __default__ @@ -360,28 +343,23 @@ __default__ * Description: Unexpected error. * Schema: [Error](#error) +## AppData Methods> -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</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. +Retrieve the applications in an organization through providing both Id of application and organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __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 retrieved application data. +* Schema: [AppData](#appdata) __default__ @@ -389,53 +367,48 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2> +<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2> -Get a group's feed through providing all the identifications. +Remove an application from an organization through providing both Id of application and organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __groupId__ ((string)) -One of the group's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of group's activity. -* Schema: [ActivityFeed](#activityfeed) +* Description: An array of deleted application info. +* Schema: [AppData](#appdata) __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Credential Methods> -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2> -Create an activity in the activities collection. +Retrieve the client Id and client secret credentials for an application in an organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __userId-3__ ((string)) -One of the user's identification which includes username or UUID. (Specified in path). -* __CreateActivity__ ([CreateActivity](#createactivity)) -One or more sets of activity properties. (Specified in body). <h3>Responses</h3> __200__ -* Description: An array of user's activity. -* Schema: [ActivityFeed](#activityfeed) +* Description: An array of retrieved credentials info. +* Schema: [Credential](#credential) __default__ @@ -443,25 +416,23 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2> +<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2> -Retrieve a user's feed through providing all the identifications. +Generate the client Id and client secret credentials for an application in an organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __userId-3__ ((string)) -One of the user's identification which includes username or UUID. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of user's activity feed. -* Schema: [ActivityFeed](#activityfeed) +* Description: An array of generated credentials info. +* Schema: [Credential](#credential) __default__ @@ -469,23 +440,21 @@ __default__ * 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}/credentials</h2> -Retrieve details about the admin users in an organization. +Retrieve the credentials for an organization client. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of retrieved Admin user's info. -* Schema: [User](#user) +* Description: An array of Credential +* Schema: [Credential](#credential) __default__ @@ -493,67 +462,79 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2> +<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2> -Remove an admin user from an organization through providing both Id of application and organization. +Generate whole new credentials for an organization client. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __userId-2__ ((string)) -One of the user's identification which includes username, email address or UUID. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of deleted Admin user's info. -* Schema: [User](#user) +* Description: An array of Credential +* Schema: [Credential](#credential) __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Devices Methods> -<h2 class="usergrid-POST-heading">POST /management/users</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue</h2> -Create a whole new admin user. +Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications. <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). +* __notificationId__ (string) +One of the notification'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 retrieved device's info. +* Schema: [Device](#device) __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Entity Methods> -<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2> -Update the info of an admin user. +Retrieve a user's collections or connections through query statement. <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). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). +* __relation__ (string) +The relation between user and collections. (Specified in path). +* __queryStatement__ () +The query statement of the user. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of user's details. -* Schema: [User](#user) +* Description: An array of user's collections info. +* Schema: [Entity](#entity) __default__ @@ -561,27 +542,27 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2> -Delete user from a group through providing all the identifications. +Retrieve collection through query statement. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __collectionId__ (string) +One of the collection's identification which includes name or uuid. (Specified in path). +* __queryStatement__ () +Any values specified in the query statement should be enclosed in single-quotes. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of deleted user's info. -* Schema: [User](#user) +* Description: An array of retrieved collection's info. +* Schema: [Entity](#entity) __default__ @@ -589,25 +570,27 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2> +<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2> -Retrieve the users in a role through providing all the identifications. +Update collection through query statement. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __collectionId__ (string) +One of the collection's identification which includes name or uuid. (Specified in path). +* __queryStatement__ () +Any values specified in the query statement should be enclosed in single-quotes. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of retrieved user's info. -* Schema: [User](#user) +* Description: An array of updated collection's info. +* Schema: [Entity](#entity) __default__ @@ -615,27 +598,31 @@ __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}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2> -Remove a user from a role through providing all the identifications. +Add an entity to a collection through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __collectionId__ (string) +One of the collection's identification which includes name or uuid. (Specified in path). +* __entityId1__ (string) +The Id of the 1st entity. (Specified in path). +* __relation__ (string) +The relation between 1st entity and 2nd entity. (Specified in path). +* __entityId2__ (string) +The Id of the 2nd entity. (Specified in path). <h3>Responses</h3> __200__ -* Description: An array of deleted user's info. -* Schema: [User](#user) +* Description: An array of added entity's info. +* Schema: [Entity](#entity) __default__ @@ -643,25 +630,31 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2> +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2> -Create a user in the users collection through providing all the identifications. +Remove an entity from a collection through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __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 user's info. -* Schema: [User](#user) +* Description: An array of deleted entity's info. +* Schema: [Entity](#entity) __default__ @@ -669,25 +662,27 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2> -Update a user through providing all the identifications. +Retrieve an entity through providing Id of application, organization, collection and entity. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __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 updated user's info. -* Schema: [User](#user) +* Description: An array of retrieved entity's info. +* Schema: [Entity](#entity) __default__ @@ -695,18 +690,209 @@ __default__ * Schema: [Error](#error) -## Notification Methods - -<h2 class="usergrid-PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}</h2> +<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2> -Cancel sent notifications through providing the Id of the notification. +One or more properties can be updated with a single request. <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). +* __entityId__ (string) +One of the entity's identification which includes name or uuid. (Specified in path). +* __entityproperty__ ([CreateEntities](#createentities)) +The properties of the entity. (Specified in body). + +<h3>Responses</h3> + +__200__ + +* Description: An array of updated entity's info. +* Schema: [Entity](#entity) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2> + +Delete an entity from the collection. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __collectionId__ (string) +One of the collection's identification which includes name or uuid. (Specified in path). +* __entityId__ (string) +One of the entity's identification which includes name or uuid. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of deleted entity's info. +* Schema: [Entity](#entity) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2> + +When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __entitytype__ (string) +The entity type to create. (Specified in path). +* __entityproperty__ ([CreateEntities](#createentities)) +The properties of the entity. (Specified in body). + +<h3>Responses</h3> + +__200__ + +* Description: An array of created custom entity's info. +* Schema: [Entity](#entity) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + +## Event Methods> + +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2> + +Create an event through providing both Id of organization and application. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __CreateEvent__ ([CreateEvent](#createevent)) +The required property of the event. (Specified in body). + +<h3>Responses</h3> + +__200__ + +* Description: An array of created event's info. +* Schema: [Event](#event) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + +## Group Methods> + +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2> + +Create a new group through providing both Id of organization and application. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __groupproperty__ ([CreateGroup](#creategroup)) +The property of the created group. (Specified in body). + +<h3>Responses</h3> + +__200__ + +* Description: An array of created group's info. +* Schema: [Group](#group) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2> + +Get a group through through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __groupId__ (string) +One of the group's identification which includes name or uuid. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of retrieved group's info. +* Schema: [Group](#group) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2> + +Update a group through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __groupId__ (string) +One of the group's identification which includes name or uuid. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of updated group's info. +* Schema: [Group](#group) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + +## Notification Methods> + +<h2 class="usergrid-PUT-heading">PUT /my-org/sandbox/notifications/{notificationId}</h2> + +Cancel sent notifications through providing the Id of the notification. + +<h3>Parameters</h3> + +* __notificationId__ (string) +One of the notification's identification which includes name or uuid. (Specified in path). +* __cancelMsg__ ([CancelMSG](#cancelmsg)) +Indicete whether is canceled or not. (Specified in body). <h3>Responses</h3> @@ -727,9 +913,9 @@ Create notifications for user through targeting by location and providing all th <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). @@ -759,9 +945,9 @@ Create notifications for all devices. This request will target all device entiti <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). @@ -789,11 +975,11 @@ Create notifications for a single device. This request will target a specific de <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __deviceId__ ((string)) +* __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). @@ -821,11 +1007,11 @@ Create notifications for a group. This request will target all users associated <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __path__ ((string)) +* __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). @@ -853,9 +1039,9 @@ Retrieve one or more notifications through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -877,11 +1063,11 @@ Remove unsent notifications through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __notificationId__ ((string)) +* __notificationId__ (string) One of the notification's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -903,11 +1089,11 @@ Create notifications for a user. This request will target a specific user entity <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __userId-3__ ((string)) +* __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). @@ -935,11 +1121,11 @@ Retrieve notifications associated with one or more receipts through providing al <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __receiptId__ ((string)) +* __receiptId__ (string) One of the receipt's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -954,28 +1140,23 @@ __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Organization Methods> -## Event Methods - -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2> +<h2 class="usergrid-POST-heading">POST /management/orgs</h2> -Create an event through providing both Id of organization and application. +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). -* __CreateEvent__ ([CreateEvent](#createevent)) -The required property of the event. (Specified in body). +* __CreateOrg__ ([CreateOrg](#createorg)) +A set of organization properties supplied through a form. (Specified in body). <h3>Responses</h3> __200__ -* Description: An array of created event's info. -* Schema: [Event](#event) +* Description: An array of created Organization. +* Schema: [Organization](#organization) __default__ @@ -983,61 +1164,57 @@ __default__ * Schema: [Error](#error) -## Group Methods - -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2> -Create a new group through providing both Id of organization and application. +Retrieve an organization given a specified UUID or username. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) -One of the application's identification which includes name or uuid. (Specified in path). -* __groupproperty__ ([CreateGroup](#creategroup)) -The property of the created group. (Specified in body). <h3>Responses</h3> __200__ -* Description: An array of created group's info. -* Schema: [Group](#group) +* Description: An array of created Organization. +* Schema: [Organization](#organization) __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Permission Methods> -<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2> +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2> -Update a group through providing all the identifications. +Remove permissions from a role. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __roleId__ (string) +One of the role's identification which includes name or uuid. (Specified in path). +* __grant_url_pattern__ () +The query statement of the url pattern. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of updated group's info. -* Schema: [Group](#group) +* Description: An array of deleted permission's info. +* Schema: [Permission](#permission) __default__ * Description: Unexpected error. * Schema: [Error](#error) - -## Receipt Methods +## Receipt Methods> <h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/receipts</h2> @@ -1045,9 +1222,9 @@ Retrieve one or more receipts through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -1069,11 +1246,11 @@ Retrieve receipts associated with one or more devices through providing all the <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __deviceId__ ((string)) +* __deviceId__ (string) One of the device's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -1095,11 +1272,11 @@ Retrieve receipts for one or more notifications through providing all the identi <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __notificationId__ ((string)) +* __notificationId__ (string) One of the notification's identification which includes name or uuid. (Specified in path). <h3>Responses</h3> @@ -1114,8 +1291,31 @@ __default__ * Description: Unexpected error. * Schema: [Error](#error) +## Role Methods> + +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2> + +Retrieve the roles in an application through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of retrieved role's info. +* Schema: [Role](#role) + +__default__ -## Role Methods +* Description: Unexpected error. +* Schema: [Error](#error) + <h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2> @@ -1123,9 +1323,9 @@ Create a new role through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). @@ -1149,11 +1349,11 @@ Remove a role through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __appId__ (string) One of the application's identification which includes name or uuid. (Specified in path). -* __rolename__ ((string)) +* __rolename__ (string) The name of the role. (Specified in path). <h3>Responses</h3> @@ -1168,30 +1368,23 @@ __default__ * Description: Unexpected error. * Schema: [Error](#error) +## User Methods> -## Permission Methods - -<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2> +<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2> -Remove permissions from a role. +Retrieve details about the admin users in an organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) -One of the application's identification which includes name or uuid. (Specified in path). -* __roleId__ ((string)) -One of the role's identification which includes name or uuid. (Specified in path). -* __grant_url_pattern__ () -The query statement of the url pattern. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of deleted permission's info. -* Schema: [Permission](#permission) +* Description: An array of retrieved Admin user's info. +* Schema: [User](#user) __default__ @@ -1199,31 +1392,23 @@ __default__ * Schema: [Error](#error) -## Entity Methods - -<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2> +<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2> -Retrieve a user's collections or connections through query statement. +Remove an admin user from an organization through providing both Id of application and organization. <h3>Parameters</h3> -* __orgId__ ((string)) +* __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-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 user's collections info. -* Schema: [Entity](#entity) +* Description: An array of deleted Admin user's info. +* Schema: [User](#user) __default__ @@ -1231,27 +1416,93 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2> +<h2 class="usergrid-POST-heading">POST /management/users</h2> -Update collection through query statement. +Create a whole new admin user. + +<h3>Parameters</h3> + +* __adminuserproperty__ ([CreateAdminUser](#createadminuser)) +One or more sets of user properties of which username is mandatory and must be unique. (Specified in body). + +<h3>Responses</h3> + +__200__ + +* Description: An array of new created Admin user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2> + +Retrieve details about an admin user. + +<h3>Parameters</h3> + +* __userId__ (string) +One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of user's details +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2> + +Update the info of an admin user. <h3>Parameters</h3> -* __orgId__ ((string)) +* __userId__ (string) +One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of user's details. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2> + +Add a user to a group through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __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 updated collection's info. -* Schema: [Entity](#entity) +* Description: An array of added user's info. +* Schema: [User](#user) __default__ @@ -1259,31 +1510,27 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2> +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2> -Remove an entity from a collection through providing all the identifications. +Delete user from a group through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __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 entity's info. -* Schema: [Entity](#entity) +* Description: An array of deleted user's info. +* Schema: [User](#user) __default__ @@ -1291,29 +1538,25 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2> +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2> -One or more properties can be updated with a single request. +Retrieve the users in a role through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __roleId__ (string) +One of the role's identification which includes name or uuid. (Specified in path). <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__ @@ -1321,27 +1564,27 @@ __default__ * Schema: [Error](#error) -<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2> +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/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. +Add a user to a role through providing all the identifications. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __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 created custom entity's info. -* Schema: [Entity](#entity) +* Description: An array of added user's info. +* Schema: [User](#user) __default__ @@ -1349,27 +1592,53 @@ __default__ * Schema: [Error](#error) -## Devices Methods +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2> -<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue</h2> +Remove a user from a role through providing all the identifications. -Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications. +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __roleId__ (string) +One of the role's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of deleted user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2> + +Retrieve users though query statement. <h3>Parameters</h3> -* __orgId__ ((string)) +* __orgId__ (string) One of the organization's identification which includes name or uuid. (Specified in path). -* __appId__ ((string)) +* __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). +* __queryStatement__ () +The query statement of the User. (Specified in query). <h3>Responses</h3> __200__ -* Description: An array of retrieved device's info. -* Schema: [Device](#device) +* Description: An array of retrieved user's info. +* Schema: [User](#user) __default__ @@ -1377,28 +1646,114 @@ __default__ * Schema: [Error](#error) -# Models +<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2> -## CancelMSG +Create a user in the users collection through providing all the identifications. -__Properties__ +<h3>Parameters</h3> -<table width="80%" class="usergrid-table"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> - </tr> - <tr> - <td>canceled</td> - <td>boolean</td> - <td></td> - <td>true</td> - </tr> -</table> +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __CreateUser__ ([CreateUser](#createuser)) +The properties of the user. (Specified in body). -## Receipt +<h3>Responses</h3> + +__200__ + +* Description: An array of created user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2> + +Retrieve a user through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-2__ (string) +One of the user's identification which includes username, email address or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of retrieved user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2> + +Update a user through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of updated user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2> + +Remove a user through providing all the identifications. + +<h3>Parameters</h3> + +* __orgId__ (string) +One of the organization's identification which includes name or uuid. (Specified in path). +* __appId__ (string) +One of the application's identification which includes name or uuid. (Specified in path). +* __userId-3__ (string) +One of the user's identification which includes username or UUID. (Specified in path). + +<h3>Responses</h3> + +__200__ + +* Description: An array of deleted user's info. +* Schema: [User](#user) + +__default__ + +* Description: Unexpected error. +* Schema: [Error](#error) + + +## Models +Properties for Usergrid default entities. + +## Action __Properties__ @@ -1410,56 +1765,26 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>uuid</td> - <td>string</td> - <td>Unique entity Id.</td> - <td>false</td> - </tr> - <tr> - <td>type</td> - <td>string</td> - <td>Type of entity.</td> - <td>false</td> - </tr> - <tr> - <td>payloads</td> + <td>action</td> <td>string</td> - <td>The push notifications to be delivered.</td> + <td>The requested action.</td> <td>false</td> </tr> <tr> - <td>errorMessage</td> + <td>status</td> <td>string</td> - <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely.</td> + <td>The status of the requested action.</td> <td>false</td> </tr> <tr> - <td>errorCode</td> + <td>token</td> <td>string</td> - <td>Error code returned by the notification service.</td> - <td>false</td> - </tr> - <tr> - <td>sent</td> - <td>number</td> - <td>UTC timestamp in milliseconds for when the notification was sent.</td> - <td>false</td> - </tr> - <tr> - <td>metadata</td> - <td>ref</td> - <td></td> - <td>false</td> - </tr> - <tr> - <td>completeMsg</td> - <td>ref</td> - <td></td> + <td>The token required for getting an AdminUser.</td> <td>false</td> </tr> </table> -## Device +## ActivityFeed __Properties__ @@ -1471,76 +1796,50 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>uuid</td> - <td>string</td> - <td>Unique entity Id.</td> - <td>false</td> - </tr> - <tr> - <td>type</td> - <td>string</td> - <td>Type of entity.</td> + <td>entityproperty</td> + <td>ref</td> + <td></td> <td>false</td> </tr> <tr> - <td>name</td> + <td>category</td> <td>string</td> - <td>Notifier display name.</td> + <td>The category of the activity.</td> <td>false</td> </tr> <tr> - <td>metadata</td> + <td>metadataproperty</td> <td>ref</td> <td></td> <td>false</td> </tr> <tr> - <td>completeMsg</td> + <td>objectproperty</td> <td>ref</td> <td></td> <td>false</td> </tr> -</table> - -## ScheduleNotification - -__Properties__ - -<table width="80%" class="usergrid-table"> <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> - </tr> - <tr> - <td>timestamp</td> + <td>title</td> <td>string</td> - <td>UTC timestamp in milliseconds of when schedule notifications.</td> - <td>true</td> + <td>The title of the activity.</td> + <td>false</td> </tr> -</table> - -## SetExpiration - -__Properties__ - -<table width="80%" class="usergrid-table"> <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> + <td>verb</td> + <td>string</td> + <td>The verb of the activity.</td> + <td>false</td> </tr> <tr> - <td>timestamp</td> - <td>string</td> - <td>UTC timestamp in milliseconds of when set expirations.</td> - <td>true</td> + <td>completeMsg</td> + <td>ref</td> + <td></td> + <td>false</td> </tr> </table> -## Notification +## Actor __Properties__ @@ -1552,56 +1851,32 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>uuid</td> + <td>displayname</td> <td>string</td> - <td>Unique entity Id.</td> + <td>The display of the name of the actor.</td> <td>false</td> </tr> <tr> - <td>type</td> + <td>objecttype</td> <td>string</td> - <td>Type of entity.</td> + <td>The type of the actor.</td> <td>false</td> </tr> <tr> - <td>payloads</td> - <td>string</td> - <td>The push notifications to be delivered.</td> - <td>true</td> - </tr> - <tr> - <td>errorMessage</td> + <td>objectuuId</td> <td>string</td> - <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely.</td> - <td>false</td> - </tr> - <tr> - <td>scheduled</td> - <td>boolean</td> - <td>whether the notification is currently scheduled for delivery.</td> + <td>The UUID of the actor.</td> <td>false</td> </tr> <tr> - <td>state</td> + <td>entitytype</td> <td>string</td> - <td>The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'.</td> - <td>false</td> - </tr> - <tr> - <td>metadata</td> - <td>ref</td> - <td></td> - <td>false</td> - </tr> - <tr> - <td>completeMsg</td> - <td>ref</td> - <td></td> + <td>The entitytype of the actor.</td> <td>false</td> </tr> </table> -## Notifier +## AddPermission __Properties__ @@ -1613,57 +1888,20 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>uuid</td> - <td>string</td> - <td>Unique entity Id.</td> - <td>false</td> - </tr> - <tr> - <td>type</td> - <td>string</td> - <td>Type of entity.</td> - <td>false</td> - </tr> - <tr> - <td>name</td> - <td>string</td> - <td>Notifier display name.</td> - <td>false</td> - </tr> - <tr> - <td>provider</td> + <td>operation</td> <td>string</td> - <td>Push notification provider 'apple' or 'google'.</td> + <td>A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are allowed for the specified resource path.</td> <td>true</td> </tr> <tr> - <td>environment</td> + <td>resource_path</td> <td>string</td> - <td>The environment that corresponds to your app 'development' or 'production'.</td> + <td>The path to the resources to be accessed.</td> <td>true</td> </tr> - <tr> - <td>metadata</td> - <td>ref</td> - <td></td> - <td>false</td> - </tr> </table> -## CreateNotifications - -__Properties__ - -<table width="80%" class="usergrid-table"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> - </tr> -</table> - -## CreateNotification +## AddRole __Properties__ @@ -1674,21 +1912,21 @@ __Properties__ <th>Description</th> <th>Required</th> </tr> - <tr> - <td>notifier</td> - <td>ref</td> - <td></td> + <tr> + <td>title</td> + <td>string</td> + <td>The title of the role.</td> <td>true</td> </tr> <tr> - <td>message</td> + <td>role name</td> <td>string</td> - <td>The push notitfication message that will be delivered to the user.</td> + <td>The name of the role.</td> <td>true</td> </tr> </table> -## Permission +## AdminUserUpdate __Properties__ @@ -1700,50 +1938,57 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>applicationName</td> + <td>city</td> <td>string</td> - <td>The name of the application of the permission.</td> + <td></td> <td>false</td> </tr> <tr> - <td>entity</td> - <td>ref</td> + <td>state</td> + <td>string</td> <td></td> <td>false</td> </tr> +</table> + +## AppData + +__Properties__ + +<table width="80%" class="usergrid-table"> <tr> - <td>url</td> - <td>string</td> - <td>The url of the permission.</td> - <td>false</td> + <th>Name</th> + <th>Type</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td>applicationId</td> + <td>tester/sandbox</td> <td>string</td> - <td>The UUID of the application.</td> + <td>The UUID of tester/sandbox.</td> <td>false</td> </tr> <tr> - <td>parameters</td> + <td>tester/app1</td> <td>string</td> - <td>The parameters of the permission.</td> + <td>The UUID of tester/app1.</td> <td>false</td> </tr> <tr> - <td>organization</td> + <td>tester/app2</td> <td>string</td> - <td>The organization of the permission.</td> + <td>The UUID of tester/app2.</td> <td>false</td> </tr> <tr> - <td>permissiondata</td> + <td>completeMsg</td> <td>ref</td> <td></td> <td>false</td> </tr> </table> -## AddPermission +## CancelMSG __Properties__ @@ -1755,20 +2000,14 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>operation</td> - <td>string</td> - <td>A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are allowed for the specified resource path.</td> - <td>true</td> - </tr> - <tr> - <td>resource_path</td> - <td>string</td> - <td>The path to the resources to be accessed.</td> + <td>canceled</td> + <td>boolean</td> + <td></td> <td>true</td> </tr> </table> -## Role +## Collections __Properties__ @@ -1780,56 +2019,32 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>applicationName</td> + <td>activities</td> <td>string</td> - <td>The application name of the event.</td> - <td>false</td> - </tr> - <tr> - <td>entity</td> - <td>ref</td> <td></td> <td>false</td> </tr> <tr> - <td>url</td> - <td>string</td> - <td>The url of the event.</td> - <td>false</td> - </tr> - <tr> - <td>applicationId</td> - <td>string</td> - <td>The application UUID of the event.</td> - <td>false</td> - </tr> - <tr> - <td>parameters</td> + <td>feed</td> <td>string</td> - <td>The parameters of the event.</td> + <td></td> <td>false</td> </tr> <tr> - <td>organization</td> + <td>roles</td> <td>string</td> - <td>The title of the organization.</td> - <td>false</td> - </tr> - <tr> - <td>completeMsg</td> - <td>ref</td> <td></td> <td>false</td> </tr> <tr> - <td>path</td> + <td>users</td> <td>string</td> - <td>The path of the role.</td> + <td></td> <td>false</td> </tr> </table> -## AddRole +## CreateActivity __Properties__ @@ -1841,20 +2056,44 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>title</td> + <td>displayName</td> <td>string</td> - <td>The title of the role.</td> + <td></td> <td>true</td> </tr> <tr> - <td>role name</td> + <td>uuid</td> <td>string</td> - <td>The name of the role.</td> + <td></td> + <td>true</td> + </tr> + <tr> + <td>username</td> + <td>string</td> + <td></td> + <td>true</td> + </tr> + <tr> + <td>image</td> + <td>ref</td> + <td></td> + <td>false</td> + </tr> + <tr> + <td>verb</td> + <td>string</td> + <td></td> + <td>true</td> + </tr> + <tr> + <td>content</td> + <td>string</td> + <td></td> <td>true</td> </tr> </table> -## Event +## CreateAdminUser __Properties__ @@ -1866,50 +2105,32 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>applicationName</td> + <td>username</td> <td>string</td> - <td>The application name of the event.</td> - <td>false</td> - </tr> - <tr> - <td>entity</td> - <td>ref</td> <td></td> - <td>false</td> - </tr> - <tr> - <td>url</td> - <td>string</td> - <td>The url of the event.</td> - <td>false</td> + <td>true</td> </tr> <tr> - <td>applicationId</td> + <td>email</td> <td>string</td> - <td>The application UUID of the event.</td> + <td></td> <td>false</td> </tr> <tr> - <td>parameters</td> + <td>name</td> <td>string</td> - <td>The parameters of the event.</td> + <td></td> <td>false</td> </tr> <tr> - <td>organization</td> + <td>password</td> <td>string</td> - <td>The title of the organization.</td> - <td>false</td> - </tr> - <tr> - <td>completeMsg</td> - <td>ref</td> <td></td> <td>false</td> </tr> </table> -## CreateEvent +## CreateApp __Properties__ @@ -1921,14 +2142,20 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>timestamp</td> + <td>token</td> <td>string</td> - <td></td> + <td>The OAuth2 access token.</td> + <td>true</td> + </tr> + <tr> + <td>name</td> + <td>string</td> + <td>The name of the application.</td> <td>true</td> </tr> </table> -## Group +## CreateEntities __Properties__ @@ -1939,53 +2166,49 @@ __Properties__ <th>Description</th> <th>Required</th> </tr> +</table> + +## CreateEntity + +__Properties__ + +<table width="80%" class="usergrid-table"> <tr> - <td>uuid</td> - <td>string</td> - <td>The UUID of the group.</td> - <td>false</td> - </tr> - <tr> - <td>type</td> - <td>string</td> - <td>The type of the group.</td> - <td>false</td> - </tr> - <tr> - <td>created</td> - <td>string</td> - <td>The created Id for the group.</td> - <td>false</td> + <th>Name</th> + <th>Type</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td>modified</td> + <td>property</td> <td>string</td> - <td>The modified Id for the group.</td> + <td>The property of the entity.</td> <td>false</td> </tr> <tr> - <td>path</td> + <td>value</td> <td>string</td> - <td>The path of the group.</td> + <td>The relevant value of the property.</td> <td>false</td> </tr> +</table> + +## CreateEvent + +__Properties__ + +<table width="80%" class="usergrid-table"> <tr> - <td>metadata</td> - <td>ref</td> - <td></td> - <td>false</td> + <th>Name</th> + <th>Type</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td>title</td> + <td>timestamp</td> <td>string</td> - <td>The title of the group.</td> - <td>false</td> - </tr> - <tr> - <td>completeMsg</td> - <td>ref</td> <td></td> - <td>false</td> + <td>true</td> </tr> </table> @@ -2014,20 +2237,7 @@ __Properties__ </tr> </table> -## CreateEntities - -__Properties__ - -<table width="80%" class="usergrid-table"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> - </tr> -</table> - -## CreateEntity +## CreateNotification __Properties__ @@ -2039,20 +2249,20 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>property</td> - <td>string</td> - <td>The property of the entity.</td> - <td>false</td> + <td>notifier</td> + <td>ref</td> + <td></td> + <td>true</td> </tr> <tr> - <td>value</td> + <td>message</td> <td>string</td> - <td>The relevant value of the property.</td> - <td>false</td> + <td>The push notitfication message that will be delivered to the user.</td> + <td>true</td> </tr> </table> -## Entity +## CreateNotifications __Properties__ @@ -2063,45 +2273,52 @@ __Properties__ <th>Description</th> <th>Required</th> </tr> +</table> + +## CreateOrg + +__Properties__ + +<table width="80%" class="usergrid-table"> <tr> - <td>uuid</td> - <td>string</td> - <td>The UUID of the entity.</td> - <td>false</td> + <th>Name</th> + <th>Type</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td>type</td> + <td>organization</td> <td>string</td> - <td>The type of the entity.</td> - <td>false</td> + <td></td> + <td>true</td> </tr> <tr> - <td>actorproperty</td> - <td>ref</td> + <td>username</td> + <td>string</td> <td></td> - <td>false</td> + <td>true</td> </tr> <tr> - <td>metadata</td> - <td>ref</td> + <td>name</td> + <td>string</td> <td></td> - <td>false</td> + <td>true</td> </tr> <tr> - <td>name</td> + <td>email</td> <td>string</td> - <td>The name of the entity.</td> - <td>false</td> + <td></td> + <td>true</td> </tr> <tr> - <td>message</td> + <td>password</td> <td>string</td> <td></td> - <td>false</td> + <td>true</td> </tr> </table> -## CreateApp +## CreateUser __Properties__ @@ -2113,15 +2330,9 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>token</td> - <td>string</td> - <td>The OAuth2 access token.</td> - <td>true</td> - </tr> - <tr> - <td>name</td> + <td>username</td> <td>string</td> - <td>The name of the application.</td> + <td></td> <td>true</td> </tr> </table> @@ -2157,7 +2368,7 @@ __Properties__ </tr> </table> -## Organization +## Device __Properties__ @@ -2169,92 +2380,87 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>applicationId</td> + <td>uuid</td> <td>string</td> - <td>The application Id of the owner.</td> + <td>Unique entity Id.</td> <td>false</td> </tr> <tr> - <td>username</td> + <td>type</td> <td>string</td> - <td>The username of the owner.</td> + <td>Type of entity.</td> <td>false</td> </tr> <tr> <td>name</td> <td>string</td> - <td>The name of the owner.</td> + <td>Notifier display name.</td> <td>false</td> </tr> <tr> - <td>email</td> - <td>string</td> - <td>The email of the owner.</td> + <td>metadata</td> + <td>ref</td> + <td></td> <td>false</td> </tr> <tr> - <td>activated</td> - <td>boolean</td> - <td>Indicate whether the account is activated or not.</td> + <td>completeMsg</td> + <td>ref</td> + <td></td> <td>false</td> </tr> +</table> + +## Entity + +__Properties__ + +<table width="80%" class="usergrid-table"> <tr> - <td>disabled</td> - <td>boolean</td> - <td>Indicate whether the account is disabled or not.</td> - <td>false</td> + <th>Name</th> + <th>Type</th> + <th>Description</th> + <th>Required</th> </tr> <tr> <td>uuid</td> <td>string</td> - <td>The UUID of the owner.</td> - <td>false</td> - </tr> - <tr> - <td>adminUser</td> - <td>boolean</td> - <td>Indicate whether the use is a adminUser or not.</td> + <td>The UUID of the entity.</td> <td>false</td> </tr> <tr> - <td>displayEmail</td> + <td>type</td> <td>string</td> - <td>The display of the email of the owner.</td> + <td>The type of the entity.</td> <td>false</td> </tr> <tr> - <td>htmldisplayEmail</td> - <td>string</td> - <td>The HTML display of the email of the owner.</td> + <td>actorproperty</td> + <td>ref</td> + <td></td> <td>false</td> </tr> <tr> - <td>orgname</td> - <td>string</td> - <td>The name of the organization.</td> + <td>metadata</td> + <td>ref</td> + <td></td> <td>false</td> </tr> <tr> - <td>orguuId</td> + <td>name</td> <td>string</td> - <td>The UUID of the organization.</td> - <td>false</td> - </tr> - <tr> - <td>applicationdata</td> - <td>ref</td> - <td></td> + <td>The name of the entity.</td> <td>false</td> </tr> <tr> - <td>completeMsg</td> - <td>ref</td> + <td>message</td> + <td>string</td> <td></td> <td>false</td> </tr> </table> -## AppData +## Error __Properties__ @@ -2266,32 +2472,26 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>tester/sandbox</td> - <td>string</td> - <td>The UUID of tester/sandbox.</td> - <td>false</td> - </tr> - <tr> - <td>tester/app1</td> - <td>string</td> - <td>The UUID of tester/app1.</td> + <td>code</td> + <td>integer</td> + <td></td> <td>false</td> </tr> <tr> - <td>tester/app2</td> + <td>message</td> <td>string</td> - <td>The UUID of tester/app2.</td> + <td></td> <td>false</td> </tr> <tr> - <td>completeMsg</td> - <td>ref</td> + <td>fields</td> + <td>object</td> <td></td> <td>false</td> </tr> </table> -## CreateOrg +## Event __Properties__ @@ -2303,38 +2503,50 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>organization</td> + <td>applicationName</td> <td>string</td> + <td>The application name of the event.</td> + <td>false</td> + </tr> + <tr> + <td>entity</td> + <td>ref</td> <td></td> - <td>true</td> + <td>false</td> </tr> <tr> - <td>username</td> + <td>url</td> <td>string</td> - <td></td> - <td>true</td> + <td>The url of the event.</td> + <td>false</td> </tr> <tr> - <td>name</td> + <td>applicationId</td> <td>string</td> - <td></td> - <td>true</td> + <td>The application UUID of the event.</td> + <td>false</td> </tr> <tr> - <td>email</td> + <td>parameters</td> <td>string</td> - <td></td> - <td>true</td> + <td>The parameters of the event.</td> + <td>false</td> </tr> <tr> - <td>password</td> + <td>organization</td> <td>string</td> + <td>The title of the organization.</td> + <td>false</td> + </tr> + <tr> + <td>completeMsg</td> + <td>ref</td> <td></td> - <td>true</td> + <td>false</td> </tr> </table> -## CreateActivity +## Group __Properties__ @@ -2346,40 +2558,52 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>displayName</td> + <td>uuid</td> <td>string</td> - <td></td> - <td>true</td> + <td>The UUID of the group.</td> + <td>false</td> </tr> <tr> - <td>uuid</td> + <td>type</td> <td>string</td> - <td></td> - <td>true</td> + <td>The type of the group.</td> + <td>false</td> </tr> <tr> - <td>username</td> + <td>created</td> <td>string</td> - <td></td> - <td>true</td> + <td>The created Id for the group.</td> + <td>false</td> </tr> <tr> - <td>image</td> - <td>ref</td> - <td></td> + <td>modified</td> + <td>string</td> + <td>The modified Id for the group.</td> <td>false</td> </tr> <tr> - <td>verb</td> + <td>path</td> <td>string</td> + <td>The path of the group.</td> + <td>false</td> + </tr> + <tr> + <td>metadata</td> + <td>ref</td> <td></td> - <td>true</td> + <td>false</td> </tr> <tr> - <td>content</td> + <td>title</td> <td>string</td> + <td>The title of the group.</td> + <td>false</td> + </tr> + <tr> + <td>completeMsg</td> + <td>ref</td> <td></td> - <td>true</td> + <td>false</td> </tr> </table> @@ -2414,7 +2638,7 @@ __Properties__ </tr> </table> -## ResetPWMsg +## Metadata __Properties__ @@ -2426,26 +2650,32 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>recaptcha_response</td> + <td>cursor</td> <td>string</td> - <td>Parameters and value for the Captcha challenge.</td> - <td>true</td> + <td>The cursor of the metadata.</td> + <td>false</td> </tr> <tr> - <td>recaptcha_challenge</td> + <td>path</td> <td>string</td> - <td>The admin user's response to the Captcha challenge.</td> - <td>true</td> + <td>The path of the metadata.</td> + <td>false</td> </tr> <tr> - <td>email</td> - <td>string</td> + <td>sets</td> + <td>ref</td> <td></td> - <td>true</td> + <td>false</td> + </tr> + <tr> + <td>collections</td> + <td>ref</td> + <td></td> + <td>false</td> </tr> </table> -## ResetPW +## Notification __Properties__ @@ -2457,45 +2687,56 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>password</td> + <td>uuid</td> <td>string</td> - <td></td> - <td>true</td> + <td>Unique entity Id.</td> + <td>false</td> </tr> <tr> - <td>newpassword</td> + <td>type</td> <td>string</td> - <td></td> - <td>true</td> + <td>Type of entity.</td> + <td>false</td> </tr> -</table> - -## AdminUserUpdate - -__Properties__ - -<table width="80%" class="usergrid-table"> <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>Required</th> + <td>payloads</td> + <td>string</td> + <td>The push notifications to be delivered.</td> + <td>true</td> </tr> <tr> - <td>city</td> + <td>errorMessage</td> <td>string</td> - <td></td> + <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely.</td> + <td>false</td> + </tr> + <tr> + <td>scheduled</td> + <td>boolean</td> + <td>whether the notification is currently scheduled for delivery.</td> <td>false</td> </tr> <tr> <td>state</td> <td>string</td> + <td>The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'.</td> + <td>false</td> + </tr> + <tr> + <td>metadata</td> + <td>ref</td> + <td></td> + <td>false</td> + </tr> + <tr> + <td>completeMsg</td> + <td>ref</td> <td></td> <td>false</td> </tr> </table> -## CreateAdminUser +## Notifier __Properties__ @@ -2507,32 +2748,44 @@ __Properties__ <th>Required</th> </tr> <tr> - <td>username</td> + <td>uuid</td> <td>string</td> - <td></td> - <td>true</td> + <td>Unique entity Id.</td> + <td>false</td> </tr> <tr> - <td>email</td> + <td>type</td> <td>string</td> - <td></td> + <td>Type of entity.</td> <td>false</td> </tr> <tr> <td>name</td> <td>string</td> - <td></td> + <td>Notifier display name.</td
<TRUNCATED> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/sdks/tbd.md ---------------------------------------------------------------------- diff --git a/docs/sdks/tbd.md b/docs/sdks/tbd.md index f65681d..279d128 100644 --- a/docs/sdks/tbd.md +++ b/docs/sdks/tbd.md @@ -1 +1 @@ -# Coming soon... \ No newline at end of file +# COMING SOON... \ No newline at end of file
