Methods are organized by tag. Follow the methods are the Model Definitions.

Methods

Access-Tokens

Login with Admin-User or Organization credentials.

  • login-credentials (LoginCredentials) Login credentials either username/password or id/secret. (Specified in body).

200

default

  • Description: Unexpected error.
  • Schema: Error

Login with App-User or Application credentials.

  • login-credentials (LoginCredentials) Login credentials either username/password or id/secret. (Specified in body).

200

default

  • Description: Unexpected error.
  • Schema: Error

Activities

Get a group's feed through providing all the identifications.

  • 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).

200

  • Description: An array of group's activity.
  • Schema: ActivityFeed

default

  • Description: Unexpected error.
  • Schema: Error

Create an activity in the activities collection.

  • 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) One or more sets of activity properties. (Specified in body).

200

  • Description: An array of user's activity.
  • Schema: ActivityFeed

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve a user's feed through providing all the identifications.

  • 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).

200

  • Description: An array of user's activity feed.
  • Schema: ActivityFeed

default

  • Description: Unexpected error.
  • Schema: Error

Admin-Users

Retrieve details about the admin users in an organization.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved Admin user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Remove an admin user from an organization through providing both Id of application and organization.

  • 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).

200

  • Description: An array of deleted Admin user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Create a whole new admin user.

  • CreateAdminUser (CreateAdminUser) User entity with fields required for User creation. (Specified in body).

200

  • Description: An API Response with a entities array containing the newly created Admin User.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Initiate the reset of an admin user's password.

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Complete the password reset through getting the newpassword and the old one for identification.

  • 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).

200

  • Description: An array of complete messages.
  • Schema:

default

  • Description:
  • Schema: Error

Retrieve details about an admin user.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).

200

  • Description: An API Response with a entities array containing the Admin User.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Update the info of an admin user.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).

200

  • Description: An API Response with a entities array containing the updated Admin User
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Activate an admin user from a link provIded in an email notification.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
  • token (string) Activation token's query statement. (Specified in query).
  • confirm_email (boolean) Query statement of whether send confimation email or not. (Specified in query).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Update an admin user's password through getting the newpassword and the old one for identification.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
  • ResetPW (ResetPW) The user's old and new password. (Specified in body).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Reactivate an expired admin user.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

App-Users

Retrieve users though query statement.

  • 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 (string) The query statement of the User. (Specified in query).

200

  • Description: An array of retrieved user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Create a user in the users collection through providing all the identifications.

  • 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) The properties of the user. (Specified in body).

200

  • Description: An array of created user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve a user through providing all the identifications.

  • 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).

200

  • Description: An array of retrieved user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Update a user through providing all the identifications.

  • 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).

200

  • Description: An array of updated user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Remove a user through providing all the identifications.

  • 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).

200

  • Description: An array of deleted user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Set a user's password or reset the user's existing password.

  • 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) The user's old and new password. (Specified in body).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Entities-Collections

Retrieve a user's collections or connections through query statement.

  • 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 (string) The query statement of the user. (Specified in query).

200

  • Description: An array of user's collections info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve collection through query statement.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • appId (string) One of the application's identification which includes name or uuid. (Specified in path).
  • collectionId (string) One of the collection's identification which includes name or uuid. (Specified in path).
  • queryStatement (string) Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).

200

  • Description: An array of retrieved collection's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Update collection through query statement.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • appId (string) One of the application's identification which includes name or uuid. (Specified in path).
  • collectionId (string) One of the collection's identification which includes name or uuid. (Specified in path).
  • queryStatement (string) Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).

200

  • Description: An array of updated collection's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Add an entity to a collection through providing all the identifications.

  • 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).

200

  • Description: An array of added entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Remove an entity from a collection through providing all the identifications.

  • 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).

200

  • Description: An array of deleted entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve an entity through providing Id of application, organization, collection and entity.

  • 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).

200

  • Description: An array of retrieved entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

One or more properties can be updated with a single request.

  • 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) The properties of the entity. (Specified in body).

200

  • Description: An array of updated entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Delete an entity from the collection.

  • 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).

200

  • Description: An array of deleted entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

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.

  • 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) The properties of the entity. (Specified in body).

200

  • Description: An array of created custom entity's info.
  • Schema: Entity

default

  • Description: Unexpected error.
  • Schema: Error

Events

Create an event through providing both Id of organization and application.

  • 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) The required property of the event. (Specified in body).

