Was this Helpful?

Base URL: https://api.usergrid.com/

Access Token

URI Verb Content Types Action  
/management/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"client_secret"}' POST application/json Obtain an access token (access type = organization) Detail
/management/token '{"grant_type":"password","username":"{username}":"password"="{password}"}' POST application/json Obtain an access token (access type = admin user) Detail
/management/{org_id}/{app_id}/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}' POST application/json Obtain an access token (access type = application) Detail
/management/{org_id}/{app_id}/token '{"grant_type":"password","username":"{username}","password":"{password}"}' POST application/json Obtain an access token (access type = application user) Detail

Admin users

URI Verb Content Types Action  
/management/users POST application/json Create an admin user Detail
/management/users/{user|username|email|uuid} PUT application/json Update an admin user Detail
/management/users/{user|username|email|uuid} GET application/json Get an admin user Detail
/management/users/{user|username|email|uuid}/
password
PUT application/json Set an admin user's password Detail
/managementusers/resetpw GET application/json Initiate the reset of an admin user's password Detail
/management/users/resetpw POST application/json Complete the reset of an admin user's password Detail
/management/users/{user|username|email|uuid}/activate?
token={token}&confirm={confirm_email}
GET application/json Activate an admin user Detail
/management/users/{user|username|email|uuid}/reactivate GET application/json Reactivate an admin user Detail
/management/users/{user|username|email|uuid}/feed GET application/json Get an admin user's feed Detail

Applications

See Organizations

Organizations

URI Verb Content Types Action  
/management/organizations|orgs POST application/json Create an organization Detail
/management/organizations|orgs/{org_name}|{uuid} GET application/json Retrieve an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/
activate?token={token}&confirm={confirm_email}
GET application/json Activate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/
reactivate
GET application/json Reactivate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/
credentials
POST application/json Generate organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/
credentials
GET application/json Retrieve organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/
feed
GET application/json Retrieve an organization's activity feed Detail
/management/organizations|orgs/{org_name}|{org_uuid}/
apps
POST application/json Create an organization application Detail
/management/organizations|orgs/{org_name}|{org_uuid}/
apps/{app_name}|{app_uuid}
DELETE application/json Delete an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/
applications|apps/{app_name}|{uuid}/
credentials
POST application/json Generate credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/
applications|apps/
{app_name}|{uuid}/credentials
GET application/json Get credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/
applications|apps
GET application/json Get the applications in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/
users/{username|email|uuid}
PUT application/json Adding an admin user to an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users GET application/json Getting the admin users in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/
users/{username|email|uuid}
DELETE application/json Removing an admin user from an organization Detail

Activities

URI Verb Content Types Action  
/{org_id}/{app_id}/users/
{uuid|username}/activities
POST application/json Create an activity Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}/activities
POST application/json Post an activity to a group Detail

Assets

See Collections (other than users, groups, and roles)

Collections (other than users, groups, and roles)

URI Verb Content Types Action  
/{org_id}/{app_id}/ GET application/json Retrieve all collections Detail
/{org_id}/{app_id}/{collection} POST application/json Create a new entity or collection Detail
/{org_id}/{app_id}/{collection}/
{uuid|name}
GET application/json Retrieve an entity Detail
/{org_id}/{app_id}/{collection}/
{uuid|name}
PUT application/json Update an entity Detail
/{org_id}/{app_id}/{collection}/
{uuid|name}
DELETE application/json Delete an entity Detail
/{org_id}/{app_id}/{collection}?{query} GET application/json Query a collection Detail
/{org_id}/{app_id}/{collection}?{query} PUT application/json Update a collection by query Detail
/{org_id}/{app_id}/{collection}/{entity_id}/
{relationship}?{query}
GET application/json Query an entity's collections or connections Detail
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_id}
or
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_type}/{second_entity_id}
POST application/json Add an entity to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_id}
or
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_type}/{second_entity_id}
DELETE application/json Remove an entity from a collection or delete a connection Detail

Devices

See Collections (other than users, groups, and roles)

Events

URI Verb Content Types Action  
/{org_id}/{app_id}/events POST application/json Create an event Detail

Folders

See Collections (other than users, groups, and roles)

Groups

URI Verb Content Types Action  
/{org_id}/{app_id}/groups POST application/json Create a new group Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}/users/{uuid|username}
POST application/json Add a user to a group Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}
GET application/json Get a group Detail
/{org_id}{app_id}/groups/
{uuid|groupname}
PUT application/json Update a group Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}/users/{uuid|username}
DELETE application/json Delete user from a group Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}/feed
GET application/json Get a group's feed Detail

Roles

URI Verb Content Types Action  
/{org_id}/{app_id}/roles POST application/json Create a new role Detail
/{org_id}/{app_id}/roles GET application/json Get the roles in an application Detail
/{org_id}/{app_id}/roles/{rolename} DELETE application/json Delete a role Detail
/{org_id}/{app_id}/roles/
{rolename|role_id}/permissions
GET application/json Get permissions for a role Detail
/{org_id}/{app_id}/roles/
{rolename|role_id}/permissions
POST application/json Add permissions to a role Detail
{org_id}/{app_id}/roles/
{rolename|role_id}/permissions?
permission={grant_url_pattern}
DELETE application/json Delete permissions from a role Detail
/{org_id}/{app_id}/roles/{role_id}/
users/{uuid|username}
or
/{org_id}/{app_id}/users/
{uuid|username}/roles/{role_id}
POST application/json Add a user to a role Detail
/{org_id}/{app_id}/roles/{role_id}/
users
GET application/json Get the users in a role Detail
/{org_id}/{app_id}/roles/{role_id}/
users/{uuid|username}
DELETE application/json Delete a user from a role Detail

Users

URI Verb Content Types Action  
/{org_id}/{app_id}/users POST application/json Create a user in the users collection Detail
/{org_id}/{app_id}/users/{user}/
password
POST application/json Set a user's password or reset the user's existing password Detail
/{org_id}/{app_id}/users/
{uuid|username|email_address}
GET application/json Retrieve a user Detail
/{org_id}/{app_id}/users/
{uuid|username}
PUT application/json Update a user Detail
/{org_id}/{app_id}/users/{uuid|username} DELETE application/json Delete a user Detail
/{org_id}/{app_id}/users?{query} GET application/json Query to get users Detail
/{org_id}/{app_id}/groups/
{uuid|groupname}/users/{uuid|username}
POST application/json Add a user to a group Detail
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_id}
or
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_type}/{second_entity_id}
POST application/json Add a user to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_id}
or
/{org_id}/{app_id}/{collection}/
{first_entity_id}/{relationship}/
{second_entity_type}/{second_entity_id}
DELETE application/json Remove a user from a collection or delete a connection Detail
/{org_id}/{app_id}/users/{uuid|username}/
{relationship}?{query}
GET application/json Query a user's collections or connections Detail
/{org_id}/{app_id}/users/
{uuid|username}/feed
GET application/json Get a user's feed Detail

Notifications, Notifiers, and Receipts

See Creating and managing notifications

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)