Methods¶
Action Methods
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/orgs/{orgId}/activate
.. raw:: html
</h2>
Activate an organization from a link provIded in an email notification.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/orgs/{orgId}/reactivate
.. raw:: html
</h2>
Reactivate an expired organization.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/users/resetpw
.. raw:: html
</h2>
Initiate the reset of an admin user's password.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /management/users/resetpw
.. raw:: html
</h2>
Complete the password reset through getting the newpassword and the old
one for identification.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/users/{userId}/activate
.. raw:: html
</h2>
Activate an admin user from a link provIded in an email notification.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /management/users/{userId}/password
.. raw:: html
</h2>
Update an admin user's password through getting the newpassword and the
old one for identification.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/users/{userId}/reactivate
.. raw:: html
</h2>
Reactivate an expired admin user.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **userId** (string) One of the user's identification which includes
username, real name, email address or UUID. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/users/{user}/password
.. raw:: html
</h2>
Set a user's password or reset the user's existing password.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of complete messages.
- Schema: `Action <#action>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
ActivityFeed Methods
.. raw:: html
GET /management/orgs/{orgId}/feed
.. raw:: html
Retrieve an organization’s activity feed.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of the organization’s ActivityFeed.
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /management/users/{userId}/feed
.. raw:: html
Retrieve an admin user’s activity feed.
.. raw:: html
Parameters
.. raw:: html
- userId (string) One of the user’s identification which includes username, real name, email address or UUID. (Specified in path).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of user’s activity
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/groups/{groupId}/activities
.. raw:: html
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.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of user’s activity.
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /{orgId}/{appId}/groups/{groupId}/feed
.. raw:: html
Get a group’s feed through providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of group’s activity.
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/users/{userId}/activities
.. raw:: html
Create an activity in the activities collection.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of user’s activity.
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /{orgId}/{appId}/users/{userId}/feed
.. raw:: html
Retrieve a user’s feed through providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of user’s activity feed.
- Schema:
ActivityFeed <#activityfeed>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
AppData Methods
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/orgs/{orgId}/apps
.. raw:: html
</h2>
Retrieve the applications in an organization through providing both Id
of application and organization.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved application data.
- Schema: `AppData <#appdata>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /management/orgs/{orgId}/apps/{appId}
.. raw:: html
</h2>
Remove an application from an organization through providing both Id of
application and organization.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted application info.
- Schema: `AppData <#appdata>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Credential Methods
.. raw:: html
GET /management/orgs/{orgId}/apps/{appId}/credentials
.. raw:: html
Retrieve the client Id and client secret credentials for an application in an organization.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of retrieved credentials info.
- Schema:
Credential <#credential>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /management/orgs/{orgId}/apps/{appId}/credentials
.. raw:: html
Generate the client Id and client secret credentials for an application in an organization.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of generated credentials info.
- Schema:
Credential <#credential>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /management/orgs/{orgId}/credentials
.. raw:: html
Retrieve the credentials for an organization client.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of Credential
- Schema:
Credential <#credential>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /management/orgs/{orgId}/credentials
.. raw:: html
Generate whole new credentials for an organization client.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of Credential
- Schema:
Credential <#credential>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
Devices Methods
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/{notificationId}/\*/queue
.. raw:: html
</h2>
Retrieve the list of devices associated with one or more notifications
before the notifications are sent through providing all the
identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved device's info.
- Schema: `Device <#device>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Entity Methods
~~~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/users/{userId}/{relation}
.. raw:: html
</h2>
Retrieve a user's collections or connections through query statement.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of user's collections info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/{collectionId}
.. raw:: html
</h2>
Retrieve collection through query statement.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved collection's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /{orgId}/{appId}/{collectionId}
.. raw:: html
</h2>
Update collection through query statement.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of updated collection's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
.. raw:: html
</h2>
Add an entity to a collection through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of added entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE
/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
.. raw:: html
</h2>
Remove an entity from a collection through providing all the
identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/{collectionId}/{entityId}
.. raw:: html
</h2>
Retrieve an entity through providing Id of application, organization,
collection and entity.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /{orgId}/{appId}/{collectionId}/{entityId}
.. raw:: html
</h2>
One or more properties can be updated with a single request.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
- **appId** (string) One of the application's identification which
includes name or uuid. (Specified in path).
- **collectionId** (string) One of the collection's identification
which includes name or uuid. (Specified in path).
- **entityId** (string) One of the entity's identification which
includes name or uuid. (Specified in path).
- **entityproperty** (`CreateEntities <#createentities>`__) The
properties of the entity. (Specified in body).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of updated entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/{collectionId}/{entityId}
.. raw:: html
</h2>
Delete an entity from the collection.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/{entitytype}
.. raw:: html
</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.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created custom entity's info.
- Schema: `Entity <#entity>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Event Methods
~~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/events
.. raw:: html
</h2>
Create an event through providing both Id of organization and
application.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created event's info.
- Schema: `Event <#event>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Group Methods
~~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/groups
.. raw:: html
</h2>
Create a new group through providing both Id of organization and
application.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created group's info.
- Schema: `Group <#group>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{org\_Id}/{app\_Id}/groups/{groupId}
.. raw:: html
</h2>
Get a group through through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved group's info.
- Schema: `Group <#group>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /{org\_Id}/{app\_Id}/groups/{groupId}
.. raw:: html
</h2>
Update a group through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of updated group's info.
- Schema: `Group <#group>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Notification Methods
.. raw:: html
PUT /my-org/sandbox/notifications/{notificationId}
.. raw:: html
Cancel sent notifications through providing the Id of the notification.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of canceled notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/devices
.. raw:: html
Create notifications for user through targeting by location and providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- notification (
CreateNotifications <#createnotifications>__) These parameters are used when forming the notification portion of the request. (Specified in body). - scheduleNotification
(
ScheduleNotification <#schedulenotification>__) To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). - setExpiration (
SetExpiration <#setexpiration>__) If a push service can’t deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). - queryStatement () The query statement of the location of the user. (Specified in query).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of created notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/devices/*/notifications
.. raw:: html
Create notifications for all devices. This request will target all device entities.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- notification (
CreateNotifications <#createnotifications>__) These parameters are used when forming the notification portion of the request. (Specified in body). - scheduleNotification
(
ScheduleNotification <#schedulenotification>__) To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). - setExpiration (
SetExpiration <#setexpiration>__) If a push service can’t deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of created notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/devices/{deviceId}/notifications
.. raw:: html
Create notifications for a single device. This request will target a specific device entity.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- deviceId (string) One of the device’s identification which includes name or uuid. (Specified in path).
- notification (
CreateNotifications <#createnotifications>__) These parameters are used when forming the notification portion of the request. (Specified in body). - scheduleNotification
(
ScheduleNotification <#schedulenotification>__) To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). - setExpiration (
SetExpiration <#setexpiration>__) If a push service can’t deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of created notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/groups/{path}/notifications
.. raw:: html
Create notifications for a group. This request will target all users associated with a specific group entity.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- path (string) The path of the group. (Specified in path).
- notification (
CreateNotifications <#createnotifications>__) These parameters are used when forming the notification portion of the request. (Specified in body). - scheduleNotification
(
ScheduleNotification <#schedulenotification>__) To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). - setExpiration (
SetExpiration <#setexpiration>__) If a push service can’t deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of created notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /{orgId}/{appId}/notifications
.. raw:: html
Retrieve one or more notifications through providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of retrieved notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
DELETE /{orgId}/{appId}/notifications/{notificationId}
.. raw:: html
Remove unsent notifications through providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- 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).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of deleted notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
POST /{orgId}/{appId}/users/{userId}/notifications
.. raw:: html
Create notifications for a user. This request will target a specific user entity.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- userId-3 (string) One of the user’s identification which includes username or UUID. (Specified in path).
- notification (
CreateNotifications <#createnotifications>__) These parameters are used when forming the notification portion of the request. (Specified in body). - scheduleNotification
(
ScheduleNotification <#schedulenotification>__) To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). - setExpiration (
SetExpiration <#setexpiration>__) If a push service can’t deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of created notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
.. raw:: html
GET /{orgId}/{appId}/{receiptId}/*/notifications
.. raw:: html
Retrieve notifications associated with one or more receipts through providing all the identifications.
.. raw:: html
Parameters
.. raw:: html
- orgId (string) One of the organization’s identification which includes name or uuid. (Specified in path).
- appId (string) One of the application’s identification which includes name or uuid. (Specified in path).
- receiptId (string) One of the receipt’s identification which includes name or uuid. (Specified in path).
.. raw:: html
Responses
.. raw:: html
200
- Description: An array of retrieved notification’s info.
- Schema:
Notification <#notification>__
default
- Description: Unexpected error.
- Schema:
Error <#error>__
Organization Methods
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /management/orgs
.. raw:: html
</h2>
Create an organization through a form post.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **CreateOrg** (`CreateOrg <#createorg>`__) A set of organization
properties supplied through a form. (Specified in body).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created Organization.
- Schema: `Organization <#organization>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/orgs/{orgId}
.. raw:: html
</h2>
Retrieve an organization given a specified UUID or username.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created Organization.
- Schema: `Organization <#organization>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Permission Methods
~~~~~~~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/roles/{roleId}/permissions
.. raw:: html
</h2>
Remove permissions from a role.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
- **appId** (string) One of the application's identification which
includes name or uuid. (Specified in path).
- **roleId** (string) One of the role's identification which includes
name or uuid. (Specified in path).
- **grant\_url\_pattern** () The query statement of the url pattern.
(Specified in query).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted permission's info.
- Schema: `Permission <#permission>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Receipt Methods
~~~~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/receipts
.. raw:: html
</h2>
Retrieve one or more receipts through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved receipt's info.
- Schema: `Receipt <#receipt>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/{deviceId}/\*/receipts
.. raw:: html
</h2>
Retrieve receipts associated with one or more devices through providing
all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
- **appId** (string) One of the application's identification which
includes name or uuid. (Specified in path).
- **deviceId** (string) One of the device's identification which
includes name or uuid. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved receipt's info.
- Schema: `Receipt <#receipt>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/{notificationId}/\*/receipts
.. raw:: html
</h2>
Retrieve receipts for one or more notifications through providing all
the identifications."
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved receipt's info.
- Schema: `Receipt <#receipt>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
Role Methods
~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/roles
.. raw:: html
</h2>
Retrieve the roles in an application through providing all the
identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved role's info.
- Schema: `Role <#role>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/roles
.. raw:: html
</h2>
Create a new role through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created role's info.
- Schema: `Role <#role>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/roles/{rolename}
.. raw:: html
</h2>
Remove a role through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted role's info.
- Schema: `Role <#role>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
User Methods
~~~~~~~~~~~~
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/orgs/{orgId}/users
.. raw:: html
</h2>
Retrieve details about the admin users in an organization.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved Admin user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /management/orgs/{orgId}/users/{userId}
.. raw:: html
</h2>
Remove an admin user from an organization through providing both Id of
application and organization.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted Admin user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /management/users
.. raw:: html
</h2>
Create a whole new admin user.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **adminuserproperty** (`CreateAdminUser <#createadminuser>`__) One or
more sets of user properties of which username is mandatory and must
be unique. (Specified in body).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of new created Admin user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /management/users/{userId}
.. raw:: html
</h2>
Retrieve details about an admin user.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **userId** (string) One of the user's identification which includes
username, real name, email address or UUID. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of user's details
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /management/users/{userId}
.. raw:: html
</h2>
Update the info of an admin user.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **userId** (string) One of the user's identification which includes
username, real name, email address or UUID. (Specified in path).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of user's details.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/groups/{groupId}/users/{userId}
.. raw:: html
</h2>
Add a user to a group through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of added user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}
.. raw:: html
</h2>
Delete user from a group through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/roles/{roleId}/users
.. raw:: html
</h2>
Retrieve the users in a role through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/roles/{roleId}/users/{userId}
.. raw:: html
</h2>
Add a user to a role through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of added user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}
.. raw:: html
</h2>
Remove a user from a role through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of deleted user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/users
.. raw:: html
</h2>
Retrieve users though query statement.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
- **appId** (string) One of the application's identification which
includes name or uuid. (Specified in path).
- **queryStatement** () The query statement of the User. (Specified in
query).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-POST-heading">
POST /{orgId}/{appId}/users
.. raw:: html
</h2>
Create a user in the users collection through providing all the
identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</h3>
- **orgId** (string) One of the organization's identification which
includes name or uuid. (Specified in path).
- **appId** (string) One of the application's identification which
includes name or uuid. (Specified in path).
- **CreateUser** (`CreateUser <#createuser>`__) The properties of the
user. (Specified in body).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of created user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-GET-heading">
GET /{orgId}/{appId}/users/{userId}
.. raw:: html
</h2>
Retrieve a user through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of retrieved user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-PUT-heading">
PUT /{orgId}/{appId}/users/{userId}
.. raw:: html
</h2>
Update a user through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</h3>
**200**
- Description: An array of updated user's info.
- Schema: `User <#user>`__
**default**
- Description: Unexpected error.
- Schema: `Error <#error>`__
.. raw:: html
<h2 class="usergrid-DELETE-heading">
DELETE /{orgId}/{appId}/users/{userId}
.. raw:: html
</h2>
Remove a user through providing all the identifications.
.. raw:: html
<h3>
Parameters
.. raw:: html
</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).
.. raw:: html
<h3>
Responses
.. raw:: html
</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**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
action
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The requested action.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
status
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The status of the requested action.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
token
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The token required for getting an AdminUser.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
ActivityFeed
~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
entityproperty
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
category
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The category of the activity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadataproperty
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
objectproperty
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
title
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the activity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
verb
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The verb of the activity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Actor
~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
displayname
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The display of the name of the actor.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
objecttype
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The type of the actor.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
objectuuId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the actor.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
entitytype
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The entitytype of the actor.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
AddPermission
~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
operation
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are
allowed for the specified resource path.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
resource\_path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path to the resources to be accessed.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
AddRole
~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
title
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the role.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
role name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the role.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
AdminUserUpdate
~~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
city
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
state
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
AppData
~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
tester/sandbox
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of tester/sandbox.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
tester/app1
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of tester/app1.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
tester/app2
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of tester/app2.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
CancelMSG
~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
canceled
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
Collections
~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
activities
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
feed
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
roles
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
users
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
CreateActivity
~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
displayName
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
image
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
verb
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
content
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateAdminUser
~~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
password
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
CreateApp
~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
token
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The OAuth2 access token.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the application.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateEntities
~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
</table>
CreateEntity
~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
property
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The property of the entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
value
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The relevant value of the property.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
CreateEvent
~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
timestamp
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateGroup
~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
title
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the group.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path of the group.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateNotification
~~~~~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
notifier
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
message
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The push notitfication message that will be delivered to the user.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateNotifications
~~~~~~~~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
</table>
CreateOrg
~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
organization
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
password
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
CreateUser
~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
Credential
~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
client\_Id
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The Id of the client.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
client\_secret
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The secret of the client.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Device
~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Unique entity Id.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Type of entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Notifier display name.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Entity
~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The type of the entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
actorproperty
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
message
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Error
~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
code
.. raw:: html
</td>
<td>
integer
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
message
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
fields
.. raw:: html
</td>
<td>
object
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Event
~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
applicationName
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application name of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
entity
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
url
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The url of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
applicationId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application UUID of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
parameters
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The parameters of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
organization
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the organization.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Group
~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The type of the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
created
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The created Id for the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
modified
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The modified Id for the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path of the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
title
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the group.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
ImageModel
~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
url
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
wIdth
.. raw:: html
</td>
<td>
integer
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Metadata
~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
cursor
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The cursor of the metadata.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path of the metadata.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
sets
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
collections
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Notification
~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Unique entity Id.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Type of entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
payloads
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The push notifications to be delivered.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
errorMessage
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Error message returned by the notification service (APNs or GCM) if the
notification fails entirely.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
scheduled
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
whether the notification is currently scheduled for delivery.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
state
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The current delivery status of the notification 'FINISHED', 'SCHEDULED'
or 'CANCELED'.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Notifier
~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Unique entity Id.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Type of entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Notifier display name.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
provider
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Push notification provider 'apple' or 'google'.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
environment
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The environment that corresponds to your app 'development' or
'production'.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Object
~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
displayname
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The display of the name of the object.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
objecttype
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The type of the object.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
objectuuId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the object.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
entitytype
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The entitytype of the object.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Organization
~~~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
applicationId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application Id of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The username of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The email of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
activated
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the account is activated or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
disabled
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the account is disabled or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
adminUser
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the use is a adminUser or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
displayEmail
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The display of the email of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
htmldisplayEmail
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The HTML display of the email of the owner.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
orgname
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the organization.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
orguuId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the organization.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
applicationdata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Permission
~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
applicationName
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of the application of the permission.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
entity
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
url
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The url of the permission.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
applicationId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of the application.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
parameters
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The parameters of the permission.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
organization
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The organization of the permission.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
permissiondata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
Receipt
~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Unique entity Id.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
type
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Type of entity.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
payloads
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The push notifications to be delivered.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
errorMessage
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Error message returned by the notification service (APNs or GCM) if the
notification fails entirely.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
errorCode
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Error code returned by the notification service.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
sent
.. raw:: html
</td>
<td>
number
.. raw:: html
</td>
<td>
UTC timestamp in milliseconds for when the notification was sent.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
metadata
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
ResetPW
~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
password
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
newpassword
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
ResetPWMsg
~~~~~~~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
recaptcha\_response
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
Parameters and value for the Captcha challenge.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
recaptcha\_challenge
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The admin user's response to the Captcha challenge.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
Role
~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
applicationName
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application name of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
entity
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
url
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The url of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
applicationId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application UUID of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
parameters
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The parameters of the event.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
organization
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The title of the organization.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path of the role.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
ScheduleNotification
Properties
.. raw:: html
Name .. raw:: html |
Type .. raw:: html |
Description .. raw:: html |
Required .. raw:: html |
|---|---|---|---|
timestamp .. raw:: html |
string .. raw:: html |
UTC timestamp in milliseconds of when schedule notifications. .. raw:: html |
true .. raw:: html |
SetExpiration
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
timestamp
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
UTC timestamp in milliseconds of when set expirations.
.. raw:: html
</td>
<td>
true
.. raw:: html
</td>
</tr>
</table>
Sets
~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
rolenames
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
permissions
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>
User
~~~~
**Properties**
.. raw:: html
<table width="80%" class="usergrid-table">
<tr>
<th>
Name
.. raw:: html
</th>
<th>
Type
.. raw:: html
</th>
<th>
Description
.. raw:: html
</th>
<th>
Required
.. raw:: html
</th>
</tr>
<tr>
<td>
applicationId
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The application Id of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
username
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The username of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
name
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The name of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
email
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The email of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
activated
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the account is activated or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
disabled
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the account is disabled or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
uuid
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The UUID of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
adminUser
.. raw:: html
</td>
<td>
boolean
.. raw:: html
</td>
<td>
Indicate whether the use is a adminUser or not.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
displayEmail
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The display of the email of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
htmldisplayEmail
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The HTML display of the email of a user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
organization
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The organization of the user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
picture
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The uri of the user's picture.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
uri
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The uri of the user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
path
.. raw:: html
</td>
<td>
string
.. raw:: html
</td>
<td>
The path of the user.
.. raw:: html
</td>
<td>
false
.. raw:: html
</td>
</tr>
<tr>
<td>
completeMsg
.. raw:: html
</td>
<td>
ref
.. raw:: html
</td>
<td></td>
<td>
false
.. raw:: html
</td>
</tr>
</table>