200

  • Description: An array of created event's info.
  • Schema: Event

default

  • Description: Unexpected error.
  • Schema: Error

Groups

Create a new group through providing both Id of organization and application.

  • 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) The property of the created group. (Specified in body).

200

  • Description: An array of created group's info.
  • Schema: Group

default

  • Description: Unexpected error.
  • Schema: Error

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.

  • 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) One or more sets of activity properties. (Specified in body).

200

default

  • Description: Unexpected error.
  • Schema: Error

Add a user to a group through providing all the identifications.

  • 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).

200

  • Description: An array of added user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Delete user from a group through providing all the identifications.

  • 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).

200

  • Description: An array of deleted user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Get a group through through providing all the identifications.

  • 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).

200

  • Description: An array of retrieved group's info.
  • Schema: Group

default

  • Description: Unexpected error.
  • Schema: Error

Update a group through providing all the identifications.

  • 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).

200

  • Description: An array of updated group's info.
  • Schema: Group

default

  • Description: Unexpected error.
  • Schema: Error

Notifications

Create notifications for user through targeting by location and providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notification (CreateNotifications) These parameters are used when forming the notification portion of the request. (Specified in body).
  • queryStatement (string) The query statement of the location of the user. (Specified in query).

200

  • Description: An array of created notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Create notifications for all devices. This request will target all device entities.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notification (CreateNotifications) These parameters are used when forming the notification portion of the request. (Specified in body).

200

  • Description: An array of created notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Create notifications for a single device. This request will target a specific device entity.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • deviceId (string) One of the device's identification which includes name or uuid. (Specified in path).
  • notification (CreateNotifications) These parameters are used when forming the notification portion of the request. (Specified in body).

200

  • Description: An array of created notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Create notifications for a group. This request will target all users associated with a specific group entity.

  • 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) These parameters are used when forming the notification portion of the request. (Specified in body).

200

  • Description: An array of created notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve one or more notifications through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).

200

  • Description: An array of retrieved notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Update a Notification in order to cancel the notifcation or set a new expiration time.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notificationId (string) One of the notification's identification which includes name or uuid. (Specified in path).
  • notificationUpdate (NotificationUpdate) Object with Notification fields to be updated. (Specified in body).

200

  • Description: An API Response object containing an entity of type Notification.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Delete an unsent Notification from the system.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notificationId (string) One of the notification's identification which includes name or uuid. (Specified in path).

200

  • Description: API Response containing Notification entity that was deleted.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve one or more receipts through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).

200

  • Description: An array of retrieved receipt's info.
  • Schema: Receipt

default

  • Description: Unexpected error.
  • Schema: Error

Create notifications for a user. This request will target a specific user entity.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • userId-3 (string) One of the user's identification which includes username or UUID. (Specified in path).
  • notification (CreateNotifications) These parameters are used when forming the notification portion of the request. (Specified in body).

200

  • Description: An array of created notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve receipts associated with one or more devices through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • deviceId (string) One of the device's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved receipt's info.
  • Schema: Receipt

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notificationId (string) One of the notification's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved device's info.
  • Schema: Device

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve receipts for one or more notifications through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • notificationId (string) One of the notification's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved receipt's info.
  • Schema: Receipt

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve notifications associated with one or more receipts through providing all the identifications.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • applicationId (string) One of the application's identification which includes name or uuid (same as appId). (Specified in path).
  • receiptId (string) One of the receipt's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved notification's info.
  • Schema: Notification

default

  • Description: Unexpected error.
  • Schema: Error

Organizations-Applications

Create an organization through a form post.

  • CreateOrg (CreateOrg) A set of organization properties supplied through a form. (Specified in body).

200

  • Description: An array of created Organization.
  • Schema: Organization

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve an organization given a specified UUID or username.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of created Organization.
  • Schema: Organization

default

  • Description: Unexpected error.
  • Schema: Error

Activate an organization from a link provIded in an email notification.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).
  • token (string) Activation token. (Specified in query).
  • confirm_email (boolean) Send confirmation email or not. (Specified in query).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve the applications in an organization through providing both Id of application and organization.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of retrieved application data.
  • Schema: AppData

default

  • Description: Unexpected error.
  • Schema: Error

Remove an application from an organization through providing both Id of application and organization.

  • 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).

200

  • Description: An array of deleted application info.
  • Schema: AppData

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve the client Id and client secret credentials for an application in an organization.

  • 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).

