Maa S360 Webservices Reference Guide V10.67

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 287 [warning: Documents this large are best viewed by clicking the View PDF Link!]

© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
IBM MaaS360®
API Reference Guide
For Web Services
For v10.67
Updated 13 February 2018
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
2
Note: Before using this information and the product it supports, read the information in the Notices
section.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
3
Table of Contents
IBM MaaS360® API Reference Guide For Web Services .................................................. 1
Overview .......................................................................................................... 7
Authentication .................................................................................................... 8
Compressed Content ............................................................................................. 9
Error Codes ..................................................................................................... 10
Webservice usage limits ....................................................................................... 11
Device View to Platform Matrix .............................................................................. 12
Device Actions to Platform Matrix ........................................................................... 13
Device ............................................................................................................ 14
Basic Search (v1) ..................................................................................................... 14
Basic Search (v2) ..................................................................................................... 17
Get Core Attributes ................................................................................................... 20
Get Summary Attributes .............................................................................................. 22
Get Hardware Inventory .............................................................................................. 27
Get Device Identity Attributes ........................................................................................ 31
Get Software Installed ................................................................................................ 32
Get Security & Compliance Information for a Mobile Device ....................................................... 34
Get Enabled MaaS360 Services for a Device......................................................................... 38
Get Network Information for a Mobile Device ....................................................................... 40
Get Patch Information ................................................................................................ 44
Get Network Information for a Computer ............................................................................ 45
Get Security Applications Information ............................................................................... 46
Get Application Distributions ......................................................................................... 49
Get Device Location History .................................................................................. 50
Get Cellular Data Usage for a Device ................................................................................ 50
Get Device Location History ......................................................................................... 51
Get Devices with Associated Users ................................................................................... 53
Get Groups for a Device .............................................................................................. 55
Get Relevant Data Views for a Device ............................................................................... 56
Get Relevant Actions for a Device ................................................................................... 58
Set Device Name ...................................................................................................... 61
Cloud Extender ................................................................................................. 62
Get Cloud Extender Clusters .......................................................................................... 62
Get Cloud Extender Cluster Configuration ........................................................................... 63
Set Cloud Extender Cluster Config ................................................................................... 65
Join Cloud Extender Cluster .......................................................................................... 66
Update Cloud Extender Cluster Name ................................................................................ 67
Add a New Cloud Extender Cluster .................................................................................. 68
Device Actions .................................................................................................. 70
Assign a user to a device .............................................................................................. 70
Set Custom Attribute Value ........................................................................................... 71
Refresh Device Information .......................................................................................... 72
Send Message ......................................................................................................... 73
Locate Device ......................................................................................................... 74
Lock Device ........................................................................................................... 75
Reset Device Passcode ................................................................................................ 76
Change Device Policy ................................................................................................ 77
Change Compliance Ruleset .......................................................................................... 78
Selective Wipe Device ................................................................................................ 79
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
4
Revoke Selective Wipe ............................................................................................... 80
Wipe Device .......................................................................................................... 81
Cancel Pending Wipe ................................................................................................. 82
Approve Device in Messaging System ............................................................................... 83
Block Device in Messaging System .................................................................................. 84
Remove Device ....................................................................................................... 85
Remove Device from Mailbox Server ................................................................................ 86
Hide Device ........................................................................................................... 87
Update Device Certificate ............................................................................................ 88
Check Action Status .................................................................................................. 89
Search Action History (v1) ........................................................................................... 90
Search Action History (v2) ........................................................................................... 92
Create New Device Custom Attribute ................................................................................ 94
Get All Device Custom Attributes for a Given Organization ........................................................ 96
Device Enrollment ............................................................................................. 98
Create Device Enrollment ............................................................................................ 98
Manage Device Enrollments .........................................................................................100
Groups ..........................................................................................................102
Get User & Device Groups ..........................................................................................102
Search Devices by Device Group ....................................................................................103
Search Users by Group...............................................................................................105
Get Group level distributions ........................................................................................107
Get Search Criteria Options ..........................................................................................109
Create Device Groups ................................................................................................111
Create User Groups ..................................................................................................114
My WatchList .................................................................................................116
Get WatchLists .......................................................................................................116
Search by WatchList .................................................................................................117
Policy ...........................................................................................................119
Get Relevant Policies for a Service ..................................................................................119
Get Enabled Services in a Persona Policy ...........................................................................120
Compliance Rules .............................................................................................121
Search Compliance Events ...........................................................................................121
Applications ....................................................................................................123
Search Installed Apps ................................................................................................123
Search Apps ..........................................................................................................125
Get App Details ......................................................................................................128
Search App Distributions ............................................................................................131
Get App Distribution Details by Device .............................................................................133
Distribute App .......................................................................................................135
Delete App ...........................................................................................................136
Upgrade App (apps smaller than 50 MB) ............................................................................137
Upgrade App (apps larger than 50 MB) .............................................................................139
Mark App as Primary ................................................................................................141
Update Provisioning Profile .........................................................................................142
Stop App Distribution ................................................................................................143
Add iTunes App Store App (v1) .....................................................................................144
Add iTunes App Store App (v2) .....................................................................................147
Add iOS Enterprise App (apps smaller than 50 MB) ................................................................150
Add iOS Enterprise App (apps more than 50 MB) ..................................................................152
Enterprise App Upload Request Status ..............................................................................154
Add Google Play App (v1) ..........................................................................................155
Add Google Play App (v2) ..........................................................................................156
Add Android Enterprise App (apps smaller than 50 MB) ...........................................................158
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
5
Add Android Enterprise App (apps larger than 50 MB) .............................................................160
Add Mac App Store App.............................................................................................162
Add Windows Dependency ..........................................................................................165
Add Windows Enterprise App .......................................................................................166
Add Windows EXE App .............................................................................................168
Add Windows MSI App .............................................................................................170
Add Windows Store App ............................................................................................172
Delete Windows Dependency .......................................................................................174
Download Windows Dependency ...................................................................................175
Get Category List ....................................................................................................176
Mark App as Featured ...............................................................................................177
Delete User Review and Update Rating .............................................................................179
List Featured Apps and Bundles Info ................................................................................180
List Apps Bundles with their Apps Info .............................................................................182
Fetch All the Reviews ................................................................................................184
Application Publication Workflow (for use by App Ecosystem Partners only)........................185
Get the list of app events pending for review ........................................................................185
Get details of each app that is pending for scan .....................................................................186
Get binary of the app pending for review ............................................................................187
Submit the app and results of the scan ...............................................................................188
User .............................................................................................................191
Search Users .........................................................................................................191
Add Local User Account .............................................................................................193
Edit a Local User Account ...........................................................................................194
Add Groups to Local User Account .................................................................................195
Remove Groups from Local User Account ..........................................................................196
Get AD Groups ......................................................................................................197
Change Persona Policy ...............................................................................................198
Set Custom Attribute Value for a User ..............................................................................199
Update User Certificate ..............................................................................................200
Get User Custom Attributes .........................................................................................201
Delete User ...........................................................................................................202
Delete User Status....................................................................................................204
Administrator .................................................................................................205
Create Administrator .................................................................................................205
Check Administrator Account Availability ..........................................................................207
Account .........................................................................................................208
Provision New Customer Account ...................................................................................208
Check Account Name Availability ..................................................................................210
Convert Trial into Customer Account ...............................................................................211
Expire an Account ...................................................................................................212
Extend Trial Account ................................................................................................213
Get Customer Accounts ..............................................................................................214
Get Customer Account Configuration ...............................................................................216
Set Customer Account Configuration ...............................................................................218
Sign Apple MDM CSR request ......................................................................................220
Get Device Enrollment Settings .....................................................................................222
Configure Device Enrollment Settings ..............................................................................223
Provision New Partner Account .....................................................................................225
Get Partner Account Configuration ..................................................................................227
Set Partner Account Configuration ..................................................................................229
Get Customer’s Allowed Services ...................................................................................231
Enable a Service for a Customer .....................................................................................233
Disable a Service for a Customer ....................................................................................236
Get User’s Enabled Services .........................................................................................239
Reporting ......................................................................................................242
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
6
Get List of Dashboards...............................................................................................242
Get Report List For A Dashboard....................................................................................243
Download Report Details ............................................................................................244
Cisco ISE Integration .........................................................................................245
MDM Server Info ....................................................................................................245
MDM Device Attributes Query ......................................................................................246
MDM Device Attributes Query (POST version) ....................................................................248
MDM Action .........................................................................................................250
Messaging ............................................................................................................251
Admin Audit ...................................................................................................252
Get Admin Login Reports ...........................................................................................252
Get Roles Audit ......................................................................................................253
Get Services Audit ...................................................................................................254
Get Deployment Settings Audit ......................................................................................255
Get Login Settings Audit ............................................................................................257
Get Notifications Settings Audit .....................................................................................259
Get User Group Changes Audit ......................................................................................260
Get Device Group Changes Audit ...................................................................................262
Get Admin Changes Audit ...........................................................................................264
Alerts ...........................................................................................................266
Create Alert ..........................................................................................................266
Platform-Specific APIs .......................................................................................269
Get GA or Beta Version Details of Mac Apps.......................................................................269
Get Download Location of Mac Apps ...............................................................................271
Change History ................................................................................................272
Notices ..........................................................................................................284
Trademarks ...........................................................................................................285
Terms and conditions for product documentation ...................................................................286
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
7
Overview
❖ MaaS360 provides REST style web-service APIs.
❖ The API response is in XML format.
❖ The API root URL varies by MaaS360 instance on which the customer account exists
o M1: https://services.fiberlink.com/
o M2: https://services.m2.maas360.com/
o M3: https://services.m3.maas360.com/
❖ Every web-service request needs to include the Billing Account context – The
provided Billing Account context is validated against context available with the
authenticated session. All web-services will require authentication.
❖ UTF-8 encoding should be used when sending arguments to the API.
❖ All timestamp attributes returned by the webservices are in GMT
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
8
Authentication
To use any web service, the app will need to authenticate first and get an authentication
token. Once generated, authentication token is valid for 60 mins. Webservices can continue
to be executed using this token and once it expires, a refreshed authentication token will
need to be generated.
To be able to make the request to generate authentication token, we need to provision the
app in MaaS360 with authorization to use MaaS360 webservices. Contact Fiberlink support for
provisioning this. Once provisioned, the following information will be provided:
• App ID
• App Version
• Platform ID
• App Access Key
Following inputs will then need to be provided for token generation.
• ROOT_WS_URL: Depends on your MaaS360 instance
o M1: https://services.fiberlink.com/
o M2: https://services.m2.maas360.com/
o M3: https://services.m3.maas360.com/
• Billing ID: <<Customer's Billing ID>>
• Administrator Username: <<Your MaaS360 Username>>
• Administrator Password: <<Your MaaS360 Password>>
• App ID (for App authorized to use MaaS360 services): <<App ID provisioned in
MaaS360>>
• App Version: <<App Version of app provisioned in MaaS360>>
• Platform ID: 3 <<Use this for now>>
• App Access Key: <<Access Key generated by MaaS360>>
Sample java program that uses MaaS360 web services is provided along with this document.
There are 2 java files in the zipped file:
• Authenticator.java - Outlines how to authenticate.
• Client.java – Outlines how to make device api calls (search as an example) using the
token generated by the Authenticator.
Third-party jars etc. required by the sample programs are already part of the tar file.
The customer will need to configure sections in the code within the following comment
blocks.
// [[ Section to be configured by the caller
// Section to be configured by the caller ]]
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
9
Compressed Content
Web service response can be retuned as compressed content to support transfer of large
volumes of data.
Webservice client will have send the following Header to indicate that it wants compressed
content: Accept-Encoding:deflate.
In case the Webservice client accepts compressed content, server may return compressed
content. In this case it will return following header indicating that the content is
compressed using deflate: Content-Encoding:deflate.
If client doesn’t send Accept-Encoding:deflate header, the response will never be
compressed by server.
Webservice client needs to decompress the received data else it will be illegible.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
10
Error Codes
Web-services will return a Response and HTTP Response Status Code.
❖ Status Code indicates whether the web-service has executed successfully or an
error condition. Possible values:
o 200 OK: Success
o 400 Bad Request: The web-service request was invalid.
o 401 Unauthorized: Authentication for the web-service request failed.
Invalid credentials.
o 403 Forbidden: Web-service request is requesting a resource that the
server does not allow access to.
o 404 Not Found: The requested resource is not found.
o 500 Internal Server Error: An internal server error occurred while
processing the request.
o 502 Bad Gateway: MaaS360 Web-service server is not reachable.
o 503 Service Unavailable: The server is currently unable to handle the
request due to a temporary overloading or maintenance of the server. The
implication is that this is a temporary condition which will be alleviated
after some delay.
o 204 No Content
❖ Response contains the result of web-service execution
In case of critical errors, following is the recommendation:
❖ 500: Report a bug. Do not retry till the bug is fixed
❖ 502: Retry after 10 min
❖ 503: Retry after 10 min
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
11
Webservice usage limits
MaaS360 continuously monitors usage of webservices and at an account level, by default, applies the
following limits per day for various categories of webservices:
- device-apis/: 100,000
- auth-apis/: 250,000
- application-apis/: 100,000
- user-apis/: 100,000
In case you exceed these limits and want to increase them, contact Fiberlink Technical support with details
of your current usage.
In every webservice, the following new HTTP headers are returned. Inspect these headers for data on
webservices usage.
- X-Rate-Limit-Max: The rate limit ceiling for that given request
- X-Rate-Limit-Remaining: The number of requests left for the day window <24 hours - not calendar
day>
- X-Rate-Limit-ResetWindow: The remaining window before the rate limit resets in seconds - from
time of call
On exceeding the rate limits for the day, API calls will return an HTTP 429 “Too Many Requests” or HTTP
500 (Internal Server Error) response code (HTTP 500 is likely with Apache 2.1).
Webservice clients should respect these error codes and stop calling webservices for the remaining period
of the day.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
12
Device View to Platform Matrix
Methods
Windows
Mac
ActiveSync
Devices
BlackBerrys
iOS MDM
Android
MDM
Windows
Phone
Basic Search
X
X
X
X
X
X
X
Get Core Attributes
X
X
X
X
X
X
X
Get Summary Attributes
X
X
X
X
X
X
X
Get Hardware Inventory
X
X
X
X
X
X
X
Get Device Identity Attributes
X
X
X
X
X
X
X
Get Software Installed
X
X
X
X
X
X
Get Security & Compliance
Information for a Mobile Device
X
X
X
X
X
Get Enabled MaaS360 Services for
a Device
X
X
X
Get Network Information for a
Mobile Device
X
X
X
X
Get Patch Information for a
Computer
X
X
Get Network Information for a
Computer
X
X
Get Security Applications
Information
X
X
Get Application Distributions
X
X
X
X
Get Location History
X
X
X
Get Cellular Data Usage for a
Device
X
X
Get Devices with Associated
Users
X
X
Get Groups for a Device
X
X
X
Get Relevant Data Views for a
Device
X
X
X
X
X
X
X
Get Relevant Actions for a Device
X
X
X
X
X
X
X
Set Device Name
X
X
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
13
Device Actions to Platform Matrix
Methods
Windows
Mac
ActiveSync
Devices
BlackBerrys
iOS MDM
Android
MDM
Windows
Phone
MDM
Refresh Device Information
X
X
X
X
Assign a User to a Device
X
X
Set Custom Attribute Value
X
X
Refresh Device Information
X
X
Send Message
X
X
Locate Device
X
X
X
Lock Device
X
X
X
Reset Device Passcode
X
X
X
X
Change Device Policy
X
X
X
X
X
Change Compliance Ruleset
X
X
X
X
X
Update Device Certificate
X
X
X
Selective Wipe Device
X
X
X
Revoke Selective Wipe
X
X
X
Wipe Device
X
X
X
X
X
Cancel Pending Wipe
X
X
X
X
X
Approve Device in Messaging
System
X
Block Device in Messaging System
X
Remove Device
X
X
X
X
X
X
X
Remove Device from Mailbox
Server
X
X
Hide Device
X
X
X
X
X
X
X
Check Action Status
X
X
X
X
X
X
X
Search Action History
X
X
X
X
X
X
X
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
14
Device
Basic Search (v1)
Request
GET /device-apis/devices/1.0/search/<billingID>
Definition
❖ Search for devices by Device Name, Username, Phone Number, Platform, Device Status and other
Device Identifiers
❖ Support for partial match for Device Name, Username, Phone Number
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
deviceStatus
Optional
Active or Inactive
partialDeviceName
Optional
Partial (Starts with) or full Device Name string that
needs to be searched for
partialUsername
Optional
Partial (Starts with) or full Username string that needs
to be searched for
partialPhoneNumber
Optional
Partial (Starts with) or full Phone Number that needs to
be searched for
udid
Optional
Full UDID of the device. Specific to iOS devices
imeiMeid
Optional
Full IMEI or MEID of the device
wifiMacAddress
Optional
Full Wi-Fi Mac Address of the device
mailboxDeviceId
Optional
Full ActiveSync ID of the device
excludeCloudExtenders
Optional
Possible values: Yes (Default), No
platformName
Optional
Windows
Mac
iOS
BlackBerry
Android
Windows Mobile
Symbian
Windows Phone 7
Others
operator
Optional
Operator to be used between various criteria. Default
value = “AND”
match
Optional
0 indicates Partial match for Device Name, Username,
Phone Number – This is the default value
1 indicates Exact match
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular page. Default is first
page
billingID
Required
Billing ID of the account for which the web-service is
being executed
sortAttribute
Optional
Possible values:
- lastReported (Default)
- installedDate
sortOrder
Optional
Possible values:
- asc
- dsc (Default)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
15
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/search/1101234?deviceStatus=Active&partialDeviceName=BBFL&partialUsername=ther&
partialPhoneNumber=99005&platformName=Windows&operator=OR&match=0&pageSize=25&pageNumber
=2
Sample Response
<devices>
<device>
<maas360DeviceID>ApplF17R9GAGGRY5</maas360DeviceID>
<deviceName>iPhone</deviceName>
<customAssetNumber></customAssetNumber>
<ownership>Corporate Owned</ownership>
<deviceOwner></deviceOwner>
<username>vinayaknp</username>
<emailAddress>vinayaknp@in.ibm.com</emailAddress>
<platformName>iOS</platformName>
<sourceID>1</sourceID>
<deviceType>Smartphone</deviceType>
<manufacturer>Apple</manufacturer>
<model>iPhone 6S</model>
<osName>iOS 11</osName>
<osServicePack></osServicePack>
<imeiEsn>355763072568722</imeiEsn>
<installedDate>2017-12-08T07:53:53</installedDate>
<lastReported>2017-12-08T07:53:54</lastReported>
<installedDateInEpochms>1512719633199</installedDateInEpochms>
<lastReportedInEpochms>1512719634449</lastReportedInEpochms>
<deviceStatus>Active</deviceStatus>
<maas360ManagedStatus>Enrolled</maas360ManagedStatus>
<udid>647f87aaa8a9ede2cdf6773e886b18067232fbf5</udid>
<wifiMacAddress>e4:9a:79:d7:0e:06</wifiMacAddress>
<mailboxDeviceId></mailboxDeviceId>
<mailboxLastReported></mailboxLastReported>
<mailboxLastReportedInEpochms></mailboxLastReportedInEpochms>
<mailboxManaged></mailboxManaged>
<isSupervisedDevice>false</isSupervisedDevice>
<testDevice>false</testDevice>
<unifiedTravelerDeviceId>3UV2UD4GP564N3T67UD4AG50AS</unifiedTravelerDeviceId>
</device>
<count>1</count>
<pageNumber>1</pageNumber>
<pageSize>1</pageSize>
</devices>
Possible values for SourceID:
1: Device
2: Messaging Server (Exchange Server/Lotus Notes)
3: Device as well as Messaging Server (Exchange Server/Lotus Notes)
4: BES
Mandatory attributes in Response
- maas360DeviceID
- deviceName
- username
- platformName
- deviceType
- lastReported
- deviceStatus
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
16
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
17
Basic Search (v2)
Request
GET /device-apis/devices/2.0/search/customer/<billingID>
Definition
❖ Search for devices by Device Name, Username, Phone Number, Platform, Device Status and other
Device Identifiers
❖ Support for partial match for Device Name, Username, Phone Number
❖ Get results on specified pages of the Result-set
❖ Returns JSON as default response. Only when Accept header is set to application/xml, XML response
is returned
Parameters
Parameter Name
Required /
Optional
Description
deviceStatus
Optional
Active or Inactive
partialDeviceName
Optional
Partial (Starts with) or full Device Name string
partialUsername
Optional
Partial (Starts with) or full Username string
partialPhoneNumber
Optional
Partial (Starts with) or full Phone Number
udid
Optional
Full UDID of the device. Specific to iOS devices
imeiMeid
Optional
Full IMEI or MEID of the device
wifiMacAddress
Optional
Full Wi-Fi Mac Address of the device
mailboxDeviceId
Optional
Full ActiveSync ID of the device
platformName
Optional
Windows
Mac
iOS
BlackBerry
Android
Windows Mobile
Symbian
Windows Phone 7
Others
excludeCloudExtenders
Optional
Possible values: Yes (Default), No
maas360DeviceId
Optional
Full MaaS360 Device ID string that needs to be searched
for
userDomain
Optional
Full User domain string that needs to be searched for
email
Optional
Full Email address string that needs to be searched fo
maas360ManagedStatus
Optional
Possible values:
- Inactive
- Activated
- Control Removed
- Pending Control Removed
- User Removed Control
- Not Enrolled
- Enrolled
mailBoxManaged
Optional
Possible values:
- ActiveSync
- Domino
- BES
- GmailSync
- RPAS
mdmMailboxDeviceId
Optional
Full ActiveSync Device ID of the device reported by
MDM
plcCompliance
Optional
Possible values: OOC, ALL (Default)
ruleCompliance
Optional
Possible values: OOC, ALL (Default)
appCompliance
Optional
Possible values: OOC, ALL (Default)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
18
pswdCompliance
Optional
Possible values: OOC, ALL (Default)
selectiveWipe
Optional
Possible values: NOTAPPLIED, PENDING, COMPLETE
installedAfter
Optional
Installed date after
lastReportedAfter
Optional
Last reported date after
operator
Optional
Operator to be used between various criteria. Default
value = “AND”
match
Optional
0 indicates Partial match for Device Name, Username,
Phone Number – This is the default value
1 indicates Exact match
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 250
pageNumber
Optional
Results specific to a particular page. Default is first
page
billingID
Required
Billing ID of the account for which the web-service is
being executed
sortAttribute
Optional
Possible values:
- lastReported (Default)
- installedDate
sortOrder
Optional
Possible values:
- asc
- dsc (Default)
Sample Request
https://services.fiberlink.com/device-
apis/devices/2.0/search/customer/1101234?deviceStatus=Active&partialDeviceName=BBFL&partialUsern
ame=lind&partialPhoneNumber=99005&platformName=Windows&operator=OR&match=0&pageSize=25&p
ageNumber=2
Sample Response (JSON)
{
"devices":
{
"device":
{
"maas360DeviceID": "androidc60775214",
"deviceName": "glindsey-ADR6400L",
"customAssetNumber": "",
"ownership": "Corporate Owned",
"deviceOwner": "",
"username": "dlindsey",
"emailAddress": "TEST@EXAMPLE.COM",
"platformName": "Android",
"sourceID": 1,
"deviceType": "Smartphone",
"manufacturer": "HTC",
"model": "ADR6400L",
"osName": "Android 2.2.1 (FRG83D)",
"osServicePack": "",
"imeiEsn": 99000032580168,
"installedDate": "2011-04-27T16:36:00",
"lastReported": "2011-05-09T17:13:15",
"deviceStatus": "Active",
"maas360ManagedStatus": "Activated",
"udid": "Androide636110899cac677",
"wifiMacAddress": "n\/a",
"mailboxDeviceId": "",
"mailboxLastReported": "",
"mailboxManaged": "",
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
19
"isSupervisedDevice": "true",
"unifiedTravelerDeviceId": "Androide636110899cac677",
"phoneNumber": 8588885305,
"userDomain": "na",
"policyComplianceState": "In Compliance",
"appComplianceState": "",
"ruleComplianceState": "",
"selectiveWipeStatus": "n\/a",
"jailbreakStatus": "No",
"encryptionStatus": "Not Supported",
"passcodeCompliance": "Compliant",
"mdmMailboxDeviceId": ""
},
"count": 1,
"pageNumber": 1,
"pageSize": 1
}
}
Possible values for SourceID:
1: Device
2: Messaging Server (Exchange Server/Lotus Notes)
3: Device as well as Messaging Server (Exchange Server/Lotus Notes)
4: BES
Mandatory attributes in Response
- maas360DeviceID
- deviceName
- username
- platformName
- deviceType
- lastReported
- deviceStatus
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
20
Get Core Attributes
Request
GET /device-apis/devices/1.0/core/<billingID>
Definition
❖ Get core attributes of a device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/core/1101234?deviceId=a2e13f
Sample Response
<device>
<maas360DeviceID>a2e13f</maas360DeviceID>
<deviceName>BBFLLT3337</deviceName>
<customAssetNumber>09026</customAssetNumber>
<ownership>Employee Owned</ownership>
<deviceOwner>Stephen Murphy</deviceOwner>
<username>smurphy</username>
<emailAddress>smurphy@example.com</emailAddress>
<platformName>Windows</platformName>
<sourceID>1</sourceID>
<deviceType>Laptop</deviceType>
<manufacturer>Lenovo</manufacturer>
<model>T400</model>
<osName>Microsoft Windows XP</osName>
<osServicePack>SP2</osServicePack>
<imeiEsn>3456789019202019</imeiEsn>
<wifiMacAddress>09:AB:12:12:21:13</wifiMacAddress>
<udid>8e380a56a937cce81620b143359d3404498dd638</udid>
<unifiedTravelerDeviceId>ApplCCQK66E7F4JR</unifiedTravelerDeviceId>
<installedDate>2010-11-30T05:52:53.011+00:00</installedDate>
<lastReported>2010-11-30T05:52:53.011+00:00</lastReported>
<deviceStatus>Active</deviceStatus>
<maas360ManagedStatus>Not Enrolled</maas360ManagedStatus>
<mailboxManaged>ActiveSync Managed</mailboxManaged>
<mailboxDeviceID>Appl1234567</mailboxDeviceID>
<mailboxLastReported>2010-11-30T05:52:53.011+00:00</mailboxLastReported>
</device>
Mandatory attributes in Response
- maas360DeviceID
- deviceName
- username
- platformName
- deviceType
- lastReported
- deviceStatus
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
21
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
22
Get Summary Attributes
Request
GET /device-apis/devices/1.0/summary/<billingID>
Definition
❖ Get summary attributes of a device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/summary/1101234?deviceId=a2e13f
Sample Response
<deviceSummary>
<maas360DeviceId>a2e13f</maas360DeviceId>
<deviceAttributes>
<deviceAttribute>
<key>isOnline</key>
<type>Boolean</type>
<value>Yes</value>
<deviceAttribute>
</deviceAttributes>
</deviceSummary>
Mandatory attributes in Response
- maas360DeviceId
- key
- type
Various Device Attributes
Platform = 1 (Windows)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
IBM
Hardware
10
Model
String
ThinkPad T42
Hardware
20
Physical Memory
Installed (MB)
Integer
1024
Hardware
30
Free Space On
System Drive(%)
Percentage
64.97 %
Hardware
40
Operating System
String
Microsoft Windows XP
Hardware
50
Office/Location
String
Bangalore
Hardware
60
Anti-Virus Status
String
Not Detected
Security
10
Anti-Virus Definition
Date
Date
2010-12-30
Security
20
Anti-Spyware Status
String
Not Detected
Security
30
Personal Firewall
Status
String
Not Detected
Security
40
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
23
Encryption Status
String
Not Detected
Security
50
Last Backup
Date
2010-12-30
Security
60
Microsoft Auto-
Update Status
String
Disabled
Security
70
Missing Critical
Security Patches
Integer
10
Security
80
Service Package
String
Operational Visibility
MaaS360 Services
10
Installed Date (GMT)
Timestamp
2010-11-
30T05:52:53.011+00:00
MaaS360 Services
20
Platform = 2 (Mac)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
IBM
Hardware
10
Model
String
ThinkPad T42
Hardware
20
Physical Memory
Installed (MB)
Integer
1024
Hardware
30
Free Space On
System Drive(%)
Percentage
64.97 %
Hardware
40
Operating System
String
Microsoft Windows XP
Hardware
50
Office/Location
String
Bangalore
Hardware
60
Service Package
String
Operational Visibility
MaaS360 Services
10
Installed Date (GMT)
Timestamp
2010-11-
30T05:52:53.011+00:00
MaaS360 Services
20
Source = 2 & Any Platform value
Key
Type
Example Value
Display Section
Display Order
Installed Date
(GMT)
Timestamp
2010-11-30T05:52:53.011+00:00
Hardware
10
Email Address
String
smurphy@example.com
Hardware
20
Manufacturer
String
IBM
Hardware
30
Model
String
ThinkPad T42
Hardware
40
Operating System
String
Microsoft Windows XP
Hardware
50
Default Language
String
Bangalore
Hardware
60
ActiveSync Agent
String
RoadSync-Android/2.502
Hardware
70
ActiveSync Device
ID
String
354957034059348
Hardware
80
Exchange Approval
State
String
Quarantined
Security &
Compliance
10
Remote Wipe
Support
String
Yes
Security &
Compliance
20
Device Wiped
String
Pending
Security &
Compliance
30
Last Wipe Applied
Date (GMT)
Timestamp
2010-11-30T05:52:53.011+00:00
Security &
Compliance
40
Exchange
ActiveSync Policy
String
9.3 Exchange
Security &
Compliance
50
Last Policy Updated
Date (GMT)
Timestamp
2010-11-30T05:52:53.011+00:00
Security &
Compliance
60
Device Passcode
Status
String
Passcode Policy Not Configured
Security &
Compliance
70
Source = 1 or 3 & Platform = 3 (iOS)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
Apple
Hardware
10
Model
String
iPhone 3Gs
Hardware
20
Operating System
String
iOS4
Hardware
30
Free Internal
Storage (GB)
Integer
10.25
Hardware
40
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
24
Apple Serial
Number
String
86019B093NQ
Hardware
50
Ownership
String
Corporate Owned
Hardware
60
Exchange Activated
String
Yes
Hardware
70
Email Address
String
smurphy@example.com
Hardware
80
Phone Number
String
09742040039
Network
Information
10
ICCID
String
8991 8600 4420 2837 752
Network
Information
20
Roaming
String
No
Network
Information
30
International Data
Roaming Enabled
String
Enabled
Network
Information
40
Home Carrier
String
Vodafone
Network
Information
50
Current Carrier
String
Vodafone
Network
Information
60
MDM Policy
String
General Policy - vipin (5)
Security &
Compliance
10
Device Passcode
Status
String
Compliant
Security &
Compliance
20
Hardware
Encryption
String
Block-level & File-level
Security &
Compliance
30
Exchange Approval
State
String
Approved
Security &
Compliance
40
Source = 4 (BES)
Key
Type
Example Value
Display Section
Display Order
PIN
String
22100AB1
Hardware
10
Model
String
Curve 8900
Hardware
20
Operating System
Version
String
6.0.0.284
Hardware
30
Ownership
String
Corporate Owned
Hardware
40
Test Device
Boolean
Yes
Hardware
45
Email Address
String
smurphy@example.com
Hardware
50
Phone Number
String
09742040039
Network
Information
10
ICCID
String
8991 8600 4420 2837 752
Network
Information
20
Home Carrier
String
Vodafone
Network
Information
30
Current Carrier
String
Vodafone
Network
Information
40
Last Time Message
Received by Device
Timestamp
2010-11-30T05:52:53
Messaging
History
10
Last Time Message
Sent from Device
Timestamp
2010-11-30T05:52:53
Messaging
History
20
BES Policy Name
String
General Policy - vipin (5)
Security &
Compliance
10
Policy Compliance
State
String
In-Compliance
Security &
Compliance
20
Device Passcode
Status
String
Compliant
Security &
Compliance
30
User-Device
Configuration
String
Default Configuration
Security &
Compliance
40
Source = 1 or 3 and Platform = 5 (Android)
Key
Type
Example Value
Display Section
Display Order
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
25
Manufacturer
String
Apple
Hardware
10
Model
String
iPhone 3Gs
Hardware
20
Operating System
String
iOS4
Hardware
30
Total Free Storage
(GB)
Integer
10.25
Hardware
40
Device Serial
Number
String
86019B093NQ
Hardware
50
Ownership
String
Corporate Owned
Hardware
60
Test Device
Boolean
Yes
Hardware
65
Exchange Activated
String
Yes
Hardware
70
Email Address
String
smurphy@example.com
Hardware
80
Phone Number
String
09742040039
Network
Information
10
SIM
String
8991 8600 4420 2837 752
Network
Information
20
Roaming
String
No
Network
Information
30
International Data
Roaming Enabled
String
Enabled
Network
Information
40
Home Carrier
String
Vodafone
Network
Information
50
Current Carrier
String
Vodafone
Network
Information
60
MDM Policy
String
General Policy - vipin (5)
Security &
Compliance
10
Policy Compliance
State
String
In-Compliance
Security &
Compliance
20
Device Rooted
String
No
Security &
Compliance
30
Background Data
Sync Enabled
String
No
Security &
Compliance
40
Device Passcode
Status
String
Compliant
Security &
Compliance
50
Exchange Approval
State
String
Approved
Security &
Compliance
60
Source = 1 or 3 and Platform = 7 (Symbian)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
Apple
Hardware
10
Model
String
iPhone 3Gs
Hardware
20
Operating System
String
iOS4
Hardware
30
Total Free Storage
(GB)
Integer
10.25
Hardware
40
Device Serial
Number
String
86019B093NQ
Hardware
50
Ownership
String
Corporate Owned
Hardware
60
Test Device
Boolean
Yes
Hardware
65
Exchange Activated
String
Yes
Hardware
70
Email Address
String
smurphy@example.com
Hardware
80
Phone Number
String
09742040039
Network
Information
10
SIM
String
8991 8600 4420 2837 752
Network
Information
20
Roaming
String
No
Network
Information
30
International Data
Roaming Enabled
String
Enabled
Network
Information
40
Home Carrier
String
Vodafone
Network
Information
50
Current Carrier
String
Vodafone
Network
Information
60
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
26
Device Passcode
Status
String
Compliant
Security &
Compliance
10
Hardware
Encryption
String
No
Security &
Compliance
20
Data Backup
Enabled
String
No
Security &
Compliance
30
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
27
Get Hardware Inventory
Request
GET /device-apis/devices/1.0/hardwareInventory/<billingID>
Definition
❖ Get hardware inventory attributes of a device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/hardwareInventory/1101234?deviceId=a2e13f
Sample Response
<deviceHardware>
<maas360DeviceId>a2e13f</maas360DeviceId>
<deviceAttributes>
<deviceAttribute>
<key>Manufacturer</key>
<type>String</type>
<value>Dell Inc</value>
<deviceAttribute>
</deviceAttributes>
</deviceHardware>
Mandatory attributes in Response
- maas360DeviceId
- key
- type
Various Device Attributes
Platform = 1 (Windows)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
IBM
Hardware
10
Model
String
ThinkPad T42
Hardware
20
Model ID
String
Latitude E5500
Hardware
30
Device Type
String
Laptop
Hardware
40
Motherboard Serial
Number
String
.2F5NXG1.CN7016695D0003.
Hardware
50
BIOS Serial Number
String
2F5NXG1
Hardware
60
BIOS Date
Date
30/07/2010
Hardware
70
Processor
String
Intel(R) Core(TM)2 Duo CPU
T9550 @ 2.66GHz
Hardware
80
Physical Memory
Installed (MB)
Integer
4 GB
Hardware
90
WMI Status
String
Running
Hardware
100
Test Device
String
No
Hardware
110
OS Username
String
Jdoe
Hardware
120
User Access Level
String
Administrator
Hardware
130
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
28
CD/DVD Name
String
HL-DT-ST DVD+-RW GT10N ATA
Device
Hardware
140
Local Timezone
String
(UTC-05:00) Eastern Time (US
& Canada)
Hardware
150
Number of Drives
Integer
2
Hardware
160
Total Drive Size
(GB)
Float
160
Hardware
170
Total Free Space
(GB)
Float
25
Hardware
180
Operating System
String
Microsoft Windows 7
Operating System
10
OS Edition
String
Enterprise Edition
Operating System
20
Service Pack
String
SP1
Operating System
30
OS Architecture
String
32 bit
Operating System
40
Version
String
6.1.7600
Operating System
50
Default OS Language
String
English - United States
Operating System
60
Microsoft Auto-
Update Status
String
Automatically download and
install patches
Operating System
70
Platform = 2 (Mac)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
Apple
Hardware
10
Model
String
MacBook Pro
Hardware
20
Model ID
String
MacBook Pro 4,1
Hardware
30
Device Type
String
Laptop
Hardware
40
Boot Rom Version
String
MBP41.00c1.b03
Hardware
50
SMC Version
String
1.27f2
Hardware
60
Manufactured Date
Date
2/10/2009
Hardware
70
Apple Serial Number
String
W88341H6YJX
Hardware
80
UDID
String
9D86CFF6-5FD8-5E49-81C3-
BD1F7BEB5947
Hardware
90
Processor
String
2000 MHz Core 2
Hardware
100
Physical Memory
Installed (MB)
Integer
2048
Hardware
110
OS Username
String
Jdoe
Hardware
120
User Access Level
String
Administrator
Hardware
130
Local Timezone
String
(GMT+5:30) Chennai, Kolkata,
Mumbai, New Delhi
Hardware
140
Number of Drives
Integer
2
Hardware
150
Total Drive Size (GB)
Float
160
Hardware
160
Total Free Space
(GB)
Float
25
Hardware
170
Operating System
String
Mac OS X Leopard
Operating System
10
OS Architecture
String
32 bit
Operating System
20
Version
String
10.5.1
Operating System
30
Default OS Language
String
English - United States
Operating System
40
Source = 2 & Any Platform value
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
IBM
Hardware
10
Model
String
ThinkPad T42
Hardware
20
Device Type
String
Smartphone
Hardware
30
Operating System
String
Microsoft Windows XP
Hardware
40
Default Language
String
Bangalore
Hardware
50
ActiveSync Agent
String
RoadSync-Android/2.502
Hardware
60
ActiveSync Device
ID
String
354957034059348
Hardware
70
Source = 1 or 3 & Platform = 3 (iOS)
Key
Type
Example Value
Display Section
Display Order
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
29
Manufacturer
String
Apple
Hardware
10
Model
String
iPhone 3Gs
Hardware
20
Model ID
String
MC610LL
Hardware
30
Device Type
String
Smartphone
Hardware
40
Email Address
String
jballengee@maas360dz.com
Hardware
50
Apple Serial
Number
String
830340GWA4T
Hardware
60
UDID
String
2a7e5207dc46949bdbe
Hardware
70
Operating System
String
iOS4
Hardware
80
Operating System
Version
String
4.2.1 (8C148)
Hardware
90
Modem Firmware
Version
String
03.10.01
Hardware
100
Activation Date
(GMT)
Timestamp
17/12/2010 20:33
Hardware
110
Total Internal
Storage (GB)
Float
29.06 GB
Hardware
120
Free Internal
Storage (GB)
Float
10.25
Hardware
130
Application Data
(GB)
Float
372 MB
Hardware
140
Source = 1 or 3 and Platform = 5 (Android)
Key
Type
Example Value
Display Section
Display Order
Manufacturer
String
Samsung
Hardware
10
Model
String
SCH-I800
Hardware
20
Device Type
String
Smartphone
Hardware
30
Device Serial
Number
String
ABCDEFGH
Hardware
40
Email Address
String
vhetrick@maas360dz.com
Hardware
50
Processor Name
String
ARM
Hardware
60
Processor Speed
String
1 Ghz
Hardware
70
Number of
Processor Cores
String
2
Hardware
80
RAM (MB)
Float
500
Hardware
90
Total Internal
Storage (GB)
Float
10
Hardware
100
Free Internal
Storage (GB)
Float
5
Hardware
110
Total External
Storage (GB)
Float
30
Hardware
120
Free External
Storage (GB)
Float
5
Hardware
130
Application Data
(MB)
Float
1010
Hardware
140
Screen Resolution
String
600*1024
Hardware
150
Screen Language
String
English
Hardware
160
Screen Width
Float
7.0
Hardware
170
Battery Level
Float
50%
Hardware
180
Battery Condition
String
Good
Hardware
190
Timezone
String
GMT-05:00, Eastern Standard
Time
Hardware
200
Operating System
String
Android 2.2 (FROYO)
Operating System
10
Operating System
Version
String
2.2
Operating System
20
Kernel Version
String
2.6.32.9 root@sep-40 #3 Tue Oct
12 21:33:42 KST 2010
Operating System
30
API Level
String
8
Operating System
40
Baseband Version
String
S:I800.0.3V.DJ11
Operating System
50
Build Number
String
FROYO.DJ11
Operating System
60
Source = 4 (BES)
Key
Type
Example Value
Display Section
Display Order
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
30
Manufacturer
String
22100AB1
Hardware
10
Model
String
Curve 8900
Hardware
20
Device Type
String
Smartphone
Hardware
30
PIN
String
22100AB1
Hardware
40
Email Address
String
smurphy@example.com
Hardware
50
Operating System
String
BlackBerry 6
Hardware
60
Operating System
Version
String
6.0.0.284
Hardware
70
Software Platform
Version
String
6.4.0.120
Hardware
80
Secured Boot ROM
String
Yes
Hardware
90
Total Memory (MB)
String
512
Hardware
100
Available Memory
(MB)
String
32
Hardware
110
Activation Date
(GMT)
Timestamp
2010-11-30T05:52:53
Hardware
120
Screen Resolution
String
320 * 480
Hardware
130
Screen Language
String
EN (US)
Hardware
140
Battery Level (%)
Integer
39
Hardware
150
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
31
Get Device Identity Attributes
Request
GET /device-apis/devices/1.0/identity/<billingID>
Definition
❖ Get all predefined Device identity attributes as well as custom attributes of a device.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/identity/1101234?deviceId=a2e13f
Sample Response
<deviceIdentity>
<maas360DeviceID>a2e13f</maas360DeviceID>
<customAssetNumber>BL1200</customAssetNumber>
<owner>Jim James</owner>
<ownership>Corporate Owned</ownership>
<vendor>Staples Inc</vendor>
<poNumber>100May2010</poNumber>
<purchaseType>Direct</purchaseType>
<purchaseDate>02/01/2009</purchaseDate>
<purchasePrice>100</purchasePrice>
<warrantyNumber>10001</warrantyNumber>
<warrantyExpirationDate>02/01/2011</warrantyExpirationDate>
<warratyType>24*7</warratyType>
<office>Blue Bell</office>
<department>Sales</department>
<CustomAttributes>
<customAttribute>
<customAttributeName>Business Unit</customAttributeName>
<customAttributeValue>Healthcare</customAttributeName>
</customAttribute>
</CustomAttributes>
<comments>”Some comments come here”</comments>
</deviceIdentity>
Mandatory attributes in Response
- maas360DeviceID
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
32
Get Software Installed
Request
GET /device-apis/devices/1.0/softwareInstalled/<billingID>
Definition
❖ Get softwares installed for a device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/softwareInstalled/1101234?deviceId=a2e13f
Sample Response
<deviceSoftwares>
<deviceID>a2e13f</deviceID>
<lastSoftwareDataRefreshDate>2010-11-30T05:52:53.011+00:00</lastSoftwareDataRefreshDate>
<devicesw>
<swName>Angry Birds</swName>
<swAttrs>
<swAttr>
<key>Application ID</key>
<type>String</type>
<value>com.angrybirds.com</value>
<displayOrder>10</displayOrder>
</swAttr>
</swAttrs>
</devicesw>
</deviceSoftwares>
Mandatory attributes in Response
- maas360DeviceID
- lastSoftwareDataRefreshDate
- swName
- key
- type
- value
Various Software Attributes
Platform = 1 (Windows)
Key
Type
Example Value
Application Vendor
String
Adobe
Full Version
String
10.1
Installed Date
Date
05/15/2010
Platform = 2 (Mac)
Key
Type
Example Value
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
33
Full Version
String
5.2
Source = 2 & Any Platform value
Not valid. No attributes are returned.
Source = 1 or 3 & Platform = 3 (iOS)
Key
Type
Example Value
Application ID
String
Com.angrybirds
Version
String
1.3
File Size
Float
30
AppDataSize
Float
50
Manage Status
String
Installed By MDM
Source = 1 or 3 and Platform = 5 (Android)
Key
Type
Example Value
App ID
String
Com.angrybirds
Full Version
String
2.1
Application Size
(MB)
Float
30
Data Size (MB)
Float
50
Install Location
String
Internal Storage
Source = 4 (BES)
Key
Type
Example Value
Vendor
String
BlackBerry
Full Version
String
6.0
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
34
Get Security & Compliance Information for a Mobile Device
Request
GET /device-apis/devices/1.0/mdSecurityCompliance/<billingID>
Definition
❖ Get Security & Compliance attributes for a Mobile Device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/mdSecurityCompliance/1101234?deviceId=a2e13f
Sample Response
<securityCompliance>
<maas360DeviceID>a2e13f</maas360DeviceID>
<complianceAttributes>
<complianceAttribute>
<key>Device Wiped</key>
<type>String</type>
<value>Not Applied</value>
<complianceAttribute>
</complianceAttributes>
</securityCompliance>
Mandatory attributes in Response
- maas360DeviceID
- key
- type
Various Device Attributes
Platform = 1 (Windows)
-
Platform = 2 (Mac)
-
Source = 2 & Any Platform value
Key
Type
Example Value
Display Section
Display Order
Mailbox Approval
State
String
Approved
Security &
Compliance
10
Remote Wipe
Support
String
Not Available
Security &
Compliance
20
Device Wiped
String
Not Applied
Security &
Compliance
30
Last Wipe Applied
Date (GMT)
Timestamp
28/03/2011 10:12
Security &
Compliance
40
Exchange
ActiveSync Policy
String
Default
Security &
Compliance
50
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
35
Last Policy Updated
Date (GMT)
Timestamp
28/03/2011 10:12
Security &
Compliance
60
Device Passcode
Status
String
Passcode Policy Not Configured
Security &
Compliance
70
Source = 1 or 3 & Platform = 3 (iOS)
Key
Type
Example Value
Display Section
Display Order
Device Jailbroken
String
Yes
Security &
Compliance
10
Jailbreak Detection
Date (GMT)
Timestamp
28/03/2011 16:10
Security &
Compliance
20
Device Passcode
Status
String
Compliant
Security &
Compliance
30
Hardware
Encryption
String
Block-level & File-level
Security &
Compliance
40
MDM Policy
String
Example Corp IOS (6)
Security &
Compliance
50
Last MDM Policy
Update Date (GMT)
Timestamp
28/03/2011 16:10
Security &
Compliance
60
Last MDM Policy
Update Source
String
Default
Security &
Compliance
65
Policy Compliance
State
String
In Compliance
Security &
Compliance
70
Out-of-Compliance
Reasons (Policies)
String
Email Profile Not Configured
Security &
Compliance
80
Effective Workplace
Persona Policy
String
Person Policy number 3
Security &
Compliance
81
Compliance Ruleset
String
Named ruleset
Security &
Compliance
82
Rule Compliance
Status
String
Out-of-Compliance
Security &
Compliance
85
Out-of-Compliance
Reasons (Rules)
String
Minimum Version Check Not Met
Security &
Compliance
86
Device Wiped
String
Pending
Security &
Compliance
90
Last Wipe Applied
Date (GMT)
Timestamp
28/03/2011 16:10
Security &
Compliance
100
Selective Wipe
String
Not Applied
Security &
Compliance
104
Last Selective Wipe
Applied Date (GMT)
Timestamp
28/03/2011 16:10
Security &
Compliance
105
Mailbox Approval
State
String
Approved
Security &
Compliance
110
Allow Installing of
Applications
String
Yes
Device
Restrictions
10
Allow Use of
Camera
String
Yes
Device
Restrictions
20
Allow Screen
Capture
String
Yes
Device
Restrictions
30
Allow User of Safari
String
Yes
Device
Restrictions
40
Allow Use of
YouTube
String
Yes
Device
Restrictions
50
Allow User of
iTunes Music Store
String
Yes
Device
Restrictions
60
Allow Explicit Music
and Podcasts
String
Yes
Device
Restrictions
70
Source = 1 or 3 and Platform = 5 (Android)
Key
Type
Example Value
Display Section
Display Order
Device Rooted
String
Yes
Device Security
Status
10
Hardware
Encryption
String
No Encryption
Device Security
Status
20
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
36
Lock SIM Card
String
Yes
Device Security
Status
30
Device Wiped
String
Pending
Policy &
Compliance
10
Last Wipe Applied
Date (GMT)
Timestamp
2010-11-30T05:52:53
Policy &
Compliance
20
Selective Wipe
String
Pending
Policy &
Compliance
30
Last Selective Wipe
Applied Date (GMT)
Timestamp
2010-11-30T05:52:53
Policy &
Compliance
40
MDM Policy Name
String
Corporate Policy
Policy &
Compliance
50
Policy Version
String
2
Policy &
Compliance
60
Last MDM Policy
Update Date (GMT)
Timestamp
2010-11-30T05:52:53
Policy &
Compliance
70
Last MDM Policy
Update Source
String
Manual
Policy &
Compliance
80
Policy Compliance
State
String
In Compliance
Policy &
Compliance
90
Out-of-Compliance
Reasons (Policies)
String
Passcode Not Enabled
Policy &
Compliance
100
Effective Workplace
Persona Policy
String
Person Policy number 3
Security &
Compliance
101
Compliance Ruleset
String
Named ruleset
Security &
Compliance
102
Rules Compliance
Status
String
Out-of-Compliance
Policy &
Compliance
103
Out-of-Compliance
Reasons (Rules)
String
Minimum Version Check Not Met
Policy &
Compliance
104
Settings Configured
String
Exchange profile configured
Policy &
Compliance
106
Settings Failed to
Configure
String
Exchange profile
Policy &
Compliance
107
Other Device
Administration
Solutions
String
Email
Policy &
Compliance
110
Device Passcode
Status
String
Compliant
Passcode Settings
10
Minimum Passcode
Length
Integer
4
Passcode Settings
20
Passcode Quality
String
Numeric
Passcode Settings
30
Number of Complex
Characters Required
Integer
4
Passcode Settings
40
Passcode History
String
10
Passcode Settings
50
Maximum Passcode
Age (days)
String
365
Passcode Settings
60
Maximum Failed
Password Attempts
String
10
Passcode Settings
70
Maximum Time to
Lock (min)
String
10
Passcode Settings
80
Background Data
Sync Enabled
String
Yes
Accounts and
Sync
10
Auto-Sync Enabled
String
Yes
Accounts and
Sync
20
Allow installation of
Non-Market Apps
String
Yes
Application
Settings
10
Allow Mock
Locations
String
Yes
Application
Settings
20
Automatic Data
Backup to Google
Servers Enabled
String
Yes
Application
Settings
30
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
37
Automatic Restore
from Data Backup
on Application
Reinstall
String
Yes
Application
Settings
40
Visible Passwords
String
Yes
Application
Settings
50
Camera Present
String
Yes
Device Features
10
GPS Present
String
Yes
Device Features
20
Bluetooth Enabled
String
Yes
Device Features
30
Near Field
Communication
(NFC) Enabled
String
Yes
Device Features
40
Source = 4 (BES)
Key
Type
Example Value
Display Section
Display Order
Hardware Encryption
String
Fully Encrypted
Security &
Compliance
10
Encryption Algorithms
Supported
String
Triple DES
Security &
Compliance
20
Auto-Backup
Configured
String
Yes
Security &
Compliance
30
Auto-Backup
Frequency
String
Daily
Security &
Compliance
40
Last Successful
Backup Time
Timestamp
2010-11-30T05:52:53
Security &
Compliance
50
Auto-Backup
Exclusions
String
Messages
Security &
Compliance
60
Device Wiped
String
Pending
Security &
Compliance
70
Last Wipe Applied
Time (GMT)
Timestamp
2010-11-30T05:52:53
Security &
Compliance
80
BES Policy Name
String
Std. Corporate Policy 1.0
Security &
Compliance
90
Last Policy Update
Date (GMT)
Timestamp
2010-11-30T05:52:53
Security &
Compliance
100
Policy Compliance
State
String
In Compliance
Security &
Compliance
110
Allow User to install
applications
String
Yes
Security &
Compliance
120
Device Passcode
Status
String
Enabled
Security &
Compliance
130
User-Device
Configuration
String
Default Configuration
Security &
Compliance
140
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
38
Get Enabled MaaS360 Services for a Device
Request
GET /device-apis/devices/1.0/getEnabledMaaS360Services/{billingId}/
Definition
❖ Returns all the MaaS360 services enabled on a device
❖ Supported for iOS, Android and Windows Phone MDM device
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/getEnabledMaaS360Services
/1101234?deviceId=a2e13f
Sample Response
<enabledServices>
<service>Browser</service>
<service>MaaS360 Gateway for Browser</service>
</enabledServices>
Mandatory attributes in Response
- service
Possible MaaS360 Services
- App Catalog
- CMIS MaaS360 Enterprise Gateway
- CMIS Resources
- Contextual Rules
- Corporate Docs
- Corporate Sharepoint Access
- Enable URL Filtering in Secure Browser
- IBM Connection MaaS360 Enterprise Gateway
- IBM Connections
- Kiosk
- Knox
- Location Tracking
- MEG Docs
- Mobile Expense Management
- Privacy Settings
- Public Cloud integration for Docs
- Remote Control
- Secure Browser
- Secure Browser Gateway
- Secure Browser MaaS360 Enterprise Gateway
- Secure Editor for Docs
- Secure Gateway for Internal SharePoint
- Secure Mail
- Secure Viewer
- Sevices
- Sharepoint MaaS360 Enterprise Gateway
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
39
- Trusteer Malware
- User Sync
- User Sync For Laptops
- Windows File Share
- Windows FileShare MaaS360 Enterprise Gateway
- Workplace SDK MaaS360 Enterprise Gateway
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
40
Get Network Information for a Mobile Device
Request
GET /device-apis/devices/1.0/mdNetworkInformation/<billingID>
Definition
❖ Get network information for a device
❖ Relevant for iOS MDM, Android MDM devices and BES devices only
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/mdNetworkInformation/1101234?deviceId=a2e13f
Sample Response
<maas360DeviceID>ApplF17R9GAGGRY5</maas360DeviceID>
<deviceAttributes>
<deviceAttribute>
<key>IP Address</key>
<type>String</type>
<value></value>
</deviceAttribute>
<deviceAttribute>
<key>Last Connection Date</key>
<type>String</type>
<value></value>
</deviceAttribute>
<deviceAttribute>
<key>SSID</key>
<type>String</type>
<value></value>
</deviceAttribute>
<deviceAttribute>
<key>Subnet Mask</key>
<type>String</type>
<value></value>
</deviceAttribute>
<deviceAttribute>
<key>MAC Address</key>
<type>String</type>
<value></value>
</deviceAttribute>
<deviceAttribute>
<key>Data Roaming</key>
<type>String</type>
<value>Disabled</value>
</deviceAttribute>
<deviceAttribute>
<key>Voice Roaming</key>
<type>String</type>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
41
<value>Disabled</value>
</deviceAttribute>
<deviceAttribute>
<key>Phone Number</key>
<type>String</type>
<value>+12153179338</value>
</deviceAttribute>
<deviceAttribute>
<key>ICCID</key>
<type>String</type>
<value>8901 4103 2876 5915 8665</value>
</deviceAttribute>
<deviceAttribute>
<key>Roaming</key>
<type>String</type>
<value>Yes</value>
</deviceAttribute>
<deviceAttribute>
<key>International Data Roaming</key>
<type>String</type>
<value>Disabled</value>
</deviceAttribute>
<deviceAttribute>
<key>Home Carrier</key>
<type>String</type>
<value>AT&amp;T</value>
</deviceAttribute>
<deviceAttribute>
<key>Current Carrier</key>
<type>String</type>
<value>Not Available</value>
</deviceAttribute>
<deviceAttribute>
<key>Home Country</key>
<type>String</type>
<value>United States of America</value>
</deviceAttribute>
<deviceAttribute>
<key>Current Country</key>
<type>String</type>
<value>India</value>
</deviceAttribute>
<deviceAttribute>
<key>Current Network Type</key>
<type>String</type>
<value>Not Available</value>
</deviceAttribute>
<deviceAttribute>
<key>Carrier Setting Version</key>
<type>String</type>
<value>29.1</value>
</deviceAttribute>
<deviceAttribute>
<key>Wi-Fi Mac Address</key>
<type>String</type>
<value>e4:9a:79:d7:0e:06</value>
</deviceAttribute>
<deviceAttribute>
<key>Bluetooth Mac Address</key>
<type>String</type>
<value>e4:9a:79:d7:0e:07</value>
</deviceAttribute>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
42
<deviceAttribute>
<key>Current MCC</key>
<type>String</type>
<value>404</value>
</deviceAttribute>
<deviceAttribute>
<key>Subscriber MCC</key>
<type>String</type>
<value>310</value>
</deviceAttribute>
<deviceAttribute>
<key>Current MNC</key>
<type>String</type>
<value>86</value>
</deviceAttribute>
<deviceAttribute>
<key>Subscriber MNC</key>
<type>String</type>
<value>410</value>
</deviceAttribute>
</deviceAttributes>
</networkInformation>
Mandatory attributes in Response
- maas360DeviceID
- key
- type
Various Device Attributes
Source = 1 or 3 & Platform = 3 (iOS)
Key
Type
Example Value
Display Section
Display Order
Phone Number
String
21512312345
Network
Information
10
ICCID
String
404862413367781
Network
Information
20
IMEI
String
357168069683740
Network
Information
20
IMSI
String
404719
Network
Information
20
Roaming
String
Yes
Network
Information
30
International Data
Roaming
String
No
Network
Information
40
Home Carrier
String
Vodafone
Network
Information
50
Current Carrier
String
Vodafone
Network
Information
60
Home Country
String
UK
Network
Information
70
Current Country
String
UK
Network
Information
80
Current Network
Type
String
GPRS
Network
Information
90
Carrier Setting
Version
String
12
Network
Information
100
Wi-Fi Mac Address
String
B4-07-F9-98-C4-F9
Network
Information
110
Bluetooth Mac
Address
String
B4-07-F9-98-C4-F9
Network
Information
120
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
43
Source = 1 or 3 and Platform = 5 (Android)
Key
Type
Example Value
Display Section
Display Order
Phone Number
String
21512312345
Network
Information
10
IMEI
String
357168069683740
Network
Information
20
IMSI
String
404719
Network
Information
20
IMEI SIM2
String
357168069683740
Network
Information
20
ICCID
String
8991860024133677816
Network
Information
20
Roaming
String
Yes
Network
Information
30
Roaming Status
SIM2
String
Yes
Network
Information
30
International Data
Roaming
String
No
Network
Information
40
Home Carrier
String
Vodafone
Network
Information
50
Current Carrier
String
Vodafone
Network
Information
60
Home Country
String
UK
Network
Information
70
Current Country
String
UK
Network
Information
80
Data Network
String
No
Network
Information
90
Current Network
Type
String
GPRS
Network
Information
100
IMSI
String
404862413367781
Network
Information
110
Wi-Fi Mac Address
String
B4-07-F9-98-C4-F9
Network
Information
120
Bluetooth Mac
Address
String
B4-07-F9-98-C4-F9
Network
Information
130
Source = 4 (BES)
Key
Type
Example Value
Display Section
Display Order
Phone Number
String
2156641782
Network
Information
10
ICCID
String
8991101200003200000
Network
Information
20
Home Carrier
String
AT&T
Network
Information
30
Current Carrier
String
AT&T
Network
Information
40
Supported
Frequencies
String
GSM 850, GSM 900
Network
Information
50
Current Network
Type
String
GPRS
Network
Information
60
Direct Connect ID
String
123456
Network
Information
70
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
44
Get Patch Information
Request
GET /device-apis/devices/1.0/getPatchInformation/<billingID>
Definition
❖ Get Patch Information for a device
❖ Relevant for Windows and Mac computers only
❖ View only Installed or Missing Patches or View only Security or Other Patches
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
missingPatches
Optional
Return Missing Patches or Installed Patches
Possible values: 0 or 1 (Default value is 1).
securityPatches
Optional
Return Security Patches or Other Patches
Possible values: 0 or 1 (Default value is 1).
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/getPatchInformation/1101234?deviceId=a2e13f&missingPatches=1&securityPatches=1
Sample Response
<patchInformations>
<maas360DeviceID>a2e13f</maas360DeviceID>
<count>10</count>
<missingPatches>1</missingPatches>
<securityPatches>1</securityPatches>
<patchInformation>
<patchName>MS10-074: Security Update for Windows 7 (KB2387149)</patchName>
<patchCategory>Security</patchCategory>
<vendor>Microsoft Corporation</vendor>
<product>Windows 7</product>
<severity>Moderate</severity>
<kbID>Q2387149</kbID>
<bulletinID>MS10-074</bulletinID>
</patchInformation>
<patchInformation>
….
</patchInformation>
</patchInformations>
Mandatory attributes in Response
- maas360DeviceID
Access Control
Customer Properties: Manage Windows Desktops/Laptops or Manage Macs
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
45
Get Network Information for a Computer
Request
GET /device-apis/devices/1.0/computerNetworkInformation/<billingID>
Definition
❖ Get network information for a Windows and Mac computer
❖ Relevant for Windows and Mac computers only
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/computerNetworkInformation/1101234?deviceId=a2e13f
Sample Response
<networkInformation>
<maas360DeviceID>a2e13f</maas360DeviceID>
<count>10</count>
<domainWorkgroup>1</missingPatches>
<networkAdapters>
<networkAdapter>
<adapterName>Tata Photon</adapterName>
<adapterType>PPP</adapterType>
<adapterID>D02528DB-33A7-4AE4-A8FA-06C1786E0DDE</adapterID>
<ipAddress>14.96.3.154</ipAddress>
<subnetMask>255.255.255.255</subnetMask>
<dhcpEnabled>No</dhcpEnabled>
<macAddress>00:05:9A:3C:78:00</macAddress>
<dnsServers>10.1.20.97, 10.11.20.26</dnsServers>
<gateway>10.1.9.1</gateway>
<deviceDriverName>HUAWEI Mobile Connect - Modem</deviceDriverName>
<deviceDriverVersion>2.0.3.827</deviceDriverVersion>
<deviceDriverDate>10/09/2009</deviceDriverDate>
</networkAdapter>
</networkAdapters>
</networkInformation>
Mandatory attributes in Response
- maas360DeviceID
Access Control
Customer Properties: Manage Windows Desktops/Laptops or Manage Macs
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
46
Get Security Applications Information
Request
GET /device-apis/devices/1.0/securityApplications/<billingID>
Definition
❖ Get Security Applications information
❖ Relevant for Windows and Mac computers only
❖ Uses MaaS360 Device ID (CSN) of the device for querying
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/securityApplications/1101234?deviceId=a2e13f
Sample Response
<securityApplications>
<maas360DeviceID>a2e13f</maas360DeviceID>
<securityApplication>
<applicationAttributes>
<applicationAttribute>
<key></key>
<type></type>
<value></value>
<displaySection></displaySection>
<displayOrder></displayOrder>
</applicationAttribute>
<applicationAttribute>
…
</applicationAttribute>
</applicationAttributes>
</securityApplication>
</securityApplications>
Mandatory attributes in Response
- maas360DeviceID
- key
- type
Various Application Attributes
Anti-Virus Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
Symantec Endpoint Protection
Anti-Virus
10
Category
String
Endpoint Security
Anti-Virus
20
Application Type
String
Anti-Virus
Anti-Virus
30
Vendor
String
Symantec Corp.
Anti-Virus
40
Version
String
11.0
Anti-Virus
50
Installed Date
Date
12/10/2010
Anti-Virus
60
Status
String
Running
Anti-Virus
70
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
47
Anti-Virus
Definition Date
Timestamp
06/05/2011 00:00
Anti-Virus
80
Anti-Virus
Definition
String
5/6/2011 rev. 21
Anti-Virus
90
Last Scan Date
Timestamp
06/05/2011 00:00
Anti-Virus
100
Personal Firewall Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
Symantec Endpoint Protection
Personal Firewall
10
Category
String
Endpoint Security
Personal Firewall
20
Application Type
String
Personal Firewall
Personal Firewall
30
Vendor
String
Symantec Corp.
Personal Firewall
40
Version
String
11.0
Personal Firewall
50
Installed Date
Date
12/10/2010
Personal Firewall
60
Status
String
Running
Personal Firewall
70
Anti-Spyware Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
Symantec Endpoint Protection
Anti-spyware
10
Category
String
Endpoint Security
Anti-spyware
20
Application Type
String
Anti-Spyware
Anti-spyware
30
Vendor
String
Symantec Corp.
Anti-spyware
40
Version
String
11.0
Anti-spyware
50
Installed Date
Date
12/10/2010
Anti-spyware
60
Status
String
Running
Anti-spyware
70
Anti-Spyware
Definition Date
Timestamp
06/05/2011 00:00
Anti-spyware
80
Anti-Spyware
Definition
String
5/6/2011 rev. 21
Anti-spyware
90
Last Scan Date
Timestamp
06/05/2011 00:00
Anti-spyware
100
Data Encryption Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
BitLocker Drive Encryption
Data Encryption
10
Category
String
Data Protection
Data Encryption
20
Application Type
String
Data Encryption
Data Encryption
30
Vendor
String
Microsoft
Data Encryption
40
Version
String
7 SP1
Data Encryption
50
Installed Date
Date
12/10/2010
Data Encryption
60
Encryption Status
String
No Encryption
Data Encryption
70
Encrypted Drives
String
C:
Data Encryption
80
Peripheral Protection Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
BitLocker Drive Encryption
Peripheral
Protection
10
Category
String
Data Protection
Peripheral
Protection
20
Application Type
String
Peripheral Protection
Peripheral
Protection
30
Vendor
String
Microsoft
Peripheral
Protection
40
Version
String
7 SP1
Peripheral
Protection
50
Installed Date
Date
12/10/2010
Peripheral
Protection
60
Status
String
No Encryption
Peripheral
Protection
70
Backup & Recovery Application:
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
48
Key
Type
Example Value
Display Section
Display Order
Application Name
String
Fiberlink Backup & Recovery
Agent
Backup &
Recovery
10
Category
String
Data Protection
Backup &
Recovery
20
Application Type
String
Backup & Recovery
Backup &
Recovery
30
Vendor
String
Iron Mountain
Backup &
Recovery
40
Version
String
8.4.0.8
Backup &
Recovery
50
Installed Date
Date
12/10/2010
Backup &
Recovery
60
Status
String
Running
Backup &
Recovery
70
Last Backup
Timestamp
06/05/2011 08:52
Backup &
Recovery
80
Next Backup
Timestamp
07/05/2011 07:10
Backup &
Recovery
90
Backup Limit
String
6 GB
Backup &
Recovery
100
Data Leak Prevention Application:
Key
Type
Example Value
Display Section
Display Order
Application Name
String
BitLocker Drive Encryption
Data Leak
Prevention
10
Category
String
Data Protection
Data Leak
Prevention
20
Application Type
String
Data Leak Prevention
Data Leak
Prevention
30
Vendor
String
Microsoft
Data Leak
Prevention
40
Version
String
7 SP1
Data Leak
Prevention
50
Installed Date
Date
12/10/2010
Data Leak
Prevention
60
Status
String
No Encryption
Data Leak
Prevention
70
Access Control
Customer Properties: Manage Windows Desktops/Laptops or Manage Macs
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
49
Get Application Distributions
Request
GET /device-apis/devices/1.0/packageDistributionHistory/<billingID>
Definition
❖ Search package distributions by Device ID
❖ Relevant for iOS MDM and Android MDM Devices only
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page.
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/packageDistributionHistory/1001234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response
<packageDistributionHistory>
<count>100</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<packageDistribution>
<distributionDate>2010-11-30T05:52:53.011+00:00</distributionDate>
<distributionName>Distribute Angry Birds</distributionName>
<packageName>Angry Birds</packageName>
<status>Pending</status>
<description></description>
<details></details>
</packageDistribution>
<packageDistribution>
….
</packageDistribution>
<packageDistributionHistory>
Mandatory attributes in Response
- maas360DeviceID
- deviceId
Access Control
Customer Properties: Enable iOS Enterprise App Store or Enable Android Enterprise App Store
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
50
Get Device Location History
Get Cellular Data Usage for a Device
Request
GET /device-apis/devices/1.0/cellularDataUsage/<billingID>
Definition
❖ Returns Cellular Data Usage for a Device for last 6 periods excluding the current period
❖ Relevant for only iOS MDM and Android MDM Devices for which TEM plans are assigned
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/cellularDataUsage/1001234?deviceId=a1b2c3
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cellularDataUsageDetails>
<billingStartDate>2</billingStartDate>
<cellularDataUsageList>
<period>Current period till date</period>
<inNetworkUsage>0.13</inNetworkUsage>
<inNetworkUsageLimit>200.0</inNetworkUsageLimit>
<inNetworkUsagePercentage>0.06</inNetworkUsagePercentage>
<roamingNetworkUsage>0.0</roamingNetworkUsage>
<roamingNetworkUsageLimit>200.0</roamingNetworkUsageLimit>
<roamingUsagePercentage>0.0</roamingUsagePercentage>
</cellularDataUsageList>
<daysRemainingBillingCycle>17</daysRemainingBillingCycle>
<planName>plan1</planName>
</cellularDataUsageDetails>
Mandatory attributes in Response
-
Access Control
Customer Properties: Enable TEM
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
51
Get Device Location History
Request
GET /device-apis/devices/1.0/locationHistory/<billingID>
Definition
❖ Returns location history for a device.
❖ By default, returns the last known location of the device. But this can be used to get location history
for up to last 7 days.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
time
Optional
Possible values:
1. 0 – Last Known Location
2. 1 – Today
3. 2 – Last 1 day
4. 3 – Last 7 days
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/locationHistory/1101234?deviceId=a2e13f
Sample Response
If PII is enabled:
<deviceLocation>
<deviceId>a2e13f</deviceId>
<errorCode>1</errorCode> ## 0 – success; 1 - failure
<errorMessage>Unable to return locations since PII is enabled for the device</errorMessage>
</deviceLocation>
If PII is not enabled:
<deviceLocation>
<deviceId>a2e13f</deviceId>
<errorCode>0</errorCode> ## 0 – success; 1 – failure
<locationHistory>enabled</locationHistory>
<location>
<locatedTime>2010-11-30T05:52:53.011+00:00</locatedTime>
<latitude>10.2</latitude>
<longitude>31.5</longitude>
<accuracy>100m</accuracy>
<checkedInStatus>Yes</checkedInStatus>
</location>
</deviceLocation>
Mandatory attributes in Response
- deviceId
- errorCode
Access Control
- Customer Properties: Enable Device View
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
52
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
53
Get Devices with Associated Users
Request
GET /device-apis/devices/2.0/user-associations/customer/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Returns all the devices that have a user associated with them at the time of the query.
❖ Return values are the maas360DeviceId, the maas360UserId, and time of the request (in Unix Epoch
time format).
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer’s ID
devicesRegisteredAfterInEpochms
Optional
Time in Unix epoch milliseconds, returns devices
registered after this time
returnInactiveDevices
Optional
Possible values: true, false. True returns all
devices; false (default) only returns devices with
associated users.
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular page. Default is first
page.
Sample Request
https://services.fiberlink.com/device-apis/devices/2.0/user-associations/customer/1101234?
devicesRegisteredAfterDate =01-12-2016&pageSize= 25
Sample Response (JSON)
{
"Associations": {
"billingId": 1101234,
"count": 5,
"Association": [
{ "maas360DeviceId": "ABCDE08032013_035537_0001", "maas360UserId":
"BE9257E0032A40A9A2F5BB4C8B299F19" },
{ "maas360DeviceId": "ABCDE08032013_035537_0002", "maas360UserId":
"9B225A73EEB5D60081FCD14A3F8D4F06" },
{ "maas360DeviceId": "ABCDE08032013_041527_0001", "maas360UserId":
"D0BC847543427E28D729C8D1A092CE75" },
{ "maas360DeviceId": "ABCDE08032013_041926_0001", "maas360UserId":
"7EF1FAA010D1177B01C7210238DA18A3" },
{ "maas360DeviceId": "ABCDE08032013_041927_0002", "maas360UserId":
"7053A759869FD205CE15E429B8B77384" }
],
"pageNumber": 1,
"pageSize": 5
"time": 1477485296720
}
}
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
54
Mandatory attributes in Response
- billingId
- count
- time
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
55
Get Groups for a Device
Request
GET /device-apis/devices/1.0/getGroups/<billingID>
Definition
❖ Returns User Groups and Device Groups to which the device belongs to
❖ Only groups used for an assignment or distribution will be listed here
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/cellularDataUsage/1001234?deviceId=a1b2c3
Sample Response
<groups>
<group>
<groupID>1234</groupID>
<groupType>2</groupType> ##0: MaaS360 defined, 1: Private, 2: Public, 3: Local User
Group, 4: User Directory Group
<groupName>BYOD devices</groupName>
<lastEvaluatedDate>2010-11-30T05:52:53.011+00:00</lastEvaluatedDate>
</group>
<group>
….
</group>
</groups>
Mandatory attributes in Response
-
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
56
Get Relevant Data Views for a Device
Request
GET /device-apis/devices/1.0/deviceDataViews/<billingID>
Definition
❖ Get all categories of data relevant for a Device.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/deviceDataViews/1101234?deviceId=a12bc3
Sample Response
<deviceDataViews>
<maas360DeviceID>a2e13f</maas360DeviceID>
<deviceDataView>
<dataViewName>Device Summary</dataViewName>
<dataViewOrder>10</dataViewOrder >
<displaySections>
<displaySection>
<displaySectionName>Hardware</displaySectionName>
<displaySectionOrder>10</displaySectionOrder>
<sectionID>HARDWARE_INVENTORY</sectionID>
/displaySection>
</displaySections>
</deviceDataView>
</deviceDataViews>
Mandatory attributes in Response
- maas360DeviceID
- dataViewName
- dataViewOrder
Condition
Data Views
Data View
Order
Section Name
Section
Order
Platform = 1 (Windows)
Device Summary
10
Hardware Inventory
MaaS360 Services
10
20
Hardware Inventory
20
Hardware Inventory
Operating System
10
20
Custom Attributes
30
Custom Attributes
10
Software Installed
40
Software Installed
10
Package Distributions
50
Package Distributions
10
Platform = 2 (Mac)
Device Summary
10
Hardware Inventory
MaaS360 Services
10
20
Hardware Inventory
20
Hardware Inventory
Operating System
10
20
Custom Attributes
30
Custom Attributes
10
Software Installed
40
Software Installed
10
Source = 2 & Any
Platform value
Device Summary
10
Hardware Inventory
Security & Compliance
10
20
Custom Attributes
20
Custom Attributes
10
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
57
Action History
30
Action History
10
Source = 1 or 3 &
Platform = 3 (iOS)
Device Summary
10
Hardware Inventory
Network Information
Security & Compliance
10
20
30
Hardware Inventory
20
Hardware Inventory
10
Custom Attributes
30
Custom Attributes
10
Network Information
40
Network Information
10
Security & Compliance
50
Security & Compliance
Device Restrictions
10
20
Software Installed
60
Software Installed
10
Action History
70
Action History
10
Package Distributions
80
Package Distributions
10
Source = 4 (BES)
Device Summary
10
Hardware Inventory
Network Information
Security & Compliance
10
20
30
Hardware Inventory
20
Hardware Inventory
10
Custom Attributes
30
Custom Attributes
10
Network Information
40
Network Information
10
Security & Compliance
50
Security & Compliance
10
Software Installed
60
Software Installed
10
Action History
70
Action History
10
Source = 1 or 3 and
Platform = 5 (Android)
Device Summary
10
Hardware Inventory
Network Information
Security & Compliance
10
20
30
Hardware Inventory
20
Hardware Inventory
10
Custom Attributes
30
Custom Attributes
10
Network Information
40
Network Information
10
Security & Compliance
50
Device Security Status
Policy & Compliance
Passcode Settings
Accounts & Sync
Application Settings
Device Features
10
20
30
40
50
60
Software Installed
60
Software Installed
10
Action History
70
Action History
10
Package Distributions
80
Package Distributions
10
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
58
Get Relevant Actions for a Device
Request
GET /device-apis/devices/1.0/deviceActions/<billingID>
Definition
❖ Get all relevant actions for a device.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/deviceActions/1101234?deviceId=a1b2c3
Sample Response
<deviceActions>
<maas360DeviceID>a2e13f</maas360DeviceID>
<deviceAction>
<actionName>Wipe</actionName>
<actionID>WIPE_DEVICE</actionID> ++ APPROVE_DEVICE, BLOCK_DEVICE, WIPE_DEVICE,
CANCEL_PENDING_WIPE, LOCK_DEVICE, RESET_DEVICE_PASSCODE, LOCATE_DEVICE,
REFRESH_DEVICE_INFORMATION, CHANGE_POLICY, SELECTIVE_WIPE_DEVICE, REVOKE_SELECTIVE_WIPE,
REMOVE_DEVICE
<actionOrder>10</actionOrder>
<actionType>MDM</actionType> ++ Computer, MDM, Exchange Server, Lotus Notes, BES
</deviceAction>
</deviceActions>
Mandatory attributes in Response
- maas360DeviceID
- actionName
- actionID
- actionType
actionID
Description
Platform
Order
REFRESH_DEVICE_INFORMATION
Refresh Device
Informatio
iOS, Android, Windows, Blackberry
30
MDM_LOCATE
Locate Device
iOS, Android, Windows
40
MDM_LOCK
Lock Device
iOS, Android, Windows
50
MDM_CLEARPWD
Reset Device
Passcode
iOS, Android, Windows, Blackberry
60
CHANGE_POLICY
Change Policy
iOS, Android, Windows, Blackberry
110
MDM_REMOVE_PROFILE
Remove Control
iOS, Android, Windows, Blackberry
120
MDM_MESSAGE
Send Message
Windows
130
ACTION_MDM_HIDE_DEVICE
Hide Device
Record
Windows
160
MDM_RULESET_UPDATE
Change Rule
Set
Windows
170
MDM_BUZZ
Buzz
Windows
300
MDM_DISTRIBUTE_DOC
Distribute Doc
Windows
310
MDM_WIPE
Wipe Device
iOS, Android, Windows, Blackberry
90
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
59
SELECTIVE_WIPE_DEVICE
Selective Wipe
Device
iOS, Android, Windows
70
APPROVE_DEVICE
Exchange
Approve Device
Windows
BLOCK_DEVICE
Exchange Block
Device
Windows
Source
Platform
Action
-
1 (Windows)
Mark as Inactive
-
2 (Mac)
-
2 (Messaging System)
-
Exchange Approval State = Device Discovery
- No actions are available
Exchange Approval State = Quarantine
- Approve Device
- Block Device
Exchange Approval State = Approved
- Block Device
Exchange Approval State = Blocked
- Approve Device
In case of customer having Exchange 2007 server, the above
actions are available only if Auto-Quarantine is on.
Device Wiped = Blank
- Wipe Device
Device Wiped = Pending
- Cancel Pending Wipe
Actions always available
- Change Policy
- Remove Device from Exchange Server (or Remove
Device from Notes Traveler)
1 (MDM)
3 (iOS)
Actions always available
- Refresh Device Information
- Locate Device
- Lock Device
- Reset Device Passcode
- Change Policy
- Remove iOS Control
Device Wiped = Blank
- Wipe Device
Device Wiped = Pending
- Cancel Pending Wipe
Selective Wipe = Blank
- Selective Wipe Device
Selective Wipe = Pending or Complete
- Revoke Selective Wipe
3 (MDM + Messaging
System)
3 (iOS)
All the actions listed under iOS MDM and Messaging System
above
4 (BES)
4 (BlackBerry)
Actions always available
- Refresh Device Information
- Reset Device Passcode
- Change Policy
- Remove Device from BES
Device Wiped = Blank
- Wipe Device
Device Wiped = Pending
- Cancel Pending Wipe
1 (MDM)
5 (Android)
Actions always available
- Refresh Device Information
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
60
- Locate Device
- Lock Device
- Reset Device Passcode
- Change Policy
- Remove Android Control
Device Wiped = Blank
- Wipe Device
Device Wiped = Pending
- Cancel Pending Wipe
Selective Wipe = Blank
- Selective Wipe Device
Selective Wipe = Pending or Complete
- Revoke Selective Wipe
3 (MDM + Messaging
System)
5 (Android)
All the actions listed under Android MDM and Messaging System
above
1 (MDM)
7 (Symbian)
-
3 (MDM + Messaging
System)
7 (Symbian)
All the actions listed under Messaging System above
Access Control
Customer Properties: Enable Device View
Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
61
Set Device Name
Request
POST /device-apis/devices/1.0/setDeviceName/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Sets a name for a designated device, identified by the deviceID.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer ID number
deviceID
Required
Client Serial Number of the device
deviceName
Required
Special characters ‘%’, ‘&’, and space are not
supported in the device name.
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/setDeviceName/1101234?deviceID=
a2e13f&deviceName=MarketingTablet01
Sample Response (XML)
<actionResponse>
<result>Success</result>
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- result
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
62
Cloud Extender
Get Cloud Extender Clusters
Request
GET /device-apis/cloudExtender/1.0/getCEClusters/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides a list of Cloud Extender clusters for the requesting organization.
❖ The call can return all Cloud Extender clusters or the Cloud Extender clusters of a specified type.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
clusterType
Optional
Possible values:
- VPN
Sample Request
https://services.fiberlink.com/device-apis//device-apis/cloudExtender/1.0/getCEClusters/
1101234?clustertype=VPN
Sample Response (JSON or XML)
<CEClusterListResponse>
<CECluster>
<clusterGuid>700c895a-6c6a-491a-9cbd-9df3235735d4</clusterGuid>
<clusterType>VPN</clusterType>
<clusterName>US Default VPN</clusterName>
</CECluster>
<CECluster>
<clusterGuid>432c895a-6c6a-674d-9cbd-9df32357784g</clusterGuid>
<clusterType>VPN</clusterType>
<clusterName>US Alternate VPN</clusterName>
</CECluster>
</CEClusterListResponse>
Mandatory attributes in Response
- CEClusterListResponse
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
63
Get Cloud Extender Cluster Configuration
Request
POST /device-apis/cloudExtender/1.0/getCEClusterConfig/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Returns the configuration details for the Cloud Extender cluster associated with the requesting Cloud
Extender.
❖ If no specified configKey value is set, the default is all Keys.
❖ Some configValue responses are JSON formatted data within the XML return.
❖ NOTE: This is a POST request even though the name of the web service is getCEClusterConfig.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
clusterType
Required
Possible values:
- VPN
configKey
Optional
Contact IBM MaaS360 Customer Support for currently
supported configKey options.
certMD5
Optional
The MD5 checksum of CE Cluster Certificate
Sample Request
https://services.fiberlink.com/device-apis/cloudExtender/1.0/getCEClusterConfig
/1101234?clusterType=VPN
Sample Response (XML and JSON)
<CEClusterConfigResponse>
<errorCode>0</errorCode>
<errorDescription>Success</errorDescription>
<clusterGuid>96e9b01a-1d29-4fc0-957d-45432fc0b715</clusterGuid>
<clusterName>protype104</clusterName>
<clusterType>VPN</clusterType>
<clusterConfigs>
<config>
<configKey>VPN_CONFIG_DEF</configKey>
<configValue>{
"compLzo" : 1,
"fragment" : 1450,
"tlsAuth" : "sdfgh"
}</configValue>
</config>
<config>
<configKey>VPN_CONFIG_USER</configKey>
<configValue>{"routes":["network1:netmask1:gateway1","network2:netmask2:gateway2"],"localIp":"interna
lURL","externalPort":"internalURL","transportDetails":["1194:UDP","1195:UDP","1196:TCP"],"externalIP":"ext
ernalURL","splitTunnelingEnabled":"1","localPort":"internalURL"}</configValue>
</config>
</clusterConfigs>
</CEClusterConfigResponse>
Mandatory attributes in Response
- errorCode
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
64
- errorDescription
- clusterGuid
- clusterName
- clusterType
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
65
Set Cloud Extender Cluster Config
Request
POST /device-apis/cloudExtender/1.0/setCEClusterConfig/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Adds or updates one to four configuration key/value pairs for an existing Cloud Extender VPN cluster.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
clusterType
Required
VPN
configKey1-4
Required (at
least 1)
The parameter name for the configuration key is
followed by the numbers 1, 2, 3, or 4.
Contact IBM MaaS360 Customer Support for currently
supported configKey options.
configValue1
Required (at
least 1)
Configuration key and value pairs in JSON format. For
example:
{"server": "vpn.company.com", "ports": "1194"}
{"transportType": "UDP"}
The max length of configValue is 4000 bytes
Sample Request
https://services.fiberlink.com/device-
apis/cloudExtender/1.0/setCEClusterConfig/1101234?clusterType=VPN&configKey1=VPN_CONFIG_USER&c
onfigValue1={"server": "vpn.company.com", "ports": "1194”}
Sample Response (JSON or XML)
<CEClusterConfigResponse>
<errorCode>0</errorCode>
<errorDescription>Success</errorDescription>
<clusterGuid>96e9b01a-1d29-4fc0-957d-45432fc0b715</clusterGuid>
<clusterName>protype104</clusterName>
<clusterType>VPN</clusterType>
<clusterConfigs>
<config>
<configKey>VPN_CONFIG_USER</configKey>
<configValue>{"server": "vpn.company.com", "ports": "1194”
"routes":["network1:netmask1:gateway1","network2:netmask2:gateway2"],"localIp":"internalURL","external
Port":"internalURL","transportDetails":["1194:UDP","1195:UDP","1196:TCP"],"externalIP":"externalURL","split
TunnelingEnabled":"1","localPort":"internalURL"}</configValue>
</config>
</clusterConfigs>
</CEClusterConfigResponse>
Mandatory attributes in Response
- errorCode
- errorDescription
- clusterGuid
- clusterName
- clusterType
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
66
Join Cloud Extender Cluster
Request
POST /device-apis/cloudExtender/1.0/ joinCECluster/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Join an existing Cloud Extender cluster.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number.
certMD5
Required
The MD5 checksum of the target Cloud Extender
cluster’s X.509 certificate.
clusterType
Optional
Possible values:
- VPN
Sample Request
https://services.fiberlink.com/device-apis/cloudExtender/1.0/
joinCECluster/1101234?certMD5=ABCD1234EFGH5678&clusterType=VPN
Sample Response (XML)
<CEClusterDetails>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<requestType>joinCECluster</requestType>
<clusterGuid>700c895a-6c6a-491a-9cbd-9df3235735d4</clusterGuid>
<clusterType>VPN</clusterType>
<clusterName>US Default VPN</clusterName>
</CEClusterDetails>
Mandatory attributes in Response
- errorCode
- errorDescription
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
67
Update Cloud Extender Cluster Name
Request
POST /device-apis/cloudExtender/1.0/updateCEClusterName/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Changes the name of a specified Cloud Extender cluster.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
clusterGuid
Required
The GUID of the target cluster
newName
Required
The new cluster name
Sample Request
https://services.fiberlink.com/device-
apis/cloudExtender/1.0/updateCEClusterName/1101234?clusterGuid=7b6bd5ee-9588-4144-ab1a-
898dc9e4edb5&newName=MarketingVPN2
Sample Response (XML)
<CEClusterDetails>
<requestType>updateCEClusterName</requestType>
<clusterGuid>7b6bd5ee-9588-4144-ab1a-898dc9e4edb5</clusterGuid>
<clusterName>MarketingVPN2</clusterName>
<clusterType>VPN</clusterType>
</CEClusterDetails>
Mandatory attributes in Response
- CEClusterDetails
- requestType
- clusterGuid
- clusterName
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
68
Add a New Cloud Extender Cluster
Request
POST /device-apis/cloudExtender/1.0/addNewCECluster/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Adds a new Cloud Extender cluster and adds the cluster name to a list of available clusters.
❖ The request is made twice. Using requestType=GET_CSR_DETAILS, it returns CSR data that is used
in the final request using requestTYPE=GET_CERT.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
requestType
Required
Possible values:
- GET_CSR_DETAILS
- GET_CERT
csr
Optional
Only for use with requestType=GET_CERT
This is the CSR Data from the CECSRDetailsResponse to
the GET_CSR_DETAILS request.
clusterName
Optional
For use with all requestTypes.
This is the VPN server name.
clusterType
Optional
For use with all requestTypes.
Possible values:
- VPN
Sample Request
https://services.fiberlink.com/device-
apis/cloudExtender/1.0/addNewCECluster/1101234?requestType=GET_CERT&clusterType=VPN
https://services.fiberlink.com/device-
apis/cloudExtender/1.0/addNewCECluster/1101234?requestType=GET_CSR_DETAILS&clusterType=VPN&cl
usterName=ExampleVPNServer
Sample Response (XML)
For GET_CSR_DETAILS
<CECSRDetailsResponse>
<certChallenge>2003F9C7BF7741AD</certChallenge>
<certTargetName>/O=MaaS360/OU=M0042:S08:2028601/CN=MaaS360 VPN Server Identity
b564337371349af5ef4099214570381bf953b152/</certTargetName>
</CECSRDetailsResponse>
For GET_CERT
<CECertResponse>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<clusterGuid>700c895a-6c6a-491a-9cbd-9df3235735d4</clusterGuid
<clusterName>US Default VPN</clusterName
<clusterType>VPN</clusterType>
<caCert>YUREAjCCAuqgA+kNUxc4ih01bPDfP==</caCert>
<clusterCert>MIIEAjCCAuqgA+kZzwDvNUxc4ih01bPDfPfQ==</clusterCert>
</CECertResponse>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
69
Mandatory attributes in Response
- errorCode (for GET_CERT)
- errorDescription (for GET_CERT)
- certChallenge (for GET_CSR_DETAILS)
- certTargetName (for GET_CSR_DETAILS)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
70
Device Actions
Assign a user to a device
Request
POST /device-apis/devices/1.0/assignUserToDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Assigns a specified user to a device
❖ This is applicable for Supervised iOS devices and Shared iOS Devices
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
deviceId
Required
Client Serial Number of the device
userName
Required
domain
Required
Email
Required
phoneNumber
Optional
policySetName
Optional
Only policies for the device platform are
accepted.
rulesetName
Optional
Name of the Ruleset that needs to be assigned
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/assignUserToDevice/1101234?billingID=12345&deviceId=a1b2c3&userName=jdoe&domai
n=example.com&Email=jdoe@us.example.com
Sample Response
<actionResponse>
<result>Success</result>
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- result
Access Control
Customer Properties: Manage iPhones
Access Rights: Device View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
71
Set Custom Attribute Value
Request
POST /device-apis/devices/1.0/setCustomAttributeValue/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Sets the value for a specified custom attribute
❖ This is applicable for any device record
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
customAttributeName
Required
Name of the custom attribute for which value is to be
set
customAttributeValue
Required
Value to be set for the attribute
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/setCustomAttributeValue/1101234/
Sample Response
<actionResponse>
<result>Success</result>
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- result
Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
72
Refresh Device Information
Request
POST /device-apis/devices/1.0/refreshDeviceInformation/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Creates a request to refresh Device information
❖ This action can be executed on an iOS MDM, Android MDM, Windows Phone MDM or BES device
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
dataType
Optional
Possible values: SOFTWARE, DEVICE_INFO
Currently relevant for iOS only. For others, this value is
ignored. If specified, only the specific type of
information is refreshed
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/refreshDeviceInformation/1101234
?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
Customer Properties: Manage iPhones or Manage Androids or Manage BlackBerrys
Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
73
Send Message
Request
POST /device-apis/devices/1.0/sendMessage/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
messageTitle
Required
Max. 30 chars
message
Required
Max. 255 chars
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/sendMessage/1101234?deviceId=a1b2c3&messageTitle=message&message=hi
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
Customer Properties: Manage iPhones or Manage Androids
Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
74
Locate Device
Request
POST /device-apis/devices/1.0/locateDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Returns the current or last known location of the device
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM.
❖ Performs a real-time lookup on Android devices
❖ Provides Last Known location on iOS and Windows Phone devices
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/locateDevice/1101234?deviceId=a1b2c3
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<latitude>10.2</latitude>
<longitude>31.5</longitude>
<locatedTime>2010-11-30T05:52:53.011+00:00</locatedTime>
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
Access Control
- Customer Properties: Manage Androids
- Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
75
Lock Device
Request
POST /device-apis/devices/1.0/lockDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Lock the device
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/lockDevice/1101234?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage iPhones or Manage Androids
- Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
76
Reset Device Passcode
Request
POST /device-apis/devices/1.0/resetDevicePasscode/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This action can be executed on an iOS MDM, Android MDM, Windows Phone MDM or BES device
❖ For iOS MDM devices, this clears the Passcode set on the device and unlock the same
❖ For Android MDM and BES devices, this sets a new Passcode provided by the administrator
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
devicePasscode
Optional
Passcode to be set on the device. This is required for
Android MDM and BES devices
Expected as a Request parameter
Format
POST https://services.fiberlink.com/device-apis/devices/1.0/resetDevicePasscode/1101234
?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
Customer Properties: Manage iPhones or Manage Androids or Manage BlackBerrys
Access Rights: Help Desk Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
77
Change Device Policy
Request
POST /device-apis/devices/1.0/changeDevicePolicy/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Assigns a specified policy to a device
❖ This action can be executed on an Exchange ActiveSync, iOS MDM, Android MDM, Windows Phone
MDM, BES device, or Persona Policy devices
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
maas360DeviceId
Required
Client Serial Number of the device
policyName
Required
Name of the policy that needs to be assigned. This
policy can be a persona policy and applies to both iOS
and Android devices in mixed mode or as SPS.
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/changeDevicePolicy/1001234
?maas360DeviceId=a2e13f&policyName=test
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>0</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description >
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
Customer Properties: Manage ActiveSync Devices or Manage iPhones or Manage Androids or Manage
BlackBerrys
Access Rights: Policy Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
78
Change Compliance Ruleset
Request
POST /device-apis/devices/1.0/changeRuleSet/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Assigns a specified ruleset to a device
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
rulesetName
Required
Name of the Ruleset that needs to be assigned
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/changeRuleset/1001234?deviceId=androidc1a2b3c&rulesetName=foo
Sample Parameters
deviceId=androidc1a2b3c&rulesetName=foo&billingId=1001234
Sample Response
<actionResponse>
<actionStatus>0</actionStatus> ## 0:success; 1:error
<description>Successfully changed RuleSet : foo for device : androidc1a2b3c</description >
<maas360DeviceID>androidc1a2b3c</maas360DeviceID>
</actionResponse>
Mandatory attributes in Response
- actionStatus
- description
- maas360DeviceID
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Traveler devices or Manage iPhones
or Manage Androids or Manage BlackBerrys or Manage Windows Phones
- Access Rights: Device Management -> Change Compliance Rule Set
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
79
Selective Wipe Device
Request
POST /device-apis/devices/1.0/selectiveWipeDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Selective Wipe the device
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM device
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/selectiveWipeDevice/1101234?deviceId=a1b2c3
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage iPhones or Manage Androids
- Access Rights: Wipe Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
80
Revoke Selective Wipe
Request
POST /device-apis/devices/1.0/revokeSelectiveWipe/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Cancel Selective Wipe executed on the device
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM device
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/revokeSelectiveWipe/1101234?deviceId=a1b2c3
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage iPhones or Manage Androids
- Access Rights: Wipe Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
81
Wipe Device
Request
POST /device-apis/devices/1.0/wipeDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Remote Wipe the device
❖ This action can be executed on an Exchange ActiveSync, Notes, BES, iOS MDM, Android MDM or
Windows Phone MDM device
❖ Support for activation lock bypass for iOS MDM devices
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
notifyMe
Optional
Whether to notify the administrator on successful device
wipe.
Expected as a request parameter – “yes” value enables
this flag.
notifyUser
Optional
Whether to notify the user on successful device wipe
Expected as a request parameter – “yes” value enables
this flag.
notifyOthers
Optional
Comma separated list of other email addresses to notify
on successful device wipe
Expected as a request parameter
preserveDataPlan
Optional
(For iOS 11 and later) If a device is wiped remotely,
device data will be preserved if a data plan exists on the
device. Values: Yes, No (Default)
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/wipeDevice/1101234
?deviceId=a2e13f&notifyMe=yes&notifyUser=yes&notifyOthers=abc@example.com
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>0</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveler or Manage iPhones or
Manage Androids or Manage BlackBerrys
- Access Rights: Wipe Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
82
Cancel Pending Wipe
Request
POST /device-apis/devices/1.0/cancelPendingWipe/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Cancel outstanding Remote Wipe sent to the device
❖ This action can be executed on an Exchange ActiveSync, Traveler, BES, iOS MDM, Android MDM or
Windows Phone MDM device
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/cancelPendingWipe/1101234
?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>0</actionStatus> ## 0:success; 1:error
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveler or Manage iPhones or
Manage Androids or Manage BlackBerrys
- Access Rights: Wipe Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
83
Approve Device in Messaging System
Request
POST /device-apis/devices/1.0/approveDeviceMessagingSystem/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Approve the device in Messaging System (either Exchange, Notes or Gmail)
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
ownership
Optional
Can be either “Corporate Owned” or “Employee Owned”
deviceOwner
Optional
Name of the individual or group that owns the device
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/approveDeviceMessagingSystem/1101234?deviceId=a1b2c3
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description >
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices, Manage Notes Traveler
- Access Rights: Messaging Server Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
84
Block Device in Messaging System
Request
POST /device-apis/devices/1.0/blockDeviceMessagingSystem/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Block the device in Messaging System (Exchange, Notes or Gmail)
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/blockDeviceMessagingSystem/1101234?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices, Manage Notes Traveler
- Access Rights: Messaging Server Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
85
Remove Device
Request
POST /device-apis/devices/1.0/removeDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This is relevant for Windows Computers, Mac, Exchange ActiveSync, Notes Traveler, Gmail, BES, iOS
MDM, Android MDM and Windows Phone MDM
❖ For Windows and Mac: This marks the device as Inactive
❖ For Exchange ActiveSync, Notes Traveler, Gmail and BES: This removes the device from the source
server (which in turn marks the device as Inactive)
❖ For Enrolled devices (iOS, Android and Windows Phone):
o If the MDM Control is already removed by the user: This marks the device as Inactive
o If the device is still controlled: This removes the MDM Control and then marks the device as
Inactive
❖ For devices that are both enrolled in Mailbox server: This removes the MDM Control and then marks
the device as inactive. To remove such devices from Exchange server, use “Remove Device from
Mailbox Server” API.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/removeDevice/1101234?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
Customer Properties: Manage Windows Desktops/Laptops or Manage ActiveSync Devices or Manage Notes
Traveller or Manage BlackBerrys or Manage iPhones or Manage Androids
Access Rights: Deactivate Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
86
Remove Device from Mailbox Server
Request
POST /device-apis/devices/1.0/removeDeviceMailboxServer/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This is relevant for devices that are reporting Exchange, Traveler, Gmail and BES (Both enrolled and
not enrolled)
❖ In case of enrolled device, the action can be applied on natively merged or manually/automatically
merged record
❖ This removes the device from the source server
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/removeDeviceMailboxServer/1101234?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<actionID>12345</actionID> ##Available only in case of success
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveller or Manage
BlackBerrys
- Access Rights: Deactivate Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
87
Hide Device
Request
POST /device-apis/devices/1.0/hideDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This action can be executed on an Exchange ActiveSync, Notes, BES, iOS MDM, Android MDM or
Windows Phone MDM device
❖ This marks the device as Inactive
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Required
Client Serial Number of the device
Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/hideDevice/1101234?deviceId=a2e13f
Sample Response
<actionResponse>
<maas360DeviceID>a2e13f</maas360DeviceID>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- maas360DeviceID
- actionStatus
Access Control
- Customer Properties: Manage Windows Desktops/Laptops or Manage ActiveSync Devices or
Manage Notes Traveler or Manage BlackBerrys or Manage iPhones or Manage Androids or Manage
Windows Phone
- Access Rights: Deactivate Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
88
Update Device Certificate
Request
POST /device-apis/devices/1.0/updateCert/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Generate a new ID Certificate for a device or republish an existing one (for Certificate servers which
allow caching of Certs in Cloud Extender)
❖ This action can be executed on an iOS MDM, Android MDM or Windows Phone MDM device
Parameters
Parameter Name
Required /
Optional
Parameter Type
(Path/Query/Form)
Description
billingID
Required
Path
Billing ID of the account for
which the web-service is being
executed
maas360DeviceId
Required
Query
Client Serial Number of the
device
actionType
Required
Query
Possible values:
Generate new Certificate
Republish existing Certificate
comment
Optional
Query
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/updateCert/1001234?maas360DeviceId=ApplCCQL6FTRFFCJ&actionType=Generate new
Certificate&comment=testing
Sample Response
<actionResponse>
<maas360DeviceId>a2e13f</maas360DeviceId>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<description>Description, in case of success/error</description >
</actionResponse>
Mandatory attributes in Response
- maas360DeviceId
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Traveler devices or Manage iPhones
or Manage Androids or Manage BlackBerrys or Manage Windows Phones
- Access Rights: Device Management -> Selective Wipe
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
89
Check Action Status
Request
GET /device-apis/devices/1.0/checkActionStatus/<billingID>
Definition
❖ Check the status of a prior executed action
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
actionID
Required
Unique ID of the action that is executed
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/checkActionStatus/1101234? actionID=a1b2c3
Sample Response
<actionStatusResponse>
<actionID>a2e13f</actionID>
<deviceName>BBFL1234</deviceName>
<username>smurphy</username>
<action>Wipe</action>
<actionStatus>Pending</actionStatus> ## Pending, Complete, Failed, Executed in Exchange
Server, etc
<actionExecutedBy>admin@example.com</actionExecutedBy>
<actionExecutionTime>2010-11-30T05:52:53.011+00:00</actionExecutionTime>
<ipAddress>10.1.2.12</ipAddress>
</actionStatusResponse>
Mandatory attributes in Response
- actionID
- deviceName
- username
- action
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveler or Manage iPhones or
Manage Androids or Manage BlackBerrys
- Access Rights: Read-only Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
90
Search Action History (v1)
Request
GET /device-apis/devices/1.0/searchActionHistory/<billingID>
Definition
❖ Search action history by Device ID. If no Device ID is specified, the action history across all devices
for the customer is returned
❖ Return device change history in addition to action history
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Optional
Client Serial Number of the device
actionType
Optional
Possible values:
• Refresh Device Information
• Locate Device
• Send Message
• Buzz Device
• Lock Device
• Reset Device Passcode
• Update Device Certificate
• Selective Wipe
• Revoke Selective Wipe
• Wipe Device
• Cancel Pending Wipe
• Change Policy
• Change Rule Set
• Change Plan
• Remote Control Device
• Remove Control
• Hide Device Record
• User Authentication
• Approve Device
• Block Device
Remove device from Mailbox server
actionExecutionTimeFrom
Optional
Starting time when the action was executed
actionExecutionTimeTo
Optional
Ending time when the action was executed
actionExecutedBy
Optional
Administrator who executed the action
actionStatus
Optional
Possible values:
• Pending
• Complete
Failed
complianceEventsOnly
Optional
Possible values: Yes, No (Def)
If Yes, then return only Compliance Events
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
91
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/searchActionHistory/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response
<actionHistory>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<actionStatusResponse>
<actionID>a2e13f</actionID>
<deviceName>BBFL1234</deviceName>
<platformName>iOS</platformName>
<deviceId>Appl12345678</deviceId>
<username>smurphy</username>
<action>Wipe</action>
<actionStatus>Pending</actionStatus> ## Pending, Complete, Failed, Executed in
Exchange Server, etc
<actionExecutedBy>admin@example.com</actionExecutedBy>
<actionExecutionTime>2010-11-30T05:52:53.011+00:00</actionExecutionTime>
<ipAddress>10.104.12.109</ipAddress>
<comments></comments>
<errorDescription></errorDescription>
</actionStatusResponse>
<actionStatusResponse>
….
</actionStatusResponse>
<actionHistory>
Mandatory attributes in Response
- actionID
- deviceName
- username
- action
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveler or Manage iPhones or
Manage Androids or Manage BlackBerrys
- Access Rights: Read-only Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
92
Search Action History (v2)
Request
GET /device-apis/devices/2.0/searchActionHistory/<billingID>
Definition
❖ Search action history by Device ID. If no Device ID is specified, the action history across all devices
for the customer is returned
❖ Return device change history in addition to action history
❖ Get results on specified pages of the Result-set
❖ Action type in response is PERSONA_POL_UPDATE for persona policy changes and MDM_POL_UPDATE
for MDM policy changes
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Optional
Client Serial Number of the device
actionType
Optional
Possible values:
• Refresh Device Information
• Locate Device
• Send Message
• Buzz Device
• Lock Device
• Reset Device Passcode
• Update Device Certificate
• Selective Wipe
• Revoke Selective Wipe
• Wipe Device
• Cancel Pending Wipe
• Change Policy
• Change Rule Set
• Change Plan
• Remote Control Device
• Remove Control
• Hide Device Record
• User Authentication
• Approve Device
• Block Device
Remove device from Mailbox server
actionExecutionTimeFrom
Optional
Starting time when the action was executed
actionExecutionTimeTo
Optional
Ending time when the action was executed
actionExecutedBy
Optional
Administrator who executed the action
actionStatus
Optional
Possible values:
• Pending
• Complete
Failed
complianceEventsOnly
Optional
Possible values: Yes, No (Def)
If Yes, then return only Compliance Events
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
93
Sample Request
https://services.fiberlink.com/device-
apis/devices/2.0/searchActionHistory/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<history>
<actionStatusResponses>
<action>PERSONA_POL_UPDATE</action>
<actionExecutedBy>4174790_ravjadav</actionExecutedBy>
<actionExecutionTime>2017-02-20 11:31:48.0</actionExecutionTime>
<actionID>57666683</actionID>
<actionStatus>PENDING</actionStatus>
<comments>Changed to: Select a Policy Set</comments>
<deviceId>ApplDLXNQ294FCM5</deviceId>
<deviceName>Mg'ipad</deviceName>
<errorDescription></errorDescription>
<ipAddress>127.0.0.1</ipAddress>
<platformName>iOS</platformName>
<username>mahesh</username>
</actionStatusResponses>
<count>1</count>
<pageNumber>1</pageNumber>
<pageSize>1</pageSize>
</history>
Mandatory attributes in Response
- actionID
- deviceName
- username
- action
- actionStatus
Access Control
- Customer Properties: Manage ActiveSync Devices or Manage Notes Traveler or Manage iPhones or
Manage Androids or Manage BlackBerrys
- Access Rights: Read-only Actions
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
94
Create New Device Custom Attribute
Request
POST https://<host>/device-apis/devices/2.0/customAttributes/customer/<billingId>
Definition
❖ Create new custom attributes for a given name and type (and enum values in case of enum type)
❖ Authorization header: MaaS token=”<ADMIN_AUTH_MAAS_TOKEN>”
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
name
Required
Name of the custom attribute being created
type
Required
Type of custom attribute being created. Possible
values: boolean, date, enum, number, text
enumValues
Optional
Values for enum, required only if attributeType is
enum
defaultEnumValueIndex
Optional
Index of enum value that should be selected by
default. For example, if enumValues = ["value1",
"value2], value1 and the default enum value for
defaultEnumValueIndex should be 0, while value2 and
the default enum value for defaultEnumValueIndex
should be 1
Sample JSON Request
{
"name":"<attribute name>",
"type":"<attribute type>",
"enumValues":["value1", "value2", ..],
"defaultEnumValueIndex":<default enum index value>
}
Sample JSON Response
{
"billingId": <billing id>,
"name": "<attributeName>",
"responseCode": <Response Code>
}
Response Code Messages
Response code
Message
Scenario
0
Custom Attribute created
successfully
When a Custom Attribute is created successfully
without any errors
1
Unknown error occurred
while adding Custom
Attribute
When an internal error occurs
2
Custom attribute name
requires at least one non
space character
When an empty name is supplied
3
No Custom Attribute type
available with the given
type
When the given type of Custom Attribute is invalid
4
You have reached the
number of Custom
When the number of Custom Attributes present
already reached the limit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
95
Attributes that can be
created for your Account.
You can create a maximum
of 23 Custom attributes - 5
of which can be of Enum
type, 10 can be Text
values, 3 can be of Date
values and 5 can be of
Boolean or Integer values
5
Custom Attribute of type
enum requires at least one
non-empty enum value
When the enum type custom attribute is requested
with no enum values provided
6
Custom Attribute enum
values should be unique
When duplicate enum values are provided
7
Another attribute exists
with the same name
When the Custom Attribute name provided is already
in use
8
Custom Attribute name
exceeds maximum length
When the Custom Attribute name exceeds the
maximum number of allowed characters (currently
255)
9
Custom Attribute name
does not support the
following special
characters: period (.),less
than (<) and greater than
(>)
When the Custom Attribute name contains invalid
characters
10
Invalid default enum value
provided for custom
attribute
When the default enum index is invalid
Access Control
- Customer Properties: Enable Web Services
- Access Rights: Manage Device Custom Attributes
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
96
Get All Device Custom Attributes for a Given Organization
Request
GET /device-apis/devices/2.0/customAttributes/customer/<billingID>
Definition
❖ Get all device custom attributes for a given billing ID.
❖ Request headers: Authorization MaaS token="<ADMIN_AUTH_MAAS_TOKEN>"
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
GET https://<host>/device-apis/devices/2.0/customAttributes/customer/<billingID>
Sample Response
For valid authorization and sufficient privileges:
Response Status Code when custom attribute is added without errors: 200
Response Status Code when unknown internal error occurs: 500
Response Body:
{
"attributes" : [
{
"name":"<attribute name>",
"type":"<attribute type>"
},
{
"name":"<attribute name>",
"type":"<attribute type>",
"enumValues":["value1", "value2", ..],
"defaultEnumValue":<default enum value>
},
.
.
]
}
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
97
Response Body Details:
Parameter Name
Possible
Values
Description
name
Name of the custom attribute
type
boolean,
date, enum,
number, text
Type of custom attribute
enumValues
Values for enum, will only be present if type is enum
defaultEnumValue
Value of enum which is selected by default
In case of invalid authorization:
Response Code: 401
In case of insufficient privileges:
Response Code: 403
Sample Success Response
{
"billingId": 23456899,
"attributes" : [
{
"name":"lastUpdateDate",
"type":"date"
},
{
"name":"lastUpdateType",
"type":"enum",
"enumValues":["software", "hardware", ..],
"defaultEnumValue":"software"
},
.
.
]
}
Access Control
- Customer Properties: Enable Web Services
- Access Rights: Manage Device Custom Attributes
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
98
Device Enrollment
Create Device Enrollment
Request
POST /device-apis/devices/1.0/enrollDevice/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Creates an enrollment request and returns the enrollment details to be used for device enrollment.
❖ Relevant for Passcode, AD and 2-Factor authentication customers
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
userName
Required
domain
Required
emailAddress
Required
country
Optional
phoneNumber
Optional
ownership
Optional
Possible values:
- 0: Corporate Owned
- 1: Employee Owned
- 2: Corporate Shared
- 3: Provide Later
emailUser
Optional
Possible values: Yes, No
emailAdmin
Optional
Possible values: Yes, No
emailOther
Optional
Any other email address to which enrollment should be
sent
sendSMSUser
Optional
Possible values: Yes, No
enrollWithMdm
Optional
Applicable only for mixed mode customers. Applicable
only for mixed mode customer. This parameter is not
considered for MDM/MAM/SPS customers. Decides the
type of Add device request:
• Yes - Creates enrollment request for mixed mode
customer.
• No - Creates activation request for mixed mode
customer.
workplacePolicy
Optional
Workplace policy to be assigned. Supported only for
customers with Workplace policy defined
platform
Optional
Possible values:
- iOS
- Android
- Windows Phone 7
- BlackBerry
- Windows
- Mac
Only Platforms corresponding to services enabled for the
billing account will be accepted
policySet
Optional
Only policies for the specified platform will be accepted.
Also for Windows Phone 7, Windows and Mac no policies
are accepted currently
ruleSet
Optional
dataPlan
Optional
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
99
overrideAuthMode
Optional
Relevant only for AD customers. Possible values:
- 0: Corporate Credentials
- 1: Passcode
comments
Optional
customAttributes
Optional
<customAttributes>
<customAttribute>
<customAttributeName>attr1</customAttributeName>
<customAttributeValue>true</customAttributeValue>
</customAttribute>
<customAttribute>
< customAttributeName >attr2</
customAttributeName >
<customAttributeValue>val1</customAttributeValue>
</customAttribute>
</customAttributes>
authTypePostEnrollment
Optional
Applies to AD customers only. Can be used with
overrideAuthMode and usable with Passcode only value
(1). Possible values:
- 0: Corporate
- 1: Local
useAndroidWork
Optional
Used by Android for Work configured accounts.
Possible Values: True or False
True creates the Android for Work enrollment request if
configured to use Android for Work.
androidWorkAccountType
Optional
Used by EMM managed accounts.
Possible Values: device or user
User is the default Android for Work account type if the
account is EMM managed.
Sample Request
POST https://services.fiberlink.com/device-
apis/devices/1.0/enrollDevice/1101234/?userName=example&
domain=example.com&emailAddress=abc@example.com
Sample Response
<deviceEnrollment>
<url>https://iqservices1v.fiberlink.com/dp/a.htm?t=1652-2231118&c=2014622</url>
<corporateIdentifier>2014622</corporateIdentifier>
<passcode>32brtr8</passcode>
<qrCodeURL>
http://www.google.com/chart?cht=qr&chs=200x200&chl=https://iqservices1v.fiberlink.com/dp/a.htm?t
=1652-2231118&c=2014622</qrCodeURL>
<enrollmentId>12126</enrollmentId>
</deviceEnrollment>
Mandatory attributes in Response
- url
- corporateIdentifier
- passcode
- qrCodeURL
Access Control
- Customer Properties: Enable Device View
- Access Rights: Manage Device Enrollments
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
100
Manage Device Enrollments
Request
GET /device-apis/devices/1.0/manageDeviceEnrollments/<billingID>
Definition
❖ Returns the various Device Enrollments created for the billing account
❖ Enrollments can be filtered by Request Creation Date, Username, Status, Administrator Username – In
case of more than 1 criteria is specified, enrollments that meet all the criteria will be returned
❖ If request creation date range is not returned, then return requests created in last 90 days
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
requestCreationFromDate
Optional
Starting date from which the enrollment request was
created
requestCreationToDate
Optional
Ending date on which the enrollment request was
created
partialUsername
Optional
Partial Username using which the enrollment was
created
status
Optional
Possible values:
0 - "New"
1 - "Pending"
2 - "Complete"
3 - "Failed"
4 - "Exceeded"
5 - "Expired"
6 - "Deleted"
7 - "PendingSecurityAssessment"
partialAdminUsername
Optional
Partial Administrator Username of the Administrator
who created the enrollment request
includeCustomAttributes
Optional
Possible values: 0 (do not include in response; Default),
1 (include in response)
pageSize
Optional
Limit number of requests returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
enrollmentId
Optional
Enrollment ID of the account for which the web-service
is being executed
phoneNumber
Optional
Phone number specified while creating enrollment
request for the device
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/manageDeviceEnrollments/1101234
Sample Response
<deviceEnrollments>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<deviceEnrollment>
<requestDate>2010-11-30T05:52:53.011+00:00</requestDate>
<platform>iOS</platform>
<domain>Corporate</domain>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
101
<username>jsmith</username>
<emailAddress>jsmith@example.com</emailAddress>
<policySet>Corporate Policy</policySet>
<status>2</status>
<registrationDate>2010-11-30T05:52:53.011+00:00</registrationDate>
<registeredDeviceName>James’ iPhone</registeredDeviceName>
<errorInformation></errorInformation>
<requestedBy>admin@example.com</requestedBy>
<Id>12126</Id>
<phoneNumber>9871235460</phoneNumber>
<maas360DeviceID>ApplCCQDKLC6DCP7</maas360DeviceID>
<CustomAttributes>
<customAttribute>
<customAttributeName>Boolean</customAttributeName>
<customAttributeValue>true</customAttributeValue>
</customAttributes>
<customAttributes>
<customAttributeName>Enum</customAttributeName>
<customAttributeValue>one</customAttributeValue>
</customAttribute>
</CustomAttributes>
</deviceEnrollment>
</deviceEnrollments>
Mandatory attributes in Response
- requestDate
- platform
- username
- emailAddress
- status
- requestedBy
Access Control
Customer Properties: Enable Device View
Access Rights: Manage Device Enrollments
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
102
Groups
Get User & Device Groups
Request
GET /group-apis/group/1.0/groups/customer/<billing_id>
Definition
❖ Get all Device Groups (Public, Private & MaaS360 defined) and User Groups available for the currently
logged-in Administrator
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
https://services.fiberlink.com/group-apis/group/1.0/groups/customer/1001234/
Sample Response
<groups>
<count>3</count>
<group> <createdBy>hsao_fladmin</createdBy>
<createdOn>2013-08-12 10:24:03.0</createdOn>
<description>himanshu sao</description>
<groupID>341275</groupID>
<groupName>Hsao-test Group</groupName>
<groupType>3</groupType>
<lastModifiedOn>2013-08-12 10:24:03.0</lastModifiedOn>
</group>
<group>
…
</group>
</groups>
Possible values for groupType:
0: MaaS 360 Defined Device Group
1: Private Device Group
2: Public Device Group
3: Local User Group
4: User Directory User Group
Mandatory attributes in Response
- groupID
- groupName
- groupType
- createdBy
- createdOn
- lastModifiedOn
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
103
Search Devices by Device Group
Request
GET /device-apis/devices/1.0/searchByDeviceGroup/<billingID>
Definition
❖ Get devices belonging to a Device Group
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
deviceGroupId
Required
ID of the Device Group for which the devices need to be
retrieved
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default value:
50.
pageNumber
Optional
Results specific to a particular page. Default is first page
billingID
Required
Billing ID of the account for which the web-service is
being executed
sortAttribute
Optional
Keys: lastReported, installedDate
sortOrder
Optional
Keys: asc, dsc
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/searchByDeviceGroup/1101234?deviceGroupId=12345&pageSize=25&pageNumber=2&sort
Attribute=installedDate&sortOrder=asc
Sample Response
<devices>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<device>
<maas360DeviceID>a2e13f</maas360DeviceID>
<deviceName>BBFLLT3337</deviceName>
<customAssetNumber>09026</customAssetNumber>
<ownership>Employee Owned</ownership>
<deviceOwner>Stephen Murphy</deviceOwner>
<username>smurphy</username>
<emailAddress>smurphy@example.com</emailAddress>
<platformName>Windows</platformName>
<sourceID>1</sourceID>
<deviceType>Laptop</deviceType>
<manufacturer>Lenovo</manufacturer>
<model>T400</model>
<osName>Microsoft Windows XP</osName>
<osServicePack>SP2</osServicePack>
<imeiEsn>3456789019202019</imeiEsn>
<udid>8e380a56a937cce81620b143359d3404498dd638</udid>
<wifiMacAddress>09:AB:12:12:21:13</wifiMacAddress>
<installedDate>2010-11-30T05:52:53.011+00:00</installedDate>
<lastReported>2010-11-30T05:52:53.011+00:00</lastReported>
<deviceStatus>Active</deviceStatus>
<maas360ManagedStatus>Not Enrolled</maas360ManagedStatus>
<mailboxManaged>ActiveSync Managed</mailboxManaged>
<mailboxDeviceID>Appl1234567</mailboxDeviceID>
<mailboxLastReported>2010-11-30T05:52:53.011+00:00</mailboxLastReported>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
104
</device>
<device>
…
</device>
</devices>
Mandatory attributes in Response
- maas360DeviceID
- deviceName
- username
- platformName
- deviceType
- lastReported
- deviceStatus
- unifiedTravellerId (for iOS only. Consists of the ActiveSync mailbox ID, or iOS’s Exchange ID, or
deviceID)
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
105
Search Users by Group
Request
GET /user-apis/user/1.0/searchByGroup/customer/<billingID>/groupIdentifier/<groupID>
Definition
❖ Returns users in a User Group (Currently not supported for Device Group)
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
groupID
Required
includeAllUsers
Optional
Possible values:
- 0: Include users with devices only (Default)
- 1: Include all users
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
Sample Request
https://services.fiberlink.com/user-
apis/user/1.0/searchByGroup/customer/2047022/groupIdentifier/620532?includeAllUsers=0&pageSize=25
&pageNumber=1
Sample Response
<users>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<user>
<userIdentifier>B3A139685EF3719620211A7A99AD0E34</userIdentifier>
<userName>abarnes</userName>
<emailAddress>smurphy@example.com</emailAddress>
<domain>Fiberlink</domain>
<status>Active</status>
<location>Bangalore</location>
<source>0</source>
<authType>0</authType>
<createDate>Sep 10, 2015 6:56:34 PM</createdDate>
<updateDate>Sep 12, 2016 3:56:34 AM</updateDate>
<groups>
<group>
<groupId>12345</groupId>
<name>Sales</name>
<groupDN>cn=Sales,DC=Acmecorp,DC=com<groupDN>##This has value
only for User Directory Groups
<group>
…
</groups>
<userCustomAttributes>
<customAttribute>
<customAttributeName>home</customAttributeName>
<customAttributeValue>msn.com</customAttributeValue>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
106
</cusomAttribute>
</userCustomAttributes>
</user>
<user>
…
</user>
</users>
Mandatory attributes in Response
- userIdentifier
- userName
- domain
- emailAddress
- source
- status
- createDate
- updateDate
Access Control
Customer Properties: Enable User View for Customer
Access Rights: Users - Read Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
107
Get Group level distributions
Request
GET group-
apis/group/1.0/distributions/customer/<billing_id>/group/<group_identifier>/type/<dist_type_integer>
Definition
❖ Returns following types of distributions made on a User / Device Group
o 1: Automated Request
o 2: Policy
o 3: Rules
o 4: Apps
o 5: Docs
o 6: Corporate Doc Shares
o 7: Group Based Rules
o 8: Locations
Parameters
Parameter Name
Required /
Optional
Description
customer
Required
Billing ID of the account for which the web-service is
being executed
group_identifier
Required
Group for which details have to be retrieved
type
Required
Type of distributions that are needed:
- 1: Automated Enrollment Request
- 2: Policy
- 3: Rules
- 4: Apps
- 5: Docs
- 6: Corporate Doc Shares
- 7: Group Based Rules
- 8: Locations
Sample Request
https://services.fiberlink.com/user-
apis/group/1.0/distributions/customer/1001234/group/1234/type/5/
Sample Response
For Apps:
<distributions>
<distribution>
<category>App</category>
<name>usergrp</name>
<type>IOS_WEB_CLIP</type>
</distribution>
</distributions>
For Docs:
<distributions>
<distribution>
<category>Doc</category>
<name>apns_certs</name>
<type>txt</type>
</distribution>
</distributions>
For Automated Enrollment Requests
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
108
<distributions>
<distribution>
<category>AutomatedRequest</category>
<type>ENROLLMENT</type>
</distribution>
</distributions>
For Automated Activation Requests
<distributions>
<distribution>
<category>AutomatedRequest</category>
<type>ACTIVATION</type>
</distribution>
</distributions>
For Rule set
<distributions>
<distribution>
<category>Rule</category>
<name>RuleSet_Mon16022015_101410</name>
</distribution>
</distributions>
For Policies
<distributions>
<distribution>
<category>Policy</category>
<name>Default Android MDM Policy</name>
<type>Android MDM</type>
</distribution>
</distributions>
Mandatory attributes in Response
-
Access Control
Customer Properties: Enable Device View
Access Rights: Device View – Read Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
109
Get Search Criteria Options
Request
GET https://<host>/group-apis/group/2.0/searchCriteria/customer/<billing_id>
Definition
❖ Get All possible search criteria for a given organization
o Authorization header: MaaS token=<ADMIN_AUTH_MAAS_TOKEN>
o Accepts XML or JSON headers
Parameters
Parameter Name
Required /
Optional
Description
billing_id
Required
Billing ID of the account for which the web-service is
being executed
Sample JSON Response
{
“searchCriteriaOptions": {
"conditions": [
{
"category": "Hardware Inventory",
"attributes" : [
{
"attribute": "Enrollment Mode (Inactive)",
"type": "enum",
"criterias": [
"Equal To",
"Not Equal To"
],
"possibleValues": [
"Manual",
"Apple Configurator",
"DEP"
]
},
.
.
]
},
.
.
],
"criteriaOperator": [
"All Conditions (AND)",
"Any Condition (OR)",
"Across Conditions (Advanced)"
],
"deviceStatus": [
"Active Devices",
"Inactive Devices",
"All Devices"
],
"deviceTypes": [
"Smartphones",
"Tablets"
],
"lastReported": [
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
110
"Last 15 Minutes",
"Last 1 Hour",
"Today",
"Last 7 Days",
.
.
]
}
}
}
Access Control
Customer Properties: Enable Web Services
Access Rights: View Devices
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
111
Create Device Groups
Request
POST https://<host>/group-apis/group/2.0/deviceGroups/customer/<billing_id>
Definition
❖ Create a device group with search criteria
o Authorization header: MaaS token=<ADMIN_AUTH_MAAS_TOKEN>
o Accepts XML or JSON headers
Parameters
Parameter Name
Required /
Optional
Description
billing_id
Required
Billing ID of the account for which the web-service is
being executed
Sample JSON Request
{
"groupName" : "<group name>",
"groupDescription" : "<group description>",
"deviceStatus" : "<device status>",
"lastReported" : "<last reported>",
"criteriaOperator" : "<criteria operator>",
"deviceTypes" : [ "device type 1", "device type 2", ..]
"conditions" : [
{
"category" : "<category name>",
"attribute" : "<attribute name>",
"criteria" : "<criteria>",
"value1" : "<value 1>",
"value2" : "<value 2>"
}
Sample Request Parameters
Parameter Name
Required /
Optional
Description
groupName
Required
Name of the device being created.
groupDescription
Optional
Description of the group being created.
deviceStatus
Optional
Status of the device being searched for. Default: Active
Devices
lastReported
Optional
Search includes devices last reported in this time.
Default: Last 7 Days
deviceTypes
Optional
Types of devices to include in search. Default: All
available types are included
criteriaOperator
Optional
Decides if the devices meet all or any one condition
provided. Default: All Conditions (AND)
conditions
Optional
Conditions for search criteria, maximum of 10
category
Required
Category name on which condition is being constructed
attribute
Required
Attribute name on which condition is being constructed.
Requires the category parameter.
criteria
Required
Criteria to be used for comparison of values. Requires
the attribute parameter.
value1
Required
Value of the attribute. Requires the criteria parameter
and the attribute parameter.
value2
Optional
Second value of the attribute. Use if criteria such as
“between” is used.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
112
Sample JSON Response
{
"response": {
"billingId": 40006999,
"groupIdentifier": 4491847,
"name": "fromWebService3",
"responseCode": 0
}
Response Code Messages
Response
code
Message
Scenario
0
Group created successfully
When the group is created successfully without any
errors
1
Unknown error occurred while
creating device group
When an internal error occurs
2
Add device group workflow is
not supported
When the user doesn't have enough privileges to
create device group
3
Group name contains one or
more following illegal
characters: & * < >
When the group name contains illegal characters
4
Group name is empty
When the group name that is provided is empty
5
Group description contains one
or more following illegal
characters: ^ & < >
When the group description contains illegal
characters
6
Device group with the
provided name already exists
When a group already exists with the provided group
name
7
Invalid value provided for
deviceStatus
When the value provided for the deviceStatus is not
"Active Devices","Inactive Devices","All Devices"
8
Invalid value provided for
lastReported
When an invalid value is provided for lastReported
9
Invalid value operator
provided for criteriaOperator
When the value provided for criteriaOperator
provided is not "All Conditions (AND)", "Any Condition
(OR)", "Across Conditions (Advanced)"
10
Invalid values provided for
deviceTypes
When the deviceTypes contain invalid or unavailable
values
11
Number of conditions provided
exceed 10
When the number of conditions provided is more
than 10
12
Invalid value provided for
category
When an invalid value is provided for category
13
Invalid value provided for
attribute
When an invalid value is provided for attribute
14
Invalid value provided for
criteria
When an invalid value is provided for criteria
15
Two values are required for
"Between" criteria
When "Between" criteria is provided but only one
valid value is specified
16
At least one invalid value
provided for attribute of type
date/timestamp
When the value for date is not in epoch milliseconds
format or empty
17
At least one invalid value
provided for attribute of type
number/double
When an invalid value is provided for attributes of
number/double format
18
At least one invalid value
provided for attribute of type
integer
When an invalid value is provided for attributes for
the integer format
19
No value is provided in
condition for comparision
When at least one value is not provided for
comparison in the condition
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
113
20
Second value provided in
condition unnecessarily
When non "Between" criteria is selected but second
value is provided
21
Invalid value provided for
enum type attribute
When an enum attribute is selected, but the
comparison value provided is not one of the values in
the enum definition
22
Invalid value provided for
boolean type attribute
When enum attribute is selected, but the value
provided is not “Yes" or "No"
23
Advanced criteriaOperator is
not yet supported
When Advanced search criteria is provided, but it’s
not yet available for general use
Access Control
Customer Properties: Enable Web Services
Access Rights: Create Device Group
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
114
Create User Groups
Request
POST https://<host>/group-apis/group/1.0/userGroups/customer/<billing_id>
Definition
❖ Create a user group
o Authorization header: MaaS token=<ADMIN_AUTH_MAAS_TOKEN>
o application/x-www-form-urlencoded
Parameters
Parameter Name
Required /
Optional
Description
billing_id
Required
Billing ID of the account for which the web-service is
being executed
userGroupName
Required
Name of the user group.
The name cannot be empty or use only spaces. The
name should not contain the following special
characters: < > * , = & "
The maximum length of the group name is 54
characters.
You can replace the following characters with the
encoded format:
• & can be replaced with %26
• % can be replaced with %25
maas360UserIdsList
Optional
The user IDs of users who should be a part of this user
group.
parentGroupIdsList
Optional
The group IDs of the parent group. (Applies to nested
groups).
groupDescription
Optional
Description of the user group.
The description should not contain the following special
characters: < > * = & "
The maximum length of the group description is 255
characters.
You can replace the following characters with the
encoded format:
• & can be replaced with %26
• % can be replaced with %25
availableFor
Optional
Use one of the following:
• ADMIN_ACCESS_CONTROL (Applies to customers
with "Enable Access Control based on User
Groups" turned on)
• SECURITY
• APPS
• DOCS (Applies to customers with "Enable
Document management(Beta)" turned on)
• PLANS (Applies to customers with "Enable
Telecom Expense Management" turned on)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
115
Sample XML Response (Success)
<group>
<description>abc,def^a</description>
<groupId>9294173</groupId>
<name>abc_test_9</name>
</group>
Sample XML Response (Failure)
<group>
<errorCode>6</errorCode>
<name>abc_test_9</name>
</group>
HTTP Status Code Errors
HTTP Status
code
Error code
Meaning
403
1
Unable to create group due to insufficient previlages
– Check that all required customer properties are
turned on.
400
2
billingId cannot be empty.
400
3
userGroupName cannot be empty.
400
4
userGroupName contains one or more of the
following invalid characters < > * , = & " or exceeds
54 characters in length.
400
5
groupDescription contains one or more of the
following invalid characters < > * = & " or exceeds
255 characters in length.
400
6
The user group with the provided name already
exists.
403
7
The nested groups feature is unavailable for the
customer.
400
8
parentGroupIdsList contains IDs in an invalid format
403
9
The customer does not support one or more of the
work flows specified inavailableFor.
400
10
availableFor contains duplicate values.
Access Control
Customer Properties: Enable Web Services and User Management Type - "MaaS360 Local Account" or "User
Directory (MaaS360 Managed Groups)"
Access Rights: User Views – Add User and Device or higher
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
116
My WatchList
Get WatchLists
Request
GET /device-apis/devices/1.0/getWatchLists/<billingID>/
Definition
❖ Refresh the value of all WatchLists relevant for the account and return the latest values for these
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/getWatchLists/1101234/
Sample Response
<watchLists>
<count>50</count>
<watchList>
<alertType>INFO</alertType> ##Possible values: INFO, SECURITY
<shortText>Inactive Devices</shortText>
<watchListName>dv_old_av_def</watchListName>
<watchListCategories>
<watchListCategory>Desktop Management</watchListCategory>
<watchListCategory>Mobile Device Management</watchListCategory> ##
Possible values: Desktop Management, Mobile Device Management
</watchListCategories>
<watchListDescription>”Devices Not Reported in Last 7 days.”</watchListDescription >
<watchListShortDescription>Inactive Devices</watchListShortDescription>
<watchListValue>10</watchListValue>
</watchList>
<watchList>
…
</watchList>
</watchLists>
Mandatory attributes in Response
- watchListName
- watchListDescription
- watchListValue
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
117
Search by WatchList
Request
GET /device-apis/devices/1.0/searchByWatchList/<billingID>
Definition
❖ Get devices that are included in a WatchList
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
watchListName
Required
Name of the WatchList for which the devices need to be
retrieved
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default value:
50.
pageNumber
Optional
Results specific to a particular page. Default is first page
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
https://services.fiberlink.com/device-
apis/devices/1.0/searchByWatchList/<billingID>?watchListName=dv_old_av_def&pageSize=50&pageNumb
er=2
Sample Response
<devices>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<device>
<maas360DeviceID>a2e13f</maas360DeviceID>
<deviceName>BBFLLT3337</deviceName>
<customAssetNumber>09026</customAssetNumber>
<ownership>Employee Owned</ownership>
<deviceOwner>Stephen Murphy</deviceOwner>
<username>smurphy</username>
<emailAddress>smurphy@example.com</emailAddress>
<platformName>Windows</platformName>
<sourceID>1</sourceID>
<deviceType>Laptop</deviceType>
<manufacturer>Lenovo</manufacturer>
<model>T400</model>
<osName>Microsoft Windows XP</osName>
<osServicePack>SP2</osServicePack>
<imeiEsn>3456789019202019</imeiEsn>
<udid>8e380a56a937cce81620b143359d3404498dd638</udid>
<wifiMacAddress>09:AB:12:12:21:13</wifiMacAddress>
<installedDate>2010-11-30T05:52:53.011+00:00</installedDate>
<lastReported>2010-11-30T05:52:53.011+00:00</lastReported>
<deviceStatus>Active</deviceStatus>
<maas360ManagedStatus>Not Enrolled</maas360ManagedStatus>
<mailboxManaged>ActiveSync Managed</mailboxManaged>
<mailboxDeviceID>Appl1234567</mailboxDeviceID>
<mailboxLastReported>2010-11-30T05:52:53.011+00:00</mailboxLastReported>
</device>
<device>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
118
…
</device>
</devices>
Mandatory attributes in Response
- maas360DeviceID
- deviceName
- username
- platformName
- deviceType
- lastReported
- deviceStatus
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
119
Policy
Get Relevant Policies for a Service
Request
GET /device-apis/devices/1.0/policies/<billingID>
Definition
❖ Returns all relevant policies for a Service
❖ Relevant for iOS MDM, Android MDM, Windows Phone MDM, OSX MDM, Exchange ActiveSync, BES, and
Persona Policy
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
service
Optional
Possible values:
- iOS MDM
- Android MDM
- Windows Phone MDM
- OSX MDM
- Persona Policy
- Exchange ActiveSync
- BES
Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/policies/1101234?service=BES
Sample Response
<policies>
<count>10</count>
<policy>
<policyName>Corporate Policy</policyName>
<isDefault>No</isDefault>
<service>iOS MDM</service>
<policyStatus>Needs Publish</policyStatus>
<publishVersion>8</publishVersion>
<precedence>1</precedence>
<lastModifiedDate>2010-11-30T05:52:53.011+00:00</lastModifiedDate>
<lastPublishedDate>2010-11-30T05:52:53.011+00:00</lastPublishedDate>
<policy>
</policies>
Mandatory attributes in Response
- policyName
- isDefault
- service
- policyStatus
- lastModifiedDate
Access Control
Customer Properties: Manage ActiveSync Devices or Manage iPhones or Manage Androids or Manage
BlackBerrys
Access Rights: Policies (View Only)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
120
Get Enabled Services in a Persona Policy
Request
GET /policymgmt-apis/policies/2.0/enabledServices/customer/<billingId>/<policyName>
Definition
❖ Returns all enabled services for a specified Persona policy
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
policyName
Required
Name of the Persona policy
Sample Request
https://services.fiberlink.com/policymgmt-
apis/policies/2.0/enabledServices/customer/1101234?policyName=Corporate
Sample Response
<enabledServices>
<service>Secure Mail</service>
<service>Gateway for Browser</service>
</enabledServices>
Possible Services
- App Catalog
- Docs Editor
- Gateway for Browser
- Secure Browser
- Secure Browser MaaS360 Enterprise Gateway
- Secure Editor for Docs
- Secure Mail
- Secure Viewer
- Workplace App Container
Mandatory attributes in Response
- enabledServices
- service
Access Control
Access Rights: Policies (View Only)
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
121
Compliance Rules
Search Compliance Events
Request
GET /device-apis/devices/1.0/searchComplianceEvents/<billingID>
Definition
❖ Search compliance events by Device ID. If no Device ID is specified, the compliance events across all
devices for the customer is returned
❖ Only events for devices that are currently out of compliance will be returned by this API
❖ The events are sorted in newest first order
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Optional
Client Serial Number of the device
pageSize
Optional
Limit number of devices returned at one time.
(Default value is 50).
Recommended page sizes are 25, 50, 100, 200 & 250
pageNumber
Optional
Results specific to a particular page. Default is first
page.
Sample Request
For all devices: https://services.fiberlink.com/device-
apis/devices/1.0/searchComplianceEvents/<billingID>?pageSize=25&pageNumber=1
Or
For specific device: https://services.fiberlink.com/security-
apis/compliance/1.0/searchComplianceEvents/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response
<complianceEvents>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<complianceEvent>
<deviceName>BBFL1234</deviceName>
<platformName>iOS</platformName>
<maas360DeviceID>Appl12345678</maas360DeviceID>
<username>smurphy</username>
<rule>Restrict Jailbroken and Rooted device </rule>
<ruleset>Corporate Ruleset</ruleset>
<action>Selective Wipe</action>
<actionStatus>Complete</actionStatus> ## Pending, Complete, Failed, Executed in
Exchange Server, etc
<actionExecutionTime>2010-11-30T05:52:53.011+00:00</actionExecutionTime>
</complianceEvent>
<complianceEvent>
….
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
122
</complianceEvent>
</complianceEvents>
Mandatory attributes in Response
- deviceName
- platformName
- maas360DeviceID
- username
- rules
- ruleset
- action
Access Control
- Customer Properties: Enable Rules based Actions
- Access Rights: Rules - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
123
Applications
Search Installed Apps
Request
GET /application-apis/installedApps/1.0/search/<billingID>
Definition
❖ Search for all installed Apps across all devices by App Name, App ID and Platform
❖ Support for partial match for these attributes
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
partialAppName
Optional
Partial or full App Name string that needs to be
searched for
appID
Optional
Full AppID that needs to be searched for
platform
Optional
Supported values:
- iOS
- Android
- BlackBerry
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
https://services.fiberlink.com/application-apis/installedApps/1.0/search/1101234?
appID=com.maas360.control&platform=iOS&pageSize=25&pageNumber=2
Sample Response
<installedApps>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<app>
<devicecount>40</devicecount>
<appName>MaaS360</appName>
<platform>iOS</platform>
<appID>com.fiberlink.maas360forios</appID>
<majorVersions>3</majorVersions>
</app>
<app>
…
</app>
</installedApps>
Mandatory attributes in Response
- appName
- platform
- appID
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
124
- majorVersions
Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
125
Search Apps
Request
GET /application-apis/applications/1.0/search/<billingId>
Definition
❖ Search for iOS, macOS, and Android apps by App Name, App ID, App Type, Enterprise rating,
Category, Status & Device type
❖ Support for partial match for these attributes
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
appName
Optional
Partial Application Name string that needs to be
searched for
appId
Required
Partial or full App ID for the app to be searched
appType
Optional
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
8: iOS Web-Clip
10: Mac App Store Application
11: Mac Enterprise Application
enterpriseRating
Optional
Possible Values: 1, 2, 3, 4, 5
category
Optional
Partial or full category Name string that needs to be
searched for
status
Optional
Active or Deleted (Case insensitive)
deviceType
Optional
Possible values:
1: Smartphone
2: Tablet
3: Smartphone, Tablet
Sample Request
GET https://services.fiberlink.com/application-
apis/applications/1.0/search/1101234?appName=webex&appType=3&status=active&pageSize=25&pageNu
mber=2
Sample Response
<apps>
<count>1</count>
<pageSize>50</pageSize
<pageNumber>2</pageNumber
<app>
<appIconURL>icon1.png</appIconURL>
<appIconFullURL>https://cdn.maas360.com/icon1.png</appIconFullURL>
<appName>Webex Productivity Tool</appName>
<appId>com.sample.app</appId>
<enterpriseRating>3</enterpriseRating>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
126
<fileName>ptools.app</fileName>
<platform>iOS</platform>
<appType>2</appType>
<appFullVersion>5.2.5</appFullVersion>
<appVersionState>1</appVersionState>
<category>Games</category>
<appSize>1.106</appSize>
<status>active</status>
<deviceType>1</deviceType>
<vppCodes></vppCodes>
<uploadDate>2010-11-30T05:52:53.011+00:00</uploadDate>
<uploadedBy>admin@acmecorp.com</uploadedBy>
<lastUpdated>2010-11-30T05:52:53.011+00:00</lastUpdated>
</app>
</apps>
Sample Response (JSON)
{
"apps": {
"count": "10",
"pageSize": "50",
"pageNumber": "2",
"app": {
"appIconURL": "icon1.png",
"appIconFullURL": "https://cdn.maas360.com/icon1.png",
"appName": "Webex Productivity Tool",
"appId": "com.sample.app",
"enterpriseRating": "3",
"fileName": "ptools.app",
"platform": "iOS",
"appType": "2",
"appFullVersion": "5.2.5",
"appVersionState": "1",
"category": "Games",
"appSize": "1.106",
"status": "active",
"deviceType": "1",
"uploadDate": "2010-11-30T05:52:53.011+00:00",
"uploadedBy": "admin@acmecorp.com",
"lastUpdated": "2010-11-30T05:52:53.011+00:00"
}
}
Response Definitions
Response Key
Value or definition
appVersionState
Possible values:
1: Primary app with no secondary apps present
2: Primary app with secondary apps present
3: Secondary app
Mandatory attributes in Response
- appName
- appIconURL
- appId
- platform
- appType
- status
- deviceType
- uploadDate
- uploadedBy
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
127
- lastUpdated
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps-Read only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
128
Get App Details
Request
GET /application-apis/applications/1.0/getAppDetails/<billingID>
Definition
❖ Returns details for active iOS, macOS, and Android apps
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Customer identification number
appType
Optional
Possible values:
1: iOS Enterprise app
2: iOS App Store app
3: Android Enterprise app
4: Android Market app
8: iOS web-clip
10: Mac App Store Application
11: Mac Enterprise Application
appId
Required
Unique ID of app
appVersion
Optional
Required if there is a secondary app
Sample Request
https://services.fiberlink.com/application-apis/applications/1.0/getAppDetails
/1101234?appId=com.example&appType=2
Sample Response (XML)
<app>
<appName>Webex Productivity Tool</appName>
<appId>com.webex</appId
<platform>iOS</platform>
<appType>2</appType>
<status>ACTIVE</status>
<category>Games</category>
<supportedOn>1</supportedOn> ##1: 1: Smartphone, 2: Tablet, 3: Smartphone, Tablet
<distributions>
<distribution>All devices</distribution>
</distributions>
<installs>1</installs>
<distributed>3</distributed>
<appVersion>1.0</appVersion>
<appVersionState>1</appVersionState>
<appSize>10.5<appSize>
<uploadDate>2010-11-30T05:52:53.011+00:00</uploadDate>
<uploadedBy>admin@acmecorp.com</uploadedBy
<provisioningProfileExpiry>2010-11-30T05:52:53.011+00:00</provisioningProfileExpiry>
<minimumOSVersion>4.3</minimumOSVersion>
<secPolicies>
<secPolicy>
<key>RESTRICT_DATA_BACKUP</key>
<value>Yes</value>
</secPolicy>
<secPolicies>
<appDiscoveryPortal>0</appDiscoveryPortal>
<appOwner>maas360@fiberlink.com</appOwner> ## If App Discovery portal is enabled for the account
<details>xyz</details>
<appAttributes
<appAttribute>
<attributeName>UR"L_Type'</attributeName>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
129
<attributeValue />
</appAttribute>
</appAttributes>
<rawManifestUrl>http://manifest</rawManifestUrl>
</app>
Sample Response (JSON)
{
"app": {
"appName": "Example Productivity Tool",
"appId": "com.example",
"platform": "iOS",
"appType": "2",
"status": "ACTIVE",
"category": "Marketing",
"supportedOn": "1",
"distributions": {
"distribution": "All devices"
},
"installs": "1",
"distributed": "3",
"appVersion": "1.0",
"appVersionState": "1",
"appSize": "10.5",
"uploadDate": "2016-11-30T05:52:53.011+00:00",
"uploadedBy": "admin@example.com",
"provisioningProfileExpiry": "2016-11-30T05:52:53.011+00:00",
"minimumOSVersion": "7.0",
"secPolicies": {
"secPolicy": {
"key": "RESTRICT_DATA_BACKUP",
"value": "Yes"
}
},
"appDiscoveryPortal": "0",
"appOwner": "owner@example.com",
"details": "Download this to do your job",
"appAttributes":{
"Attribute":{
"AttributeName":"Email",
"AttributeValue":"abc@fiberlink.com"
}
}
}
"rawManifestUrl":"http://manifest"
}
Response Definitions
Response Key
Value or definition
supportedOn
1: Smartphone
2: Tablet
3: Smartphone and Tablet
appDiscoveryPortal
Appears if it’s enabled for the account.
0: Not Available
1: View only
2: View and Request
secPolicy
Contains:
RESTRICT_DATA_BACKUP
REMOVE_APP_ON_MDM_CONTROL
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
130
Response Key
Value or definition
REMOVE_APP_ON_SELECTIVE_WIPE
REMOVE_APP_ON_MDM_CONTROL_AND_SELECTIVE_WIPE
RESTRICT_CUT_COPY_PASTE
ENFORCE_AUTHENTICATION
ENFORCE_COMPLIANCE
INSTANT_INSTALL
INSTANT_INSTALL_TRANSPORT
INSTANT_INSTALL_TRANSPORT
Key contained in secPolicy. Has the following possible values:
0: All Networks
1: Wi-fi only
2: Wi-fi and In-network cellular
appVersionState
Possible values:
1: Primary app with no secondary apps present
2: Primary app with secondary apps present
3: Secondary app
Mandatory attributes in Response
- appName
- appId
- platform
- appType
- status
- category
- uploadDate
- uploadedBy
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps-Read only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
131
Search App Distributions
Request
GET /application-apis/applications/1.0/searchDistributions/<billingID>
Definition
❖ Search for Managed Application Distributions – Search by Application Name, Application Type,
Distribution Status
❖ Relevant for iOS and Android
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
appId
Required
Unique ID of the application
appType
Required
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
status
Optional
Published, Expired or Stopped (case insensitive
Sample Request
GET https://services.fiberlink.com/application-
apis/applications/1.0/searchDistributions/1101234?appName=webex&appType=3&appId=com.sample.app
&status=published&pageSize=25&pageNumber=2
Sample Response
<appDistributions>
<count>10</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<appDistribution>
<distributionName>Give ExampleCo Tool - Fri Aug 28 10:07:58 GMT+00:00
2015</distributionName>
<appName>ExampleCo Productivity Tool</appName>
<platform>iOS</platform>
<appType>2</appType>
<targetDevices>All Devices</targetDevices>
<status>published</status>
<distributionDate>2015-08-30T05:52:53.011+00:00</distributionDate>
<expirationDate>2015-09-30T00:00:00.011+00:00</expirationDate>
<distributedBy>admin@example.com</distributedBy>
<sendEmailNotification>yes</sendEmailNotification>
</appDistribution>
<appDistribution>
…
</appDistribution>
</appDistributions>
Mandatory attributes in Response
- distributionName
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
132
- appName
- platform
- appType
- targetDevices
- status
- distributionDate
- expirationDate
- distributedBy
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps-Read only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
133
Get App Distribution Details by Device
Request
GET /application-apis/applications/1.0/getAppDistributionByDevice/<billingID>
Definition
❖ Returns all the relevant devices to which the application has been distributed and the status of
application distribution
❖ If a deviceId is specified, then details of the distribution to just that specific device is returned
❖ Relevant for iOS MDM and Android MDM
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
deviceId
Optional
Client Serial Number of the device
appType
Required
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
appId
Required
Unique ID of the application distributed
activeDistribution
Optional
Possible values:
- Yes: Default
- No
- Any
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
Sample Request
GET https://services.fiberlink.com/application-
apis/applications/1.0/getAppDistributionByDevice/1101234?appId=com.sample.app&appType=2&
pageSize=25&pageNumber=2
Sample Response
<devices>
<count>100</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<device>
<activeDistribution>Yes</activeDistribution>
<maas360DeviceId>a1b2c3</maas360DeviceId>
<deviceName>jsmith’s iPhone</deviceName>
<status>Pending</status>
<username>user1</username>
<installedMDM>Yes</installedMDM>
</device>
<device>
…
</device>
</devices>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
134
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps-Read only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
135
Distribute App
Request
POST /application-apis/applications/1.0/distributeApp/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Distribute app to all devices, device group or specific device
❖ Relevant for iOS and Android
❖ If you distribute to a MaaS360 Device Group, a copy of the Device Group is created on which
distribute action is executed. In future, for Stop Distribution API, use the Device Group ID for the
copied over group and NOT the original Device Group.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
appId
Required
Unique ID of the application distributed
targetDevices
Required
Possible values:
0: All Devices
1: Device Group
2: Specific Device
appVersion
Optional
Version of app to be distributed, if more than one
version is stored
deviceGroupId
Optional
Required if targetDevices = 1
deviceId
Optional
Required if targetDevices = 2
instantInstall
Required
Possible values: Yes, No; Relevant only for appType = 1
or 2 (For others, this value is ignored)
sendEmail
Required
Possible values: Yes, No
sendNotification
Required
Possible values: Yes, No Relevant only for appType = 1
or 2 (For others, this value is ignored)
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/distributeApp/1007263?appType=1&appId=com.example&targetDevices=0&instantI
nstall=Yes&sendEmail=yes&sendNotification=Yes
Sample Response
<actionResponse>
<status>Success</status>
<description>Application distributed successfully.</description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps-Distribute Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
136
Delete App
Request
POST /application-apis/applications/1.0/deleteApp/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Stop all distributions of the app and delete the app
❖ Relevant for iOS and Android
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
appId
Required
Unique ID of the application
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/deleteApp/1007263?appType=1&appId=com.example
Sample Response
<actionResponse>
<status>Success</status>
<description>Application deleted successfully.</description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
137
Upgrade App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/upgradeApp/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Upgrade iOS and Android Enterprise app to MaaS360
❖ The ipa/apk file can be uploaded directly via webservice or can be provided via a URL where it is
hosted
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
appId
Required
Unique ID of the application distributed
maas360Hosted
Optional
Default is Yes
appSource
Optional
The ipa/apk file to be uploaded.
If maas360Hosted = Yes, then this is mandatory
appSourceURL
Optional
The URL where App is hosted.
If maas360Hosted = No, then this is mandatory
appVersion
Optional
Version of app to be upgraded, if more than one
version is stored
maintainAsAdditionalVersion
Optional
Possible values: Yes, No (Default)
appAttributes
Optional
versionReleaseNotes
Optional
A description of what’s new in the upgrade
instantUpdate
Optional
Silently updates installed app. Possible values: Yes, No
(Default)
Sample Request
POST https://services.fiberlink.com/application-apis/applications/1.0/upgradeApp/1007263
The request should contain 2 parts:
- Part 1: Name = app_details; Value = XML file for attributes other than the upgrade file
Format for the XML is as follows:
<appDetails>
<appId>com.cdw.cdw</appId>
<appType>1</appType>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<appVersion>5.2.5</appVersion>
<maintainAsAdditionalVersion>true</maintainAsAdditionalVersion>
<versionReleaseNotes>The icons are now in color!</versionReleaseNotes>
<instantUpdate>Yes</instantUpdate>
<appAttributes>
<appAttribute>
<attributeName>name</attributeName>
<attributeValue>xyz</attributeValue>
</appAttribute>
</appAttributes>
</appDetails>
- Part 2: Name = appSource; Value = upgrade file
o For example, the uploaded app version matches 5.2.5.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
138
Sample Response
<actionResponse>
<status>Success</status>
<description>Application upgraded successfully</description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
139
Upgrade App (apps larger than 50 MB)
Request
POST /application-apis/applications/1.0/upgradeAppPlus/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Upgrade iOS and Android Enterprise app to MaaS360
❖ The ipa/apk file can be uploaded directly via webservice or can be provided via a URL where it is
hosted
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
appId
Required
Unique ID of the application distributed
maas360Hosted
Optional
Default is Yes
appSource
Optional
The ipa/apk file to be uploaded.
If maas360Hosted = Yes, then this is mandatory
appSourceURL
Optional
The URL where App is hosted.
If maas360Hosted = No, then this is mandatory
maintainAsAdditionalVersion
Optional
Possible values: Yes, No (Default)
appAttributes
Optional
versionReleaseNotes
Optional
A description of what’s new in the upgrade
instantUpdate
Optional
Silently updates installed app. Possible values: Yes, No
(Default)
Sample Request
POST https://services.fiberlink.com/application-apis/applications/1.0/upgradeAppPlus/1007263
The request should contain 2 parts:
- Part 1: Name = app_details; Value = XML file for attributes other than the upgrade file
Format for the XML is as follows:
<appDetails>
<appId>com.cdw.cdw</appId>
<appType>1</appType>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<maintainAsAdditionalVersion>true</maintainAsAdditionalVersion>
<versionReleaseNotes>The icons are now in color!</versionReleaseNotes>
<instantUpdate>Yes</instantUpdate>
<appAttributes>
<appAttribute>
<attributeName>name</attributeName>
<attributeValue>xyz</attributeValue>
</appAttribute>
</appAttributes>
</appDetails>
- Part 2: Name = appSource; Value = upgrade file
Sample Response
<actionResponse>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
140
<status>Success</status>
<description>Package upgrade request successful.</description>
<appUpgradeRequestId>1422603013985</appUpgradeRequestId>
</actionResponse>
Mandatory attributes in Response
- status
- appUpgradeRequestId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
141
Mark App as Primary
Request
POST /application-apis/applications/1.0/markAsPrimary/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Mark a particular version of App as primary
❖ Relevant for iOS and Android Enterprise Apps
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
appId
Required
Unique ID of the application
appVersion
Required
Version of the App to be marked as Primary
instantInstall
Optional
Possible values: true, false
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/markAsPrimary/1007263?appType=1&appId=com.example&appVersion=4.0.1
Sample Response
<actionResponse>
<status>Success</status>
<description>Requested App marked as Primary</description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
142
Update Provisioning Profile
Request
POST /application-apis/applications/1.0/updateProvisioningProfile/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Update provisioning profile for iOS Enterprise app
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
appId
Required
Unique ID of the application distributed
provisioningProfile
Required
Updated Provisioning profile for the App
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/updateProvisioningProfile/1007263
The request should contain 2 parts:
- Part 1: Name = app_details; Value = XML file for attributes other than the upgrade file
Format for the XML is as follows:
<appDetails>
<appId>com.cdw.cdw</appId>
<appType>1</appType>
</appDetails>
- Part 2: Name = provisioningProfile; Value = upgrade file
Sample Response
<actionResponse>
<status>Success</status>
<description>Provisioning profile updated successfully.</description>
<provisioningProfileExpiry>2013-11-03T05:30:20.011+00:00</provisioningProfileExpiry>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
143
Stop App Distribution
Request
POST /application-apis/applications/1.0/stopAppDistribution/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Stop a specific distribution of an app
❖ Relevant for iOS and Android
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appType
Required
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
appId
Required
Unique ID of the application distributed
targetDevices
Required
Possible values:
0: All Devices
1: Device Group
2: Specific Device
deviceGroupId
Optional
Required if targetDevices = 1
deviceId
Optional
Required if targetDevices = 2
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/stopAppDistribution/1007263?appType=1&appId=com.example&targetDevices=0
Sample Response
<actionResponse>
<status>Success</status>
<description>Distribution stopped successfully.</description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable iOS App Store or Enable Android App Store or Enable New App
Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
144
Add iTunes App Store App (v1)
Request
POST /application-apis/applications/1.0/addITunesApp/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a iTunes App Store app to MaaS360
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
region
Optional
Default is US
appName
Required
Full App Name of the app that needs to be added to
MaaS360
removeApp
Required
Remove App on MDM Control Removal and Selective
Wipe. Possible values: Yes, No
restrictDataBackup
Required
Restrict Data Backup to iTunes. Possible values: Yes,
No
showInADP
Optional
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
appOwner
Optional
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/addITunesApp/1007263?appName=sample&removeApp=Yes&restrictDataBackup=Ye
s
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
List of country codes for “region” parameter
• Argentina: AR
• Armenia: AM
• Australia : AU
• Austria: AT
• Belgium: BE
• Botswana: BW
• Brazil: BR
• Bulgaria: BG
• Canada: CA
• Chile: CL
• China: CN
• Colombia: CO
• Costa Rica: CR
• Croatia: HR
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
145
• Czech Republic: CZ
• Denmark: DK
• Dominican Republic: DO
• Ecuador: EC
• Egypt: EG
• El Salvador: SV
• Estonia: EE
• Finland: FI
• France: FR
• Germany: DE
• Greece: GR
• Guatemala: GT
• Honduras: HN
• Hong Kong: HK
• Hungary: HU
• India: IN
• Indonesia: ID
• Ireland: IE
• Israel: IL
• Italy: IT
• Jamaica: JM
• Japan: JP
• Jordan: JO
• Kazakstan: KZ
• Kenya: KE
• Kuwait: KW
• Latvia: LV
• Lebanon: LB
• Lithuania: LT
• Luxembourg: LU
• Macau: MO
• Macedonia: MK
• Madagascar: MG
• Malaysia: MY
• Mali: ML
• Malta: MT
• Mauritius: MU
• Mexico: MX
• Netherlands: NL
• New Zealand: NZ
• Nicaragua: NI
• Niger: NE
• Norway: NO
• Pakistan: PK
• Panama: PA
• Paraguay: PY
• Peru: PE
• Philippines: PH
• Poland: PL
• Portugal: PT
• Qatar: QA
• Republic Of Korea: KR
• Republic Of Moldova: MD
• Romania: RO
• Russia: RU
• Saudi Arabia: SA
• Senegal: SN
• Singapore: SG
• Slovakia: SK
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
146
• Slovenia: SI
• South Africa: ZA
• Spain: ES
• Sri Lanka: LK
• Sweden: SE
• Switzerland: CH
• Taiwan: TW
• Thailand: TH
• Tunisia: TN
• Turkey: TR
• Uganda: UG
• United Arab Emirates: AE
• United Kingdom: GB
• United States: US
• Uruguay: UY
• Venezuela: VE
• Vietnam: VN
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
147
Add iTunes App Store App (v2)
Request
POST /application-apis/applications/2.0/addITunesApp/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Add a iTunes App Store app to MaaS360
❖ Enhanced version of addITunesApp API to support specifying App attributes
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
region
Optional
Default is US
appName
Required
Full App Name of the app that needs to be added to
MaaS360
removeApp
Required
Remove App on MDM Control Removal and Selective
Wipe. Possible values: Yes, No
restrictDataBackup
Required
Restrict Data Backup to iTunes. Possible values: Yes,
No
showInADP
Optional
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
appOwner
Optional
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)
appAttributes
Optional
Sample Request
POST https://services.fiberlink.com/application-apis/applications/2.0/addITunesApp/customer/1007263
The request should contain 1 part:
- Name = app_details; Value = XML file for attributes other than the file
Format for the XML is as follows:
<appDetails>
<region>US</region>
<appName>MyApp</appName>
<removeApp>Yes</removeApp>
<restrictDataBackup>Yes</restrictDataBackup>
<showInADP>0</showInADP>
<appOwner>owner@example.com</appOwner>
<appAttributes>
<appAttribute>
<attributeName>name</attributeName>
<attributeValue>xyz</attributeValue>
</appAttribute>
<appAttribute>
<attributeName>Email</attributeName>
<attributeValue>abc@def.com</attributeValue>
</appAttribute>
</appAttributes>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
148
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
List of country codes for “region” parameter
• Argentina: AR
• Armenia: AM
• Australia : AU
• Austria: AT
• Belgium: BE
• Botswana: BW
• Brazil: BR
• Bulgaria: BG
• Canada: CA
• Chile: CL
• China: CN
• Colombia: CO
• Costa Rica: CR
• Croatia: HR
• Czech Republic: CZ
• Denmark: DK
• Dominican Republic: DO
• Ecuador: EC
• Egypt: EG
• El Salvador: SV
• Estonia: EE
• Finland: FI
• France: FR
• Germany: DE
• Greece: GR
• Guatemala: GT
• Honduras: HN
• Hong Kong: HK
• Hungary: HU
• India: IN
• Indonesia: ID
• Ireland: IE
• Israel: IL
• Italy: IT
• Jamaica: JM
• Japan: JP
• Jordan: JO
• Kazakstan: KZ
• Kenya: KE
• Kuwait: KW
• Latvia: LV
• Lebanon: LB
• Lithuania: LT
• Luxembourg: LU
• Macau: MO
• Macedonia: MK
• Madagascar: MG
• Malaysia: MY
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
149
• Mali: ML
• Malta: MT
• Mauritius: MU
• Mexico: MX
• Netherlands: NL
• New Zealand: NZ
• Nicaragua: NI
• Niger: NE
• Norway: NO
• Pakistan: PK
• Panama: PA
• Paraguay: PY
• Peru: PE
• Philippines: PH
• Poland: PL
• Portugal: PT
• Qatar: QA
• Republic Of Korea: KR
• Republic Of Moldova: MD
• Romania: RO
• Russia: RU
• Saudi Arabia: SA
• Senegal: SN
• Singapore: SG
• Slovakia: SK
• Slovenia: SI
• South Africa: ZA
• Spain: ES
• Sri Lanka: LK
• Sweden: SE
• Switzerland: CH
• Taiwan: TW
• Thailand: TH
• Tunisia: TN
• Turkey: TR
• Uganda: UG
• United Arab Emirates: AE
• United Kingdom: GB
• United States: US
• Uruguay: UY
• Venezuela: VE
• Vietnam: VN
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
150
Add iOS Enterprise App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/addIOSEnterpriseApp/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Uploads an iOS Enterprise app to MaaS360.
❖ Upload an ipa file, or provide the URL where the ipa file is hosted.
❖ The request contains at least two parts: the app details, then the app source, then any screenshots.
o Part 1: Name = app_details; Value = XML of app details
o Part 2: Name = appSource; Value = upload file binary or URL
o Part 3-4: Name = screenshot1, Value = screen shot file binary
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Customer identification number
maas360Hosted
Optional
Possible values: Yes (default), No
appSource
Optional, or
Required if
maas360Hosted=No
The filepath of the ipa file to be uploaded
Mutually exclusive with appSourceURL
appSourceURL
Optional, or
required if
maas360Hosted=No
The URL of the hosted ipa file.
Mutually exclusive with appSource
description
Required
Text description of the app
category
Optional
MaaS360 app catalog category
screenshot1
Optional
Uploads jpg, gif, or png
screenshot2
Optional
Uploads jpg, gif, or png
removeApp
Required
Possible values: Yes, No
Set to remove the app during MDM Control
Removal and Selective Wipe.
restrictDataBackup
Optional
Possible values: Yes, No
Prevents backing up the app to iTunes.
showInADP
Optional
Possible values: 0 (Not Available), 1 (View only), 2
(View & Request)
Use only if the App Discovery Portal is enabled for
the account.
appOwner
Optional, or
Required if
showInADP=1 or 2
Contact email address of the app owner
Sample Request
POST https://services.fiberlink.com/application-apis/applications/1.0/addIOSEnterpriseApp/1101234
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>Download this app immediately. </description>
<category>General</category>
<removeApp>Yes</removeApp>
<restrictDataBackup>Yes</restrictDataBackup>
<showInADP>2</showInADP>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
151
<appOwner>devteam@example.com</appOwner>
</appDetails>
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully. </description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
152
Add iOS Enterprise App (apps more than 50 MB)
Request
POST /application-apis/applications/1.0/addIOSEnterpriseApp2/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Uploads an iOS Enterprise app (the filesize of which exceeds 50MB) to MaaS360.
❖ Upload an ipa file, or provide the URL where the ipa file is hosted.
❖ The request contains at least two parts: the app details, then the app source, then any screenshots.
o Part 1: Name = app_details; Value = XML of app details
o Part 2: Name = appSource; Value = upload file binary or URL
o Part 3-4: Name = screenshot1, Value = screen shot file binary
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Customer identification number
maas360Hosted
Optional
Possible values: Yes (default), No
appSource
Optional, or Required
if maas360Hosted=No
The filepath of the ipa file to be uploaded
Mutually exclusive with appSourceURL
appSourceURL
Optional, or required
if maas360Hosted= No
The URL of the hosted ipa file
Mutually exclusive with appSource
description
Required
Text description of the app
category
Optional
MaaS360 app catalog category
screenshot1
Optional
Uploads jpg, gif, or png
screenshot2
Optional
Uploads jpg, gif, or png
removeApp
Required
Possible values: Yes, No
Set to remove the app during MDM Control
Removal and Selective Wipe.
showInADP
Optional
Possible values: 0 (Not Available), 1 (View only),
2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
appOwner
Optional, or Required
if showInADP=1 or 2
Contact email address of the app owner
Sample Request
https://services.fiberlink.com/application-apis/applications/1.0/addIOSEnterpriseApp2/1101234
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>Download this app immediately. </description>
<category>General</category>
<removeApp>Yes</removeApp>
<restrictDataBackup>Yes</restrictDataBackup>
<showInADP>2</showInADP>
<appOwner>devteam@example.com</appOwner>
</appDetails>
Sample Response
<actionResponse>
<status>Success</status>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
153
<description>Application uploaded successfully. </description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
- appUploadRequestId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
154
Enterprise App Upload Request Status
Request
GET /application-apis/applications/1.0/appUploadRequestStatus/<billingID>?appUploadRequestId=1234
Definition
❖ Gets the status of large enterprise apps (more than 50 MB) uploaded – iOS or Android
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appUploadRequestId
Required
Request ID which was given as a response in the large
Enterprise App upload APIs
Sample Request
https://services.fiberlink.com/application-
apis/applications/1.0/appUploadedRequestStatus/1007623?appUploadRequestId=1234
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable iOS App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
155
Add Google Play App (v1)
Request
POST /application-apis/applications/1.0/addPlayApp/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a Google Play app to MaaS360
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appSourceURL
Required
Google Play URL for the app
removeAppMDMRemoval
Required
Possible values: Yes, No
removeAppSelWipe
Required
Possible values: Yes, No
enforceAuthentication
Required
Possible values: Yes, No
enforceCompliance
Required
Possible values: Yes, No
showInADP
Optional
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
appOwner
Optional
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/1.0/addPlayApp/1007263?appSourceURL=https://play.google.com/store/apps/details?i
d=org.cocos2dx.NautilusCricket2014&removeAppMDMRemoval=Yes&removeAppSelWipe=Yes&enforceAuth
entication=Yes&enforceCompliance=Yes
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable Android App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
156
Add Google Play App (v2)
Request
POST /application-apis/applications/2.0/addPlayApp/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Add a Google Play app to MaaS360
❖ Enhanced version of addPlayApp API to support specifying App attributes
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
appSourceURL
Required
Google Play URL for the app
removeAppMDMRemoval
Required
Possible values: Yes, No
removeAppSelWipe
Required
Possible values: Yes, No
enforceAuthentication
Required
Possible values: Yes, No
enforceCompliance
Required
Possible values: Yes, No
showInADP
Optional
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
appOwner
Optional
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)
appAttributes
Optional
Sample Request
POST https://services.fiberlink.com/application-apis/applications/2.0/addPlayApp/customer/1007263
- Name = app_details; Value = XML file for attributes other than the file
Format for the XML is as follows:
<appDetails>
<appSourceURL>https://play.google.com/store/apps/details?id=org.cocos2dx.NautilusCricket201
4</appSourceURL>
<removeAppMDMRemoval>Yes</removeAppMDMRemoval>
<removeAppSelWipe>Yes</removeAppSelWipe>
<enforceAuthentication>Yes</enforceAuthentication>
<enforceCompliance>Yes</enforceCompliance>
<showInADP>0</showInADP>
<appOwner>owner@example.com</appOwner>
<appAttributes>
<appAttribute>
<attributeName>name</attributeName>
<attributeValue>xyz</attributeValue>
</appAttribute>
<appAttribute>
<attributeName>Email</attributeName>
<attributeValue>abc@def.com</attributeValue>
</appAttribute>
</appAttributes>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
157
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable Android App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
158
Add Android Enterprise App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/addAndroidEnterpriseApp/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Uploads an Android Enterprise app (the filesize of which exceeds 50MB) to MaaS360.
❖ Upload an apk file, or provide the URL where the apk file is hosted.
❖ The request contains at least two parts: the app details, then the app source, then any screenshots.
o Part 1: Name = app_details; Value = XML of app details
o Part 2: Name = appSource; Value = upload file binary or URL
o Part 3-4: Name = screenshot1, Value = screen shot file binary
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Customer identification number
maas360Hosted
Optional
Possible values: Yes (default), No
appSource
Optional, or Required
if maas360Hosted=Yes
The filepath of the apk file to be uploaded
Mutually exclusive with appSourceURL
appSourceURL
Optional, or Required
if maas360Hosted= No
The URL of the hosted apk file
Mutually exclusive with appSource
description
Required
Text description of the app
category
Optional
MaaS360 app catalog category
screenshot1
Optional
Uploads jpg, gif, or png
screenshot2
Optional
Uploads jpg, gif, or png
removeAppMDMRemoval
Required
Possible values: Yes, No
Set to remove the app during MDM Control
Removal.
removeAppSelWipe
Required
Possible values: Yes, No
Set to remove the app during Selective Wipe.
enforceAuthentication
Required
Possible values: Yes, No
enforceCompliance
Required
Possible values: Yes, No
instantInstall
Optional
Possible values: Yes, No
instantInstallTransport
Optional, or Required
if instantInstall=Yes
Possible values: 0 (All networks), 1 (Wi-fi
only), 2 (Wi-fi and in-network cellular)
showInADP
Optional
Possible values: 0 (Not Available), 1 (View
only), 2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
appOwner
Optional, or Required
if showInADP=1 or 2
Contact email address of the app owner
Sample Request
https://services.fiberlink.com/application-apis/applications/1.0/addAndroidEnterpriseApp/1101234
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>Download this app immediately. </description>
<category>General</category>
<removeAppMDMRemoval>Yes</removeAppMDMRemoval>
<removeAppSelWipe>Yes</removeAppSelWipe>
<enforceAuthentication>Yes</enforceAuthentication>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
159
<enforceCompliance>Yes</enforceCompliance>
<instantInstall>Yes</instantInstall>
<instantInstallTransport>2</instantInstallTransport>
<showInADP>2</showInADP>
<appOwner>devteam@example.com</appOwner>
</appDetails>
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully. </description>
<appUploadRequestId>1234</appUploadRequestId >
</actionResponse>
Mandatory attributes in Response
- status
- appUploadRequestId
- appId
Access Control
- Customer Properties: Enable Android App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
160
Add Android Enterprise App (apps larger than 50 MB)
Request
POST /application-apis/applications/1.0/addAndroidEnterpriseAppPlus/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Uploads an Android Enterprise app (the filesize of which exceeds 50MB) to MaaS360.
❖ Upload an apk file, or provide the URL where the apk file is hosted.
❖ The request contains at least two parts: the app details, then the app source, then any screenshots.
o Part 1: Name = app_details; Value = XML of app details
o Part 2: Name = appSource; Value = upload file binary or URL
o Part 3-4: Name = screenshot1, Value = screen shot file binary
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Customer identification number
maas360Hosted
Optional
Possible values: Yes (default), No
appSource
Optional, or Required
if maas360Hosted=Yes
The filepath of the apk file to be uploaded
Mutually exclusive with appSourceURL
appSourceURL
Optional, or Required
if maas360Hosted= No
The URL of the hosted apk file
Mutually exclusive with appSource
description
Required
Text description of the app
category
Optional
MaaS360 app catalog category
screenshot1
Optional
Uploads jpg, gif, or png
screenshot2
Optional
Uploads jpg, gif, or png
removeAppMDMRemoval
Required
Possible values: Yes, No
Set to remove the app during MDM Control
Removal.
removeAppSelWipe
Required
Possible values: Yes, No
Set to remove the app during Selective Wipe.
enforceAuthentication
Required
Possible values: Yes, No
enforceCompliance
Required
Possible values: Yes, No
instantInstall
Optional
Possible values: Yes, No
instantInstallTransport
Optional, or Required
if instantInstall=Yes
Possible values: 0 (All networks), 1 (Wi-fi
only), 2 (Wi-fi and in-network cellular)
showInADP
Optional
Possible values: 0 (Not Available), 1 (View
only), 2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
appOwner
Optional, or Required
if showInADP=1 or 2
Contact email address of the app owner
Sample Request
https://services.fiberlink.com/application-apis/applications/1.0/addAndroidEnterpriseAppPlus/1101234
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>Download this app immediately. </description>
<category>General</category>
<removeAppMDMRemoval>Yes</removeAppMDMRemoval>
<removeAppSelWipe>Yes</removeAppSelWipe>
<enforceAuthentication>Yes</enforceAuthentication>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
161
<enforceCompliance>Yes</enforceCompliance>
<instantInstall>Yes</instantInstall>
<instantInstallTransport>2</instantInstallTransport>
<showInADP>2</showInADP>
<appOwner>devteam@example.com</appOwner>
</appDetails>
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully. </description>
<appUploadRequestId>1234</appUploadRequestId >
</actionResponse>
Mandatory attributes in Response
- status
- appUploadRequestId
Access Control
- Customer Properties: Enable Android App Store or Enable New App Management workflows
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
162
Add Mac App Store App
Request
POST /application-apis/macApps/2.0/addMacAppStoreApp/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add a Mac App Store app to MaaS360.
❖ The request should contain one part:
o Part 1: Name = appDetails; Value = XML file for attributes other than the file
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
Region
Optional
Default: US
appName
Required
Full app name of the app that needs to be
added to MaaS360
removeWithSelectiveWipe
Required
Remove App on selective wipe. Possible
values: Yes or No. Default: Yes
removeWithMDMRemoval
Required
Remove App on MDM Control Removal. Possible
values: Yes or No. Default: Yes
removeOnStopDist
Optional
Remove App on Stopping Distribution. Possible
values: Yes or No. Default:No
Sample Request
POST https://services.fiberlink.com/application-
apis/macApps/2.0/addMacAppStoreApp/customer/1007263
Sample Request Value (Part 1)
<appDetails>
<region>US</region>
<appName>MyApp</appName>
<removeWithSelectiveWipe>No</removeWithSelectiveWipe>
<removeWithMDMRemoval>No</removeWithMDMRemoval>
<removeOnStopDist>Yes</removeOnStopDist>
</appDetails>
List of country codes for “region” parameter
• Argentina: AR
• Armenia: AM
• Australia : AU
• Austria: AT
• Belgium: BE
• Botswana: BW
• Brazil: BR
• Bulgaria: BG
• Canada: CA
• Chile: CL
• China: CN
• Colombia: CO
• Costa Rica: CR
• Croatia: HR
• Czech Republic: CZ
• Denmark: DK
• Dominican Republic: DO
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
163
• Ecuador: EC
• Egypt: EG
• El Salvador: SV
• Estonia: EE
• Finland: FI
• France: FR
• Germany: DE
• Greece: GR
• Guatemala: GT
• Honduras: HN
• Hong Kong: HK
• Hungary: HU
• India: IN
• Indonesia: ID
• Ireland: IE
• Israel: IL
• Italy: IT
• Jamaica: JM
• Japan: JP
• Jordan: JO
• Kazakstan: KZ
• Kenya: KE
• Kuwait: KW
• Latvia: LV
• Lebanon: LB
• Lithuania: LT
• Luxembourg: LU
• Macau: MO
• Macedonia: MK
• Madagascar: MG
• Malaysia: MY
• Mali: ML
• Malta: MT
• Mauritius: MU
• Mexico: MX
• Netherlands: NL
• New Zealand: NZ
• Nicaragua: NI
• Niger: NE
• Norway: NO
• Pakistan: PK
• Panama: PA
• Paraguay: PY
• Peru: PE
• Philippines: PH
• Poland: PL
• Portugal: PT
• Qatar: QA
• Republic Of Korea: KR
• Republic Of Moldova: MD
• Romania: RO
• Russia: RU
• Saudi Arabia: SA
• Senegal: SN
• Singapore: SG
• Slovakia: SK
• Slovenia: SI
• South Africa: ZA
• Spain: ES
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
164
• Sri Lanka: LK
• Sweden: SE
• Switzerland: CH
• Taiwan: TW
• Thailand: TH
• Tunisia: TN
• Turkey: TR
• Uganda: UG
• United Arab Emirates: AE
• United Kingdom: GB
• United States: US
• Uruguay: UY
• Venezuela: VE
• Vietnam: VN
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: Enable AppCatalog for macOS
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
165
Add Windows Dependency
Request
POST /application-apis/winApps/2.0/addWindowsDependency/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add one Windows dependency file (appx or appxbundle) to MaaS360.
❖ The request should contain one part:
o Part 1: Name = appSource; Value = Upload file
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
appSource
Required
Dependency file to be uploaded
Sample Request
POST https://services.fiberlink.com/application-
apis/winApps/2.0/addWindowsDependency/customer/1007263
Sample Response
<actionResponse>
<status>Success</status>
<description>Dependency uploaded successfully.</description>
<dependencyName>Microsoft.NET.Native.Runtime.1.1</dependencyName>
<dependencyVersion>1.1.23406.0</dependencyVersion>
<dependencyArchitecture>ARM,</dependencyArchitecture>
</actionResponse>
Mandatory attributes in Response
- status
- dependencyName
- dependencyVersion
- dependencyArchitecture
Access Control
- Customer Properties: ENABLE_NEW_APPS, MANAGE_WINDOWS7_PHONE
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
166
Add Windows Enterprise App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseApp/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add a Windows enterprise app to MaaS360.
❖ Upload an xap, appx, appxbundle file, or provide the URL where the file is hosted.
❖ The request should contain six parts:
o Part 1: Name = app_details; Value = XML file for attributes other than the file
o Part 2: Name = appSource; Value = Upload file
o Part 3: Name = screenshot1; Value = Screenshot file1
o Part 4: Name = screenshot2; Value = Screenshot file2
o Part 5: Name = screenshot3; Value = Screenshot file3
o Part 6: Name = screenshot4; Value = Screenshot file4
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
maas360Hosted
Optional
Default: Yes
appSource
Optional
The ipa file to be uploaded. If maas360Hosted
= Yes, then this parameter is mandatory.
appSourceURL
Optional
The URL where the app is hosted. If
maas360Hosted = No, then this parameter is
mandatory.
description
Required
category
Optional
screenshot1
Optional
screenshot2
Optional
screenshot3
Optional
screenshot4
Optional
removeAppOnMDMRemoval
Required
Remove App on MDM Control Removal.
Possible values: Yes or No
removeAppOnSelectiveWipe
Required
Remove App Selective Wipe. Possible values:
Yes or No
removeAppOnStopDistribution
Required
Remove App on Stop distribution. Possible
values: Yes or No
instantInstall
Optional
Instant install of the app on the device.
Possible values: Yes or No
isUniversalApp
Required
Is the app uploaded a universal app. Possible
values: Yes or No
pfn
Optional
Package Family Name. Mandatory for universal
apps.
showInADP
Optional
Relevant only If App Discovery Portal is
enabled for the account.
Possible values:
0: Not Available
1: View only
2: View & Request
appOwner
Optional
Email address of the owner of the app who
needs to be intimated. Required if showInADP
= 1 or 2.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
167
appAttributes
Optional
Sample Request
POST https://services.fiberlink.com/application-
apis/winApps/2.0/addWindowsEnterpriseApp/customer/1007263
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>Enterprise App</description>
<category>General</category>
<removeAppOnMDMRemoval>Yes</removeAppOnMDMRemoval>
<removeAppOnSelectiveWipe>Yes</removeAppOnSelectiveWipe>
<removeAppOnStopDistribution>Yes</removeAppOnStopDistribution>
<instantInstall>Yes</instantInstall>
<isUniversalApp>Yes</isUniversalApp>
<pfn>95b4d4a7-a5c2-4873-a769-7cdee54ecfce_z1fqjy1wgpzc2</pfn>
<showInADP>2</showInADP>
<appOwner>owner@fiberlink.com</appOwner>
<appAttributes>
<appAttribute> <attributeName>name</attributeName>
<attributeValue>xyz</attributeValue> </appAttribute>
</appAttributes>
</appDetails>
Sample Response
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>com.sample.app</appId>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: ENABLE_NEW_APPS, MANAGE_WINDOWS7_PHONE
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
168
Add Windows EXE App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseEXEApp/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add a Windows EXE app (.exe) to MaaS360.
❖ The EXE app file must be uploaded by the web service.
❖ The request should contain seven parts:
o Part 1: Name = appSource; Value = Upload file
o Part 2: Name = app_details; Value = XML file containing all attributes with value
o Part 3: Name = screenshot1 (optional)
o Part 4: Name = screenshot2 (optional)
o Part 5: Name = screenshot3 (optional)
o Part 6: Name = screenshot4 (optional)
o Part 7: Name = icon
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
POST https://services.fiberlink.com/application-
apis/winApps/2.0/addWindowsEnterpriseEXEApp/customer/1007263
Sample Request Value
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>newDescriptiondgg8787gMAV</description>
<category>games</category>
<removeAppOnMDMRemoval>Yes</removeAppOnMDMRemoval>
<removeAppOnSelectiveWipe>Yes</removeAppOnSelectiveWipe>
<removeAppOnStopDistribution>No</removeAppOnStopDistribution>
<showInADP>2</showInADP>
<appOwner>maas360@fiberlink.com</appOwner>
<name>AppEXENEWAPPMAV</name>
<executionCommandUnInstall>uninstallss.exe</executionCommandUnInstall>
<executionCommandInstall>installsss.exe</executionCommandInstall>
<isRestartReq>No</isRestartReq>
<supportedArchitecture>X64</supportedArchitecture>
<maintainAsAdditionalVersion>Yes</maintainAsAdditionalVersion>
<appVersion>6.89</appVersion>
<winPkgType>EXE</winPkgType>
<installationMode>UI</installationMode>
<IsRestartReq>Yes</IsRestartReq>
<installSuccessCriteria>[{"file":[{"filePath":"C:\\Program Files
(x86)\\Evernote\\Evernote\\Evernote.exe","fileSize":"18040160"}]},
{"file":[{"filePath":"C:\\Program Files
(x86)\\Evernote\\Evernote\\Evernote.exe","fileSize":"18040160"}]}]
</installSuccessCriteria>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
169
Mandatory attributes in Request
- installationMode
- supportedArchitecture
- executionCommandUnInstall
- installSuccessCriteria
o appName
o appVersion
o appIcon
Sample Response
<actionResponse>
<description>Application Successfully Added</description>
<status>Success</status>
</actionResponse>
Access Control
- Customer Properties: ENABLE_NEW_APPS, WIN_DESKTOP_DEVICES
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
170
Add Windows MSI App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseMSIApp/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add a Windows MSI app (.msi) to MaaS360.
❖ The MSI app file must be uploaded by the web service.
❖ The request should contain seven parts:
o Part 1: Name = appSource; Value = Upload file (.msi)
o Part 2: Name = app_details; Value = XML file containing all attributes with value
o Part 3: Name = screenshot1 (optional)
o Part 4: Name = screenshot2 (optional)
o Part 5: Name = screenshot3 (optional)
o Part 6: Name = screenshot4 (optional)
o Part 7: Name = icon
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
POST https://services.fiberlink.com/application-
apis/winApps/2.0/addWindowsEnterpriseMSIApp/customer/1007263
Sample Request Value
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL></appSourceURL>
<description>newDescriptiondgg8787gMAV</description>
<category>games</category>
<removeAppOnMDMRemoval>No</removeAppOnMDMRemoval>
<removeAppOnSelectiveWipe>Yes</removeAppOnSelectiveWipe>
<removeAppOnStopDistribution>No</removeAppOnStopDistribution>
<showInADP>2</showInADP>
<appOwner>maas360@fiberlink.com</appOwner>
<name>AppEXENEWAPPMAV</name>
<upgradeCode>{930652F4-E661-40E2-BF23-C4B58913B223}</upgradeCode>
<packageCode>{930652F4-E661-40E2-BF23-C4B58913B223}</packageCode>
<executionCommandUnInstall>uninstallss.exe</executionCommandUnInstall>
<executionCommandInstall>installsss.exe</executionCommandInstall>
<isRestartReq>No</isRestartReq>
<supportedArchitecture>X64</supportedArchitecture>
<maintainAsAdditionalVersion>Yes</maintainAsAdditionalVersion>
<appVersion>6.89</appVersion>
<winPkgType>EXE</winPkgType>
<installationMode>UI</installationMode>
<IsRestartReq>Yes</IsRestartReq>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
171
Mandatory attributes in Request
- installationMode
- supportedArchitecture
- executionCommandUnInstall
- installSuccessCriteria
o appName
o appVersion
o appIcon
Sample Response
<actionResponse>
<description>Application Successfully Added</description>
<status>Success</status>
</actionResponse>
Access Control
- Customer Properties: ENABLE_NEW_APPS, WIN_DESKTOP_DEVICES
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
172
Add Windows Store App
Request
POST /application-apis/winApps/2.0/addWinStoreApp/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Add a Windows Store app to MaaS360.
❖ The request should contain one part:
o Part 1: Name = app_details; Value = XML file for attributes other than the file
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
maas360Hosted
Optional
Default: Yes
appSourceURL
Required
Windows Store URL of app to be added
showInADP
Optional
Relevant only If App Discovery Portal is
enabled for the account.
Possible values:
0: Not Available
1: View only
2: View & Request
category
Optional
Additional categories to be assigned to app
other than the Store categories
appOwner
Optional
Email address of the owner of the app who
needs to be intimated.
Required if showInADP = 1 or 2.
appAttributes
Optional
Map of various app attributes
Sample Request
POST https://services.fiberlink.com/application-apis/winApps/2.0/addWinStoreApp/customer/1007263
Sample Request Value (Part 1)
<appDetails>
<maas360Hosted>Yes</maas360Hosted>
<appSourceURL>https://www.microsoft.com/en-in/store/p/ted/9wzdncrfj07f</appSourceURL>
<category>games</category>
<showInADP>2</showInADP>
<appOwner>maas360@fiberlink.com</appOwner>
<appAttributes>
<appAttribute>
<attributeName>name</attributeName>
<attributeValue>xyz</attributeValue>
</appAttribute>
<appAttribute>
<attributeName>Email</attributeName>
<attributeValue>abc@def.com</attributeValue>
</appAttribute>
</appAttributes>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
173
Sample Response (XML)
<actionResponse>
<status>Success</status>
<description>Application uploaded successfully.</description>
<appId>234567</appId>
<appVersion>1.1.23406.0</appVersion>
</actionResponse>
Mandatory attributes in Response
- status
- appId
Access Control
- Customer Properties: ENABLE_NEW_APPS, MANAGE_WINDOWS7_PHONE
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
174
Delete Windows Dependency
Request
DELETE /application-apis/winApps/2.0/deleteWindowsDependency/customer/<billingId>
Definition
❖ Delete Windows Dependency file (appx or appxbundle).
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
dependencyName
Required
Dependency name to be deleted
dependencyVersion
Required
Dependency version to be deleted
dependencyArchitecture
Required
Dependency architecture to be deleted
Sample Request
DELETE https://services.fiberlink.com/application-
apis/winApps/2.0/deleteWindowsDependency/customer/1007263
Sample Response
<actionResponse>
<status>Success</status>
<description>Dependency deleted successfully.</description>
</actionResponse
Mandatory attributes in Response
- status
Access Control
- Customer Properties: ENABLE_NEW_APPS, MANAGE_WINDOWS7_PHONE
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
175
Download Windows Dependency
Request
GET /application-apis/winApps/2.0/downloadWindowsDependency/customer/<billingId>
Definition
❖ Download Windows Dependency file (appx or appxbundle).
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
dependencyName
Required
Dependency name to be deleted
dependencyVersion
Required
Dependency version to be deleted
dependencyArchitecture
Required
Dependency architecture to be deleted
Sample Request
GET https://services.fiberlink.com/application-
apis/winApps/2.0/downloadWindowsDependency/customer/1007263
Access Control
- Customer Properties: ENABLE_NEW_APPS, MANAGE_WINDOWS7_PHONE
- Access Rights: Apps - Manage Apps
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
176
Get Category List
Request
GET /applications-api/applications/2.0/getCategoryList/customer/<billingId>
Definition
❖ Get the list of all the app categories for the given billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
POST https://services.fiberlink.com/application-
apis/applications/2.0/getCategoryList/customer/1007263
Sample Response (JSON)
{
"categories":
{
"category":["Administration","Administration Abc","Book","Books","Business","Casual"],
"count":6
}
}
Sample Response (XML)
<categories>
<category>Administration</category>
<category>Administration Abc</category>
<category>Book</category>
<category>Books</category>
<category>Business</category>
<category>Casual</category>
<count>6</count>
</categories>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
177
Mark App as Featured
Request
POST /applications-api/applications/2.0/markAppAsFeatured/customer/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Mark the app selected as featured in the catalog.
❖ The request should contain two parts:
o Part 1: Name = app_details; Value = XML file for attributes other than the upgrade file
o Part 2: Name = featuredImage; Value = Featured image file
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
appType
Required
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
appId
Required
Unique ID of the application being upgraded
secondaryApp
Optional
Default: No
appFullVersion
Optional
Required if secondaryApp = Yes
appVersion
Optional
Required if secondaryApp = Yes
featureSubtext
Required
Accepts string as the feature subtext
showAppAndFeaturedDescription
Optional
Possible values:
true
false (Default)
featuredBannerStyle
Optional
Possible values:
1: Basic
2: Detailed
Required if showAppAndFeaturedDescription =
true.
featuredFontColor
Required
Accepts HTML style hex string.
For example: #5d5d5d
Required if showAppAndFeaturedDescription =
true.
Sample Request
https://services.fiberlink.com/application-apis/applications/2.0/markAppAsFeatured/customer/1007263
Sample Request Value (Part 1)
<appDetails>
<appId>com.cdw.cdw</appId>
<appType>1</appType>
<secondaryApp>Yes</secondaryApp>
<appFullVersion>1.2.3</appFullVersion>
<appVersion>4.5.6</appVersion>
<featureSubtext>Sample sub text</featureSubtext>
<showAppAndFeaturedDescription>true</showAppAndFeaturedDescription>
<featuredBannerStyle>1</featuredBannerStyle>
<featuredFontColor>#2d9f4a</featuredFontColor>
</appDetails>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
178
Sample Response (XML)
<actionResponse>
<status>Success</status>
<description>App marked as featured.</description>
</actionResponse>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
179
Delete User Review and Update Rating
Request
DELETE /applications-api/applications/2.0/deleteReview/customer/<billingId>
Definition
❖ Deletes user review of an app and updates its average.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-
service is being executed
reviewId
Required
Review ID of the review to be deleted.
Sample Request
https://services.fiberlink.com/application-
apis/applications/2.0/deleteReview/customer/1007263?reviewId=1623
Sample Response
{
"actionResponse": {
"description": "Review with reviewId - 1623 has been deleted successfully.",
"status": "Success"
}
}
Possible Error Codes
Error Code
Description
200 OK
Success
204 No Content
400 Bad Request
The web-service request was invalid.
401 Unauthorized
Authentication for the web-service request
failed. Invalid credentials.
403 Forbidden
Web-service request is requesting a resource
that the server does not allow access to.
404 Not Found
The requested resource is not found.
500 Internal Server Error
An internal server error occurred while
processing the request.
502 Bad Gateway
MaaS360 Web-service server is not reachable.
503 Service Unavailable
The server is currently unable to handle the
request due to a temporary overloading or
maintenance of the server. The implication is
that this is a temporary condition which will
be alleviated after some delay.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
180
List Featured Apps and Bundles Info
Request
GET applications/2.0/getFeaturedAppsAndBundles/customer/<billingId>
Definition
❖ Lists featured apps and bundles info.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
https://services.fiberlink.com/application-
apis/applications/2.0/getFeaturedAppsAndBundles/customer/1007263
Sample Response
{
"featuredElements": {
"count": 2,
"featured": [
{
"appType": "IOS_ENTERPRISE_APP",
"displayBit": 8,
"elementName": "AppConfig",
"elementType": "APP",
"position": 9,
"showElement": false,
"appVersion": "1.0",
"bundleId": "com.fiberlink.AppConfig",
"bundleVersion": "1.0",
"featuredImageUrl": "https://iq2services.fiberlink.com/cdn-
content/softwares/10001589/1502279792435/46453134625496_4_test_rescaled/e7b007f648eea4fd364220
e18f1c52233119a840.jpeg",
"featuredName": "zAppConfig"
},
{
"displayBit": 8,
"elementName": "ZBundle",
"elementType": "BUNDLE",
"position": 10,
"showElement": false,
"featuredImageUrl": "https://iq2services.fiberlink.com/cdn-
content/softwares/10001589/1502280025723/46686440726446_7_test_rescaled/e7b007f648eea4fd364220
e18f1c52233119a840.jpeg",
"featuredName": "ZB1Text"
}
],
"pageNumber": 1,
"pageSize": 4
}
}
Possible Error Codes
Error Code
Description
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
181
200 OK
Success
204 No Content
400 Bad Request
The web-service request was invalid.
401 Unauthorized
Authentication for the web-service request
failed. Invalid credentials.
403 Forbidden
Web-service request is requesting a resource
that the server does not allow access to.
404 Not Found
The requested resource is not found.
500 Internal Server Error
An internal server error occurred while
processing the request.
502 Bad Gateway
MaaS360 Web-service server is not reachable.
503 Service Unavailable
The server is currently unable to handle the
request due to a temporary overloading or
maintenance of the server. The implication is
that this is a temporary condition which will
be alleviated after some delay.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
182
List Apps Bundles with their Apps Info
Request
GET applications/2.0/getAppBundlesWithApps/customer/<billingId>
Definition
❖ Lists app bundles with their apps info.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
https://services.fiberlink.com/application-
apis/applications/2.0/getAppBundlesWithApps/customer/1007263
Sample Response
{
"bundleDetails": {
"count": 2,
"bundles": [
{
"description": "ZB2Sub",
"featuredBannerStyle": 0,
"featuredImageUrl": "",
"iconURL": "https://iq2services.fiberlink.com/cdn-
content/softwares/10001589/1502280142904/46803777963306_8_test_rescaled/0406785c196625abebf6b1
494ebe94c38cf367bf.jpeg",
"name": "ZBundle2",
"showNmOnFeaturedImage": false,
"apps": [
{
"appVersion": "4.1",
"bundleId": "com.alligatorapps.aplusspellngtest",
"name": "A+ Spelling Test",
"type": "IOS_APPSTORE_APP"
},
{
"appVersion": "5.0.15",
"bundleId": "com.abcdigital.abc.videoplayer",
"bundleVersion": "5.0.15",
"name": "ABC â“ Watch Live TV & Stream Full Episodes",
"type": "IOS_APPSTORE_APP"
}
]
},
{
"description": "zzz",
"featuredBannerStyle": 0,
"featuredImageUrl": "https://iq2services.fiberlink.com/cdn-
content/softwares/10001589/1502280025723/46686440726446_7_test_rescaled/e7b007f648eea4fd364220
e18f1c52233119a840.jpeg",
"featuredName": "ZB1Text",
"featuredTextColor": "#ffffff",
"iconURL": "https://iq2services.fiberlink.com/cdn-
content/softwares/10001589/1502279976450/46637319323003_5_test_rescaled/0406785c196625abebf6b1
494ebe94c38cf367bf.jpeg",
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
183
"name": "ZBundle",
"showNmOnFeaturedImage": true,
"apps": [
{
"appVersion": "9.11.0",
"bundleId": "com.amazon.Amazon",
"bundleVersion": "9.11.0",
"name": "Amazon App: shop, scan, compare, and read reviews",
"type": "IOS_APPSTORE_APP"
},
{
"bundleId": "com.netflix.mediaclient",
"name": "Netflix",
"type": "ANDROID_APPSTORE_APP"
}
]
}
],
"pageNumber": 1,
"pageSize": 2
}
}
Possible Error Codes
Error Code
Description
200 OK
Success
204 No Content
400 Bad Request
The web-service request was invalid.
401 Unauthorized
Authentication for the web-service request
failed. Invalid credentials.
403 Forbidden
Web-service request is requesting a resource
that the server does not allow access to.
404 Not Found
The requested resource is not found.
500 Internal Server Error
An internal server error occurred while
processing the request.
502 Bad Gateway
MaaS360 Web-service server is not reachable.
503 Service Unavailable
The server is currently unable to handle the
request due to a temporary overloading or
maintenance of the server. The implication is
that this is a temporary condition which will
be alleviated after some delay.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
184
Fetch All the Reviews
Request
GET applications/2.0/getAllReviews/customer/<billingId>
Definition
❖ Fetches all the reviews.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-
service is being executed
Sample Request
https://services.fiberlink.com/application-apis/applications/2.0/getAllReviews/customer/1007263
Sample Response
{
"reviewDetails": {
"count": "1",
"pageSize": "50",
"pageNumber": "2",
"reviews": [
{
"reviewId": 5674565,
"rating": 3,
"lastName": "XYZ",
"firstName": "ABC",
"emailId": "joker.muddle@au1.ibm.com",
"review": "Nice app and works well... ",
"title": "Good One",
"reviewDate": "01/16/2015 01:19:06"
}
]
}
}
Possible Error Codes
Error Code
Description
200 OK
Success
204 No Content
400 Bad Request
The web-service request was invalid.
401 Unauthorized
Authentication for the web-service request
failed. Invalid credentials.
403 Forbidden
Web-service request is requesting a resource
that the server does not allow access to.
404 Not Found
The requested resource is not found.
500 Internal Server Error
An internal server error occurred while
processing the request.
502 Bad Gateway
MaaS360 Web-service server is not reachable.
503 Service Unavailable
The server is currently unable to handle the
request due to a temporary overloading or
maintenance of the server. The implication is
that this is a temporary condition which will
be alleviated after some delay.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
185
Application Publication Workflow (for use by App Ecosystem
Partners only)
Get the list of app events pending for review
Request
GET /application-
apis/appApproval/2.0/getAppsPendingReview/customer/<billingID>/vendor/<vendorOfferingId>?<timesta
mp>
Definition
❖ Get all app events pending for review or scan for a specific vendor ID.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
vendorOfferingId
Required
Unique id to represent the vendor offering. Created
during vendor on-boarding process.
vendorSharedKey
Required
Secret shared key, shared between vendor and Maas.
Created during vendor on-boarding process.
timestamp
Optional
epoch timestamp value. Fetches all app events that are
pending for scan between the timestamp and current
time.
Request Headers
vendorSharedKey: Required
Authorization: MaaS token="<Auth Token>"
Response header
lastTimestamp
Sample Request
GET https://services.fiberlink.com/application-
apis/appApproval/2.0/getAppsPendingReview/customer/1101234/vendor/xyz?timestamp=1512956711278
Request Header
vendorSharedKey: 98dce6eb-8b7d-4e9c-bfrb-89d565844ba5
Authorization: MaaS token="4c8c3dbb-0c9f-4845-ab09-da80289d41f5-DEInVIg"
Sample Response
{
"appsPendingReview": {
"appList": {
"actionKey": "test_script_14",
"guid": "1287ed0e-b6a8-4560-bd45-aa9f502e4aca",
"timestamp": 1518604374120
},
"count": 1
}
}
Response header
lastTimestamp: 1518604374120
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
186
Get details of each app that is pending for scan
Request
GET /application-
apis/appApproval/2.0/getAppDetailsForReview/customer/<billingID>/review/<reviewId>
Definition
❖ Get the details of each app that is pending for review or scan.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
reviewId
Required
Unique id that is assigned to each review step.
Request Headers
Authorization: MaaS token="<Auth Token>"
Sample Request
GET https://services.fiberlink.com/application-apis/appApproval/2.0/
getAppDetailsForReview/customer/1101234/review/f298521b-abd8-48eb-b073-aeab9aad1033
Request Headers
Authorization: MaaS token="4c8c3dbb-0c9f-4845-ab09-da80289d41f5-DEInVIg"
Sample Response
{
"appDetailsForReview": {
"reviewId": "1287ed0e-b6a8-4560-bd45-aa9f502e4aca",
"appBundleId": "com.mobilemotion.dubsmash",
"appName": "Dubsmash",
"category": "Entertainment",
"platform": "iOS",
"appVersion": "2.31.1",
"bundleVersion": "2.31.1",
"appSize": "",
"appIconURL": "http://is3.mzstatic.com/image/thumb/Purple128/v4/4d/9e/11/4d9e11df-5d06-2d10-
6038-ca9b0a60bc55/source/512x512bb.jpg",
"marketAppId": 918820076,
"region": "US",
"minimumOSVersion": 9,
"description": "Make fun lip sync videos with your favorite quotes.",
"supportedOn": 3,
"appAttributes": ""
}
}
Possible Values for "supportedOn"
• Smartphone
• Tablet
• Smartphone, tablet
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
187
Get binary of the app pending for review
Request
GET /application-apis/appApproval/2.0/getAppBinaryForReview/customer/<billingID>/review/<reviewId>
Definition
❖ Get all binary of the app pending for scan. It may or may not be required based on the origin of the
app, i.e. app store app or private app.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
reviewId
Required
Unique id that is assigned to each review step.
Request Headers
Authorization: MaaS token="<Auth Token>"
Response
Input stream of app binary
Response headers
Content-Disposition: attachment; filename=<file name>
checksum<SHA256 checksum>
fileSize <file size in MB>
Sample Request:
GET https://services.fiberlink.com/application-
apis/appApproval/2.0/getAppBinaryForReview/customer/1101234/review/f298521b-abd8-48eb-b073-
aeab9aad1033
Request Headers
Authorization: MaaS token="4c8c3dbb-0c9f-4845-ab09-da80289d41f5-DEInVIg"
Response
input stream of app binary
Response headers
Content-Disposition: attachment; filename="AroundMe 6.2.5.ipa"
checksum: 35a79e938990d5686ffa45da586a562618fdfa4af928b98d423156b4d6575ca9
fileSize: 7.771MB
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
188
Submit the app and results of the scan
Request
POST /application-
apis/appApproval/2.0/submitAppReviewResults/customer/<billingID>/review/<reviewId>
Definition
❖ Submit the app and results of scan from your integration to MaaS360 so that it can be displayed for
the MaaS360 App Administrator to take actions
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
reviewId
Required
Unique id that is assigned to each review step.
resultJson : result
Mandatory
Composed of pre-defined keys and custom keys.
Pre-defined keys:
Operationstatus, errcode, isresultappbinary
Custom keys:
Any
resultJson : result :
operationstatus
Mandatory
Indicates whether the vendor operation was
success/failure.
Possible values:
success, failure
resultJson : result : errcode
Mandatory
Indicates the errorcode from vendor in case of
operation failure. Use "nil" in case operation was
successful.
resultJson : result :
isbinaryupdated
Mandatory
App security vendors may use this to indicate that
the app has been injected with security wrappers
as necessary and resultant file is an app binary
that needs to replace original binary.
Possible values:
yes, no
App binary will be replaced automatically as soon
as App Administrator approves the result of the
app.
resultJson : result : key 1,
key 2, key 3….
Optional
Use your own key and values for results such as
the following. The key and values will be
displayed to the app reviewer in order to
approve/reject the app.
HIGH VULNERABILITIES = 3
RISK RATING = 75%
RATING = 8.0
resultJson: resultDataURLs:
URLs : URL 1, URL 2, URL
3….
Optional
These may be externally available URLs or URLs
within vendor portal. URLs will be displayed to
the app reviewer inorder from where results can
be viewed
resultJson : result :
resultfilechecksum
Mandatory if
resultJson : result :
isresultfileavailable
= yes
Specify SHA2 checksum of return document
containing results of a scan such as .doc, .pdf,
.xls, .xml, .htm file.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
189
resultFile
Optional,
Mandatory if
resultJson : result :
isresultfileavailable
= yes
Return document containing results of a scan such
as .doc, .pdf, .xls, .xml, .htm file.
Max file size: 2GB
resultJson : result :
updatedBinaryChecksum
Mandatory if
resultJson : result :
isbinaryupdated =
yes
Specify SHA2 checksum of return hardened or
wrapped app binary
updatedBinaryApp
Optional
Mandatory if
resultJson : result :
isbinaryupdated =
yes
Return hardened or wrapped app binary.
Max file size: 2GB
Request Headers
Authorization: MaaS token="<Auth Token>"
POST data
Part 1: resultJson: Required
Content-Type: multipart/form-data
Part 2: updatedBinaryApp: Optional - POST data can be multi part content that contains the actual result
file ‘resultFile’. Result data file can also be the updated app. Only one file resultDataFile can be posted
to MaaS360 workflow.
Content-Type: multipart/form-data
Part 3: resultFile: Optional
Content-Type: multipart/form-data
Sample Request
POST https://services.fiberlink.com/application-
apis/appApproval/2.0/submitAppReviewResults/customer/30074548/review/1a3e90d0-8aae-4a20-9e74-
3231d4c7b639
Request Headers
Authorization: MaaS token="4c8c3dbb-0c9f-4845-ab09-da80289d41f5-DEInVIg"
POST data
Part 1: resultJsonFile: Required
resultJson: { "result": { "isbinaryupdated": "yes", "isresultfileavailable": "yes", "errorcode": "nil",
"operationstatus": "success", resultSummary": {"key1": "value1", "key2": "value2", "key3": "value3" },
"resultDataURLs" : {"key1":"URL1", "key2":"URL2", "key3":"URL3", "key4":"URL4"},
"resultfilechecksum":"resultFileSha2Checksum", "updatedBinaryChecksum": "updateBinaryAppChecksum" } }
Content-Type: multipart/form-data
Part 2: updatedBinaryApp: Optional - POST data can be multi part content that contains the actual result
file ‘resultFile’. Result data file can also be the updated app. Only one file resultDataFile can be posted
to MaaS360 workflow.
Content-Type: multipart/form-data
Part 3: resultFile: Optional
Content-Type: multipart/form-data
Response
Success or Failure with the error message
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
190
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<actionResponse>
<description>Results uploaded successfully</description>
<status>Success</status>
</actionResponse>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
191
User
Search Users
Request
GET /user-apis/user/1.0/search/<billingID>
Definition
❖ Search for users by Username, Domain, Full Name, Email Address and Source
❖ Support for partial match for these attributes
❖ Get results on specified pages of the Result-set
Parameters
Parameter Name
Required /
Optional
Description
partialUserName
Optional
Partial or full Username string
domain
Optional
Full domain name string
partialUserName
Optional
Partial or full “UserName” string
partialFullUserName
Optional
Partial or full “Full UserName” string
partialEmailAddress
Optional
Partial or full Email Address
includeAllUsers
Optional
Possible values:
- 0: Include users with devices only (Default)
- 1: Include all users
source
Optional
Possible values:
- 0: Local Directory
- 1: User Directory
match
Optional
Possible values:
- 0: Indicates Partial match for Username, Full Name
and Email Address (Default)
- 1: Indicates Exact match
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
pageNumber
Optional
Results specific to a particular page. Default is first
page
billingID
Required
Billing ID of the account for which the web-service is
being executed
includeCustomAttributes
Optional
Possible values: 1, 0 (default)
authType
Optional
Possible values:
- 0: Local Directory
- 1: User Directory
usersUpdatedAfterInEpochms
Optional
Time in Unix epoch milliseconds, returns users updated
after this time
Sample Request
https://services.fiberlink.com/user-apis/user/1.0/search/1101234?
partialUserName=BBFL&partialFullUsername=ther&partialEmailAddress=therchek@example.com&include
AllUsers=0&match=0&pageSize=25&pageNumber=2
Sample Response
<users>
<count>1000</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<user>
<userIdentifier>B3A139685EF3719620211A7A99AD0E34</userIdentifier>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
192
<userName>abarnes</userName>
<emailAddress>abcd@example.com</emailAddress>
<domain>ExampleDomain</domain>
<status>Active</status>
<location>Bangalore</location>
<source>0</source>
<authType>0</authType>
<createDate>Sep 10, 2015 6:56:34 PM</createdDate>
<updateDate>Sep 12, 2016 3:56:34 AM</updateDate>
<groups>
<group>
<groupId>12345</groupId>
<name>Sales</name>
<groupDN>cn=Sales,DC=Acmecorp,DC=com<groupDN>##This has value
only for User Directory Groups
<group>
…
</groups>
<userCustomAttributes>
<customAttribute>
<customAttributeName>home</customAttributeName>
<customAttributeValue>msn.com</customAttributeValue>
<customAttribute>
</userCustomAttributes>
</user>
<user>
…
</user>
</users>
Mandatory attributes in Response
- userIdentifier
- userName
- domain
- emailAddress
- source
- status
- createDate
- updateDate
Access Control
- Customer Properties: Enable User Management workflows and Enable Web-Services
- Access Rights: Users - Read Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
193
Add Local User Account
Request
POST /user-apis/user/1.0/addUser/customer/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a Local user in MaaS360
❖ Support addition of Local accounts for customers with User Directory integration as well as MaaS360
Local Account
Parameters
Parameter Name
Required /
Optional
Description
customer
Required
Billing ID of the account for which the web-service is
being executed
fullname
Optional
userName
Required
domain
Required
email
Required
phoneNumberCountry
Optional
phoneNumber
Optional
location
Optional
Sample Request
POST https://services.fiberlink.com/user-
apis/user/1.0/addUser/customer/1007463?userName=abc&domain=example.com&email=abc@example.co
m
Sample Response
<response>
<status>1</status> ## 0:success; 1:error
<userIdentifier>4D0E6C29440C9FD0DF22D24E97741B3B</userIdentifier>
</response>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable User View for Customer
- Access Rights: User View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
194
Edit a Local User Account
Request
PUT /user-apis/user/1.0/editUser/customer/<billingID>/user/<user_identifier>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Edit a Local user in MaaS360. This is for customers with User Directory integration as well as MaaS360
Local Account
❖ Following parameters can be edited: Full Name, Domain, Email Address, Phone Number Country,
Phone Number and Location
❖ Note: User Directory User accounts cannot be edited. An error should be returned if a User Directory
account is edited
Parameters
Parameter Name
Required /
Optional
Description
customer
Required
Billing ID of the account for which the web-service is
being executed
user_identifier
Required
MaaS360 User ID for the user account which needs to be
edited
fullName
Optional
domain
Optional
email
Optional
phoneNumberCountry
Optional
phoneNumber
Optional
location
Optional
Sample Request
PUT https://services.fiberlink.com/user-apis/user/1.0/editUser/customer/1007463/user/
5D74F9BF45C98E1CFCD241D093D73383
Sample Response
<response>
<status>Success</status> ## In case of any failure in action, this is set to Failed and description
has failure reasons.
<description>User account uploaded successfully.</description>
</response>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable User View for Customer
- Access Rights: User View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
195
Add Groups to Local User Account
Request
PUT /user-apis/user/1.0/addGroups/customer/<billingID>/user/<user_identifier>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a Local or User Directory Group to a Local user account
Parameters
Parameter Name
Required /
Optional
Description
customer
Required
Billing ID of the account for which the web-service is
being executed
user_identifier
Required
User Identifier of the user for whom we are adding
groups
groupIds
Required
Comma separated list of multiple Group IDs to be added
Sample Request
PUT https://services.fiberlink.com/user-
apis/user/1.0/addGroups/customer/1007463/user/99950C69056BF0971FCA5807F752C53
Sample Response
<response>
<status>1</status> ## 1:success; 0:error
<description>Description, in case of success/error</description >
<userIdentifier>99950C69056BF0971FCA5807F752C53</userIdentifier>
</response>
Mandatory attributes in Response
- status
- userIdentifier
Access Control
- Customer Properties: Enable User View for Customer
- Access Rights: User View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
196
Remove Groups from Local User Account
Request
DELETE /user-apis/user/1.0/removeGroups/customer/<billingID>/user/<user_identifier>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Remove Local or User Directory Group from a Local user account
Parameters
Parameter Name
Required /
Optional
Description
customer
Required
Billing ID of the account for which the web-service is
being executed
user_identifier
Required
User Identifier of the user for which we are deleting
groups
groupIds
Required
Comma separated list of multiple Group IDs to be added
Sample Request
DELETE https://services.fiberlink.com/user-apis/user/1.0/removeGroups/customer/1007463/user/12345
Sample Response
<response>
<status>1</status> ## 1:success; 0:error
<description>Description, in case of success/error</description >
<userIdentifier>99950C69056BF0971FCA5807F752C53</userIdentifier>
</response>
Mandatory attributes in Response
- status
- userIdentifier
Access Control
- Customer Properties: Enable User View for Customer
- Access Rights: User View - Edit
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
197
Get AD Groups
Request
GET /user-apis/user/1.0/getADGroups/<billingID>
Definition
❖ Returns all the AD Groups applicable for the user
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
userName
Required
Username for which AD Groups information needs to be
retrieved
Sample Request
GET https://services.fiberlink.com/user-apis/user/1.0/getADGroups/1101234?userName=user1
Sample Response
<adGroups>
<adGroup>Administrators</adGroup>
<adGroup>Help Desk</adGroup>
….
</adGroups>
Mandatory attributes in Response
- adGroup
Access Control
- Customer Properties: Enable User View for Customer
- Access Rights: Device View - View Only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
198
Change Persona Policy
Request
POST /user-apis/user/1.0/billingID/<billingID>/user/<user>/changePolicy
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Assigns a Persona policy for the user
❖ This can be for a MaaS360 Local Account or User Directory account.
❖ Note: Assignments to User Groups will take precedence over individual user policy assignment.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed.
Needs to be specified only in URL
user
Required
Username for which Persona policy needs to be
changed
Needs to be specified only in URL
personaPolicy
Required
Name of the Persona policy assigned
domain
Optional;
Required if
user isn’t
unique
Domain of the user. For example, “example.com”
Sample Request
POST https://services.fiberlink.com/user-
apis/user/1.0/billingID/1101234/user/jsmith/changePolicy?personaPolicy=marketing&domain=example.c
om
Sample Response
<response>
<status>Success</status> ##In case of any failure, this is set to Failed & description has details of
the error
<description>Description comes here</description>
</response>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: Enable User Management (Beta)
- Access Rights: Manage Users
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
199
Set Custom Attribute Value for a User
Request
POST /user-apis/user/1.0/setCustomAttributes/<billingID>/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Sets the value for a specified custom attribute for a user record
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-
service is being executed
userName
Required
domain
Required
attributeName
Required
Name of the custom attribute for which value is
to be set
attributeDistinguisedName
Required
Distinguished name of the custom attribute for
which value is to be set
attributeValue
Required
Value to be set for the attribute
Sample Request
POST https://services.fiberlink.com/user-apis/user/1.0/setCustomAttributes/1101234
?userName=johndoe&domain=example.com&attributeName=test&attributeDistinguisedName=TEST&attri
buteValue=test/
Sample Response
<actionResponse>
<result>Success</result>
<description>Description, in case of success/error</description>
</actionResponse>
Mandatory attributes in Response
- result
Access Control
- Customer Properties: Enable User Management (Beta)
- Access Rights: Manage Users
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
200
Update User Certificate
Request
POST /user-apis/user/1.0/updateUserCert/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Deliver a new User Certificate to all enrolled devices of the user
Parameters
Parameter Name
Required /
Optional
Parameter Type
(Path/Query/Form)
Description
billingID
Required
Path
Billing ID of the account for which
the web-service is being executed
userName
Required
Query
domain
Required
Query
Sample Request
POST https://services.fiberlink.com/user-
apis/user/1.0/updateUserCert/1001234?userName=user01&domain=forest02.acmecorp.local
Sample Response
<actionResponse>
<actionStatus>1</actionStatus> ## 0:success; 1:error
<description>Description, in case of success/error</description >
</actionResponse>
Mandatory attributes in Response
- actionStatus
Access Control
- Customer Properties: Enable User Management (Beta)
- Access Rights: Manage Users
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
201
Get User Custom Attributes
Request
GET /user-apis/user/1.0/userAttributes/<billingID>
Definition
❖ Returns all user custom attributes defined for the account
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
GET https://services.fiberlink.com/user-apis/user/1.0/userAttributes/1101234
Sample Response
<userAttributes>
<userAttribute>
<displayName>SecureAttribute</displayName>
<distinguishedName>SECUREATTRIBUTE</distinguishedName>
<path>securefield1</path>
</userAttribute>
<userAttribute>
<displayName>TextAttribute</displayName>
<distinguishedName>TEXTATTRIBUTE</distinguishedName>
<path>string1</path>
</userAttribute>
</userAttributes>
Access Control
- Customer Properties: Enable User Custom Attributes
- Access Rights: View Custom Attributes
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
202
Delete User
Request
DELETE /user-apis/user/2.0/users/customer/<billingID>/user/<useridentifier>
Definition
❖ Queue user for deletion.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
userIdentifier
Required
User identifier for user deletion.
Sample Request
GET https://services.fiberlink.com/user-apis/user/1.0/userAttributes/1101234
Sample Response
<userAttributes>
<userAttribute>
<displayName>SecureAttribute</displayName>
<distinguishedName>SECUREATTRIBUTE</distinguishedName>
<path>securefield1</path>
</userAttribute>
<userAttribute>
<displayName>TextAttribute</displayName>
<distinguishedName>TEXTATTRIBUTE</distinguishedName>
<path>string1</path>
</userAttribute>
</userAttributes>
Access Control
- Customer Properties: ENABLE_WEB_SERVICES
- Access Rights: User Views - Add User and Device
HTTP Status Codes
HTTP
Status
code
Scenario
Error code
Meaning
202
User successfully
queued for deletion.
0
User has been queued for permanent
deletion.
500
Internal server error
1
User could not be queued for permanent
deletion. Please try again later or
contact support if problem persists.
400
userIdentifier is
null/empty/invalid
2
Invalid user identifier.
403
Admin does not
have access to given
user
3
Admin does not have access to given
user.
400
Education user
4
This user is being managed via Apple
School Manager and cannot be deleted.
400
User has/had CE
device
5
User cannot be deleted. User has or had
Cloud Extender devices mapped to
his/her name.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
203
400
User has active
device or apps/doc
distribution
6
The user cannot be deleted because this
user has active devices or a distribution
of an app or doc has been made
specifically to a device belonging to the
user. Mark the devices as inactive or
remove the individual device distribution
and try again.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
204
Delete User Status
Request
GET /user-apis/user/2.0/deleteUserStatus/customer/<billingID>/user/<useridentifier>
Definition
❖ Know the status of the user that was in the queue deletion.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
userIdentifier
Required
User identifier for user deletion.
Access Control
- Customer Properties: ENABLE_WEB_SERVICES
- Access Rights: User Views - Add User and Device
HTTP Status Codes
HTTP Status
code
Scenario
Error code
Meaning
200
User is in queue
0
User has been queued for permanent
deletion.
200
User is in queue
1
User deletion is started.
200
User is in queue
2
Device deletion is started.
200
User is in queue
3
User deletion is in progress.
200
User deletion failed
4
User deletion failed.
200
User deletion
completed
5
User deleted successfully.
400
userIdentifier is
Invalid
6
Empty User Identifier.
403
Admin does not
have access to
given user
7
Admin does not have access to given
user.
400
User Does not Exist
/ Deleted
8
Provided user does not exist. If user
identifier is correct, then user is
deleted.
500
userIdentifier is
empty
• If user is deleted, we cannot find user identifier and user id relation. If the user is deleted, we will
see that the user does not exist.
• In scenarios, where the user is deleted successfully, we cannot find the user or the mapping of the
user identifier and user id.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
205
Administrator
Create Administrator
Request
POST /account-provisioning/administrator/1.0/createAdministrator/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Creates a new Administrator account using the specified role
❖ Password is auto-generated by MaaS360 and emailed to the specific administrator email address
❖ The Administrator maybe prompted to change the temporary password or setup their profile
❖ This API is available both for Customer and Partner administrator account.
Parameters
Parameter Name
Required /
Optional
Description
customerBillingID
Required
Billing ID of the account for which the web-service is
being executed
adminUsername
Required
Username of the Administrator account to be created
adminEmailAddress
Required
Email Address of the Administrator account
roles
Required
Comma separated list of role(s) of the Administrator
account
firstName
Optional
First Name of the Administrator
lastName
Optional
Last Name of the Administrator
countryCodePhoneNumber
Optional
Country Code for the Phone Number of the
Administrator
phoneNumber
Optional
Phone Number of the Administrator
requestPassword
Optional
Possible Options:
1 – Show password
0 (Default) – Don't show
forceResetTempPassword
Optional
Possible Options:
0 (Default) – User does not need to change the
password on first time login
1 – User is forced to change the password on first time
login
allowPortalLogin
Optional
Possible Options:
0 – Admin account cannot be used to log into portal.
This is for webservice only
1 – Admin account can be used for both portal login &
webservice (Default)
Sample Request
POST https://services.fiberlink.com/account-
provisioning/administrator/1.0/createAdministrator/1101234?customerBillingID=1101234&adminUsernam
e=abc&adminEmailAddress=abc@example.com&roles=Help Desk
Sample Response
<administrator>
<adminUsername>admin_acmecorp</adminUsername>
<customerBillingId>1009001</customerBillingId>
<errorCode>ERROR_1001</errorCode>
<errorMessage>Username already exists</errorMessage>
<status>0</status> ##0:Failure, 1: Success
</administrator>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
206
Mandatory attributes in Response
- customerBillingId
- adminUsername
- status
Access Control
- Customer Properties: -
- Access Rights: Manage Administrators
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
207
Check Administrator Account Availability
Request
GET /account-provisioning/account/1.0/ checkAdminAccountAvailability/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Check if the administrator username is available before creating an administrator account for a
customer or partner account
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
❖ This account name is globally validated across all partners and customers accounts.
Parameters
Parameter Name
Required /
Optional
Description
adminUsername
Required
Administrator Username
Sample Request
POST https://services.fiberlink.com/account-provisioning/account/1.0/
checkAdminAccountAvailability/1101234?adminUsername=2001234_admin
Sample Response
<administrator>
<adminUsername>2001234_admin</adminUsername>
<errorCode>ERROR_1001</errorCode>
<errorMessage>Username already exists</errorMessage>
<available>0</available>## 1- Yes (User name is available for addition), 0- No (Username is
already taken)
</administrator>
Mandatory attributes in Response
- available
- adminUsername
Access Control
- Customer Properties: Enable Webservice
- Access Rights: All rights related to Onboarding
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
208
Account
Provision New Customer Account
Request
POST /account-provisioning/account/1.0/createCustomerAccount/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Create customer account for Partner and configure all account setup information. For the primary
administrator account created, change temporary password and set profile steps are skipped. Also,
the administrator is assigned all roles copied from Parent account.
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Billing ID specified as a parameter is the Parent of the customer account and will be to be a part of
partner hierarchy (directly or indirectly) of the account whose credentials is specified for
authentication
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the Partner account for which the customer
account should be created
accountType
Required
Possible values: Trial (Default), Customer
accountName
Required
Display name for the Account
service
Optional
Possible values: MDM, SPS, MAM. If no value is
specified, MDM is assumed
adminEmailAddress
Required
Email Address of the primary administrator for the
account
country
Optional
Country name or country code where the customer
account is located. For example: India or IN
externalAccountID
Optional
ID used by partner to identify partner’s customer. Limit
255 characters.
password
Optional
If specified, this will be set for the Administrator
account. Else, an autogenerated password will be set
defaultLanguage
Optional
Default Language set for the account. Default = English
• en or English
• de or Deutsch
• es or Spanish
• fr or French
• it or Italiano
• ja or Japanese
• zh-TW or Chinese Taiwan
• zh-CN or Simplified Chinese
• ko or Korean
• pt or Portuguese
• nl or Dutch
• ru or Russian
• cs or Czech
• pl or Polish
• no or Norwegian
These input values are case sensitive.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
209
Parameter Name
Required /
Optional
Description
forceAdminAcceptEULA
Optional
Account Name for the account to be provisioned.
Default = No
sendWelcomeEmail
Optional
Whether to send Welcome Email from MaaS360 or not.
Default = Yes
allowPortalLogin
Optional
Possible Options:
0 – Admin account cannot be used to log into portal.
This is for webservice only
1 – Admin account can be used for both portal login &
webservice (Default)
committedLicenses
Optional
Ignored if Account Type = Trial
customerVertical
Optional
Customer Vertical for which the account information is
provided. Possible values:
• CONSUMER
• EDUCATION
• FINANCIAL_SERVICES
• HEALTHCARE
• MANUFACTURING
• PUBLIC_SECTOR
• PROFESSIONAL_SERVICES
• OTHERS
Sample Request
POST https://services.fiberlink.com/account-provisioning
/account/1.0/createCustomerAccount/1101234?accountType=Customer&accountName=Demo
Customer1&adminEmailAddres=abc@example.com
Sample Response
<account>
<billingId>1101234</billingId>
<accountName>Demo Customer1</accountName>
<partnerBillingId>2001234</partnerBillingId>
<adminUserName>2001234_admin</adminUserName>
<adminPassword>a1b2c3d4</adminPassword> ## Only when autogenerated
<loginUrl>https://portal.fiberlink.com/</loginUrl>
</account>
Mandatory attributes in Response
- billingId
- accountName
- partnerBillingId
- adminUserName
- loginURL
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Onboard Customer
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
210
Check Account Name Availability
Request
POST /account-provisioning/account/1.0/ checkAccountNameAvailability/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Check if Account name is available before creating an account for a customer under the Partner
hierarchy
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
❖ This account name is globally validated across all partner and customer accounts in MaaS360.
Parameters
Parameter Name
Required /
Optional
Description
accountName
Required
Account Name
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/checkAccountNameAvailability/1101234?accountName=ExampleCo
Sample Response
<account>
<accountName>ExampleCo</accountName>
<available>0</available>## 1- Yes (Accout name is available for addition), 0- No (Account Name
is already taken)
<errorCode>1001</errorCode>
<errorMessage>Exception …</errorMessage>
</account>
Mandatory attributes in Response
- available
- accountName
Access Control
- Customer Properties: Enable Provision New Customer & Enable Provision New Partner
- Access Rights: Onboard Customer or Onboard Partner
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
211
Convert Trial into Customer Account
Request
POST /account-provisioning/account/1.0/convertToCustomer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Convert a trial account into customer account.
❖ Applies only for trial accounts
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
❖ Trial account Billing ID specified should be in the partner hierarchy (directly or indirectly) of the
account whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
customerBillingId
Required
Billing ID of the trial account which needs to be
converted into customer account
committedLicenses
Optional
This is integer field and will be null by default
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/convertToCustomer/1101234?customerBillingId=1101237
Sample Response
<account>
<billingId>1101237</billingId>
<status>0</status> ## 1:success; 0:error
<errorCode>1001</errorCode>
<errorMessage>Exception …</errorMessage>
</account>
Mandatory attributes in Response
- billingId
- status
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Convert Customer
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
212
Expire an Account
Request
POST /account-provisioning/account/1.0/expireAccount/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Expires an existing trial account or active customer account. Sets the status of account to “expired”.
❖ Only active customer account or a trial account can be expired. Partner account cannot be expired.
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
❖ Customer account Billing ID specified should be in the partner hierarchy (directly or indirectly) of the
account whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
customerBillingId
Required
Billing ID of customer or trial account to be expired.
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/expireAccount/1101234?customerBillingId=1101235
Sample Response
<account>
<billingId>1101234</billingId>
<status>0</status> ## 1:success; 0:error
<errorCode>1001</errorCode>
<errorMessage>Exception …</errorMessage>
</account>
Mandatory attributes in Response
- billingId
- status
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Expire Customer
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
213
Extend Trial Account
Request
POST /account-provisioning/account/1.0/extendAccount/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Support for extending a trial account or an expired account.
❖ Only trial and expired accounts can be specified.
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
❖ Customer account Billing ID specified is in the partner hierarchy (directly or indirectly) of the account
whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
customerBillingId
Required
Billing ID of trial account for which trial period is to be
extended.
days
Optional
• This is integer field and would indicate number of
days trial gets extended by. This is additive to
existing period.
• Possible values: Any positive value less than 90
days.
• Default behavior would be to extend by partner
account default trial period.
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/extendAccount/1101234?customerBillingId=1101235
Sample Response
<account>
<billingId>1101234</billingId>
<status>0</status> ## 1:success; 0:error
<errorCode>1001</errorCode>
<errorMessage>Exception …</errorMessage>
</account>
Mandatory attributes in Response
- billingId
- status
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Extend Trials
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
214
Get Customer Accounts
Request
POST /account-provisioning/account/1.0/searchCustomers/<partnerBillingId>
Definition
❖ Returns all customer and partner accounts directly under a Partner Billing account. Note: Only
customer accounts directly under this account is listed
❖ This API is available only for Partner administrator account.
❖ Return Access Denied error if web-service is executed for a customer Account
❖ Results are sorted by descending order of “Created On”
Parameters
Parameter Name
Required /
Optional
Description
partnerBillingId
Required
Billing ID of a partner for which the customer account
list is to be retrieved.
childPartnerBillingID
Optional
Billing ID of the child partner (for which this api should
be executed) under the Parent Partner
(partnerBillingId).
If this param is not provided, partnerBillingId will be
considered for executing this api.
partialAccountName
Optional
Partial (Starts with) or full Customer Account Name
string to be searched for
externalAccountID
Optional
Account ID for the customer in Partner’s Billing system.
Used for mapping accounts from Partner’s system to
MaaS360.
accountStatus
Optional
Possible values:
- Trial
- Customer
- Expired
By default, all accounts are returned
pageSize
Optional
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular page. Default is first
page
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/searchCustomers/1101234?accountStatus=Trial
Sample Response
<accounts>
<count>924</count>
<pageSize>50</pageSize>
<pageNumber>2</pageNumber>
<account>
<billingID>1101234</billingID>
<accountType>PARTNER</accountType> ## or CUSTOMER
<customerName>Example Corp</customerName>
<accountStatus>Trial</accountStatus> ## Trial, Customer, Expired
<creationBy>Registration Process<creationBy>
<creationDate>2012-01-19<creationDate>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
215
<trialDuration>60</trialDuration> ## of days for trial accounts, null in case of customers
<trialExpiryDate>YYYY-MM-DD</trialExpiryDate> ## date when this account expires in
case of trial, null in case of customer
<customerConversionDate>YYYY-MM-DD</customerConversionDate> ## date when this
account got converted to a customer account, in case of customer; null, otherwise
<committedLicenseCount>100</committedLicenseCount> ## -1 for null & otherwise
integer value
<service>MDM</service>
<primaryAdminEmail>admin@example.com</primaryAdminEmail>
<defaultLanguage>English</defaultLanguage>
<externalAccountID>A1B2C3</externalAccountID>
<corporateId>ExampleCo</corporateId>
</account>
</accounts>
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Onboard Partners
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
216
Get Customer Account Configuration
Request
POST /account-provisioning/account/1.0/getCustomerConfig/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Return account details for an existing customer or trial account
❖ This API is available both for Customer and Partner administrator account.
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required /
Optional
Description
customerBillingId
Required
Billing ID of customer for which the account
information is to be retrieved.
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/getCustomerConfig/1101234?customerBillingId=1101235
Sample Response
<account>
<billingId>1101234</billingId>
<country>India</country>
<customerName>Example Corp</customerName>
<accountStatus>Trial</accountStatus> ## Trial, Customer, Expired
<committedLicenseCount>100</committedLicenseCount> ## -1 for null & otherwise integer value
<trialDuration>60</trialDuration> ## of days for trial accounts, null in case of customers
<trialExpiryDate>YYYY-MM-DD</trialExpiryDate> ## date when this account expires in case of
trial, null in case of customer
<primaryAdminEmail>admin@example.com</primaryAdminEmail>
<primaryAdmin>jsmith</primaryAdmin>
<defaultLanguage>English</defaultLanguage>
<externalAccountID>naus100101extid</externalAccountID>
<creationDate>2012-01-19<creationDate>
<adminEULASetting>0</adminEULASetting> ## One of the four possible values (0-Don’t prompt,
1-Force only the first login to accept EULA, 2-Force all admins to accept EULA on first time login, 3-Force
all admins to accept changes to EULA)
<endUserReacceptEULAEnabled>Yes/No</endUserReacceptEULAEnabled> #1-Yes, 0 -No
<endUserReacceptEULAReminderDuration>7</endUserReacceptEULAReminderDuration> #days
<endUserReacceptEULADelayAfterReminder>7</endUserReacceptEULADelayAfterReminder>
#days
<endUserReacceptEULAAction>0</endUserReacceptEULAAction> ## one of three actions (0- Do
nothing, 1- Selectively Wipe, 2- Remove Control, 3 – Alert User)
<allocatedSpace>50</allocatedSpace> ## Space in MBs
<usedSpace>10.56</usedSpace> ##Space in MBs
<errorCode>1001</errorCode>
<errorMessage>Exception details</errorMessage>
</account>
Mandatory attributes in Response
- billingId
- accountStatus
Access Control
- Customer Properties: Enable Provision New Customer
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
217
- Access Rights: Onboard Customers
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
218
Set Customer Account Configuration
Request
POST /account-provisioning/account/1.0/setCustomerConfig/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Configure customer account settings
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required / Optional
Description
customerBillingId
Required
Billing ID of customer for which the account
information is provided
externalAccountID
Optional
ID of a partner’s customer, unique only in the
partner’s scope
committedLicenseCount
Required
Committed number of licenses for this
customer id
adminEULASettings
Required
One of the following 4 values
0-Don’t prompt
1-Force only the first login to accept EULA
2-Force all admins to accept EULA on first
time login
3-Force all admins to accept changes to EULA
endUserReacceptEULAEnabl
ed
Required
• This customer account has enforced end
users to re-accept EULA when the
applicable EULA changes
• Possible values (Yes/No)
endUserReacceptEULARemi
nderDuration
Required if
endUserReacceptEULAEna
bled is set to “Yes”
• This field indicates the duration after
which end user would get a reminder to
re-accept EULA in case he/she hasn’t
done so yet.
• Possible Value:2,7,15,30 Days
endUserReacceptEULADelay
AfterReminder
Required if
endUserReacceptEULAEna
bled is set to “Yes”
• If the user doesn’t re-accept the EULA
even after the reminder, this field
indicates the delay after the reminder
for marking the user out of EULA
compliance and take specified action on
all devices belonging to this user.
• Possible Value: 2,7,15,30
endUserReacceptEULAActio
n
Required if
endUserReacceptEULAEna
bled is set to “Yes”
• This field indicates the action to be
taken on all devices belonging to user in
case the user has not accepted EULA
• Possible values
o 0 - Do Nothing
o 1 - Selective Wipe
o 2- Remove Control
country
Optional
Country name or country code where the
customer account is located. For example:
India or IN
allocatedSpace
Optional
• Values are in MBs
• Possible values:
o 10
o 50
o 100
o 500
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
219
Parameter Name
Required / Optional
Description
o 1000
o 5000
o 10000
o 25000
o 50000
o 100000
defaultLanguage
Optional
ISO language code: cs, de, en, es, fr, it, ja,
ko, nl, pl, pt, ru, zh-CN, zh-TW
customerVertical
Optional
Customer Vertical for which the account
information is provided. Possible values:
• CONSUMER
• EDUCATION
• FINANCIAL_SERVICES
• HEALTHCARE
• MANUFACTURING
• PUBLIC_SECTOR
• PROFESSIONAL_SERVICES
• OTHERS
Sample Request
POST https://services.fiberlink.com/account-provisioning/account/1.0/setCustomerConfig/1101234
?customerBillingId=1101235?committedLicenseCount=1&adminEULASettings=0&endUserReacceptEULAEna
bled=No
Sample Response
<account>
<billingId>1101234</billingId>
<status>0</status> ## 1:success; 0:error
<description>Details of customer updated successfully</description>
<errorCode>1001</errorCode>
<errorMessage>Exception details</errorMessage>
</account>
Mandatory attributes in Response
- billingId
- status
Access Control
- Customer Properties: Enable Provision New Customer
- Access Rights: Onboard Customers
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
220
Sign Apple MDM CSR request
Request
POST /provisioning-apis/provisioning/1.0/getSignedCSR/<billingId>
Content Type Header: multipart/form-data
Definition
❖ Takes an unsigned CSR as input and return a signed CSR that can be used to generate Apple
Certificate.
❖ Apple restrictions for generating the unsigned CSR apply - The CSR should be generated on the user’s
device who is trying to enroll for MDM
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
unsignedCSR
Required
multipart/form-data
Sample Request
POST https://services.fiberlink.com/provisioning-apis/provisioning/1.0/getSignedCSR/1101234
The request should contains 1 part
- Part: Name = unsignedCSR; Value = Unsigned CSR
Sample Response
Byte array of signed CSR
Mandatory attributes in Response
- signedCSR
Access Control
- Customer Properties: -
- Access Rights: Service Configuration
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
221
Upload Apple MDM Certificate
Request
POST /provisioning-apis/provisioning/1.0/uploadAppleMDMCert/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Upload Apple MDM Certificate and Password. The Certificate will be uploaded as a file
❖ Validate the Certificate before saving this.
❖ If an existing Apple MDM Certificate exists, then this overrides the existing content
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the Customer account for which the Apple
MDM Certificate is to be uploaded
Sample Request
POST https://services.fiberlink.com/provisioning-apis/provisioning/1.0/uploadAppleMDMCert/1101234
The request should contain 2 parts
- Part1: Name = appleMDMCertFile; Value = App MDM Certificate file
- Part2: Name = certPassword; Value = password
Sample Response
<actionResponse>
<status>Success</status>
<description>Apple MDM Certificate has been uploaded successfully</description>
<certExpiryDate>2010-11-30T05:52:53.011+00:00</certExpiryDate>
<certTopic>com.apple.mgmt.External.711f921c-84ef-4a27-a930-e19884dad4bf</certTopic>
</actionResponse>
Mandatory attributes in Response
- status
- certTopic
- certExpiryDate
Access Control
- Customer Properties: -
- Access Rights: Services Configuration
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
222
Get Device Enrollment Settings
Request
GET /provisioning-apis/provisioning/1.0/getDeviceEnrollSettings/<billingID>
Definition
❖ Return the following Device Enrollment Settings
o Corporate Identifier
o User Authentication Mode
o Device Platforms allowed to Enroll
o Prompt user to accept usage policy
o Corporate Support information
o Alert administrator on device enrollment
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
Sample Request
https://services.fiberlink.com/provisioning-apis/provisioning/1.0/getDeviceEnrollSettings/1007463
Sample Response
<enrollSettings>
<corporateID>EXAMPLECO</corporateID>
<userAuthenticationMode>0</userAuthenticationMode>
<adEnrollURL>https://m.dm/EXAMPLECO</adEnrollURL>
<defaultDomain>acme</defaultDomain>
<allowedDevicePlatforms>iPhone,iPad</allowedDevicePlatforms>
<promptUsagePolicy>Yes</promptUsagePolicy>
<usagePolicyURL>http://services.fiberlink.com/usagePolicy/1009081</usagePolicyURL>
<corpSupportEmail>support@example.com</corpSupportEmail>
<corpSupportPhone>1-800-123-1234</corpSupportPhone>
<alertAdmin>Yes</alertAdmin>
<deviceTypesAlert>1</deviceTypesAlert>
<alertEmailAddresses>admin@example.com</alertEmailAddresses>
</enrollSettings>
Mandatory attributes in Response
- corporateID
- userAuthenticationMode
Access Control
- Customer Properties: -
- Access Rights: Service Configuration
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
223
Configure Device Enrollment Settings
Request
POST /provisioning-apis/provisioning/1.0/configureDeviceEnrollSettings/<billingID>
Content Type Header: multipart/form-data
Definition
❖ Configure the following Device Enrollment Settings
o Corporate Identifier
o User Authentication Mode
o Device Platforms allowed to Enroll
o Prompt user to accept usage policy
o Corporate Support information
o Alert administrator on device enrollment
❖ If any setting below is not mentioned, then the value for this setting will be cleared. To retain the
old value, the setting will need to be specified again with the old value.
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the account for which the web-service is
being executed
corporateID
Optional
Corporate Identifier for the account
userAuthenticationMode
Optional
Possible values:
0: Passcode
1: Corporate Active Directory
2: Two factor authentication
3: SAML
4: MaaS360 Local Account
defaultDomain
Optional
Relevant only if userAuthenticationMode = 2 or 3
allowedDevicePlatforms
Optional
Comma separated list of values
Possible values:
iPhone
iPad
iPod
Android
OS X
BlackBerry
Windows Phone
promptUsagePolicy
Optional
Possible values: Yes, No
usagePolicy
Optional
Required if promptUsagePolicy = Yes. This file is the
file that is uploaded.
corpSupportEmail
Optional
corpSupportPhone
Optional
alertAdmin
Optional
Possible values: Yes, No
deviceTypesAlert
Optional
Possible values:
0: All Devices
1: Smartphones & Tablets only
2: Laptops & Desktops only
alertEmailAddresses
Optional
If alertAdmin = Yes, then at least 1 value is required.
Sample Request
POST https://services.fiberlink.com/provisioning-
apis/provisioning/1.0/configureDeviceEnrollSettings/1101234
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
224
The request should contain 2 parts
- Part1: Name = config_enroll_settings; Value = XML file for attributes other than Usage Policy file
Format for the XML is as follows:
<Customer>
<corporateID>him53</corporateID>
<userAuthenticationMode>1</userAuthenticationMode>
<defaultDomain>testADDomain</defaultDomain>
<allowedDevicePlatforms>iphone,iPad,iPod,Android</allowedDevicePlatforms>
<corpSupportEmail>support@example.com</corpSupportEmail>
<corpSupportPhone>123456</corpSupportPhone>
<promptUsagePolicy>Yes</promptUsagePolicy>
<alertAdmin>Yes</alertAdmin>
<deviceTypesAlert>1</deviceTypesAlert>
<alertEmailAddresses>admin@example.com</alertEmailAddresses>
</Customer>
- Part2: Name = usagePolicy; Value = usage policy file
Sample Response
<actionResponse>
<status>Success</status>
<description>Device Enrollment Settings configured successfully. </description>
</actionResponse>
Mandatory attributes in Response
- status
Access Control
- Customer Properties: -
- Access Rights: Services Configuration
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
225
Provision New Partner Account
Request
POST /account-provisioning/account/1.0/createPartnerAccount/<billingID>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Create a new Partner account and configure all account setup information. For the primary
administrator account created, change temporary password and set profile steps are skipped.
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Billing ID specified as a parameter is the Parent Partner account and will be to be a part of partner
hierarchy (directly or indirectly) of the account whose credentials is specified for authentication
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the Partner account under which the new
Partner account should be created
uniquePartnerNameInMaaS360
Required
Unique Partner Name used within MaaS360
partnerDisplayName
Required
Partner Name used for branding purposes in the portal
partnerCode
Required
Unique 4 to 8 characters long (alphanumeric) code to
identify the partner in the Service Registration URL.
templateAccountID
Optional
Billing ID of the template Account. If left blank, use
the Parent Account as the template Account. Also, if
specified, then check that the specified Template
Account is in the scope of provided credentials
adminEmailAddress
Required
Email Address of the primary administrator for the
account
country
Optional
Country name or country code where the customer
account is located. For example: India or IN
password
Optional
If specified, this will be set for the Administrator
account. Else, an autogenerated password will be set
allowPortalLogin
Optional
Possible Options:
0 – Admin account cannot be used to log into portal.
This is for webservice only
1 – Admin account can be used for both portal login &
webservice (Default)
multipleAccountEmailDomains
Optional
Comma separated list of email domains for which
multiple customer accounts can be created. In this
case, the account name instead of email address, will
be <<BillingID>>_Email Prefix.
leadNotificationEmailAddress
Required
Email address to which new customer account creation
notification emails should be sent
sendWelcomeEmail
Optional
Whether to send Welcome Email from MaaS360 or not.
Default = Yes
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/createPartnerAccount/1101234?uniquePartnerNameInMaaS360=Demo
Customer1&partnerDisplayName=DemoCustomer1&partnerCode=demozone&adminEmailAddress=abc@exa
mple.com&leadNotificationEmailAddress=abc@example.com
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
226
Sample Response
<account>
<billingID>2001234</billingID>
<accountName>Demo Customer1</accountName>
<parentBillingID>1101234</parentBillingID>
<adminUsername>2001234_admin</adminUsername>
<adminPassword>a1b2c3d4</adminPassword> ## Only when autogenerated
<trialRegistrationURL>
https://portal.fiberlink.com/tryMDM/SK_TELK_MDM_C</trialRegistrationURL>
</account>
Mandatory attributes in Response
- billingID
- accountName
- parentBillingID
- adminUsername
- trialRegistrationURL
Access Control
- Customer Properties: Enable Partner Onboarding
- Access Rights: Onboard Partner
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
227
Get Partner Account Configuration
Request
POST /account-provisioning/account/1.0/getPartnerAccountConfig/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Return account details for a partner account
❖ End User EULA Settings will be returned in response only if the endUserReacceptEULAEnabled is set to
“Yes”
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required /
Optional
Description
parnterBillingId
Required
Billing ID of partner for which the account information
is expected.
country
Optional
Get the country code for the partner account. For
example: India or IN
See page 143 for a list of country codes.
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/getPartnerAccountConfig/1101234?partnerBillingId=1101234
Sample Response
<account>
<country>US</country><partnerBillingId>1101234</partnerBillingId>
<partnerUniqueName>ExampleCo Master Account</partnerUniqueName>
<partnerDispalyName> ExampleCo Master Account</partnerDispalyName>
<partnerCode>SK</partnerCode>
<primaryAdminEmail>admin@example.com</primaryAdminEmail>
<primaryAdmin>admin_master</primaryAdmin>
<trialURL>https://portal.fiberlink.com/tryMDM/SK_CCAS_MDM_C</trialURL>
<leadNotificationEmail>abc@fiberlink.com<l/eadNotificationEmail>
<trialDuration>60</trialDuration> ## of days for trial accounts, null in case of customers
<specialDomains>abc.com, pqr.com</specialDomains> ## comma separated domains
<adminEULASetting>0</adminEULASetting> ## One of the four possible values (0-Don’t prompt,
1-Force only the first login to accept EULA, 2-Force all admins to accept EULA on first time login, 3-Force
all admins to accept changes to EULA)
<endUserReacceptEULAEnabled>Yes/No</endUserReacceptEULAEnabled>
<endUserReacceptEULAReminderDuration>7</endUserReacceptEULAReminderDuration> #days
<endUserReacceptEULADelayAfterReminder>7</endUserReacceptEULADelayAfterReminder>
#days
<endUserReacceptEULAAction>0</endUserReacceptEULAAction> ## one of three actions (0- Do
nothing, 1- Selectively Wipe, 2- Remove Control, 3 – Alert user)
<errorCode>1001</errorCode>
<errorMessage>Exception details</errorMessage>
</account>
Mandatory attributes in Response
- partnerBillingId
Access Control
- Customer Properties: Enable Provision New Partner
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
228
- Access Rights: All rights related to Onboarding
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
229
Set Partner Account Configuration
Request
POST /account-provisioning/account/1.0/setPartnerAccountConfig/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Configure partner account settings
❖ Credentials specified for authentication should be for a Partner account.
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required / Optional
Description
partnerBillingId
Required
Billing ID of partner for which the account
information is provided
specialDomain
Optional
Comma Separated values of domains. Only
applicable to partners
leadNotificationEmail
Required
Emails for notifying if new customers/trial
sign up under the partner hierarchy
trialDuration
Required
Integer field – Indicates number of days for
which trial account is valid. Default Trail
period for customer accounts created under
this partner account
Possible Values: 15, 30, 45, 60, 75, 90
adminEULASettings
Required
One of the following 4 values
0-Don’t prompt
1-Force only the first login to accept EULA
2-Force all admins to accept EULA on first
time login
3-Force all admins to accept changes to
EULA
endUserReacceptEULAEnabl
ed
Required
• This customer account has enforced
end users to re-accept EULA when the
applicable EULA changes
• Possible values (Yes/No)
endUserReacceptEULARemi
nderDuration
Required if
endUserReacceptEULAEnabl
ed is set to “Yes”
• This field indicates the duration after
which end user would get a reminder
to re-accept EULA in case he/she
hasn’t done so yet.
• Possible Value:2,7,15,30 Days
endUserReacceptEULADelay
AfterReminder
Required if
endUserReacceptEULAEnabl
ed is set to “Yes”
• If the user doesn’t re-accept the EULA
even after the reminder, this field
indicates the delay after the reminder
for marking the user out of EULA
compliance and take specified action
on all devices belonging to this user.
• Possible Value: 2,7,15,30
endUserReacceptEULAActio
n
Required if
endUserReacceptEULAEnabl
ed is set to “Yes”
• This field indicates the action to be
taken on all devices belonging to user
in case the user has not accepted EULA
• Possible values
o 0 - Do Nothing
o 1 - Selective Wipe
o 2- Remove Control
country
Optional
Set the country code for the partner
account. For example: India or IN
See page 143 for a list of country codes.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
230
Sample Request
POST https://services.fiberlink.com/account-
provisioning/account/1.0/setPartnerAccountConfig/1101234?partnerBillingId=1101234&leadNotificationE
mail=abc@example1.com&trialDuratio=75&adminEULASettings=1&endUserReacceptEULAEnabled=No
Sample Response
<account>
<partnerBillingId>1101234</partnerBillingId >
<country>US</country>
<status>0</status> ## 1:success; 0:error
<description>Details of customer updated successfully</description>
<errorCode>1001</errorCode>
<errorMessage>Exception details</errorMessage>
</account>
Mandatory attributes in Response
- partnerBillingId
- status
Access Control
- Customer Properties: Enable Provision New Partner
- Access Rights: Onboard Partners
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
231
Get Customer’s Allowed Services
Request
GET /account-provisioning/service/1.0/getServicesInfo/< loggedInUserbillingId>?<parameters>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Returns the set of services that can be enabled for a customer.
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
customer account.
❖ Billing ID specified as a parameter is the child of the Partner account and will be to be a part of partner
hierarchy (directly or indirectly) of the account whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
loggedInUserbillingId
Required
Billing ID of the query’s account
customerBillingId
Required
Billing ID of the customer account
serviceKey
Optional
Use to check for a specific service.
Sample Request
POST https://services.fiberlink.com/account-provisioning/service/1.0/getServicesInfo/1224321
?loggedInUserbillingId=1224321&customerBillingId=1224321
Sample Response
<response>
<status>SUCCESS</status>
<count>13</count>
<services>
<service>
<serviceKey>ACT_SYNC</serviceKey>
<description>Enable Exchange and Office365 integration</description>
<status>Disabled</status>
<inputs/>
<childServices/>
</service>
<service>
<serviceKey>BES</serviceKey>
<description>Enable Blackberry enterprise server integration</description>
<status>Disabled</status>
<inputs/>
<childServices/>
</service>
<service>
<serviceKey>DOCS_SERVICE</serviceKey>
<description>Documents management and distribution capability for a wide range of devices. </description>
<status>Enabled</status>
<inputs/>
<childServices>
<service>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
<description>Enable content sync for user</description>
<parentServiceKey>DOCS_SERVICE</parentServiceKey>
<status>Disabled</status>
<inputs/>
<childServices/>
</service>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
232
</childServices>
</service>
</services>
</response>
Sample Error Response
<response>
<errorCode>NOT_IN_HIERARCHY</errorCode>
<errorMsg>Selected Customer 1224321 is not in hierarchy of parent: 1004952</errorMsg>
</response>
Response Definitions
ServiceKey
Description
Parent Service
MDM
Does not enable SPS or EAS
ACT_SYNC
Exchange and Office365 integration. Manages only via
mail and are not enrolled in MDM.
MAM_INT
Mobile Application Management
SECURE_BROWSER
Secure Browser
SECURE_EMAIL
Secure email
APP_WRAPPING
WINDOWS_FILE_SHARE
Connect to a Sharepoint through the MEG
SB_INTRANET_ACCESS
Use the Secure Browser through the MEG
BES
Blackberry enterprise server integration
DOCS_SERVICE
Documents management and distribution
RPAS
Email Access Gateway
TEM
Mobile expense management to track mobile data usage
MDM_C
Mobile Device Management
ENTERPRISE_GATEWAY
MaaS360 gateway
EUP
End User Portal
ACT_SYNC_NOTES
IBM Traveler and IBM Connections Cloud integration
CONTENT_SYNC_USER
Content sync for user
DOCS_SERVICE
SECURE_EDITOR
Secure editor (enables Viewer on Android)
DOCS_SERVICE
SECURE_VIEWER
Secure Viewer
DOCS_SERVICE
DV
Visibility services for Mac desktops and laptops
INT_DTM_BIGFIX_C
Advanced Patch Management using Bigfix
WINDOWS_DTM
_C
INT_DTM_LOCATE_C
Location tracking for Windows Desktops and Laptops
WINDOWS_DTM
_C
MAC
Management for Mac desktops and laptops
MAC_V
Visibility services for Mac desktops and laptops
WINDOWS_DTM_C
Management for Windows desktops and laptops
WINDOWS_ENROLLMEN
T_MODE
Windows 10 MDM
WINDOWS_DTM
_C
EUP_ADD_DEVICE
Show/hide Add Device Request Action in EUP
EUP
APP_SECURITY
Mobile App security
MAM_INT
MALWARE_DETECT
Threat management, Trusteer
MAM_INT
WP_APP_SECURITY
Workplace app security
MAM_INT
ANDROID_MDM_C
Android device management
MDM_C
BB_MDM
BlackBerry Device management
MDM_C
IPHONE_MDM_C
IOS device management
MDM_C
WIN_MOBILE
Manage Windows 8 devices
MDM_C
WIN7_PHONE
Manage Windows 7 phones
MDM_C
WINDOWS_PHONE_MDM
_C
Manage Windows 10 devices
MDM_C
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
233
ServiceKey
Description
Parent Service
SB_INTRANET_ACCESS
Secure browser gateway
SECURE_BROW
SER
SB_URL_FILTERING
URL filtering for Secure Browser
SECURE_BROW
SER
WINDOWS_SECURE_BR
OWSER
Windows secure browser
SECURE_BROW
SER
MAIL_CAL_APNS
Push notifications
SECURE_MAIL
SECURE_CHAT
Secure chat. This needs Secure Email to be enabled.
SECURE_MAIL
Mandatory attributes in Response
- status
- count
- service
Access Control
- Customer Properties: Enable Web Services
- Access Rights: Registration Portal workflows
Enable a Service for a Customer
Request
POST /account-provisioning/service/1.0/enableService/<billingID>?<serviceKey>&<customerBillingId>
Content Type Header: application/x-www-form-urlencoded
Accept: application/json OR Accept: application/xml
Definition
❖ A Partner can enable a service for a specified customer.
❖ The Billing ID specified in the request and credentials specified for authentication can be for a Partner
or Simple Customer account.
❖ Billing ID specified as a parameter is the Parent of the customer account and will be to be a part of
partner hierarchy (directly or indirectly) of the account whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
billingID
Required
Billing ID of the logged in Partner account
serviceKey
Required
See table “Parameter Keys” for allowed values.
customerBillingId
Required
Billing ID of the customer account
Parameter Keys
ServiceKey
Description
Parent Service
MDM
Does not enable SPS or EAS
ACT_SYNC
Exchange and Office365 integration.
Manages only via mail and are not
enrolled in MDM.
MAM_INT
Mobile Application Management
SECURE_BROWSER
Secure Browser
SECURE_EMAIL
Secure email
APP_WRAPPING
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
234
ServiceKey
Description
Parent Service
WINDOWS_FILE_SHARE
Connect to a Sharepoint through the
MEG
SB_INTRANET_ACCESS
Use the Secure Browser through the
MEG
BES
Blackberry enterprise server integration
DOCS_SERVICE
Documents management and
distribution
RPAS
Email Access Gateway
TEM
Mobile expense management to track
mobile data usage
MDM_C
Mobile Device Management
ENTERPRISE_GATEWAY
MaaS360 gateway
EUP
End User Portal
ACT_SYNC_NOTES
IBM Traveler and IBM Connections
Cloud integration
CONTENT_SYNC_USER
Content sync for user
DOCS_SERVICE
SECURE_EDITOR
Secure editor (enables Viewer on
Android)
DOCS_SERVICE
SECURE_VIEWER
Secure Viewer
DOCS_SERVICE
DV
Visibility services for Mac desktops and
laptops
INT_DTM_BIGFIX_C
Advanced Patch Management using
Bigfix
WINDOWS_DTM_C
INT_DTM_LOCATE_C
Location tracking for Windows Desktops
and Laptops
WINDOWS_DTM_C
MAC
Management for Mac desktops and
laptops
MAC_V
Visibility services for Mac desktops and
laptops
WINDOWS_DTM_C
Management for Windows desktops and
laptops
WINDOWS_ENROLLMENT_MODE
Windows 10 MDM
WINDOWS_DTM_C
EUP_ADD_DEVICE
Show/hide Add Device Request Action
in EUP
EUP
APP_SECURITY
Mobile App security
MAM_INT
MALWARE_DETECT
Threat management, Trusteer
MAM_INT
WP_APP_SECURITY
Workplace app security
MAM_INT
ANDROID_MDM_C
Android device management
MDM_C
BB_MDM
BlackBerry Device management
MDM_C
IPHONE_MDM_C
IOS device management
MDM_C
WIN_MOBILE
Manage Windows 8 devices
MDM_C
WIN7_PHONE
Manage Windows 7 phones
MDM_C
WINDOWS_PHONE_MDM_C
Manage Windows 10 devices
MDM_C
SB_INTRANET_ACCESS
Secure browser gateway
SECURE_BROWSER
SB_URL_FILTERING
URL filtering for Secure Browser
SECURE_BROWSER
WINDOWS_SECURE_BROWSER
Windows secure browser
SECURE_BROWSER
MAIL_CAL_APNS
Push notifications
SECURE_MAIL
SECURE_CHAT
Secure chat. This needs Secure Email
to be enabled.
SECURE_MAIL
Sample Request
POST https://services.fiberlink.com/account-provisioning/service/1.0/enableService/
1101234?serviceKey=MEM&customerBillingId=1224321
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
235
Sample Response
<serviceResponse>
<status>SUCCESS</status>
<customerBillingId>1224321</customerBillingId>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
</serviceResponse>
Mandatory attributes in Response
- status
- customerBillingId
- serviceKey
Sample Error Response
<serviceResponse>
<status>FAILED</status>
<errorCode>REQUIRED_PARAMETER_MISSING</errorCode>
<errorMsg>Service Key is required for enabling service : 4169009</errorMsg>
</serviceResponse>
<serviceResponse>
<status>FAILED</status>
<customerBillingId>4169009</customerBillingId>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
<errorCode>NOT_A_SIMPLE_CUSTOMER</errorCode>
<errorMsg>Selected customer with billing id: 75869 is not a Simple Customer</errorMsg>
</serviceResponse>
Other errors include:
• INVALID_CUSTOMER
• INVALID_SERVICE_KEY
• SERVICE_ALREADY_ENABLED
• PARENT_SERVICE_NOT_ENABLED
• NOT_IN_HIERARCHY
Access Control
- Customer Properties: Enable Web Service
- Access Rights: Registration Portal workflows
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
236
Disable a Service for a Customer
Request
POST /account-provisioning/service/1.0/disableService/<billingID>?<serviceKey>&<customerBillingId>
Content Type Header: application/x-www-form-urlencoded
Accept: application/json OR Accept: application/xml
Definition
❖ A Partner can disable a service for a specified customer.
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Billing ID specified as a parameter is the Parent of the customer account and will be to be a part of
partner hierarchy (directly or indirectly) of the account whose credentials is specified for authentication
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the logged in Partner account
serviceKey
Required
See table “Parameter Keys” for allowed values.
customerBillingId
Required
Billing ID of the customer account
Parameter Keys
ServiceKey
Description
Parent Service
MDM
Does not enable SPS or EAS
ACT_SYNC
Exchange and Office365 integration. Manages
only via mail and are not enrolled in MDM.
MAM_INT
Mobile Application Management
SECURE_BROWSER
Secure Browser
SECURE_EMAIL
Secure email
APP_WRAPPING
WINDOWS_FILE_SHARE
Connect to a Sharepoint through the MEG
SB_INTRANET_ACCESS
Use the Secure Browser through the MEG
BES
Blackberry enterprise server integration
DOCS_SERVICE
Documents management and distribution
RPAS
Email Access Gateway
TEM
Mobile expense management to track mobile
data usage
MDM_C
Mobile Device Management
ENTERPRISE_GATEWAY
MaaS360 gateway
EUP
End User Portal
ACT_SYNC_NOTES
IBM Traveler and IBM Connections Cloud
integration
CONTENT_SYNC_USER
Content sync for user
DOCS_SERVICE
SECURE_EDITOR
Secure editor (enables Viewer on Android)
DOCS_SERVICE
SECURE_VIEWER
Secure Viewer
DOCS_SERVICE
DV
Visibility services for Mac desktops and laptops
INT_DTM_BIGFIX_C
Advanced Patch Management using Bigfix
WINDOWS_DTM_
C
INT_DTM_LOCATE_C
Location tracking for Windows Desktops and
Laptops
WINDOWS_DTM_
C
MAC
Management for Mac desktops and laptops
MAC_V
Visibility services for Mac desktops and laptops
WINDOWS_DTM_C
Management for Windows desktops and
laptops
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
237
ServiceKey
Description
Parent Service
WINDOWS_ENROLLMENT_MODE
Windows 10 MDM
WINDOWS_DTM_
C
EUP_ADD_DEVICE
Show/hide Add Device Request Action in EUP
EUP
APP_SECURITY
Mobile App security
MAM_INT
MALWARE_DETECT
Threat management, Trusteer
MAM_INT
WP_APP_SECURITY
Workplace app security
MAM_INT
ANDROID_MDM_C
Android device management
MDM_C
BB_MDM
BlackBerry Device management
MDM_C
IPHONE_MDM_C
IOS device management
MDM_C
WIN_MOBILE
Manage Windows 8 devices
MDM_C
WIN7_PHONE
Manage Windows 7 phones
MDM_C
WINDOWS_PHONE_MDM_C
Manage Windows 10 devices
MDM_C
SB_INTRANET_ACCESS
Secure browser gateway
SECURE_BROW
SER
SB_URL_FILTERING
URL filtering for Secure Browser
SECURE_BROW
SER
WINDOWS_SECURE_BROWSER
Windows secure browser
SECURE_BROW
SER
MAIL_CAL_APNS
Push notifications
SECURE_MAIL
SECURE_CHAT
Secure chat. This needs Secure Email to be
enabled.
SECURE_MAIL
Sample Request
POST https://services.fiberlink.com/account-provisioning/service/1.0/disableService/
1101234?serviceKey=MEM&customerBillingID=1224321
Sample Response
<serviceResponse>
<status>SUCCESS</status>
<customerBillingId>4169009</customerBillingId>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
</serviceResponse>
Mandatory attributes in Response
- status
- customerBillingId
- serviceKey
Sample Error Response
<serviceResponse>
<status>FAILED</status>
<errorCode>REQUIRED_PARAMETER_MISSING</errorCode>
<errorMsg>Service Key is required for disabling service : 4169009</errorMsg>
</serviceResponse>
<serviceResponse>
<status>FAILED</status>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
<errorCode>REQUIRED_PARAMETER_MISSING</errorCode>
<errorMsg>customerBillingId is required for disabling service :
CONTENT_SYNC_USER</errorMsg>
</serviceResponse>
<serviceResponse>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
238
<status>FAILED</status>
<customerBillingId>416900987</customerBillingId>
<serviceKey>CONTENT_SYNC_USER</serviceKey>
<errorCode>NOT_A_SIMPLE_CUSTOMER</errorCode>
<errorMsg>Selected customer with billing id: 9798638is not a Simple Customer</errorMsg>
</serviceResponse>
Other errors include:
• INVALID_CUSTOMER
• INVALID_SERVICE_KEY
• SERVICE_KEY_NOT_ENABLED
• SERVICE_KEY_NOT_VISIBLE
• NOT_IN_HIERARCHY
Access Control
- Customer Properties: Allow Disable Services, Enable Web Services
- Access Rights: Registration Portal
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
239
Get User’s Enabled Services
Request
GET /account-provisioning/accountreporting/1.0/getUserReport/<billingID>?<parameters>
Content Type Header: application/x-www-form-urlencoded
Accept: application/json OR application/xml
Definition
❖ Return a user, associated devices, and the services enabled for each device.
❖ Either a user name or a phone number is required.
❖ The Billing ID specified in the request and credentials specified for authentication should be for a
Partner account.
❖ Billing ID specified as a parameter is the Parent of the customer account and will be to be a part of
partner hierarchy (directly or indirectly) of the account whose credentials is specified for authentication
❖ Return Access Denied error if webservice is executed for a customer Account
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the Partner account
custBillingId
Required
Billing ID of the Customer account
username
Required*
*Either a user name or a phone number is required.
phoneNumber
Required*
*Either a user name or a phone number is required.
Sample Request
GET https://services.fiberlink.com/account-
provisioning/accountreporting/1.0/getUserReport/1101234?username=johndoe
Sample Response
<response>
<custbillingId>1101234</custbillingId>
<users> <user> <username>johndoe</username>
<deviceCount>2</deviceCount>
<devices>
<device>
<CSN>ANDROID9cf3876c63a8</CSN>
<services>
<service>DOC</service>
<service>EAS</service>
</services>
<phoneNumber>Not Available</phoneNumber>
</device>
<device>
<CSN>SEC1c2690863109a</CSN>
<services>
<service>MDM</service>
<service>SEB</service>
</services>
<phoneNumber>Not Available</phoneNumber>
</device>
</devices>
</user>
</users>
</response>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
240
Sample Error Response
<response>
<errorCode> INPUT_NOT_VALID </errorCode>
<errorMsg>Customer Billing ID 1101234 is not valid</errorMsg>
</response>
<response>
<errorCode>REQUIRED_PARAMETER_MISSING</errorCode>
<errorMsg> At least one of the parameters, username or phone number, is required for getting reports
</errorMsg>
</response>
Other errors include:
• INPUT_COMBINATION_HAS_NO_DEVICES
• NOT_A_SIMPLE_CUSTOMER
Response Definitions
ServiceKey
Full Name
Notes
MDM
Mobile Device Management
Devices managed by MDM, not including
SPS or EAS devices, are counted.
ACT_SYNC
Email Managed (ActiveSync)
Devices
Devices that are managed only via mail
and are not enrolled in MDM are counted.
MAM_INT
Mobile App Management
Devices that have the app catalog
available on the device, and have at least
one app deployed are counted.
TEM
Mobile Expense Management
Devices that have a MEM data plan
assigned to them are counted.
MALWARE_DETECT
Mobile Threat Management
Devices that have Trusteer activated and
in use are counted.
CON
Mobile Content Cloud
Exists for billing purposes, does not require
enable service option.
SECURE_BROWSER
Secure Browser
Devices that have Secure Browser
installed are counted.
SECURE_EMAIL
Secure Mail
Devices that have Secure Mail installed
are counted.
SECURE_CHAT
Secure Chat
Devices that have Secure Chat installed
are counted.
APP_WRAPPING
App Security
Devices with App Wrapping enabled are
counted
DOC
Mobile Content Management
Every active device is counted.
SECURE_EDITOR
Secure Editor
Devices that have Secure Editor installed
are counted.
CONTENT_SYNC_USER
Secure Doc Sync
Devices that have Secure Doc Sync
enabled are counted.
WINDOWS_FILE_SHARE
MEG – Docs
Devices that connect to a Sharepoint
through the MEG are counted.
SB_INTRANET_ACCESS
MEG – Browser
Devices that use the Secure Browser
through the MEG are counted.
WP_APP_SECURITY
MEG – Apps
Devices that use apps that use the
WorkPlace SDK are counted.
Mandatory attributes in Response
- custbillingId
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
241
- CSN (maas360DeviceID)
- username or phonenumber
- device
Access Control
- Customer Properties: Enable User Usage Report, Enable Web Service
Access Rights: Portal Manager AccessReporting
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
242
Reporting
Get List of Dashboards
Request
GET /reporting-apis/bi/1.0/getDashboards/{billingId}/
Definition
❖ Returns a list of dashboards.
Parameters (table)
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for which the web-
service is being executed
locale
Optional
Locale in which the name of reports and
categories are to be displayed
customerBillingID
Optional
Only available for Partner dashboards
Sample Request
GET https://services.fiberlink.com/reporting-apis/bi/1.0/getDashboards/1101234
Sample Response
<dashboards>
<count>2</count>
<dashboard>
<dashboardName>MDM OVERVIEW</dashboardName >
<dashboardCode>BI_IA_MDMO</dashboardCode >
</dashboard >
<dashboard >
< dashboardName>PLATFORM</dashboardName >
<dashboardCode>BI_IA_PLATO</dashboardCode>
</dashboard >
</dashboards>
Access Control
- Customer Properties: New BI - MDM Dashboards or New BI - DTM Dashboards or New BI - Partner
Dashboards or New BI - MEM Dashboards
- Access Rights: Reports
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
243
Get Report List For A Dashboard
Request
GET /reporting-apis/bi/1.0/getReport/{billingId}/{dashboardCode}/
Definition
❖ Return the list of reports available for the requested dashboard
Parameters (table)
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for which this api
is being executed
dashboardCode
Required
The code of the dashboard for which this
api is being executed
locale
Optional
Locale in which the name of filters are to
be displayed
Sample Request
GET https://services.fiberlink.com/reporting-apis/bi/1.0/getReport/1101234/BI_IA_MDMO/
Sample Response
<reports>
<count>4</count>
<report>
<categoryName>Device Summary</categoryName>
<reportName>Platform</reportName>
<reportCode>BI_IA_MDMO_DEVICES_BY_PLATFORM</reportCode>
</report>
<report>
<categoryName>Device Summary</categoryName>
<reportName>Managed Status</reportName>
<reportCode>BI_IA_MDMO_DEVICES_BY_MANAGED_STATUS</reportCode>
</report>
<report>
<categoryName>Device Summary</categoryName>
<reportName>Ownership</reportName>
<reportCode>BI_IA_MDMO_DEVICES_BY_OWNERSHIP</reportCode>
</report>
<report>
<categoryName>Hardware Details</categoryName>
<reportName>Details Report</reportName>
<reportCode>BI_IA_MDMO_DEVICE_DETAILS_REPORT</reportCode>
</report>
</reports>
Mandatory attributes in Response
- categoryName
- reportName
- reportCode
Access Control
- Customer Properties: New BI - MDM Dashboards or New BI - DTM Dashboards or New BI - Partner
Dashboards or New BI - MEM Dashboards
- Access Rights: Reports
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
244
Download Report Details
Request
GET /reporting-apis/bi/1.0/download/{billingId}/{dashboardCode}{reportCode}
Definition
❖ Downloads a zipped CSV file with name REPORT_CODE_yyyy-mm-dd-hh-mm.zip containing the details
of the specified report
❖ The credentials specified for authentication change the customerBillingID parameter
❖ Columns are customized for as specified by the authenticated admin user
❖ Only one report per account at a time; simultaneous requests result in an error message
Parameters (table)
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for which this api is
being executed
dashboardCode
Required
The code of the dashboard for which this api
is being executed
reportCode
Required
The code of the report for which the details
are requested
locale
Optional
Locale in which the name of filters are to be
displayed
customerBillingId
Optional
When logged in as Customer admin, it is not
required
When logged in as Partner admin, it is
required
Sample Request
GET https://services.fiberlink.com/reporting-apis/bi/1.0/download/1101234/ BI_IA_MDMO?reportcode=
BI_IA_MDMO_DEVICES_BY_PLATFORM
Sample Response
Downloads a CSV file with name BI_IA_MDMO_DEVICES_BY_PLATFORM_2015-09-01-13-22.zip.
Access Control
- Customer Properties: New BI - MDM Dashboards or New BI - DTM Dashboards or New BI - Partner
Dashboards or New BI - MEM Dashboards
- Access Rights: Reports
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
245
Cisco ISE Integration
This section describes integrating MaaS360 with Cisco’s Identity Services Engine (ISE). The current version
of the REST APIs is supported with ISE 1.4. Partner MDM servers implementing v2 APIs must be backward
compatible with the previous v1 APIs.
MDM Server Info
Request
GET https://mdm-server/ciscoise/mdminfo/?ise_api_version=<max_ise_supported_api_version>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This API is used to initially add an MDM vendor into ISE and the ISE admin page. This also provides
information about the API version used by ISE as a URL query parameter. The MDM server determines
which version of the API to use, based on this api version information.
❖ The URL required for sending the MDM Server Info API request is fixed, since the API path (obtained
from the REST webservice response for the MDM Server Info API) is not yet known to ISE.
Parameters
Parameter Name
Required /
Optional
Description
ise_api_version
Required
Billing ID of the Partner account for which the customer
account should be created
Sample Request
GET https://mdm-server/ciscoise/mdminfo/?ise_api_version=2
Sample Response
<ise_api>
<name>mdminfo</name>
<api_version>3</api_version>
<api_path>/ise/mdm/api</api_path>
<redirect_url>http://example.com<redirect_url>
<query_max_size>3000</query_max_size>
<messaging_support>true</messaging_support>
<vendor>Example Co.</vendor>
<product_name>Example Co. Mobile Device Manager</product_name>
<product_version>5.5.5</product_version>
</ise_api>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
246
MDM Device Attributes Query
Request
GET /ciscoise/devices/?
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This API queries device attributes. Each query has a category (MAC address, compliance status),
value, and an Attribute filter to determine what information in in the return.
❖ The maximum number of devices returned is the value of “query_max_size” returned from “MDM Server
Info” API (default is 5000).
❖ The initial call of this API passes paging info “0”. If the MDM has more devices than the
“query_max_size”, it can design its own paging scheme, and returns the paging_info in the response,
which will be part of the URL in next call from ISE. If the paging info is “0” in response, or it doesn’t
return paging info in its response, all the records have been returned.
Parameters
Parameter Name
Required /
Optional
Description
paging
Required
0 means first call or all records
querycriteria
Optional
Choose the query criteria category:
• macaddress
• compliance
value
Optional
Choose the query criteria value:
• macaddress - 12 HEX without separator
• meid – 14 character HEX code or 10 digit
decimal code
• udid (Unique Device Identifier)
• imei (International Mobile Station Equipment
Identity)
• compliance - true/false
• username - string
filter
Required
Use any number of filters, separated by “+”:
• all
• register_status - Boolean (true/false)
• Compliance - Status (true/false), Failure_reason
(String), Rememdiation (String)
• disk_encryption_on - Boolean (true/false)
• pin_lock_on - Boolean (true/false)
• jail_broken - Boolean (true/false)
• Manufacturer - String
• Model - String
• Imei - String
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
247
Parameter Name
Required /
Optional
Description
• Meid - String
• Udid - String
• HTTP - Method Url
• serial_number - String
• os_version - String
• phone_number - String
Sample Request
https://services.fiberlink.com/ciscoise/devices/?paging=0&querycriteria=macaddress&value=0000000000
00&filter=all
https://services.fiberlink.com/ciscoise/devices/?paging=0&
querycriteria=meid&value=1234567890abcd&filter=all
https://services.fiberlink.com/ciscoise/devices/?paging=0&querycriteria=username&value=abcd1234&filt
er=register_status+compliance_status
https://services.fiberlink.com/ciscoise/devices/?paging=0&querycriteria=compliance&value=false&filter
=all
https://services.fiberlink.com/ciscoise/devices/?paging=0&filter=all
Sample Response
<ise_api >
<name>attributes</name>
<api_version>2</api_version>
<paging_info>0</paging_info>
<deviceList>
<device>
<macaddress>000000000000</macaddress>
<attributes>
<register_status>true</register_status>
<compliance>
<status>false<status>
<failure_reason>something not compliant</failure_reason>
<remediation>instruction on how to rememdiate</remediation>
</compliance>
<disk_encryption_on>yes</ disk_encryption_on>
<pin_lock_on>true</ pin_lock_on>
<jail_broken>false</ jail_broken>
<manufacturer>Samsung</ manufacturer>
<imei>1234567890</imei>
<meid>A0123456789012</meid>
<udid>2b6f0cc904d137be2e1730235f5664094b831186</udid>
<os_version>Android,4.3<os_version>
</attributes>
</device>
<deviceList>
</ise_api>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
248
MDM Device Attributes Query (POST version)
Request
POST /ciscoise/batchdevices/?
Content Type Header: application/x-www-form-urlencoded
Definition
❖ This is the POST version of the “MDM Device Attributes Query” API. It is functionally equivalent to the
“GET” version.
❖ The “POST” version allows passing multiple values of a particular query criterion. For example, if query
criterion is macaddress, then it can pass a list of mac addresses for the query.
Parameters
Parameter Name
Required /
Optional
Description
paging
Required
0 means first call or all records
querycriteria
Optional
Choose the query criteria category:
• macaddress
• compliance
value
Optional
Choose the query criteria value:
• macaddress - 12 HEX without separator
• meid – 14 character HEX code or 10 digit
decimal code
• udid (Unique Device Identifier)
• imei (International Mobile Station Equipment
Identity)
• compliance - true/false
• username - string
filter
Required
Use any number of filters, separated by “+”:
• all
• register_status - Boolean (true/false)
• Compliance - Status (true/false), Failure_reason
(String), Rememdiation (String)
• disk_encryption_on - Boolean (true/false)
• pin_lock_on - Boolean (true/false)
• jail_broken - Boolean (true/false)
• Manufacturer - String
• Model - String
• Imei - String
• Meid - String
• Udid - String
• HTTP - Method Url
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
249
Parameter Name
Required /
Optional
Description
• serial_number - String
• os_version - String
• phone_number - String
Sample Request
https://services.fiberlink.com/ciscoise/batchdevices/paging=0&querycriteria=macaddress&value=000000
000000&filter=all
Sample Response
<ise_api >
<name>attributes</name>
<api_version>2</api_version>
<paging_info>0</paging_info>
<deviceList>
<device>
<macaddress>000000000000</macaddress>
<attributes>
<register_status>true</register_status>
<compliance>
<status>false<status>
<failure_reason>something not compliant</failure_reason>
<remediation>instruction on how to rememdiate</remediation>
</compliance>
<disk_encryption_on>yes</ disk_encryption_on>
<pin_lock_on>true</ pin_lock_on>
<jail_broken>false</ jail_broken>
<manufacturer>Samsung</ manufacturer>
<imei>1234567890</imei>
<meid>A0123456789012</meid>
<udid>2b6f0cc904d137be2e1730235f5664094b831186</udid>
<os_version>Android,4.3<os_version>
</attributes>
</device>
<deviceList>
</ise_api>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
250
MDM Action
Request
POST /ciscoise/action/?
Content Type Header: multipart/form-data
Definition
❖ This API allows ISE to send an action command to the MDM to perform certain actions.
Parameters
Parameter Name
Required /
Optional
Description
actionType
Required
Choose the action type, and upload an XML payload:
• full_wipe
• corporate_wipe
• pin_lock
Request payload:
<?xml version="1.0" encoding="UTF-8"?>
<ise_api>
<identifier>
<macaddress> 000000000000</macaddress>
</identifier >
</ise_api>
Sample Request
https://services.fiberlink.com/ciscoise/action/actionType=pin_lock
Sample Response
<ise_api >
<name>action</name>
<api_version>2</api_version>
<deviceList>
<device>
<macaddress>000000000000</macaddress>
<result>
<action_status>true</register_status>
<failure_reason>Not Compliant</failure_reason>
</result>
</device>
<deviceList>
</ise_api>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
251
Messaging
Request
PUT /ciscoise/sendmessage
Content Type Header: multipart/form-data
Definition
❖ This API allows ISE to send a message through the MDM to end user mobile devices ifthe MDM has a
messaging system that communicates with the devices.
❖ To use this API, the “MDM Server Info” API needs to return true for “messaging_support”.
Parameters
Parameter Name
Required /
Optional
Description
sendmessage
Required
Upload an XML payload for the message
Request payload:
<?xml version="1.0" encoding="UTF-8"?>
<ise_api>
<identifier>
<macaddress> 000000000000</macaddress>
<macaddress> 111111111111</macaddress>
</identifier >
<message>
<message_type>Alert</message_type>
<message_header>Need your action in the next 10 minutes</message_header>
<message_body>Text body</message_body>
</message>
</ise_api>
Sample Request
https://services.fiberlink.com/ciscoise/sendmessage
Sample Response
<ise_api >
<name>sendmessage</name>
<api_version>2</api_version>
<deviceList>
<device>
<macaddress>000000000000</macaddress>
<result>
<message_status>false</register_status>
<failure_reason>something happened, message is not sent</failure_reason>
</result>
</device>
<device>
<macaddress>111111111111</macaddress>
<result>
<message_status>true</register_status>
<failure_reason> </failure_reason>
</result>
</device>
<deviceList>
</ise_api>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
252
Admin Audit
This section describes APIs that are available for integrating MaaS360 with IBM QRadar.
Get Admin Login Reports
Request
GET /account-provisioning-ws/administrator/1.0/getAdminLoginReports/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides admin login events success/failures at MaaS portal for a billing ID
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
authStatus
Optional
Status of the authentication
(Successful, Device
Authentication Failed, User
Authentication Failed)
fromDate
Optional
Starting date for limit of audit
toDate
Optional
End date for limit of audit
pageSize
Optional
Limit number of events returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default is first page
Sample XML Response
<loginEvents>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<loginEvent>
<username>40005185_hs.harish</username>
<loginAttemptTime>1493279650928</loginAttemptTime>
<logoutTime>1493278946000</logoutTime>
<duration>70.2</duration>
<operatingSystem>Windows Seven NT 6.1</operatingSystem>
<browserVersion>Chrome 57.0.2987.133</browserVersion>
<ipAddress>208.76.135.129</ipAddress>
<authStatus>Successful</authStatus>
</loginEvent>
</loginEvents>
Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
253
Get Roles Audit
Request
GET /account-provisioning/roles/1.0/getRolesAudit/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of roles for a billing ID.
Parameters
Parameter Name
Required /
Optional
Description
billingId
Required
Billing ID of the account for which the web-service is
being executed
fromDate
Optional
Start date for limit of audit (Required if toDate is used)
toDate
Optional
End date for limit of audit (Required if fromDate is
used)
pageSize
Optional
Limit number of audits returned at one time. Allowed
page sizes: 25, 50, 100, 200, 250. Default value: 50
pageNumber
Optional
Results specific to a particular page. Default: first page
Sample XML Response
<roles>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<role>
<roleId>57605</roleId>
<roleName>Custom</roleName>
<roleDescription>Testing..!</roleDescription>
<availableForCustomer>Y</availableForCustomer>
<modifiedDate>1491315257000</modifiedDate>
<operation>INSERT</operation>
<accessRightsModified>
<accessRight>
<operation>INSERT</operation>
<name>Change Compliance Rule Set</name>
<category>Device Management</category>
<description>Ability to change a compliance rule set through a Device View
action.</description>
</accessRight>
</accessRightsModified>
</role>
</roles>
Note: For Delete operation do not show any access rights in the response.
Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
254
Get Services Audit
Request
GET /account-provisioning/service/1.0/getServicesAudit/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides an audit of services for the billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
serviceKey
Optional
Unique service name. For
example, ACT_SYNC_NOTES,
MAM_INT, MAC
fromDate
Optional
Starting date for limit of audit
toDate
Optional
End date for limit of audit
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
<services>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<service>
<updateDate>1493010852774</updateDate>
<perfomedBy>pragagar@in.ibm.com</perfomedBy>
<ipAdress>10.104.23.168</ipAdress>
<serviceKey>MALWARE_DETECT</serviceKey>
<description>Enable threat management</description>
<parentServiceKey>MAM_INT</parentServiceKey>
<parent_description>Enable IBM Traveler and IBM Connections Cloud
integration</parent_description>
<action>ENABLE</action>
</service>
</services>
Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
255
Get Deployment Settings Audit
Request
GET /account-provisioning/settings/1.0/getDeploymentSettingsAudit/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of deployment settings for the billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
fromDate
Optional
Starting date for limit of audit
toDate
Optional
End date for limit of audit
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
<deploymentSettings>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<deploymentSetting>
<enrollOnBehalf>
<enable>Yes</enable>
<emailEOB>abc@gmail.com</emailEOB>
</enrollOnBehalf>
<userAuthenticationMechanism>
<mechanism>ad</mechanism>
</userAuthenticationMechanism>
<devicePlatformAllowed>ipad, iphone</devicePlatformAllowed>
<promptForOwnership>Yes</promptForOwnership>
<defaultNewAdditionMode>Enrollment</defaultNewAdditionMode>
<limitDevices>
<enable>No</enable>
</limitDevices>
<managementForCorporateIosDevice>
<setupSupervisedDevices></setupSupervisedDevices>
<depSettingsUsingAppleDevice>
<enable>Yes</enable>
<authScreenHeader>HELLO</authScreenHeader>
</depSettingsUsingAppleDevice>
<deployAppsAndConfigureToDeviceEnroll></deployAppsAndConfigureToDeviceEnroll>
</managementForCorporateIosDevice>
<corporateEmailDomain>
<enable>Yes</enable>
<emailDomain>abc@gmail.com</emailDomain>
</corporateEmailDomain>
<iosAppManagementSetting>
<depSettingsDefaultAppStore>
<enable>Yes</enable>
<regionName>United States</regionName>
</depSettingsDefaultAppStore>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
256
<promptUserDuringEnrollment></promptUserDuringEnrollment>
<convertAppsToManaged>No</convertAppsToManaged>
</iosAppManagementSetting>
<enableSilentInstallation>Yes</enableSilentInstallation>
<promptForCorporatePolicy>
<enable>No</enable>
</promptForCorporatePolicy>
<corporateInformation>
<enable>Yes</enable>
<iosServiceHostName>HLC Pvt. Ltd.</iosServiceHostName>
<contactEmail>y@gmail.com</contactEmail>
<phoneNumber>12345</phoneNumber>
<customInstructions>No Bunk</customInstructions>
</corporateInformation>
<alertOnNewDeviceDiscovery>
<enable>Yes</enable>
<deviceTypeToConsider>All Devices</deviceTypeToConsider>
<notificationEmail>xyz@ymail.com</notificationEmail>
<notificationEmail>test@ymail.com</notificationEmail>
</alertOnNewDeviceDiscovery>
<modifiedOn>1493292365868</modifiedOn>
<modifiedBy>20014949_psoni170</modifiedBy>
<previousState>
<enrollOnBehalf>
<enabled>No</enabled>
</enrollOnBehalf>
<userAuthenticationMechanism>
<mechanism>maas_auth</mechanism>
</userAuthenticationMechanism>
<alertOnNewDeviceDiscovery>
<enable>Yes</enable>
<deviceTypeToConsider>All Devices</deviceTypeToConsider>
<notificationEmail>xyz@ymail.com</notificationEmail>
</alertOnNewDeviceDiscovery>
</previousState>
</deploymentSetting>
</deploymentSettings>
Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
257
Get Login Settings Audit
Request
GET /account-provisioning/settings/1.0/getLoginSettingsAudit/customer/<billingId>
Content Type Header: application/x-wws-form-urlencoded
Definition
❖ Provides audits of login settings for the billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
fromDate
Optional
Starting date for limit of audit
toDate
Optional
End date for limit of audit
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
<loginSettings>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<loginSetting>
<modifiedDate>1495440227523</modifiedDate>
<modifiedBy>20014960_hs.harish</modifiedBy>
<authenticationMechanism>SAML</authenticationMechanism>
<samlConfig>
<identityProviderName>http://WDADFS01.fiberlinkqa.local/adfs/services/trust</identityProviderName>
<signInPageUrl>https://WDADFS01.fiberlinkqa.local/adfs/ls/</signInPageUrl>
<notificationEmail>harish@gmail.com</notificationEmail>
<allowAdminToUsePortalCred>Yes</allowAdminToUsePortalCred>
</samlConfig>
<deviceRegistrationRequired>No</deviceRegistrationRequired>
<enableOTP>No</enableOTP>
<previousState>
<samlConfig>
<notificationEmail>abc@gmail.com</notificationEmail>
</samlConfig>
<enableOTP>Yes</enableOTP>
</previousState>
</loginSetting>
<loginSetting>
<modifiedDate>1495432342725</modifiedDate>
<modifiedBy>20014960_hs.harish</modifiedBy>
<authenticationMechanism>SAML</authenticationMechanism>
<samlConfig>
<identityProviderName>http://WDADFS01.fiberlinkqa.local/adfs/services/trust</identityProviderName>
<signInPageUrl>https://WDADFS01.fiberlinkqa.local/adfs/ls/</signInPageUrl>
<notificationEmail>abc@gmail.com</notificationEmail>
<allowAdminToUsePortalCred>Yes</allowAdminToUsePortalCred>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
258
</samlConfig>
<deviceRegistrationRequired>No</deviceRegistrationRequired>
<enableOTP>Yes</enableOTP>
<previousState>
<authenticationMechanism>Customer User Directory</authenticationMechanism>
<enableOTP>No</enableOTP>
</previousState>
</loginSetting>
</loginSettings>
Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
259
Get Notifications Settings Audit
Request
GET /account-provisioning/settings/1.0/getNotificationsSettingsAudit/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of notification settings for the billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
status
Optional
Active/Inactive. If not provide
will return both
fromDate
Optional
Starting date for limit of audit
toDate
Optional
End date for limit of audit
Status
Optional
Enabled or Disabled. Default:
both
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
<notificationSettings>
<count>2</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<notificationSetting>
<updateDate>1494565275161</updateDate>
<performedBy>20014949_muqbasha</performedBy>
<ipAddress>208.76.135.129</ipAddress>
<category>
<name>MTC_DEVICE_ENROLLMENTS</name>
<description />
<action>Enabled</action>
</category>
<category>
<name>MTC_APP_DISTRIBUTION</name>
<description />
<action>Enabled</action>
</category>
</notificationSetting>
</notificationSettings>
Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
260
Get User Group Changes Audit
Request
GET /getGroupAudit/customer/40005325?fromDate=1487665805000&toDate=1492763405000
Definition
❖ Provides audits of devices groups for a billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
fromDate
Optional
Starting date for limit of audit
(Required if toDate is given)
toDate
Optional
End date for limit of audit
(Required if fromDate is given)
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
Representation of actions taken on user group
<groupsAudit>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<groupAudit>
<groupName>RCB vs SRH new</groupName>
<groupType>3</groupType>
<createdBy>40005325_psoni170</createdBy>
<lastModifiedBy>40005325_psoni170</lastModifiedBy>
<isActive>1</isActive>
<isPrivate>0</isPrivate>
<isManaged>0</isManaged>
<action>
<actionType>POLICY</actionType>
<actionPerformedBy>40005325_psoni170</actionPerformedBy>
<actionPerformedOn>1493165061378</actionPerformedOn>
</action>
</groupAudit>
</groupsAudit>
Representation for changes done on User group (e.g. description/name change)
<groupsAudit>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<groupAudit>
<groupName>RCB vs SRH new</groupName>
<groupType>3</groupType>
<createdBy>40005325_psoni170</createdBy>
<createdDate>1492681676983</createdDate>
<lastModifiedBy>40005325_psoni170</lastModifiedBy>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
261
<isActive>1</isActive>
<isPrivate>0</isPrivate>
<isManaged>0</isManaged>
<action>
<actionType>GROUP_EDIT</actionType>
<actionPerformedBy>40005325_psoni170</actionPerformedBy>
<actionPerformedOn>1493165061378</actionPerformedOn>
</action>
<previousState>
<groupName>f4a5d411-ddbd-4d12-b319-b4ff4d43015e</groupName>
</previousState>
</groupAudit>
</groupsAudit>
Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
262
Get Device Group Changes Audit
Request
GET /getGroupAudit/customer/40005325?fromDate=1487665805000&toDate=1492763405000
Definition
❖ Provides audits of devices groups for a billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
fromDate
Optional
Starting date for limit of audit
(Required if toDate is given)
toDate
Optional
End date for limit of audit
(Required if fromDate is given)
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
Representation of actions taken on Device group
<groupsAudit>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<groupAudit>
<groupName>Employee Owned Devices</groupName>
<groupType>2</groupType>
<createdBy>40005325_psoni170</createdBy>
<createdDate>1492681676983</createdDate>
<lastModifiedBy>40005325_psoni170</lastModifiedBy>
<isActive>1</isActive>
<isPrivate>0</isPrivate>
<isManaged>0</isManaged>
<action>
<actionType>ACTION_HIDE_DEVICE</actionType>
<actionDescription>Removed via Device Groups.Group Name: Employee Owned
Devices</actionDescription>
<actionPerformedBy>40005325_psoni170</actionPerformedBy>
<actionPerformedOn>1492681677008</actionPerformedOn>
<actionStatus>COMPLETED</actionStatus>
<expiryDate>1493286477062</expiryDate>
</action>
</groupAudit>
</groupsAudit>
Representation for changes done on Device group (e.g. description/name change)
<groupsAudit>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<groupAudit>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
263
<groupName>Copy of iOS Devices</groupName>
<groupType>2</groupType>
<createdBy>40005325_psoni170</createdBy>
<createdDate>1492681654529</createdDate>
<lastModifiedBy>40005325_psoni170</lastModifiedBy>
<isActive>1</isActive>
<isPrivate>0</isPrivate>
<isManaged>0</isManaged>
<action>
<actionType>CREATE_DEVICE_GROUP</actionType>
<actionPerformedOn>1492682175993</actionPerformedOn>
<actionStatus></actionStatus>
<expiryDate></expiryDate>
</action>
</groupAudit>
</groupsAudit>
Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
264
Get Admin Changes Audit
Request
GET account-provisioning/administrator/1.0/getAdminChangesAudit/customer/<billingId>
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides local admin account changes/addition/deletion at MaaS portal for a billing ID.
Parameters
Parameter Name
Required / Optional
Description
billingId
Required
Billing ID of the account for
which the web-service is being
executed
accountStatus
Optional
Active/Inactive. If not provided
will return both
fromDate
Optional
Starting date for limit of audit
(Required if toDate is given)
toDate
Optional
End date for limit of audit
(Required if fromDate is given)
pageSize
Optional
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
pageNumber
Optional
Results specific to a particular
page. Default: first page
Sample XML Response
<adminChanges>
<count>10</count>
<pageNumber>1</pageNumber>
<pageSize>50</pageSize>
<adminChange>
<updateDate>1492044920000</updateDate>
<performedBy>pragagar@in.ibm.com</performedBy>
<operationType>UPDATE</operationType>
<ipAddress>208.76.135.129</ipAddress>
<administrator>
<email>hs.harish@in.ibm.com</email>
<username>40005185_hs.harish</username>
<firstName>Harishkumar</firstName>
<middleName />
<lastName>H</lastName>
<address />
<phone />
<jobTitle />
<watchlistSubscription> Yes </watchlistSubscription>
<accountStatus>true</accountStatus>
<managedUserGroups>All Groups</managedUserGroups>
<lastLoginTime>1492044637000</lastLoginTime>
<authStatus>Successful</authStatus>
<rolesAdded>Administrator</rolesAdded>
<rolesDeleted>Help Desk<rolesDeleted>
<previousState>
<firstName>Harish</firstName>
</previousState>
</administrator>
</adminChange>
</adminChanges>
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
265
Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
266
Alerts
Create Alert
Request
POST https://<host>/alert-apis/alerts/2.0/alerts/customer/<billing_id>
Definition
❖ Create an alert using search criteria
o Authorization header: MaaS token=<ADMIN_AUTH_MAAS_TOKEN>
o Accepts XML or JSON headers
Parameters
Parameter Name
Required /
Optional
Description
billing_id
Required
Billing ID of the account for which the web-service is
being executed
Sample JSON Request
{
"name":"<alert name>",
"description":"<alert description>",
"type":"<alert type>",
"availableFor":"<available for>"
"deviceStatus" : "<device status>",
"lastReported" : "<last reported>",
"criteriaOperator" : "<criteria operator>",
"deviceTypes" : [ "device type 1", "device type 2", ..]
"conditions" : [
{
"category" : "<category name>",
"attribute" : "<attribute name>",
"criteria" : "<criteria>",
"value1" : "<value 1>",
"value2" : "<value 2>"
}
}
Sample Request Parameters
Parameter Name
Required /
Optional
Description
name
Required
Name of the alert being created.
description
Required
Description of the alert being created.
deviceStatus
Optional
Status of the device being searched for. Default: Active
Devices
lastReported
Optional
Search includes devices last reported in this time.
Default: Last 7 Days
deviceTypes
Optional
Types of devices to include in search. Default: All
available types are included
criteriaOperator
Optional
Decides if the devices meet all or any one condition
provided. Default: All Conditions (AND)
conditions
Optional
Conditions for search criteria, maximum of 10
category
Required
Category name on which condition is being constructed
attribute
Required
Attribute name on which condition is being constructed.
Requires the category parameter.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
267
criteria
Required
Criteria to be used for comparison of values. Requires
the attribute parameter.
value1
Required
Value of the attribute. Requires the criteria parameter
and the attribute parameter.
value2
Optional
Second value of the attribute. Use if criteria such as
“between” is used.
type
Optional
Type of group being created. Possible values: Security,
Info
availableFor
Optional
Who should receive the alert. Possible values: All
Administrators, Only Me
Sample JSON Response
{
"response": {
"billingId": 40006999,
"name": "custAttributeAlert",
"responseCode": 0
}
}
Response Code Messages
Response
code
Message
Scenario
0
Alert created successfully
When an alert is created without any errors
1
Unknown error occurred while
creating alert
When an internal error occurs
2
Alerts are not enabled for this
billingId
When alerts are not enabled for the requested user
3
Alert name requires at lease
one non-space character
When an alert name is not provided or provided with
empty characters
4
Alert name does not support
the following special
characters: ampersand
(&),lesser than (<) and greater
than (>)
When an alert name contains illegal characters
5
Alert description does not
support the following special
characters: ampersand
(&),lesser than (<) and greater
than (>)
When an alert description contains illegal characters
6
Alert description requires at
lease one non-space character
When an alert description is not provided or provided
with empty characters
7
Invalid value provided for
deviceStatus
When the value provided for the deviceStatus is not
"Active Devices","Inactive Devices","All Devices"
8
Invalid value provided for
lastReported
When an invalid value is provided for lastReported
9
Invalid value operator
provided for criteriaOperator
When the value provided for criteriaOperator
provided is not "All Conditions (AND)", "Any Condition
(OR)", "Across Conditions (Advanced)"
10
Invalid values provided for
deviceTypes
When deviceTypes provided contain invalid or
unavailable values
11
Number of conditions provided
exceed 10
When the number of conditions provided is more
than 10
12
Invalid value provided for
category
When an invalid value is provided for category
13
Invalid value provided for
attribute
When an invalid value is provided for attribute
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
268
14
Invalid value provided for
criteria
When an invalid value is provided for criteria
15
Two values are required for
"Between" criteria
When "Between" criteria is provided, but only one
valid value is specified
16
At least one invalid value
provided for attribute of type
date/timestamp
When the value for date is not in epoch milliseconds
format or empty
17
At least one invalid value
provided for attribute of type
number/double
When an invalid value is provided for attributes of
number/double format
18
At least one invalid value
provided for attribute of type
integer
When an invalid value is provided for attributes of
Integer format
19
No value is provided in
condition for comparision
When at least one value is not provided for
comparison in th econdition
20
Second value provided in
condition unnecessarily
When non "Between" criteria is selected, but a
second value is provided
21
Invalid value provided for
enum type attribute
When an enum attribute is selected, but the
comparison value provided is not one of the values in
enum definition
22
Invalid value provided for
boolean type attribute
When enum attribute is selected, but with a value
that is not "Yes" or "No"
23
Advanced criteriaOperator is
not yet supported
When Advanced search criteria is provided, but it’s
not yet available for general use
24
Invalid value provided for
availableFor
When a value other than "Only Me","All
Administrators" is provided for availableFor
25
Invalid alert type provided
When a value other than "Security", "Info" is provided
for alertType
Access Control
Customer Properties: Enable Web Services, Enable Watch List, Enable New Smart Search
Access Rights: Create Alert
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
269
Platform-Specific APIs
Mac APIs
Get GA or Beta Version Details of Mac Apps
Request
GET https://${services-url}/mac-apis/mac-app-
services/v1/generic/customer/{billing_id}/macAppVersions/{APPS_REQUIRED}
Definition
❖ The agent gets information about all agent versions, including the Packager GA version, MDM Agent
GA version, Mac App Catalog GA version, and the Mac App Catalog Beta version if applicable. The
Packager GA version is only available if the request is from the Admin.
❖ The apps require an integer value, with one value reserved for each app. The parameter is numeric
or all the bits required by the apps. The bits reserved for each app:
-App Packager: The numeric code is 2.
-Mac MDM Agent: The numeric code is 4.
-Mac App Catalog: The numeric code is 8.
❖ Authorization header: JSON
Sample JSON Response
{
"productDetails": [
{
"productName": "MAC_MDM_AGENT",
"type": "GA",
"version": "2.30",
"manifest": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<Module
ModuleID=\"1001\" Name=\"MAC_DEVICE_MANAGEMENT_AGENT\" Version=\"1\"> \n
<Params>\n
<Param Name=\"ID\" Value=\"176029\" />\n
<Param Name=\"Url\" Value=\"/macagents/MaaS360_MAC_MDM_Service_2.30.pkg\" />\n
<Param Name=\"BundleId\" Value=\"com.fiberlink.maas360.servicedaemon\" />\n
<Param Name=\"BundleVersion\" Value=\"1.60.200.010\" />\n
<Param Name=\"CreateDate\" Value=\"10/17/2013 09:27:56\" />\n
<Param Name=\"Sha1Checksum\" Value=\"6182b7248e95343ccc24c6a71eb1b74499be4dce\" />\n
<Param Name=\"Delay\" Value=\"480\" />\n
</Params>\n
<Action ActionID=\"OSX000100_1.01\"/> \n</Module>"
},
{
"productName": "MAC_APP_CATALOGUE",
"type": "GA",
"version": "1.30",
"manifest": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<Module
ModuleID=\"1002\" Name=\"MAC_APP_CATALOGUE\" Version=\"1\"> \n
<Params>\n
<Param Name=\"ID\" Value=\"176029\" />\n
<Param Name=\"Url\" Value=\"/macagents/MaaS360_MAC_Catalogue.pkg\" />\n
<Param Name=\"BundleId\" Value=\"com.fiberlink.maas360.servicedaemon\" />\n
<Param Name=\"BundleVersion\" Value=\"1.60.200.010\" />\n
<Param Name=\"CreateDate\" Value=\"10/17/2013 09:27:56\" />\n
<Param Name=\"Sha1Checksum\" Value=\"6182b7248e95343ccc24c6a71eb1b74499be4dce\" />\n
<Param Name=\"Delay\" Value=\"480\" />\n
</Params>\n
<Action ActionID=\"OSX000100_1.01\"/> \n</Module>"
},
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
270
{
"productName": "MAC_APP_CATALOGUE",
"type": "BETA",
"version": "1.40",
"manifest": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<Module
ModuleID=\"1001\" Name=\"MAC_DEVICE_MANAGEMENT_AGENT\" Version=\"1\"> \n
<Params>\n
<Param Name=\"ID\" Value=\"176029\" />\n
<Param Name=\"Url\" Value=\"/macagents/MaaS360_MAC_Catalogue.pkg\" />\n
<Param Name=\"BundleId\" Value=\"com.fiberlink.maas360.servicedaemon\" />\n
<Param Name=\"BundleVersion\" Value=\"1.60.200.010\" />\n
<Param Name=\"CreateDate\" Value=\"10/17/2013 09:27:56\" />\n
<Param Name=\"Sha1Checksum\" Value=\"6182b7248e95343ccc24c6a71eb1b74499be4dce\" />\n
<Param Name=\"Delay\" Value=\"480\" />\n
</Params>\n
<Action ActionID=\"OSX000100_1.01\"/> \n</Module>"
},
{
"productName": "MAC_PACKAGER",
"type": "GA",
"version": "1.40",
"manifest": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<Module
ModuleID=\"1001\" Name=\"MAC_DEVICE_MANAGEMENT_AGENT\" Version=\"1\"> \n
<Params>\n
<Param Name=\"ID\" Value=\"176029\" />\n
<Param Name=\"Url\" Value=\"/macagents/MaaS360_MAC_PACKAGER.pkg\" />\n
<Param Name=\"BundleId\" Value=\"com.fiberlink.maas360.servicedaemon\" />\n
<Param Name=\"BundleVersion\" Value=\"1.60.200.010\" />\n
<Param Name=\"CreateDate\" Value=\"10/17/2013 09:27:56\" />\n
<Param Name=\"Sha1Checksum\" Value=\"6182b7248e95343ccc24c6a71eb1b74499be4dce\" />\n
<Param Name=\"Delay\" Value=\"480\" />\n
</Params>\n
<Action ActionID=\"OSX000100_1.01\"/> \n</Module>"
}
]
}
The manifest is configurable by the agent. For this example, the manifest is hard-coded. For each agent
release, the agent will create two or more files. The first file is the manifest required for MDM
installation of the package and the second file is the manifest to be stubbed inside the web-service
response listed above.
The relative location of the agent in CDN is decided and name-spaced by the agent team. The CDN URL-
prefix, major version, and minor version in the template is substituted by the fabric task.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
271
Get Download Location of Mac Apps
Request
GET https://${services-url}/mac-apis/mac-app-
services/v1/generic/customer/{billing_id}/macApp/{AGENT_TYPE}/download?manifestOnly=false
Definition
❖ Gets the download location of a particular app.
❖ The AGENT_TYPE is one type of the following types: MAC_MDM_AGENT, MAC_APP_CATALOGUE,
MAC_APP_PACKAGER
❖ If the manifestOnly value is set to true, only the location of the manifest is returned. Any other value
returns the location of the app.
Sample JSON Response
{
"downloadUrl": "https://id4services.fiberlink.com/cdn-
content/agents/MAC_APP_CATALOGUE/AppCatalog_Signed.pkg"
}
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
272
Change History
#
Date
API
Type
Changes
1
03/06/2015
/applications/1.0/getAppDetails/
Existing
Corrected Sample Request in documentation -
appId instead of appID
2
03/06/2015
/devices/1.0/search/
Existing
Support for new Optional search criteria –
mailboxDeviceId
3
03/06/2015
/applications/1.0/addAndroidEnterpriseApp/
Existing
Corrected Sample Request in documentation -
addIOSEnterpriseAppPlus instead of
appIOSEnterpriseAppPlus
4
03/06/2015
/devices/1.0/softwareInstalled/
Existing
Return additional attribute Manage Status for
apps installed on iOS device.
5
03/06/2015
/devices/1.0/enrollDevice/
Existing
Support for specifying optional attributes while
creating
Enrollment request - enrollWithMdm,
workplacePolicy
1
06/06/2015
/devices/2.0/search/
New
Exclude Cloud Extenders by default
Enhanced version of device search API.
2
06/06/2015
/devices/1.0//locationHistory/
New
Returns location history of a device
3
06/06/2015
/devices/1.0/getGroups/
New
Returns Groups to which a device belongs to
4
06/06/2015
/devices/1.0/wipeDevice/
Existing
Support for activation lock bypass for wipe
5
06/06/2015
/devices/1.0//hideDevice/
New
Hide device action on a device
6
06/06/2015
/devices/1.0/updateDeviceCert/
New
Action to update Device Certificates issued to a
device
7
06/06/2015
/devices/1.0/searchActionHistory/
Existing
Support for optional search criteria - actionStatus,
actionBy, actionType , actionTimeFrom &
actionTimeTo
8
06/06/2015
/devices/1.0/enrollDevice/
Existing
Support for specifying custom attribute values
when creating enrollment request
9
06/06/2015
/devices/1.0/manageDeviceEnrollments/
Existing
Return custom attribute values specified for
enrollment requests
10
06/06/2015
/devices/1.0/policies/
Existing
Support for filtering by Windows Phone and
WorkPlace Persona policy
11
06/06/2015
/applications/1.0/getAppDetails
Existing
New attribute in response – appFullVersion
Support to return values for various App
attributes set for the App
12
06/06/2015
/applications/1.0/getAppDistributionByDevice/
Existing
Support for new Optional search criteria –
activeDistribution
13
06/06/2015
/applications/1.0/upgradeApp
Existing
Support for specifying App attributes
Support for maintainAsAdditionalVersion
parameter
14
06/06/2015
/applications/1.0/upgradeAppPlus/
New
New API to upgrade to Enterprise apps with
apk/ipa files greater than 50 MB
15
06/06/2015
/applications/1.0/markAsPrimary/
New
Mark a particular version of App as primary
16
06/06/2015
/applications/2.0/addITunesApp/
New
Enhanced version of addITunesApp API to support
specifying App attributes
17
06/06/2015
/applications/1.0/addIOSEnterpriseApp
Existing
Support for specifying App attributes & categories
18
06/06/2015
/applications/1.0/addIOSEnterpriseAppPlus
Existing
Support for specifying App attributes & categories
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
273
19
06/06/2015
/applications/2.0/addPlayApp/
New
Enhanced version of addPlayApp API to support
specifying App attributes
20
06/06/2015
/applications/1.0/addAndroidEnterpriseApp
Existing
Support for specifying App attributes & categories
21
06/06/2015
/applications/1.0/addAndroidEnterpriseAppPlus/
New
New API to add large android enterprise apps
greater than 50 MB
22
06/06/2015
/user/1.0/search/
Existing
Enhancement to return User custom attributes
Support for new Optional search criteria - Domain
23
06/06/2015
/user/1.0/setCustomAttributes/
New
New API to set user custom attribute values
24
06/06/2015
/devices/1.0/updateUserCert/
New
Action to update User Certificates issued to all
devices of a user
1
08/11/2015
/devices/1.0/changeRuleSet/
New
New API to assign a Compliance Ruleset for a
device
2
08/11/2015
/devices/1.0/manageDeviceEnrollments/
Existing
Support to search by phoneNumber and
phoneNumber & maaS360DeviceID in the
response
3
08/11/2015
/group-apis/group/1.0/groups/
New
Returns User & Device Groups available to the
currently logged-in
Administrator
4
08/11/2015
/user-apis/user/1.0/searchByGroup/
New
Returns users in a User Group
5
08/11/2015
/group-apis/group/1.0/distributions/
New
Returns various distributions on a User or Device
Group
6
08/11/2015
/device-apis/devices/1.0/policies/
Existing
Support for returning policies defined for OSX
MDM service
Return policy precedence as an additional
attribute
7
08/11/2015
/user-apis/user/1.0/search/
Existing
Support for filtering by authType
Return userIdentifier, authType and groupId as
additional attributes in response
8
08/11/2015
/user-apis/user/1.0/addUser/
New
Add a new Local user account in MaaS360
9
08/11/2015
/user-apis/user/1.0/editUser/
New
Edit an existing Local user account in MaaS360
10
08/11/2015
/user-apis/user/1.0/addGroups/
New
Add one or more User Groups to a Local user
account
11
08/11/2015
/user-apis/user/1.0/removeGroups/
New
Remove one or more User Groups from a Local
user account
12
08/11/2015
/user-apis/user/1.0/userAttributes/
New
Returns all user custom attributes defined for an
account
13
08/11/2015
/account-
provisioning/account/1.0/getCustomerConfig/
Existing
Return allocatedSpace & usedSpace attributes in
the response
14
08/11/2015
/account-
provisioning/account/1.0/setCustomerConfig/
Existing
Set allocatedSpace attribute for an account
15
08/11/2015
/device-apis/devices/1.0/searchActionHistory/
Existing
1. Support for returning only
Compliance Events 2. Updated
some attributes in response –
deviceId, errorDescription
16
08/11/2015
/device-
apis/devices/1.0/authenticateAdministrator
Existing
API deprecated & removed from documentation
1
10/09/2015
/devices/2.0/search/customer/
Existing
Search API V2 is released
2
10/09/2015
/devices/1.0/mdSecurityCompliance/
Existing
Added workplace persona policy and compliance
keys
3
10/09/2015
/account-
provisioning/account/1.0/getCustomerConfig/
Existing
Added support for external account IDs
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
274
4
10/09/2015
/account-
provisioning/account/1.0/setCustomerConfig/
Existing
Added support for external account IDs
5
10/09/2015
/createCustomerAccount/
Existing
Added support for external account IDs
5
10/09/2015
/applications/1.0/getAppDetails/
Existing
Added “What’s New, package update time, and
screenshot URLs
6
10/09/2015
/applications/1.0/distributeApp/
Existing
Added support for Send Notification flag
7
10/09/2015
/applications/1.0/upgradeApp/
Existing
Added support for “What’s New” information
8
10/09/2015
/applications/1.0/upgradeAppPlus/
Existing
Added support for “What’s New” information
9
10/09/2015
/devices/1.0/getEnabledMaaS360Services/
Existing
Added ability to get enabled services for a device
10
10/09/2015
/policymgmt-
apis/policies/2.0/enabledServices/customer/
Existing
Added ability to get enabled services in a Persona
Policy
11
10/09/2015
/searchCustomers/
Existing
Added ability to get the list of customers for a
Partner
12
10/09/2015
/reporting-apis/bi/1.0/getDashboards/
Existing
Get list of available customer dashboards
13
10/09/2015
/reporting-apis/bi/1.0/download/
Existing
Download the detailed report
14
10/09/2015
/reporting-apis/bi/1.0/getReportList/
Existing
Added ability to get list of reports for a specified
dashboard
1
12/10/2015
/device-apis/devices/1.0/assignUserToDevice/
New
Assigns a specified user to a device
2
12/10/2015
/applications/1.0/distributeApp/
Existing
Adds support to distribute a specific version
3
12/10/2015
/applications/1.0/upgradeApp/
Existing
Adds support to upgrade a specific version
4
12/10/2015
/account-
provisioning/account/1.0/setCustomerConfig/
Existing
Added preferred language
5
12/10/2015
/createCustomerAccount/
Existing
Added preferred language
6
12/10/2015
/device-apis/devices/1.0/summary
Existing
Added a Test Device attribute
1
09/07/2016
/account-
provisioning/accountreporting/1.0/getUserReport/
New
Get User’s Enabled Services
2
09/07/2016
/account-
provisioning/service/1.0/enableService/
New
Enable a Service for a Customer
3
09/07/2016
account-
provisioning/service/1.0/disableService/
New
Disable a Service for a Customer
4
09/07/2016
/account-
provisioning/service/1.0/getServicesInfo/
New
Get Customer’s Allowed Services
5
09/07/2016
/ciscoise/mdminfo
/ciscoise/devices
/ciscoise/batchdevices
/ciscoise/action
/ciscoise/sendmessage
New
All Cisco ISE integration APIs added
1
10/24/2016
/devices/1.0/getDeviceGroups
Existing
Deprecated API removed
1
01/27/2017
/account-provisioning/account/1.0/createCustomerAccount
/account-provisioning/account/1.0/setCustomerConfig
Existing
Added customerVertical parameter.
1
02/08/2017
/account-
provisioning/account/1.0/setPartnerAccountConfig
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
275
provisioning/account/1.0/setPartnerAccountConfi
g/1101234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/setPartnerAccountConfi
g/
1101234?partnerBillingId=1101234
&leadNotificationEmail=abc@example1.com&tria
lDuratio=75
&adminEULASettings=1&endUserReacceptEULAE
nabled=No
2
02/08/2017
/application-apis/applications/1.0/stopAppDistribution/
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/stopAppDistribution/10072
63
New Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/stopAppDistribution/10072
63?appType=
1&appId=com.example&targetDevices=0
3
02/08/2017
/device-apis/devices/1.0/getEnabledMaaS360Services/
Existing
Added new Mandatory attributes in Response:
service
4
02/08/2017
/device-apis/devices/1.0/computerNetworkInformation/
Existing
Added new Mandatory attributes in Response:
maas360DeviceID
5
02/08/2017
/device-apis/devices/1.0/sendMessage/
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/sendMessage/1101234/
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/sendMessage/1101234?deviceId
=
a1b2c3&messageTitle=message&message=hi
6
02/08/2017
/device-apis/devices/1.0/changeRuleSet/
Existing
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/changeRuleset/1001234
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/changeRuleset/1001234?deviceI
d=
androidc1a2b3c&rulesetName=foo
2. Changed parameter name.
Old parameter name: Maas360DeviceID
New parameter name: deviceId
7
02/08/2017
/application-apis/applications/1.0/distributeApp
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/distributeApp/1007263
New Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/distributeApp/
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
276
1007263?appType=1&appId=com.example&targe
tDevices
=0&instantInstall=Yes&sendEmail=yes&sendNotifi
cation
=Yes
8
02/08/2017
/application-apis/applications/1.0/markAsPrimary
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/markAsPrimary/1007263
New Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/markAsPrimary/
1007263?appType=1&appId=com.example&appV
ersion
=4.0.1
9
02/08/2017
/user-apis/user/1.0/addUser/customer
Existing
Updated Sample Request.
Old Sample Request:
POST /user-
apis/user/1.0/addUser/customer/1007463/
New Sample Request:
POST https://services.fiberlink.com/user-
apis/user/1.0/addUser/customer/1007463?userN
ame=
abc&domain=example.com&email=abc@example
.com
10
02/08/2017
/account-provisioning/account/1.0/getCustomerConfig
Existing
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/getCustomerConfig/110
1234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/getCustomerConfig/110
1234?
customerBillingId=1101235
2. Changed Mandatory attributes in Response.
Old response: customerBillingId
New response: billingId
11
02/08/2017
/account-provisioning/account/1.0/extendAccount
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/extendAccount/110123
4
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/extendAccount/110123
4?
customerBillingId=1101235
12
02/08/2017
/account-
provisioning/account/1.0/checkAccountNameAvailability
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/checkAccountNameAvai
lability/
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
277
1101234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/checkAccountNameAvai
lability/
1101234?accountName=ExampleCo
13
02/08/2017
/account-provisioning/account/1.0/expireAccount
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/expireAccount/1101234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/account/1.0/expireAccount/1101234
?
customerBillingId=1101235
14
02/08/2017
/device-apis/devices/1.0/searchByDeviceGroup/
Existing
Changed Mandatory attributes in Response.
Old response: deviceID
New response: maas360DeviceID
15
02/08/2017
/device-apis/devices/1.0/packageDistributionHistory/
Existing
Added new Mandatory attributes in Response:
maas360DeviceID
16
02/08/2017
/device-apis/devices/1.0/locationHistory/
Existing
Changed parameter name.
Old parameter name: Maas360DeviceID
New parameter name: deviceId
17
02/08/2017
/device-apis/devices/1.0/enrollDevice/
Existing
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-apis/
devices/1.0/enrollDevice/1101234/
New Sample Request:
POST https://services.fiberlink.com/device-apis/
devices/1.0/hideDevice/1101234?userName=exa
mple&
domain=example.com&emailAddress=abc@exam
ple.com
2. Changed Mandatory attributes in Response.
Old response: Passcode
New response: passcode
3. Changed parameter name.
Old parameter name: CustomAttributes
New parameter name: customAttributes
18
02/08/2017
/account-
provisioning/account/1.0/createCustomerAccount
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning
/account/1.0/createCustomerAccount/1101234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning
/account/1.0/createCustomerAccount/1101234?
accountType=Customer&accountName=
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
278
Demo
Customer1&adminEmailAddres=abc@example.co
m
Changed Mandatory attributes in Response.
Old response:
billingID,partnerBillingID,adminUsernam
New response:
billingId,partnerBillingId,adminUserName
19
02/08/2017
/account-provisioning/service/1.0/getServicesInfo
Existing
Updated Sample Request.
Old Sample Request:
GET https://services.fiberlink.com/account-
provisioning/
service/1.0/getServicesInfo/1224321
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/service/1.0/getServicesInfo/1224321
?
loggedInUserbillingId=
1224321&customerBillingId=1224321
20
02/08/2017
/device-apis/devices/1.0/approveDeviceMessagingSystem
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/approveDeviceMessagingSystem
/
1101234
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/approveDeviceMessagingSystem
/
1101234?deviceId=a1b2c3
21
02/08/2017
/device-apis/devices/1.0/selectiveWipeDevice
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/selectiveWipeDevice/1101234/
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/selectiveWipeDevice/
1101234?deviceId=a1b2c3
22
02/08/2017
/device-apis/devices/1.0/deviceActions
Existing
Changed parameter name.
Old parameter name: deviceID
New parameter name: deviceId
23
02/08/2017
/device-apis/devices/1.0/locateDevice
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/locateDevice/1101234
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/locateDevice/1101234?deviceId=
a1b2c3
24
02/08/2017
/device-apis/devices/1.0/hideDevice
Existing
Updated Sample Request.
Old Sample Request:
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
279
POST https://services.fiberlink.com/device-
apis/devices/1.0/hideDevice/1101234/
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/hideDevice/1101234?deviceId=a
2e13f
25
02/08/2017
/device-apis/devices/1.0/hardwareInventory
Existing
Changed Mandatory attributes in Response.
Old response: maas360DeviceID
New response: maas360DeviceId
26
02/08/2017
/application-apis/applications/1.0/addPlayApp
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/addPlayApp/1007263
New Sample Request:
POST https://services.fiberlink.com/application-
apis/
applications/1.0/addPlayApp/
1007263?appSourceURL=
https://play.google.com/store/apps/details?id=
org.cocos2dx.NautilusCricket2014&
removeAppMDMRemoval=Yes&removeAppSelWi
pe=
Yes&enforceAuthentication=Yes&enforceComplia
nce=Yes
27
02/08/2017
/account-
provisioning/administrator/1.0/createAdministrator
Existing
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/account-
provisioning/administrator/1.0/createAdministrat
or/
1101234
New Sample Request:
POST https://services.fiberlink.com/account-
provisioning/administrator/1.0/createAdministrat
or/
1101234?customerBillingID=1101234&adminUser
name=
abc&adminEmailAddress=abc@example.com&rol
es=
Help Desk
2. Changed Mandatory attributes in Response.
Old response: customerBillingID
New response: customerBillingId
28
02/08/2017
/application-apis/applications/1.0/deleteApp
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/application-
apis/applicatio
ns/1.0/deleteA
pp/1007263
New Sample Request:
POST https://services.fiberlink.com/application-
apis/applications/1.0/deleteApp/1007263?appTy
pe=
1&appId=com.example
29
02/08/2017
/device-apis/devices/1.0/blockDeviceMessagingSystem
Existing
Updated Sample Request.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
280
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/blockDeviceMessagingSystem/1
101234/
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/blockDeviceMessagingSystem/
1101234?deviceId=a2e13f
30
02/08/2017
/device-apis/devices/1.0/revokeSelectiveWipe
Existing
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/revokeSelectiveWipe/1101234/
New Sample Request:
POST https://services.fiberlink.com/device-
apis/devices/1.0/revokeSelectiveWipe/1101234?d
eviceId=
a1b2c3
31
02/08/2017
/application-apis/applications/2.0/addPlayApp
Existing
Updated Sample Request to:
POST https://services.fiberlink.com/application-
apis/applications/2.0/addPlayApp/customer/1007
263
1
02/09/2017
/device-apis/devices/1.0/updateCert
/user-apis/user/1.0/updateUserCert
Existing
Added Parameter Type (Path/Query/Form) to
Parameters table.
1
03/02/2017
/account-provisioning/service/1.0/getServicesInfo
Existing
Updated sample response with new tag <status>
that determines whether the service is enabled or
disabled.
1
03/24/2017
/application-apis/macApps/2.0/addMacAppStoreApp/customer
New
New API: Add Mac App Store App
2
03/24/2017
/application-
apis/winApps/2.0/addWindowsDependency/customer
New
New API: Add Windows Dependency
3
03/24/2017
/application-
apis/winApps/2.0/addWindowsEnterpriseApp/customer
New
New API: Add Windows Enterprise App
4
03/24/2017
/application-
apis/winApps/2.0/addWindowsEnterpriseEXEApp/customer
New
New API: Add Windows EXE App
5
03/24/2017
/application-
apis/winApps/2.0/addWindowsEnterpriseMSIApp/customer
New
New API: Add Windows MSI App
6
03/24/2017
/application-apis/winApps/2.0/addWinStoreApp/customer
New
New API: Add Windows Store App
7
03/24/2017
/application-
apis/winApps/2.0/deleteWindowsDependency/customer
New
New API: Delete Windows Dependency
8
03/24/2017
/application-
apis/winApps/2.0/downloadWindowsDependency/customer
New
New API: Download Windows Dependency
9
03/24/2017
/application-apis/applications/2.0/getCategoryList/customer
New
New API: Get Category List
10
03/24/2017
/application-
apis/applications/2.0/markAppAsFeatured/customer
New
New API: Mark App as Featured
11
03/24/2017
/application-apis/applications/1.0/getAppDetails
Existing
Added appVersionState and rawManifestUrl
parameters in response.
12
03/24/2017
/application-apis/applications/1.0/search
Existing
Added appVersionState, appIconFullURL, and
appFullVersion parameters in response.
1
04/10/2017
/device-apis/devices/1.0/changeDevicePolicy
Existing
Updated policyName parameter description.
Parameter now supports a persona policy for
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
281
both iOS and Android devices in mixed mode or
SPS.
1
04/18/2017
/device-apis/devices/2.0/searchActionHistory
Existing
Added version 2 for Search Action History API.
2
04/18/2017
/device-apis/devices/1.0/changeDevicePolicy
Existing
Added Persona Policy device support to action
definition for Change Device Policy API.
1
06/28/2017
• Get Distributions: /group-apis/group/1.0/distributions/
/customer/<billingId>/group/<groupIdentifier>/type/<distT
ype>
• Get Admin Login Reports: /account-provisioning-
ws/administrator/1.0/getAdminLoginReports/customer/<bi
llingId>
• Get Roles Audit: /account-
provisioning/roles/1.0/getRolesAudit/customer/<billingId>
• Get Services Audit: /account-
provisioning/service/1.0/getServicesAudit/customer/<billin
gId>
• Get Deployment Settings Audit: /account-
provisioning/settings/1.0/getDeploymentSettingsAudit/cus
tomer/<billingId>
• Get Login Settings Audit: /account-
provisioning/settings/1.0/getLoginSettingsAudit/customer/
<billingId>
• Get Notifications Settings Audit: /account-
provisioning/settings/1.0/getNotificationsSettingsAudit/cus
tomer/<billingId>
New
Added QRadar integration APIs for 10.62 platform
release.
1
07/26/2017
• Provision New Customer Account: /account-
provisioning/account/1.0/createCustomerAccount/
<billingID>
• Get Customer Account Configuration: /account-
provisioning/account/1.0/getCustomerConfig/
<billingID>
• Set Customer Account Configuration: /account-
provisioning/account/1.0/setCustomerConfig/
<billingID>
• Provision New Partner Account: /account-
provisioning/account/1.0/createPartnerAccount/
<billingID>
Existing
Added support for optional country parameter.
2
07/26/2017
Create New Device Custom Attribute: /device-
apis/devices/2.0/customAttributes/customer/<billingId>
New
Added new device web service for 10.63 platform
release.
3
07/26/2017
• Create Device Groups: /group-
apis/group/2.0/deviceGroups/customer/<billing_id>
• Create User Groups: /group-
apis/group/2.0/userGroups/customer/<billing_id>
• Get Search Criteria Options: /group-
apis/group/2.0/searchCriteria/customer/<billing_id>
New
Added new group web services for 10.63 platform
release.
4
07/26/2017
Create Alert: /alert-apis/alerts/2.0/alerts/customer/<billing_id>
New
Added new group web service for 10.63 platform
release under new Alerts category.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
282
5
07/26/2017
• Get GA or Beta Version Details of Mac Apps: /mac-
apis/mac-app-
services/v1/generic/customer/{billing_id}/macAppVersions
/{APPS_REQUIRED}
• Get Download Loaction of Mac Apps: /mac-apis/mac-app-
services/v1/generic/customer/{billing_id}/macApp/{AGENT
_TYPE}/download?manifestOnly=false
New
Added new Mac web services for 10.63 platform
release under new Platform-Specific APIs – Mac
APIs category.
6
07/26/2017
/account-
provisioning/account/1.0/searchCustomers/<partnerBillingId>
Existing
Replaced corporateID parameter with corporateId.
1
08/07/2017
/device-apis/devices/1.0/enrollDevice/<billingID>
Existing
Added new optional parameter:
authTypePostEnrollment
1
08/10/2017
Changed IBM QRadar Integration heading to Admin
Audit
1
08/17/2017
/device-
apis/devices/2.0/customAttributes/customer/<billingID>
Added new Device Actions web service for 10.64
platform release: Get All Device Custom
Attributes for a Given Organization
1
08/24/2017
• Delete User Review and Update Rating: /application-
apis/applications/2.0/deleteReview/customer/<billingId>
• List Featured Apps and Bundles Info: /application-
apis/applications/2.0/deleteReview/customer/<billingId>
• List App Bundles with their Apps Info: /application-
apis/applications/2.0/getAppBundlesWithApps/customer/<
billingId>
• Fetch All the Reviews: /application-
apis/applications/2.0/getAllReviews/customer/<billingId>
Added new App Catalog web services for 10.64
platform release.
1
09/25/2017
Extend Trial Account: /account-
provisioning/account/1.0/extendAccount/<billingId>
Existing
Added support for expired accounts and changed
the values of the days parameter.
2
09/25/2017
• Delete User: user-
apis/user/2.0/users/customer/<billingId>/user/<userIdenti
fier>
• Delete User Status: user-
apis/user/2.0/deleteUserStatus/customer/<billingId>/user/
<userIdentifier>
New
Added new User web services for 10.64 platform
release.
3
09/25/2017
• Get Partner Account Configuration: /account-provisioning/
account/1.0/getPartnerAccountConfig/<billingId>
• Set Partner Account Configuration: /account-provisioning/
account/1.0/setPartnerAccountConfig/<billingId>
Existing
Added new parameter: country
4
09/25/2017
Create Device Enrollment: /device-apis/
devices/1.0/enrollDevice/<billingID>
Existing
Added two new parameters for Android for Work
enrollment: useAndroidWork and
androidWorkAccountType
1
10/04/2017
Enable a Service for a Customer: /account-
provisioning/service/1.0/enableService/
<billingID>?<serviceKey>&<customerBillingId>
Existing
• Removed DTM_C from Parent Service key
column for the following service keys: MAC ,
WINDOWS_DTM_C , UNIX, MAC_V, DV
• Added WINDOWS_DTM_C as a parent for
the following service keys:
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
283
• Disable a Service for a Customer: /account-
provisioning/service/1.0/disableService/
<billingID>?<serviceKey>&<customerBillingId>
• Get Customer’s Allowed Services: /account-
provisioning/service/1.0/getServicesInfo/<
loggedInUserbillingId>?<parameters>
INT_DTM_LOCATE_C, INT_DTM_BIGFIX_C,
WINDOWS_ENROLLMENT_MODE
1
01/02/2018
Set Device Name: /device-
apis/devices/1.0/setDeviceName/<billingID>
Existing
Changed API type from GET to POST.
1
01/03/2018
Search Devices by Device Group: /device-
apis/devices/1.0/searchByDeviceGroup/<billingID>
Existing
Added two new parameters: sortAttribute and
sortOrder.
1
02/01/2018
Get Network Information for a Mobile Device: /device-
apis/devices/1.0/mdNetworkInformation/<billingID>
Existing
Added Current MCC, Subscriber MCC, Current
MNC, Subscriber MNC to the sample response.
2
02/01/2018
• Basic Search (v1): /device-
apis/devices/1.0/search/<billingID>
• Basic Search (v2): /device-
apis/devices/2.0/search/customer/<billingID>
Existing
Added isSupervisedDevice to the sample
response.
3
02/01/2018
Wipe Device: /device-apis/devices/1.0/wipeDevice/<billingID>
Existing
Added a new parameter to request:
preserveDataPlan
1
02/13/2018
Get Cellular Data Usage for a Device: /device-
apis/devices/1.0/cellularDataUsage/<billingID>
Existing
Updated sample response with correct version
that uses decimals in integer values.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
284
Notices
This information was developed for products and services that are offered in the USA.
IBM may not offer the products, services, or features discussed in this document in other countries. Consult
your local IBM representative for information on the products and services currently available in your area.
Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product, program, or service that
does not infringe any IBM intellectual property right may be used instead. However, it is the user's
responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document.
The furnishing of this document does not grant you any license to these patents. You can send license
inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
United States of America
For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual
Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer
of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made
to the information herein; these changes will be incorporated in new editions of the publication. IBM may
make improvements and/or changes in the product(s) and/or the program(s) described in this publication at
any time without notice.
Any references in this information to non-IBM websites are provided for convenience only and do not in any
manner serve as an endorsement of those websites. The materials at those websites are not part of the
materials for this IBM product and use of those websites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the
exchange of information between independently created programs and other programs (including this one)
and (ii) the mutual use of the information which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758 U.S.A.
Such information may be available, subject to appropriate terms and conditions, including in some cases,
payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by
IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any
equivalent agreement between us.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
285
Any performance data contained herein was determined in a controlled environment. Therefore, the results
obtained in other operating environments may vary significantly. Some measurements may have been made
on development-level systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been estimated through
extrapolation. Actual results may vary. Users of this document should verify the applicable data for their
specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their published
announcements or other publicly available sources. IBM has not tested those products and cannot confirm
the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on
the capabilities of non-IBM products should be addressed to the suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice,
and represent goals and objectives only.
This information is for planning purposes only. The information herein is subject to change before the
products described become available.
This information contains examples of data and reports used in daily business operations. To illustrate them
as completely as possible, the examples include the names of individuals, companies, brands, and products.
All of these names are fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming
techniques on various operating platforms. You may copy, modify, and distribute these sample programs in
any form without payment to IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating platform for which the
sample programs are written. These examples have not been thoroughly tested under all conditions. IBM,
therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising
out of your use of the sample programs.
© Copyright IBM Corp. 2018. All rights reserved.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be
trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at
www.ibm.com/legal/copytrade.shtml.
Cloud Extender™, Control360®, Fiberlink®, MaaS360®, MaaS360 PRO™, MI360™, Mobile NAC®,
Mobile360®, Secure Productivity Suite™, Simple. Secure. Mobility.®, Trusted Workplace™, and
Visibility360® are trademarks or registered trademarks of International Business Machines Corporation.
Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registered trademarks or trademarks
of Adobe Systems Incorporated in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the
United States, other countries, or both.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
286
Terms and conditions for product documentation
Permissions for the use of these publications are granted subject to the following terms and conditions.
Personal use
You may reproduce these publications for your personal, noncommercial use provided that all proprietary
notices are preserved. You may not distribute, display or make derivative work of these publications, or any
portion thereof, without the express consent of IBM.
Commercial use
You may reproduce, distribute and display these publications solely within your enterprise provided that all
proprietary notices are preserved. You may not make derivative works of these publications, or reproduce,
distribute or display these publications or any portion thereof outside your enterprise, without the express
consent of IBM.
Rights
Except as expressly granted in this permission, no other permissions, licenses or rights are granted, either
express or implied, to the publications or any information, data, software or other intellectual property
contained therein.
IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use of the
publications is detrimental to its interest or, as determined by IBM, the above instructions are not being
properly followed.
You may not download, export or re-export this information except in full compliance with all applicable laws
and regulations, including all United States export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THE
PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
© Copyright IBM Corp. 2018. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.
287

Navigation menu