API Users

API Users are users that have access to Medium One’s platform through API endpoints. There are three different types of API Users:

  • API Basic User
  • API Registration User
  • API Business User

Note: API Users for each project are independent i.e. If you change the password for API user on one project, it doesn’t change for any other project.

A summary of their permissions is described in the table below:

API Basic User

This role can create/retrieve/update/delete event data, retrieve/update their own user information, and fetch processed events. They cannot log in to the Medium One web portal.

There are three ways to create an API Basic User:

  • Through the UI
    • Go to Setup > Manage Users on the navigation sidebar. Here, you can find a list of all your API Basic Users.
    • On the Setup → Manage Users page, click Add New User and fill out the username and password info then save.
    • After creating a new user, you should now see it appear on the Manage Users page. You may have to refresh to see this change.
  • Using CURL command (for Mac)
    • First, you need to login, then you can create the user. Remember to replace the parameters (values in all CAPS) with your credentials.
    • Login (with your API Business User credentials):
      curl -c cookie_user.txt -i -X POST -d '{"login_id":"API_BUSINESS_LOGIN","password":"API_BUSINESS_PASSWORD","api_key":"APIKEY"}' https://api.mediumone.com/v2/login/ --header "Content-Type: application/json"
    • Create API Basic User:
      curl -b cookie_user.txt -i -X POST -d '{"login_id":"API_BASIC_USERNAME","password":"API_BASIC_PASSWORD"}' https://api.mediumone.com/v2/users/ --header "Content-Type: application/json"

Creation, updates, and deletion of API Basic Users are done exclusively through the Medium One API by an API Business User. In addition, API Registration Users can create API Basic Users, but not update or delete.

API Basic Users can also be disabled or enabled. By default, all API Basic Users are enabled once created. If they are disabled, they cannot send any event data nor can any data be sent on their behalf.

To disable an API Basic User:

curl -b cookie_user.txt -i -X PATCH -d '{"disabled":true}' https://api.mediumone.com/v2/users/johndoe --header "Content-Type: application/json"

Users that can disable an API Basic User:

  • Themselves
  • API Registration Users
  • API Basic Users

Users that can enable an API Basic User:

  • API Registration Users
  • API Basic Users

 

API Registration User

 

This role can only create API Basic Users. This role is intended for environments such as self-registering a new user from a mobile application.

Creation, updates, and deletion of API Registration Users are done through the Manage Administrators web page.

 

API Business User

 

This role is a trusted account that can access all API Basic Users’ data and is intended for the cloud to cloud integration.

Creation, update, and deletion of API Business Users are done through the Manage Administrators web page.