Apache Usergrid Documentation¶

Getting Started¶

• Getting Started
  • For Application Developers
  • For Deployment and Operations folks
  • For Open Source contributoes
• Usergrid Features
  • Data storage & management
  • Flexible data querying
  • Social
  • User management
  • Geolocation
  • Push notifications
• Usergrid Data model
  • Organizations
  • Applications
  • Collections
  • Entities
  • Default entities
  • Properties
  • Default properties
• Async vs. sync calls
  • Synchronous
  • Asynchronous

Using Usergrid¶

• Creating a Usergrid Account
  • Next steps
• Creating a new application
  • Creating an application
  • Securing an application
• Using a Sandbox Application
  • What is the sandbox application?
  • Is the sandbox secure?
  • Creating a New Sandbox Application
• Using the API
  • Supported HTTP methods
  • Base URL
  • Request construction
  • Accessing collections
  • Accessing entities
  • Issuing queries
  • Authentication (OAuth)
  • Response format
  • SDKs

Data Storage¶

• The Usergrid Data Store
• Data Store Best Practices
  • Put your data in as you’ll want to get it out
  • Best practice: Denormalize for pre-computed query results
• Collections
  • Creating Collections
  • Collection Settings
  • Setting up Selective Indexing via Collection Settings
  • Retrieving Collections
  • Updating Collections
  • Deleting Collections
• Entities
  • Creating Custom Data Entities
  • Creating multiple custom entities
  • Retrieving Data Entities
  • Updating Data Entities
  • Deleting Data Entities

Data Queries¶

• Querying your data
  • Basic query usage
• Query parameters & clauses
  • Contains
  • Location
  • Order by
  • Limit
  • Cursor
• Query operators & data types
  • Operators
  • Data types
• Advanced query usage
  • Attaching a query to all API calls

Entity Connections¶

• Connecting entities
  • Request syntax
• Retrieving connections
  • Request syntax
  • Retrieve all connected entities
  • Retrieve all connecting entities by type
  • Retrieve all connecting entities
• Disconnecting entities
  • Request syntax

Push Notifications¶

• Push notifications overview
  • Reach your users with push
  • Get started
  • Build push support
  • Learn more
• Adding push notifications support
  • Setting up push notification support
  • Requirements
  • Tutorials
  • Sample Apps
  • Troubleshooting
• Getting started with push notifications
  • What are push notifications?
  • Prerequisites
  • Setup overview
  • How it works
• Tutorial: Push notifications sample app
  • Before you begin
  • Step 1: Download a sample app
  • Step 2: Register with a notification service and generate a certificate/key
  • Step 3: Create a notifier
  • Step 4: Configure and run the sample app
  • Step 5: Review the data entities created by the sample app
  • Step 6: Send additional push notifications using other Usergrid tools
• Registering with a notification service
  • Registering with Apple APNs
  • Registering with Google GCM
• Creating notifiers
  • Requirements
  • Creating notifiers with the admin portal
  • Creating notifiers programmatically
  • Notifier endpoints
• Managing users and devices
  • Registering devices
  • Connecting devices to users
• Creating and managing notifications
  • Creating notifications
  • Scheduling notifications
  • Targeting multiple notifiers or messages
  • Setting a notification expiration
  • Getting notifications
  • Canceling sent notifications
  • Deleting unsent notifications
  • Getting receipts
  • Notification endpoints
• Troubleshooting
  • Working with Android
  • Working with PhoneGap Android

Security & Authentication¶

• Security & token authentication
• Using permissions
  • Permissions syntax
  • Complex paths
  • Assigning permissions
  • Removing permissions
• Using roles
  • Default roles
  • Creating roles
  • Assigning roles
  • Removing roles
• Authenticating users & app clients
  • Authentication levels
  • Application user authentication (user login)
  • Application client authentication
  • Admin user authentication
  • Organization client authentication
• Authentication levels
  • Configuring authentication levels
  • User authentication level
  • Admin authentication levels
• Changing token expiration (time-to-live)
  • Default ttl
  • Changing the default ttl
  • Changing ttl when a token is created
• Authenticating API requests
  • Authenticating with access tokens
  • Authenticating with client ID and client secret
• Revoking tokens (logout)
  • Revoking tokens (user logout)
• Facebook sign in
  • Facebook login example
