Current Version: 0.11.1
The Admin portal is available online at https://apigee.com/usergrid/. The Admin portal source code is fully open source and forkable. You can easily extend the Admin portal, embed it into your own applications, or inspect the code to learn best practices associated with the Usergrid API.
The Admin portal repo is located here:
You can download the Admin portal code here:
- Download as a zip file: https://github.com/apigee/usergrid-portal/archive/master.zip
- Download as a tar.gz file: https://github.com/apigee/usergrid-portal/archive/master.tar.gz
To find out more about Apigee App Services, a free, hosted version of Usergrid, see:
To view the Apigee App Services documentation, see:
Use the Admin portal for administrative operations, including:
- Create new organizations and applications.
- View information about the current organization, such as its applications, administrators, and credentials.
- Display information about an application, such as its users, groups, collections, and roles.
- Create and modify roles to manage access to your data.
- View and modify your data, with full support for users, groups, and custom entities and collections.
- Generate and access credentials for API access.
The Admin portal interface displays a variety of pages that display information and enable you to perform management actions. These include:
- Account home
- Application dashboard
You can display any of these pages by clicking its respective item in the left sidebar menu of the Admin portal.
When you log in to the Admin portal, you are presented with a home page for managing the applications and data for your organization. The home page displays:
- Applications associated with the currently selected organization
- Administrators that are part of that organization
- API credentials for the organization
- Activities performed recently by administrators
- A menu for building, organizing, and managing application content
The Application Dashboard shows a variety of statistical data for the selected application. You can see the activity level, the total number of entities, and other vital statistics for monitoring application health as well as quota limits.
The Users page lists the user entities created in the current application. You can add or delete users. You can also edit various properties of a user entity such as the user's name or address.
The Groups page lists the groups created in the current application. You can add or delete groups. You can also edit some properties of a group such as the group's display name.
The Roles page lists the roles defined for the current application. You can add or delete roles. You can also specify and update the permissions for a role.
The Activities page lists the activities posted in an application. You can view when the activity was posted, who posted the activity, and the content of the activity. You can also search for activities by content or actor.
The Collections page lists the collections created in the current application. You can also search for, add, update, or deleted collections.
Use this page to collect and analyze Usergrid usage data such as the number of times a particular collection has been accessed over a period of time. You can specify parameters for data collection, including what data points you'd like to collect, over what time period, and at what resolution. When you click the Generate button, the results are displayed in tabular form and graphically in the lower portion of the page.
The Properties page lists the credentials (Client ID and Client Secret) for the current application. You can regenerate credentials for the application from this page.
The Shell page gives you a simple way to get started using the Usergrid API. It provides a command-line environment within your web browser for trying out Usergrid API calls interactively.
You can display the equivalent cURL syntax for each API call that is made through the Admin portal. The calls are displayed in the console area of any of the following browsers: Chrome, Internet Explorer (in the debugger), Firefox (in Firebug), and Safari. For details, see Displaying Usergrid API calls as Curl commands:
More information on cURL can be found here:
We welcome your enhancements!
Like Usergrid, the Admin portal is open source and licensed under the Apache License, Version 2.0.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push your changes to the upstream branch (
git push origin my-new-feature)
- Create new Pull Request (make sure you describe what you did and why your mod is needed)
For more information on App Services, Apigee's free hosted version of Usergrid, visit http://apigee.com/about/developers.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.