Name | Type | Description | Required |
---|---|---|---|
access_token | string | Access-token that may be used on subsequent requests. | false |
expires_in | number | Time (in milliseconds) until access-token expires. | false |
user | [User](#user) | User object if login was done as a user. | false |
Name | Type | Description | Required |
---|---|---|---|
action | string | The requested action. | false |
status | string | The status of the requested action. | false |
timestamp | number | The timestamp of the requested action. | false |
duration | number | The duration of the requested action. | false |
token | string | The token required for getting an AdminUser. | false |
Name | Type | Description | Required |
---|---|---|---|
entityproperty | [Entity](#entity) | false | |
category | string | The category of the activity. | false |
metadataproperty | [Metadata](#metadata) | false | |
objectproperty | [Object](#object) | false | |
title | string | The title of the activity. | false |
verb | string | The verb of the activity. | false |
published | number | UTC timestamp of the feed publish time. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
title | string | The title of the role. | true |
role name | string | The name of the role. | true |
Name | Type | Description | Required |
---|---|---|---|
tester/sandbox | string | The UUID of tester/sandbox. | false |
tester/app1 | string | The UUID of tester/app1. | false |
tester/app2 | string | The UUID of tester/app2. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
displayName | string | true | |
uuid | string | true | |
username | string | true | |
image | [ImageModel](#imagemodel) | false | |
verb | string | true | |
content | string | true |
Name | Type | Description | Required |
---|---|---|---|
username | string | true | |
string | false | ||
name | string | false | |
password | string | false |
Name | Type | Description | Required |
---|
Name | Type | Description | Required |
---|---|---|---|
timestamp | string | true |
Name | Type | Description | Required |
---|---|---|---|
title | string | The title of the group. | true |
path | string | The path of the group. | true |
Name | Type | Description | Required |
---|
Name | Type | Description | Required |
---|---|---|---|
organization | string | true | |
username | string | true | |
name | string | true | |
string | true | ||
password | string | true |
Name | Type | Description | Required |
---|---|---|---|
username | string | true |
Name | Type | Description | Required |
---|---|---|---|
client_Id | string | The Id of the client. | false |
client_secret | string | The secret of the client. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
uuid | string | Unique entity Id. | false |
type | string | Type of entity. | false |
name | string | Notifier display name. | false |
created | number | UTC timestamp in milliseconds of when the entity was created. | false |
modified | number | UTC timestamp in milliseconds of when the entity was last modified. | false |
metadata | [Metadata](#metadata) | false | |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
uuid | string | The UUID of the entity. | false |
type | string | The type of the entity. | false |
created | number | UTC timestamp of entity creation time. | false |
modified | [Actor](#actor) | UTC timestamp of entity modified time. | false |
metadata | [Metadata](#metadata) | false | |
name | string | The name of the entity. | false |
message | string | false |
Name | Type | Description | Required |
---|---|---|---|
code | integer | false | |
message | string | false | |
fields | object | false |
Name | Type | Description | Required |
---|---|---|---|
applicationName | string | The application name of the event. | false |
entity | [Entity](#entity) | false | |
url | string | The url of the event. | false |
applicationId | string | The application UUID of the event. | false |
parameters | string | The parameters of the event. | false |
organization | string | The title of the organization. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
uuid | string | The UUID of the group. | false |
type | string | The type of the group. | false |
created | string | The created Id for the group. | false |
modified | string | The modified Id for the group. | false |
path | string | The path of the group. | false |
metadata | [Metadata](#metadata) | false | |
title | string | The title of the group. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
grant_type | string | Grant-type must be 'password' or 'client_credentials'. | false |
username | string | Username of user attempting login, required only if grant_type is 'password'. | false |
password | string | Password of user attempting login, required only if grant_type is 'password'. | false |
client_id | string | Client-ID portion of credentials, required only if grant_type is 'client_credentials'. | false |
client_secret | string | Client-Secret portion of credentials, required only if grant_type is 'client_credentials'. | false |
Name | Type | Description | Required |
---|---|---|---|
uuid | string | Unique entity Id. | false |
type | string | Type of entity. | false |
created | number | UTC timestamp in milliseconds of when the entity was created. | false |
modified | number | UTC timestamp in milliseconds of when the entity was last modified. | false |
payloads | string | The push notifications to be delivered. | true |
errorMessage | string | Error message returned by the notification service (APNs or GCM) if the notification fails entirely. | false |
scheduled | boolean | Whether the notification is currently scheduled for delivery. | false |
state | string | The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'. | false |
metadata | [Metadata](#metadata) | false | |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
canceled | boolean | Setting this field to true will cancel a Notification, if it has not yet been sent. | false |
deliver | number | Specifies the UNIX timestamp time at which the Notification should be sent. | false |
expired | number | Specifies the UNIX timestamp time at which this Notification has expired. | false |
Name | Type | Description | Required |
---|---|---|---|
applicationId | string | The application Id of the owner. | false |
username | string | The username of the owner. | false |
name | string | The name of the owner. | false |
string | The email of the owner. | false | |
activated | boolean | Indicate whether the account is activated or not. | false |
disabled | boolean | Indicate whether the account is disabled or not. | false |
uuid | string | The UUID of the owner. | false |
adminUser | boolean | Indicate whether the use is a adminUser or not. | false |
displayEmail | string | The display of the email of the owner. | false |
htmldisplayEmail | string | The HTML display of the email of the owner. | false |
orgname | string | The name of the organization. | false |
orguuId | string | The UUID of the organization. | false |
applicationdata | [AppData](#appdata) | false | |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
application | string | The UUID of the associated application. | false |
applicationName | string | The name of the associated application. | false |
organization | string | The name of the associated organization. | false |
data | array | Array of strings each being a Usergrid Permission String. | true |
Name | Type | Description | Required |
---|---|---|---|
uuid | string | Unique entity Id. | false |
type | string | Type of entity. | false |
created | number | UTC timestamp in milliseconds of when the entity was created. | false |
modified | number | UTC timestamp in milliseconds of when the entity was last modified. | false |
payloads | string | The push notifications to be delivered. | false |
errorMessage | string | Error message returned by the notification service (APNs or GCM) if the notification fails entirely. | false |
errorCode | string | Error code returned by the notification service. | false |
sent | number | UTC timestamp in milliseconds for when the notification was sent. | false |
metadata | [Metadata](#metadata) | false | |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
password | string | true | |
newpassword | string | true |
Name | Type | Description | Required |
---|---|---|---|
recaptcha_response | string | Parameters and value for the Captcha challenge. | true |
recaptcha_challenge | string | The admin user's response to the Captcha challenge. | true |
string | true |
Name | Type | Description | Required |
---|---|---|---|
applicationName | string | The application name of the event. | false |
count | number | The numebr of the roles. | false |
entity | [Entity](#entity) | false | |
url | string | The url of the event. | false |
applicationId | string | The application UUID of the event. | false |
parameters | string | The parameters of the event. | false |
organization | string | The title of the organization. | false |
completeMsg | [Action](#action) | false | |
path | string | The path of the role. | false |
Name | Type | Description | Required |
---|---|---|---|
applicationId | string | The application Id of a user. | false |
username | string | The username of a user. | false |
name | string | The name of a user. | false |
string | The email of a user. | false | |
activated | boolean | Indicate whether the account is activated or not. | false |
disabled | boolean | Indicate whether the account is disabled or not. | false |
uuid | string | The UUID of a user. | false |
adminUser | boolean | Indicate whether the use is a adminUser or not. | false |
displayEmail | string | The display of the email of a user. | false |
htmldisplayEmail | string | The HTML display of the email of a user. | false |
organization | string | The organization of the user. | false |
picture | string | The uri of the user's picture. | false |
uri | string | The uri of the user. | false |
path | string | The path of the user. | false |
completeMsg | [Action](#action) | false |
Name | Type | Description | Required |
---|---|---|---|
activities | string | false | |
feed | string | false | |
roles | string | false | |
users | string | false |
Name | Type | Description | Required |
---|---|---|---|
duration | number | false | |
height | number | false | |
url | string | false | |
wIdth | integer | false | |
string | false |
Name | Type | Description | Required |
---|---|---|---|
cursor | string | The cursor of the metadata. | false |
path | string | The path of the metadata. | false |
sets | [Sets](#sets) | false | |
collections | [Collections](#collections) | false |
Name | Type | Description | Required |
---|---|---|---|
displayname | string | The display of the name of the object. | false |
objecttype | string | The type of the object. | false |
objectuuId | string | The UUID of the object. | false |
entitytype | string | The entitytype of the object. | false |
Name | Type | Description | Required |
---|---|---|---|
rolenames | string | false | |
permissions | string | false |