IBM MaaS360 API reference for web services

MaaS360® allows administrators to access the web services API from the MaaS360 Portal user interface. Contact IBM® Support to enable this feature for your MaaS360 account.

The API reference for web services includes details such as implementation notes, mandatory attributes to run the API, access control details, response classes with model examples, and parameter details.

Web services API accessibility rights

MaaS360 includes two types of accessibility rights to access the web services API from the MaaS360 Portal. Assign the appropriate web services API accessibility rights to administrator accounts with the Service admin role.

  • Read access: The administrator can view the web service API documentation in the MaaS360 Portal. Business administrator (BU) accounts are provided with read access.
  • Admin access: The administrator can view and sample the web service API documentation in the MaaS360 Portal. Customer administrator accounts are provided with admin access.

Depending on the type of access rights an administrator is assigned, the accessibility level of web service API for an administrator account varies.

Web services API availability from the MaaS360 Portal

Administrators with the appropriate accessibility roles can access the web services API from the MaaS360 Portal. Go to Setup > Web Services API and then click Documentation to view or run the web services API from the portal.

An administrator account with admin access can use the Try it out option to run the web service API.

Note: The MaaS360 web services API supports TLS version 1.1 and later.

Web services API execution steps from the MaaS360 Portal

  1. From Setup > Web Services API, click Documentation.
  2. Go to Authentication API, enter the customer billing ID and the body parameters.
  3. Click Try it out to generate an authentication token.
    Note: Copy the generated authentication token in the response body to try out any MaaS360 web services API. After you generate the token, the token is valid for 60 minutes.
  4. Go to any MaaS360 web services API in the MaaS360 Portal, and provide the following details:
    • All the mandatory parameters that you need to try out the API such as billing ID.
    • The authorization token that you generated in step 3.
      Note: The authentication token value must be entered in quotation marks and use the prefix MaaS token=. For example, MaaS token="xxxxxx".
  5. Click Try it out to try the web service API. The request URL, response body, response code, and response headers are displayed for the web services API.
    Note: The response content type is application/XML by default. Choose application/json if the response content type must be in the JSON format.