• Security best practices
  • Never use the ‘sandbox’ for a production app
  • Review permissions in your apps
  • Edit the ‘default’ role
  • Use https
  • Acquire access tokens in a secure way
  • Treat mobile clients as untrustworthy

User Management & Social Graph¶

• User management & social graph
  • User management
  • Group management
  • Social connections
  • Activity feeds
• Working with User Data
  • Creating users
  • Retrieving user data
  • Updating & deleting user data
  • Changing a user password
  • Resetting a user password
• Working with group data
  • Creating groups
  • Retrieving groups
  • Parameter Description
  • Retrieving a group’s users
  • Deleting a group
  • Adding a user to a group
  • Removing a user from a group
• Activity
  • Posting activities
  • Posting an activity to a group
  • Creating an activity for a user’s followers in a group
  • Retrieving activity feeds
  • Retrieving a group’s activity feed
• Social Graph Connections
  • Following/followers
  • Creating a following/followers connection
• Creating other connections
• App Example - Messagee
  • Creating a user account in Usergrid
  • Creating an app and users
  • iOS client
  • iOS SDK
  • Android client and SDK
  • Javascript/HTML5 client and SDK

Geo-location¶

• Geolocating your Entities
  • Saving location data in an entity
  • Querying location data
  • Enrich your app with location data

Assets & Files¶

• Uploading assets
  • Uploading assets
  • Updating assets
• Retrieving assets
  • Retrieving asset data
  • Retrieving an asset entity
• Folders
  • Linking a folder to an asset
  • Retrieve list of folder assets

Counters & Events¶

• Counters & events
• Creating & incrementing counters
  • Request syntax
  • Example request
  • Example response
• Decrementing/resetting counters
• Using counters hierarchically
• Retrieving counters
  • Request syntax
  • Example request
  • Example response
  • Retrieving counters by time interval
  • Request syntax
  • Example request
  • Example response

Organizations & Applications¶

• Organization & application management
• Organization
  • Creating an organization
  • Getting an organization
  • Activating an organization
  • Reactivating an organization
  • Generating organization client credentials
  • Retrieving organization client credentials
  • Getting an organization’s activity feed
  • Getting the applications in an organization
  • Adding an admin user to an organization
  • Getting the admin users in an organization
  • Removing an admin user from an organization
• Application
  • Creating an application
  • Generating application credentials
  • Getting application credentials
  • Deleting and restoring Applications
• Admin user
  • Creating an admin user
  • Updating an admin user
  • Getting an admin user
  • Setting an admin user’s password
  • Resetting an admin user’s password
  • Completing a password reset
  • Activating an admin user
  • Reactivating an admin user
  • Example - Request
  • Getting an admin user’s activity feed

API Reference¶

• Methods
  • Access-Tokens
  • Activities
  • Admin-Users
  • App-Users
  • Entities-Collections
  • Events
  • Groups
  • Notifications
  • Organizations-Applications
  • Permissions-Roles
• Models
  • AccessTokenResponse
  • Action
  • ActivityFeed
  • AddRole
  • AppData
  • CreateActivity
  • CreateAdminUser
  • CreateEntities
  • CreateEvent
  • CreateGroup
  • CreateNotifications
  • CreateOrg
  • CreateUser
  • Credential
  • Device
  • Entity
  • Error
  • Event
  • Group
  • LoginCredentials
  • Notification
  • NotificationUpdate
  • Organization
  • Permissions
  • Receipt
  • ResetPW
  • ResetPWMsg
  • Role
  • User
• Sub-Types
  • Collections
  • ImageModel
  • Metadata
  • Object
  • Sets

Client SDKs¶

• COMING SOON...

Installing Usergrid¶

• Usergrid 2.1.0 Deployment Guide
  • Intended audience
  • Prerequsites
  • Getting Started
  • Deploying the Usergrid Stack
  • Deploying the Usergrid Portal
  • Additional Resources
  • The End

More about Usergrid¶

• Presentations & Videos
  • Building Mobile Apps with Apache Usergrid
  • How to Contribute to Apache Usergrid
  • Apache Usergrid Internals
  • Open Source Mobile Backend on Cassandra
  • Usergrid Overview
• How to Contribute Code & Docs
  • Contribute via GitHub
  • Building Usergrid
  • Building the Website and Documentation