200

  • Description: An array of retrieved credentials info.
  • Schema: Credential

default

  • Description: Unexpected error.
  • Schema: Error

Generate the client Id and client secret credentials for an application in an organization.

  • 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).

200

  • Description: An array of generated credentials info.
  • Schema: Credential

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve the credentials for an organization client.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of Credential
  • Schema: Credential

default

  • Description: Unexpected error.
  • Schema: Error

Generate whole new credentials for an organization client.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of Credential
  • Schema: Credential

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve an organization's activity feed.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of the organization's ActivityFeed.
  • Schema: ActivityFeed

default

  • Description: Unexpected error.
  • Schema: Error

Reactivate an expired organization.

  • orgId (string) One of the organization's identification which includes name or uuid. (Specified in path).

200

  • Description: An array of complete messages.
  • Schema: Action

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve an admin user's activity feed.

  • userId (string) One of the user's identification which includes username, real name, email address or UUID. (Specified in path).

200

  • Description: An array of user's activity
  • Schema: ActivityFeed

default

  • Description: Unexpected error.
  • Schema: Error

Permissions-Roles

Retrieve the roles in an application through providing all the identifications.

  • 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).

200

  • Description: An array of retrieved role's info.
  • Schema: Role

default

  • Description: Unexpected error.
  • Schema: Error

Create a new role through providing all the identifications.

  • 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) The required properties of the role. (Specified in body).

200

  • Description: An array of created role's info.
  • Schema: Role

default

  • Description: Unexpected error.
  • Schema: Error

Remove permissions from a role.

  • 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).
  • Permissions (Permissions) The query statement of the url pattern. (Specified in body).

200

  • Description: Permissions object with array of the deleated Usergrid Permission strings.
  • Schema: Permissions

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve the users in a role through providing all the identifications.

  • 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).

200

  • Description: An API Response with a entities array of Users.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Add a user to a role through providing all the identifications.

  • 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).

200

  • Description: An array of added user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Remove a user from a role through providing all the identifications.

  • 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).

200

  • Description: An array of deleted user's info.
  • Schema: User

default

  • Description: Unexpected error.
  • Schema: Error

Remove a role through providing all the identifications.

  • 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).

200

  • Description: An array of deleted role's info.
  • Schema: Role

default

  • Description: Unexpected error.
  • Schema: Error

Retrieve permissions for a Role.

  • 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).

200

  • Description: Permissions object with array of Usergrid Permission strings.
  • Schema: Permissions

default

  • Description: Unexpected error.
  • Schema: Error

Add permissions to a role through providing all the identifications.

  • 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).
  • Permissions (Permissions) Permissions object with array of Usergrid Permission strings to be added. (Specified in body).

200

  • Description: Permissions object with array of Usergrid Permission strings.
  • Schema: Permission

default

  • Description: Unexpected error.
  • Schema: Error

Models

This section lists the properties for the Usergrid Default Entities:

AccessTokenResponse

Properties

Action

Properties

Referring Definitions

ActivityFeed

Properties

AddRole

Properties

AppData

Properties

Referring Definitions

CreateActivity

Properties

CreateAdminUser

Properties

CreateEntities

Properties

CreateEvent

Properties

CreateGroup

Properties

CreateNotifications

An array of Notifications to be created.

Properties

CreateOrg

Properties

CreateUser

Properties

Credential

Properties

Device

Represents a single Device that is registered for recieving of Push Notifications.

Properties

Entity

Properties

Referring Definitions

Error

Properties

Event

Properties

Group

Properties

LoginCredentials

Properties

Notification

Represents a Push Notification that is either scheduled, finished or cancelled.

Properties

NotificationUpdate

Represents fields that may be updated on a Notification to cause changes in Push Notification processing.

Properties

Organization

Properties

Permissions

Represents a set of Permissions associated with a User or a Role, each being a Usergrid Permission String.

Properties

Receipt

Represents response received from Notification service indicating success or failure.

Properties

ResetPW

Properties

ResetPWMsg

Properties

Role

Properties

User

Represents a User account which may be a user within an Application's User collection, or may be an Admin User.

Properties

Referring Definitions

Sub-Types

This section lists the properties for sub-types used in Usergrid Default Entities.

Collections

Properties

Referring Definitions

ImageModel

Properties

Referring Definitions

Metadata

Properties

Referring Definitions

Object

Properties

Referring Definitions

Sets

Properties

Referring Definitions