Maa S360 Webservices Reference Guide V10.67

User Manual:

Open the PDF directly: View PDF .
Page Count: 287

Download
Open PDF In Browser	View PDF

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.

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.

2

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.

3

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.

4

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.

5

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.

6

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.

7

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: <>

•

Administrator Username: <>

•

Administrator Password: <>

•

App ID (for App authorized to use MaaS360 services): <>

•

App Version: <>

•

Platform ID: 3 <>

•

App Access Key: <>

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.

8

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.

9

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.
10
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
11
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device View to Platform Matrix
Methods

Windows

Mac

ActiveSync
Devices

Traveler
Devices

BlackBerrys

iOS MDM

Android
MDM

Windows
Phone

Basic Search

X

X

X

X

X

X

X

X

Get Core Attributes

X

X

X

X

X

X

X

X

Get Summary Attributes

X

X

X

X

X

X

X

X

Get Hardware Inventory

X

X

X

X

X

X

X

X

Get Device Identity Attributes

X

X

X

X

X

X

X

X

Get Software Installed

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

Get Location History

X

X

X

Get Cellular Data Usage for a

X

X

X

X

X

Get Security & Compliance

X

Information for a Mobile Device
Get Enabled MaaS360 Services for
a Device

X

Get Network Information for a
Mobile Device
Get Patch Information for a

X

X

X

X

X

X

Computer
Get Network Information for a
Computer
Get Security Applications
Information
Get Application Distributions

X

Device
Get Devices with Associated
Users

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

Get Groups for a Device
Get Relevant Data Views for a
Device
Get Relevant Actions for a Device
Set Device Name

© Copyright IBM Corp. 2018. All rights reserved.
12
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device Actions to Platform Matrix
Methods

Windows

Mac

ActiveSync
Devices

Traveler
Devices

BlackBerrys

iOS MDM

Android
MDM

Windows
Phone
MDM

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

Refresh Device Information

X

X

X

X

X

X

X

X

X

X

X

X

Lock Device
Reset Device Passcode
Change Device Policy

X

Change Compliance Ruleset

X

X

X

X

Update Device Certificate

X

X

X

X

Selective Wipe Device

X

X

X

Revoke Selective Wipe

X

X

X

Wipe Device

X

X

X

X

X

X

Cancel Pending Wipe

X

X

X

X

X

X

Approve Device in Messaging

X

X

X

X

X

X

X

X

X

X

X

X

X

System
Block Device in Messaging System
Remove Device

X

X

Remove Device from Mailbox
Server
Hide Device

X

X

X

X

X

X

X

X

Check Action Status

X

X

X

X

X

X

X

X

Search Action History

X

X

X

X

X

X

X

X

© Copyright IBM Corp. 2018. All rights reserved.
13
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device
Basic Search (v1)
Request
GET /device-apis/devices/1.0/search/
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
deviceStatus
partialDeviceName

Required /
Optional
Optional
Optional

partialUsername

Optional

partialPhoneNumber

Optional

udid
imeiMeid
wifiMacAddress
mailboxDeviceId
excludeCloudExtenders
platformName

Optional
Optional
Optional
Optional
Optional
Optional

operator

Optional

match

Optional

pageSize

Optional

pageNumber

Optional

billingID

Required

sortAttribute

Optional

sortOrder

Optional

Description
Active or Inactive
Partial (Starts with) or full Device Name string that
needs to be searched for
Partial (Starts with) or full Username string that needs
to be searched for
Partial (Starts with) or full Phone Number that needs to
be searched for
Full UDID of the device. Specific to iOS devices
Full IMEI or MEID of the device
Full Wi-Fi Mac Address of the device
Full ActiveSync ID of the device
Possible values: Yes (Default), No
Windows
Mac
iOS
BlackBerry
Android
Windows Mobile
Symbian
Windows Phone 7
Others
Operator to be used between various criteria. Default
value = “AND”
0 indicates Partial match for Device Name, Username,
Phone Number – This is the default value
1 indicates Exact match
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular page. Default is first
page
Billing ID of the account for which the web-service is
being executed
Possible values:
lastReported (Default)
installedDate
Possible values:
asc
dsc (Default)

© Copyright IBM Corp. 2018. All rights reserved.
14
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Request
https://services.fiberlink.com/deviceapis/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


ApplF17R9GAGGRY5
iPhone

Corporate Owned

vinayaknp
vinayaknp@in.ibm.com
iOS
1
Smartphone
Apple
iPhone 6S
iOS 11

355763072568722
2017-12-08T07:53:53
2017-12-08T07:53:54
1512719633199
1512719634449
Active
Enrolled
647f87aaa8a9ede2cdf6773e886b18067232fbf5
e4:9a:79:d7:0e:06




false
false
3UV2UD4GP564N3T67UD4AG50AS

1
1
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

© Copyright IBM Corp. 2018. All rights reserved.
15
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Access Control
Customer Properties: Enable Device View
Access Rights: Device View - View Only

© Copyright IBM Corp. 2018. All rights reserved.
16
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Basic Search (v2)
Request
GET /device-apis/devices/2.0/search/customer/
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
deviceStatus
partialDeviceName
partialUsername
partialPhoneNumber
udid
imeiMeid
wifiMacAddress
mailboxDeviceId
platformName

Required /
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

excludeCloudExtenders
maas360DeviceId

Optional
Optional

userDomain
email
maas360ManagedStatus

Optional
Optional
Optional

mailBoxManaged

Optional

mdmMailboxDeviceId

Optional

plcCompliance
ruleCompliance
appCompliance

Optional
Optional
Optional

Description
Active or Inactive
Partial (Starts with) or full Device Name string
Partial (Starts with) or full Username string
Partial (Starts with) or full Phone Number
Full UDID of the device. Specific to iOS devices
Full IMEI or MEID of the device
Full Wi-Fi Mac Address of the device
Full ActiveSync ID of the device
Windows
Mac
iOS
BlackBerry
Android
Windows Mobile
Symbian
Windows Phone 7
Others
Possible values: Yes (Default), No
Full MaaS360 Device ID string that needs to be searched
for
Full User domain string that needs to be searched for
Full Email address string that needs to be searched fo
Possible values:
Inactive
Activated
Control Removed
Pending Control Removed
User Removed Control
Not Enrolled
Enrolled
Possible values:
ActiveSync
Domino
BES
GmailSync
RPAS
Full ActiveSync Device ID of the device reported by
MDM
Possible values: OOC, ALL (Default)
Possible values: OOC, ALL (Default)
Possible values: OOC, ALL (Default)

© Copyright IBM Corp. 2018. All rights reserved.
17
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

pswdCompliance
selectiveWipe
installedAfter
lastReportedAfter
operator

Optional
Optional
Optional
Optional
Optional

match

Optional

pageSize

Optional

pageNumber

Optional

billingID

Required

sortAttribute

Optional

sortOrder

Optional

Possible values: OOC, ALL (Default)
Possible values: NOTAPPLIED, PENDING, COMPLETE
Installed date after
Last reported date after
Operator to be used between various criteria. Default
value = “AND”
0 indicates Partial match for Device Name, Username,
Phone Number – This is the default value
1 indicates Exact match
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 250
Results specific to a particular page. Default is first
page
Billing ID of the account for which the web-service is
being executed
Possible values:
lastReported (Default)
installedDate
Possible values:
asc
dsc (Default)

Sample Request
https://services.fiberlink.com/deviceapis/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.
18
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

"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.
19
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Core Attributes
Request
GET /device-apis/devices/1.0/core/
Definition
❖ Get core attributes of a device
❖

Uses MaaS360 Device ID (CSN) of the device for querying

Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/core/1101234?deviceId=a2e13f
Sample Response

a2e13f
BBFLLT3337
09026
Employee Owned
Stephen Murphy
smurphy
smurphy@example.com
Windows
1
Laptop
Lenovo
T400
Microsoft Windows XP
SP2
3456789019202019
09:AB:12:12:21:13
8e380a56a937cce81620b143359d3404498dd638
ApplCCQK66E7F4JR
2010-11-30T05:52:53.011+00:00
2010-11-30T05:52:53.011+00:00
Active
Not Enrolled
ActiveSync Managed
Appl1234567
2010-11-30T05:52:53.011+00:00

Mandatory attributes in Response
maas360DeviceID
deviceName
username
platformName
deviceType
lastReported
deviceStatus

© Copyright IBM Corp. 2018. All rights reserved.
20
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only

© Copyright IBM Corp. 2018. All rights reserved.
21
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Summary Attributes
Request
GET /device-apis/devices/1.0/summary/
Definition
❖ Get summary attributes of a device
❖

Uses MaaS360 Device ID (CSN) of the device for querying

Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/summary/1101234?deviceId=a2e13f
Sample Response

a2e13f


isOnline
Boolean
Yes




Mandatory attributes in Response
maas360DeviceId
key
type
Various Device Attributes
Platform = 1 (Windows)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Physical Memory
Installed (MB)
Free Space On
System Drive(%)
Operating System
Office/Location

String
String
Integer

IBM
ThinkPad T42
1024

Hardware
Hardware
Hardware

10
20
30

Percentage

64.97 %

Hardware

40

String
String

Microsoft Windows XP
Bangalore

Hardware
Hardware

50
60

Anti-Virus Status
Anti-Virus Definition
Date
Anti-Spyware Status
Personal Firewall
Status

String
Date

Not Detected
2010-12-30

Security
Security

10
20

String
String

Not Detected
Not Detected

Security
Security

30
40

© Copyright IBM Corp. 2018. All rights reserved.
22
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Encryption Status
Last Backup
Microsoft AutoUpdate Status
Missing Critical
Security Patches

String
Date
String

Not Detected
2010-12-30
Disabled

Security
Security
Security

50
60
70

Integer

10

Security

80

Service Package
Installed Date (GMT)

String
Timestamp

Operational Visibility
2010-1130T05:52:53.011+00:00

MaaS360 Services
MaaS360 Services

10
20

Platform = 2 (Mac)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Physical Memory
Installed (MB)
Free Space On
System Drive(%)
Operating System
Office/Location

String
String
Integer

IBM
ThinkPad T42
1024

Hardware
Hardware
Hardware

10
20
30

Percentage

64.97 %

Hardware

40

String
String

Microsoft Windows XP
Bangalore

Hardware
Hardware

50
60

Service Package
Installed Date (GMT)

String
Timestamp

Operational Visibility
2010-1130T05:52:53.011+00:00

MaaS360 Services
MaaS360 Services

10
20

Source = 2 & Any Platform value
Key

Type

Example Value

Display Section

Display Order

Installed Date
(GMT)
Email Address
Manufacturer
Model
Operating System
Default Language
ActiveSync Agent
ActiveSync Device
ID

Timestamp

2010-11-30T05:52:53.011+00:00

Hardware

10

String
String
String
String
String
String
String

smurphy@example.com
IBM
ThinkPad T42
Microsoft Windows XP
Bangalore
RoadSync-Android/2.502
354957034059348

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

20
30
40
50
60
70
80

Exchange Approval
State
Remote Wipe
Support
Device Wiped

String

Quarantined

10

String

Yes

String

Pending

Last Wipe Applied
Date (GMT)
Exchange
ActiveSync Policy
Last Policy Updated
Date (GMT)
Device Passcode
Status

Timestamp

2010-11-30T05:52:53.011+00:00

String

9.3 Exchange

Timestamp

2010-11-30T05:52:53.011+00:00

String

Passcode Policy Not Configured

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40
50
60
70

Source = 1 or 3 & Platform = 3 (iOS)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Operating System
Free Internal
Storage (GB)

String
String
String
Integer

Apple
iPhone 3Gs
iOS4
10.25

Hardware
Hardware
Hardware
Hardware

10
20
30
40

© Copyright IBM Corp. 2018. All rights reserved.
23
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Apple Serial
Number
Ownership
Exchange Activated
Email Address

String

86019B093NQ

Hardware

50

String
String
String

Corporate Owned
Yes
smurphy@example.com

Hardware
Hardware
Hardware

60
70
80

Phone Number

String

09742040039

10

ICCID

String

8991 8600 4420 2837 752

Roaming

String

No

International Data
Roaming Enabled
Home Carrier

String

Enabled

String

Vodafone

Current Carrier

String

Vodafone

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

MDM Policy

String

General Policy - vipin (5)

10

Device Passcode
Status
Hardware
Encryption
Exchange Approval
State

String

Compliant

String

Block-level & File-level

String

Approved

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40
50
60

20
30
40

Source = 4 (BES)
Key

Type

Example Value

Display Section

Display Order

PIN
Model
Operating System
Version
Ownership
Test Device
Email Address

String
String
String

22100AB1
Curve 8900
6.0.0.284

Hardware
Hardware
Hardware

10
20
30

String
Boolean
String

Corporate Owned
Yes
smurphy@example.com

Hardware
Hardware
Hardware

40
45
50

Phone Number

String

09742040039

10

ICCID

String

8991 8600 4420 2837 752

Home Carrier

String

Vodafone

Current Carrier

String

Vodafone

Network
Information
Network
Information
Network
Information
Network
Information

Last Time Message
Received by Device
Last Time Message
Sent from Device

Timestamp

2010-11-30T05:52:53

10

Timestamp

2010-11-30T05:52:53

Messaging
History
Messaging
History

BES Policy Name

String

General Policy - vipin (5)

10

Policy Compliance
State
Device Passcode
Status
User-Device
Configuration

String

In-Compliance

String

Compliant

String

Default Configuration

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40

20

20
30
40

Source = 1 or 3 and Platform = 5 (Android)
Key

Type

Example Value

Display Section

Display Order

© Copyright IBM Corp. 2018. All rights reserved.
24
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Manufacturer
Model
Operating System
Total Free Storage
(GB)
Device Serial
Number
Ownership
Test Device
Exchange Activated
Email Address

String
String
String
Integer

Apple
iPhone 3Gs
iOS4
10.25

Hardware
Hardware
Hardware
Hardware

10
20
30
40

String

86019B093NQ

Hardware

50

String
Boolean
String
String

Corporate Owned
Yes
Yes
smurphy@example.com

Hardware
Hardware
Hardware
Hardware

60
65
70
80

Phone Number

String

09742040039

10

SIM

String

8991 8600 4420 2837 752

Roaming

String

No

International Data
Roaming Enabled
Home Carrier

String

Enabled

String

Vodafone

Current Carrier

String

Vodafone

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

MDM Policy

String

General Policy - vipin (5)

10

Policy Compliance
State
Device Rooted

String

In-Compliance

String

No

Background Data
Sync Enabled
Device Passcode
Status
Exchange Approval
State

String

No

String

Compliant

String

Approved

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40
50
60

20
30
40
50
60

Source = 1 or 3 and Platform = 7 (Symbian)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Operating System
Total Free Storage
(GB)
Device Serial
Number
Ownership
Test Device
Exchange Activated
Email Address

String
String
String
Integer

Apple
iPhone 3Gs
iOS4
10.25

Hardware
Hardware
Hardware
Hardware

10
20
30
40

String

86019B093NQ

Hardware

50

String
Boolean
String
String

Corporate Owned
Yes
Yes
smurphy@example.com

Hardware
Hardware
Hardware
Hardware

60
65
70
80

Phone Number

String

09742040039

10

SIM

String

8991 8600 4420 2837 752

Roaming

String

No

International Data
Roaming Enabled
Home Carrier

String

Enabled

String

Vodafone

Current Carrier

String

Vodafone

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

20
30
40
50
60

© Copyright IBM Corp. 2018. All rights reserved.
25
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device Passcode
Status
Hardware
Encryption
Data Backup
Enabled

String

Compliant

String

No

String

No

Security &
Compliance
Security &
Compliance
Security &
Compliance

10
20
30

Access Control
- Customer Properties: Enable Device View
- Access Rights: Device View - View Only

© Copyright IBM Corp. 2018. All rights reserved.
26
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Hardware Inventory
Request
GET /device-apis/devices/1.0/hardwareInventory/
Definition
❖ Get hardware inventory attributes of a device
❖

Uses MaaS360 Device ID (CSN) of the device for querying

Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/hardwareInventory/1101234?deviceId=a2e13f
Sample Response

a2e13f


Manufacturer
String
Dell Inc



Mandatory attributes in Response
maas360DeviceId
key
type
Various Device Attributes
Platform = 1 (Windows)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Model ID
Device Type
Motherboard Serial
Number
BIOS Serial Number
BIOS Date
Processor

String
String
String
String
String

IBM
ThinkPad T42
Latitude E5500
Laptop
.2F5NXG1.CN7016695D0003.

Hardware
Hardware
Hardware
Hardware
Hardware

10
20
30
40
50

String
Date
String

Hardware
Hardware
Hardware

60
70
80

Physical Memory
Installed (MB)
WMI Status
Test Device
OS Username
User Access Level

Integer

2F5NXG1
30/07/2010
Intel(R) Core(TM)2 Duo CPU
T9550 @ 2.66GHz
4 GB

Hardware

90

String
String
String
String

Running
No
Jdoe
Administrator

Hardware
Hardware
Hardware
Hardware

100
110
120
130

© Copyright IBM Corp. 2018. All rights reserved.
27
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

CD/DVD Name

String

Hardware

140

Hardware

150

Integer
Float

HL-DT-ST DVD+-RW GT10N ATA
Device
(UTC-05:00) Eastern Time (US
& Canada)
2
160

Local Timezone

String

Number of Drives
Total Drive Size
(GB)
Total Free Space
(GB)

Hardware
Hardware

160
170

Float

25

Hardware

180

Operating System
OS Edition
Service Pack
OS Architecture
Version
Default OS Language
Microsoft AutoUpdate Status

String
String
String
String
String
String
String

Microsoft Windows 7
Enterprise Edition
SP1
32 bit
6.1.7600
English - United States
Automatically download and
install patches

Operating
Operating
Operating
Operating
Operating
Operating
Operating

Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Model ID
Device Type
Boot Rom Version
SMC Version
Manufactured Date
Apple Serial Number
UDID

String
String
String
String
String
String
Date
String
String

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

10
20
30
40
50
60
70
80
90

Processor
Physical Memory
Installed (MB)
OS Username
User Access Level
Local Timezone

String
Integer

Apple
MacBook Pro
MacBook Pro 4,1
Laptop
MBP41.00c1.b03
1.27f2
2/10/2009
W88341H6YJX
9D86CFF6-5FD8-5E49-81C3BD1F7BEB5947
2000 MHz Core 2
2048

Hardware
Hardware

100
110

Hardware
Hardware
Hardware

120
130
140

Number of Drives
Total Drive Size (GB)
Total Free Space
(GB)

Integer
Float
Float

Jdoe
Administrator
(GMT+5:30) Chennai, Kolkata,
Mumbai, New Delhi
2
160
25

Hardware
Hardware
Hardware

150
160
170

Operating System
OS Architecture
Version
Default OS Language

String
String
String
String

Mac OS X Leopard
32 bit
10.5.1
English - United States

Operating
Operating
Operating
Operating

System
System
System
System
System
System
System

10
20
30
40
50
60
70

Platform = 2 (Mac)

String
String
String

System
System
System
System

10
20
30
40

Source = 2 & Any Platform value
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Device Type
Operating System
Default Language
ActiveSync Agent
ActiveSync Device
ID

String
String
String
String
String
String
String

IBM
ThinkPad T42
Smartphone
Microsoft Windows XP
Bangalore
RoadSync-Android/2.502
354957034059348

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

10
20
30
40
50
60
70

Example Value

Display Section

Display Order

Source = 1 or 3 & Platform = 3 (iOS)
Key

Type

© Copyright IBM Corp. 2018. All rights reserved.
28
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Manufacturer
Model
Model ID
Device Type
Email Address
Apple Serial
Number
UDID
Operating System
Operating System
Version
Modem Firmware
Version
Activation Date
(GMT)
Total Internal
Storage (GB)
Free Internal
Storage (GB)
Application Data
(GB)

String
String
String
String
String
String

Apple
iPhone 3Gs
MC610LL
Smartphone
jballengee@maas360dz.com
830340GWA4T

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

10
20
30
40
50
60

String
String
String

2a7e5207dc46949bdbe
iOS4
4.2.1 (8C148)

Hardware
Hardware
Hardware

70
80
90

String

03.10.01

Hardware

100

Timestamp

17/12/2010 20:33

Hardware

110

Float

29.06 GB

Hardware

120

Float

10.25

Hardware

130

Float

372 MB

Hardware

140

Source = 1 or 3 and Platform = 5 (Android)
Key

Type

Example Value

Display Section

Display Order

Manufacturer
Model
Device Type
Device Serial
Number
Email Address
Processor Name
Processor Speed
Number of
Processor Cores
RAM (MB)
Total Internal
Storage (GB)
Free Internal
Storage (GB)
Total External
Storage (GB)
Free External
Storage (GB)
Application Data
(MB)
Screen Resolution
Screen Language
Screen Width
Battery Level
Battery Condition
Timezone

String
String
String
String

Samsung
SCH-I800
Smartphone
ABCDEFGH

Hardware
Hardware
Hardware
Hardware

10
20
30
40

String
String
String
String

vhetrick@maas360dz.com
ARM
1 Ghz
2

Hardware
Hardware
Hardware
Hardware

50
60
70
80

Float
Float

500
10

Hardware
Hardware

90
100

Float

5

Hardware

110

Float

30

Hardware

120

Float

5

Hardware

130

Float

1010

Hardware

140

String
String
Float
Float
String
String

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

150
160
170
180
190
200

Operating System
Operating System
Version
Kernel Version

String
String

600*1024
English
7.0
50%
Good
GMT-05:00, Eastern Standard
Time
Android 2.2 (FROYO)
2.2

Operating System
Operating System

10
20

Operating System

30

API Level
Baseband Version
Build Number

String
String
String

2.6.32.9 root@sep-40 #3 Tue Oct
12 21:33:42 KST 2010
8
S:I800.0.3V.DJ11
FROYO.DJ11

Operating System
Operating System
Operating System

40
50
60

String

Source = 4 (BES)
Key

Type

Example Value

Display Section

Display Order

© Copyright IBM Corp. 2018. All rights reserved.
29
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Manufacturer
Model
Device Type
PIN
Email Address
Operating System
Operating System
Version
Software Platform
Version
Secured Boot ROM
Total Memory (MB)
Available Memory
(MB)
Activation Date
(GMT)
Screen Resolution
Screen Language
Battery Level (%)

String
String
String
String
String
String
String

22100AB1
Curve 8900
Smartphone
22100AB1
smurphy@example.com
BlackBerry 6
6.0.0.284

Hardware
Hardware
Hardware
Hardware
Hardware
Hardware
Hardware

10
20
30
40
50
60
70

String

6.4.0.120

Hardware

80

String
String
String

Yes
512
32

Hardware
Hardware
Hardware

90
100
110

Timestamp

2010-11-30T05:52:53

Hardware

120

String
String
Integer

320 * 480
EN (US)
39

Hardware
Hardware
Hardware

130
140
150

Access Control
-

-

Customer Properties: Enable Device View
Access Rights: Device View - View Only

© Copyright IBM Corp. 2018. All rights reserved.
30
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Device Identity Attributes
Request
GET /device-apis/devices/1.0/identity/
Definition

❖ Get all predefined Device identity attributes as well as custom attributes of a device.
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/identity/1101234?deviceId=a2e13f
Sample Response

a2e13f
BL1200
Jim James
Corporate Owned
Staples Inc
100May2010
Direct
02/01/2009
100
10001
02/01/2011
24*7
Blue Bell
Sales


Business Unit
Healthcare


”Some comments come here”

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.
31
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Software Installed
Request
GET /device-apis/devices/1.0/softwareInstalled/
Definition
❖ Get softwares installed for a device
❖

Uses MaaS360 Device ID (CSN) of the device for querying

Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/softwareInstalled/1101234?deviceId=a2e13f
Sample Response

a2e13f
2010-11-30T05:52:53.011+00:00

Angry Birds


Application ID
String
com.angrybirds.com
10




Mandatory attributes in Response
maas360DeviceID
lastSoftwareDataRefreshDate
swName
key
type
value
Various Software Attributes
Platform = 1 (Windows)
Key

Type

Example Value

Application Vendor
Full Version
Installed Date

String
String
Date

Adobe
10.1
05/15/2010

Type

Example Value

Platform = 2 (Mac)
Key

© Copyright IBM Corp. 2018. All rights reserved.
32
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
Version
File Size
AppDataSize
Manage Status

String
String
Float
Float
String

Com.angrybirds
1.3
30
50
Installed By MDM

Source = 1 or 3 and Platform = 5 (Android)
Key

Type

Example Value

App ID
Full Version
Application Size
(MB)
Data Size (MB)
Install Location

String
String
Float

Com.angrybirds
2.1
30

Float
String

50
Internal Storage

Source = 4 (BES)
Key

Type

Example Value

Vendor
Full Version

String
String

BlackBerry
6.0

Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
33
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Security & Compliance Information for a Mobile Device
Request
GET /device-apis/devices/1.0/mdSecurityCompliance/
Definition
❖ Get Security & Compliance attributes for a Mobile Device
❖

Uses MaaS360 Device ID (CSN) of the device for querying

Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/mdSecurityCompliance/1101234?deviceId=a2e13f
Sample Response

a2e13f


Device Wiped
String
Not Applied



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
Remote Wipe
Support
Device Wiped

String

Approved

10

String

Not Available

String

Not Applied

Last Wipe Applied
Date (GMT)
Exchange
ActiveSync Policy

Timestamp

28/03/2011 10:12

String

Default

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40
50

© Copyright IBM Corp. 2018. All rights reserved.
34
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Last Policy Updated
Date (GMT)
Device Passcode
Status

Timestamp

28/03/2011 10:12

String

Passcode Policy Not Configured

Security &
Compliance
Security &
Compliance

60
70

Source = 1 or 3 & Platform = 3 (iOS)
Key

Type

Example Value

Display Section

Display Order

Device Jailbroken

String

Yes

10

Jailbreak Detection
Date (GMT)
Device Passcode
Status
Hardware
Encryption
MDM Policy

Timestamp

28/03/2011 16:10

String

Compliant

String

Block-level & File-level

String

Example Corp IOS (6)

Last MDM Policy
Update Date (GMT)
Last MDM Policy
Update Source
Policy Compliance
State
Out-of-Compliance
Reasons (Policies)
Effective Workplace
Persona Policy
Compliance Ruleset

Timestamp

28/03/2011 16:10

String

Default

String

In Compliance

String

Email Profile Not Configured

String

Person Policy number 3

String

Named ruleset

Rule Compliance
Status
Out-of-Compliance
Reasons (Rules)
Device Wiped

String

Out-of-Compliance

String

Minimum Version Check Not Met

String

Pending

Last Wipe Applied
Date (GMT)
Selective Wipe

Timestamp

28/03/2011 16:10

String

Not Applied

Last Selective Wipe
Applied Date (GMT)
Mailbox Approval
State
Allow Installing of
Applications
Allow Use of
Camera
Allow Screen
Capture
Allow User of Safari

Timestamp

28/03/2011 16:10

String

Approved

String

Yes

String

Yes

String

Yes

String

Yes

Allow Use of
YouTube
Allow User of
iTunes Music Store
Allow Explicit Music
and Podcasts

String

Yes

String

Yes

String

Yes

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Device
Restrictions
Device
Restrictions
Device
Restrictions
Device
Restrictions
Device
Restrictions
Device
Restrictions
Device
Restrictions

20
30
40
50
60
65
70
80
81
82
85
86
90
100
104
105
110
10
20
30
40
50
60
70

Source = 1 or 3 and Platform = 5 (Android)
Key

Type

Example Value

Display Section

Display Order

Device Rooted

String

Yes

10

Hardware
Encryption

String

No Encryption

Device Security
Status
Device Security
Status

20

© Copyright IBM Corp. 2018. All rights reserved.
35
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Lock SIM Card

String

Yes

Device Security
Status

30

Device Wiped

String

Pending

10

Last Wipe Applied
Date (GMT)
Selective Wipe

Timestamp

2010-11-30T05:52:53

String

Pending

Last Selective Wipe
Applied Date (GMT)
MDM Policy Name

Timestamp

2010-11-30T05:52:53

String

Corporate Policy

Policy Version

String

2

Last MDM Policy
Update Date (GMT)
Last MDM Policy
Update Source
Policy Compliance
State
Out-of-Compliance
Reasons (Policies)
Effective Workplace
Persona Policy
Compliance Ruleset

Timestamp

2010-11-30T05:52:53

String

Manual

String

In Compliance

String

Passcode Not Enabled

String

Person Policy number 3

String

Named ruleset

Rules Compliance
Status
Out-of-Compliance
Reasons (Rules)
Settings Configured

String

Out-of-Compliance

String

Minimum Version Check Not Met

String

Exchange profile configured

Settings Failed to
Configure
Other Device
Administration
Solutions

String

Exchange profile

String

Email

Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Security &
Compliance
Security &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance
Policy &
Compliance

Device Passcode
Status
Minimum Passcode
Length
Passcode Quality
Number of Complex
Characters Required
Passcode History
Maximum Passcode
Age (days)
Maximum Failed
Password Attempts
Maximum Time to
Lock (min)

String

Compliant

Passcode Settings

10

Integer

4

Passcode Settings

20

String
Integer

Numeric
4

Passcode Settings
Passcode Settings

30
40

String
String

10
365

Passcode Settings
Passcode Settings

50
60

String

10

Passcode Settings

70

String

10

Passcode Settings

80

Background Data
Sync Enabled
Auto-Sync Enabled

String

Yes

10

String

Yes

Accounts and
Sync
Accounts and
Sync

Allow installation of
Non-Market Apps
Allow Mock
Locations
Automatic Data
Backup to Google
Servers Enabled

String

Yes

10

String

Yes

String

Yes

Application
Settings
Application
Settings
Application
Settings

20
30
40
50
60
70
80
90
100
101
102
103
104
106
107
110

20

20
30

© Copyright IBM Corp. 2018. All rights reserved.
36
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Automatic Restore
from Data Backup
on Application
Reinstall
Visible Passwords

String

Yes

Application
Settings

40

String

Yes

Application
Settings

50

Camera Present
GPS Present
Bluetooth Enabled
Near Field
Communication
(NFC) Enabled

String
String
String
String

Yes
Yes
Yes
Yes

Device
Device
Device
Device

10
20
30
40

Features
Features
Features
Features

Source = 4 (BES)
Key

Type

Example Value

Display Section

Display Order

Hardware Encryption

String

Fully Encrypted

10

Encryption Algorithms
Supported
Auto-Backup
Configured
Auto-Backup
Frequency
Last Successful
Backup Time
Auto-Backup
Exclusions
Device Wiped

String

Triple DES

String

Yes

String

Daily

Timestamp

2010-11-30T05:52:53

String

Messages

String

Pending

Last Wipe Applied
Time (GMT)
BES Policy Name

Timestamp

2010-11-30T05:52:53

String

Std. Corporate Policy 1.0

Last Policy Update
Date (GMT)
Policy Compliance
State
Allow User to install
applications
Device Passcode
Status
User-Device
Configuration

Timestamp

2010-11-30T05:52:53

String

In Compliance

String

Yes

String

Enabled

String

Default Configuration

Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance
Security &
Compliance

20
30
40
50
60
70
80
90
100
110
120
130
140

Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
37
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/getEnabledMaaS360Services
/1101234?deviceId=a2e13f
Sample Response

Browser
MaaS360 Gateway for Browser

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.
38
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

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.
39
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Network Information for a Mobile Device
Request
GET /device-apis/devices/1.0/mdNetworkInformation/
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/mdNetworkInformation/1101234?deviceId=a2e13f
Sample Response
ApplF17R9GAGGRY5


IP Address
String



Last Connection Date
String



SSID
String



Subnet Mask
String



MAC Address
String



Data Roaming
String
Disabled


Voice Roaming
String

© Copyright IBM Corp. 2018. All rights reserved.
40
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Disabled


Phone Number
String
+12153179338


ICCID
String
8901 4103 2876 5915 8665


Roaming
String
Yes


International Data Roaming
String
Disabled


Home Carrier
String
AT&T


Current Carrier
String
Not Available


Home Country
String
United States of America


Current Country
String
India


Current Network Type
String
Not Available


Carrier Setting Version
String
29.1


Wi-Fi Mac Address
String
e4:9a:79:d7:0e:06


Bluetooth Mac Address
String
e4:9a:79:d7:0e:07


© Copyright IBM Corp. 2018. All rights reserved.
41
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.


Current MCC
String
404


Subscriber MCC
String
310


Current MNC
String
86


Subscriber MNC
String
410



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

10

ICCID

String

404862413367781

IMEI

String

357168069683740

IMSI

String

404719

Roaming

String

Yes

International Data
Roaming
Home Carrier

String

No

String

Vodafone

Current Carrier

String

Vodafone

Home Country

String

UK

Current Country

String

UK

Current Network
Type
Carrier Setting
Version
Wi-Fi Mac Address

String

GPRS

String

12

String

B4-07-F9-98-C4-F9

Bluetooth Mac
Address

String

B4-07-F9-98-C4-F9

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

20
20
20
30
40
50
60
70
80
90
100
110
120

© Copyright IBM Corp. 2018. All rights reserved.
42
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Source = 1 or 3 and Platform = 5 (Android)
Key

Type

Example Value

Display Section

Display Order

Phone Number

String

21512312345

10

IMEI

String

357168069683740

IMSI

String

404719

IMEI SIM2

String

357168069683740

ICCID

String

8991860024133677816

Roaming

String

Yes

Roaming Status
SIM2
International Data
Roaming
Home Carrier

String

Yes

String

No

String

Vodafone

Current Carrier

String

Vodafone

Home Country

String

UK

Current Country

String

UK

Data Network

String

No

Current Network
Type
IMSI

String

GPRS

String

404862413367781

Wi-Fi Mac Address

String

B4-07-F9-98-C4-F9

Bluetooth Mac
Address

String

B4-07-F9-98-C4-F9

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

20
20
20
20
30
30
40
50
60
70
80
90
100
110
120
130

Source = 4 (BES)
Key

Type

Example Value

Display Section

Display Order

Phone Number

String

2156641782

10

ICCID

String

8991101200003200000

Home Carrier

String

AT&T

Current Carrier

String

AT&T

Supported
Frequencies
Current Network
Type
Direct Connect ID

String

GSM 850, GSM 900

String

GPRS

String

123456

Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information
Network
Information

20
30
40
50
60
70

Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
43
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Patch Information
Request
GET /device-apis/devices/1.0/getPatchInformation/
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
billingID

Required /
Optional
Required

deviceId
missingPatches

Required
Optional

securityPatches

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Return Missing Patches or Installed Patches
Possible values: 0 or 1 (Default value is 1).
Return Security Patches or Other Patches
Possible values: 0 or 1 (Default value is 1).

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/getPatchInformation/1101234?deviceId=a2e13f&missingPatches=1&securityPatches=1
Sample Response

a2e13f
10
1
1

MS10-074: Security Update for Windows 7 (KB2387149)
Security
Microsoft Corporation
Windows 7
Moderate
Q2387149
MS10-074


….


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.
44
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Network Information for a Computer
Request
GET /device-apis/devices/1.0/computerNetworkInformation/
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/computerNetworkInformation/1101234?deviceId=a2e13f
Sample Response

a2e13f
10
1


Tata Photon
PPP
D02528DB-33A7-4AE4-A8FA-06C1786E0DDE
14.96.3.154
255.255.255.255
No
00:05:9A:3C:78:00
10.1.20.97, 10.11.20.26
10.1.9.1
HUAWEI Mobile Connect - Modem
2.0.3.827
10/09/2009



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.
45
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Security Applications Information
Request
GET /device-apis/devices/1.0/securityApplications/
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/securityApplications/1101234?deviceId=a2e13f
Sample Response

a2e13f










…




Mandatory attributes in Response
maas360DeviceID
key
type
Various Application Attributes
Anti-Virus Application:
Key

Type

Example Value

Display Section

Display Order

Application Name
Category
Application Type
Vendor
Version
Installed Date
Status

String
String
String
String
String
Date
String

Symantec Endpoint Protection
Endpoint Security
Anti-Virus
Symantec Corp.
11.0
12/10/2010
Running

Anti-Virus
Anti-Virus
Anti-Virus
Anti-Virus
Anti-Virus
Anti-Virus
Anti-Virus

10
20
30
40
50
60
70

© Copyright IBM Corp. 2018. All rights reserved.
46
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Anti-Virus
Definition Date
Anti-Virus
Definition
Last Scan Date

Timestamp

06/05/2011 00:00

Anti-Virus

80

String

5/6/2011 rev. 21

Anti-Virus

90

Timestamp

06/05/2011 00:00

Anti-Virus

100

Personal Firewall Application:
Key

Type

Example Value

Display Section

Display Order

Application Name
Category
Application Type
Vendor
Version
Installed Date
Status

String
String
String
String
String
Date
String

Symantec Endpoint Protection
Endpoint Security
Personal Firewall
Symantec Corp.
11.0
12/10/2010
Running

Personal
Personal
Personal
Personal
Personal
Personal
Personal

10
20
30
40
50
60
70

Firewall
Firewall
Firewall
Firewall
Firewall
Firewall
Firewall

Anti-Spyware Application:
Key

Type

Example Value

Display Section

Display Order

Application Name
Category
Application Type
Vendor
Version
Installed Date
Status
Anti-Spyware
Definition Date
Anti-Spyware
Definition
Last Scan Date

String
String
String
String
String
Date
String
Timestamp

Symantec Endpoint Protection
Endpoint Security
Anti-Spyware
Symantec Corp.
11.0
12/10/2010
Running
06/05/2011 00:00

Anti-spyware
Anti-spyware
Anti-spyware
Anti-spyware
Anti-spyware
Anti-spyware
Anti-spyware
Anti-spyware

10
20
30
40
50
60
70
80

String

5/6/2011 rev. 21

Anti-spyware

90

Timestamp

06/05/2011 00:00

Anti-spyware

100

Data Encryption Application:
Key

Type

Example Value

Display Section

Display Order

Application Name
Category
Application Type
Vendor
Version
Installed Date
Encryption Status
Encrypted Drives

String
String
String
String
String
Date
String
String

BitLocker Drive Encryption
Data Protection
Data Encryption
Microsoft
7 SP1
12/10/2010
No Encryption
C:

Data Encryption
Data Encryption
Data Encryption
Data Encryption
Data Encryption
Data Encryption
Data Encryption
Data Encryption

10
20
30
40
50
60
70
80

Peripheral Protection Application:
Key

Type

Example Value

Display Section

Display Order

Application Name

String

BitLocker Drive Encryption

10

Category

String

Data Protection

Application Type

String

Peripheral Protection

Vendor

String

Microsoft

Version

String

7 SP1

Installed Date

Date

12/10/2010

Status

String

No Encryption

Peripheral
Protection
Peripheral
Protection
Peripheral
Protection
Peripheral
Protection
Peripheral
Protection
Peripheral
Protection
Peripheral
Protection

20
30
40
50
60
70

Backup & Recovery Application:

© Copyright IBM Corp. 2018. All rights reserved.
47
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Key

Type

Example Value

Display Section

Display Order

Application Name

String
String

Application Type

String

Backup & Recovery

Vendor

String

Iron Mountain

Version

String

8.4.0.8

Installed Date

Date

12/10/2010

Status

String

Running

Last Backup

Timestamp

06/05/2011 08:52

Next Backup

Timestamp

07/05/2011 07:10

Backup Limit

String

6 GB

Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery
Backup &
Recovery

10

Category

Fiberlink Backup & Recovery
Agent
Data Protection

20
30
40
50
60
70
80
90
100

Data Leak Prevention Application:
Key

Type

Example Value

Display Section

Display Order

Application Name

String

BitLocker Drive Encryption

10

Category

String

Data Protection

Application Type

String

Data Leak Prevention

Vendor

String

Microsoft

Version

String

7 SP1

Installed Date

Date

12/10/2010

Status

String

No Encryption

Data Leak
Prevention
Data Leak
Prevention
Data Leak
Prevention
Data Leak
Prevention
Data Leak
Prevention
Data Leak
Prevention
Data Leak
Prevention

20
30
40
50
60
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.
48
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Application Distributions
Request
GET /device-apis/devices/1.0/packageDistributionHistory/
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
billingID

Required /
Optional
Required

deviceId
pageSize

Required
Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page.

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/packageDistributionHistory/1001234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response

100
50
2

2010-11-30T05:52:53.011+00:00
Distribute Angry Birds
Angry Birds
Pending




….


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.
49
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Device Location History
Get Cellular Data Usage for a Device
Request
GET /device-apis/devices/1.0/cellularDataUsage/
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/cellularDataUsage/1001234?deviceId=a1b2c3
Sample Response


2

Current period till date
0.13
200.0
0.06
0.0
200.0
0.0

17
plan1

Mandatory attributes in Response
Access Control
Customer Properties: Enable TEM
Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
50
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Device Location History
Request
GET /device-apis/devices/1.0/locationHistory/
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
billingID

Required /
Optional
Required

deviceId
time

Required
Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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:

a2e13f
1 ## 0 – success; 1 - failure
Unable to return locations since PII is enabled for the device

If PII is not enabled:

a2e13f
0 ## 0 – success; 1 – failure
enabled

2010-11-30T05:52:53.011+00:00
10.2
31.5
100m
Yes


Mandatory attributes in Response
deviceId
errorCode
Access Control
Customer Properties: Enable Device View

© Copyright IBM Corp. 2018. All rights reserved.
51
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
52
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Devices with Associated Users
Request
GET /device-apis/devices/2.0/user-associations/customer/
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
billingID
devicesRegisteredAfterInEpochms

Required /
Optional
Required
Optional

returnInactiveDevices

Optional

pageSize

Optional

pageNumber

Optional

Description
Customer’s ID
Time in Unix epoch milliseconds, returns devices
registered after this time
Possible values: true, false. True returns all
devices; false (default) only returns devices with
associated users.
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
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.
53
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mandatory attributes in Response
billingId
count
time

© Copyright IBM Corp. 2018. All rights reserved.
54
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Groups for a Device
Request
GET /device-apis/devices/1.0/getGroups/
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/cellularDataUsage/1001234?deviceId=a1b2c3
Sample Response


1234
2 ##0: MaaS360 defined, 1: Private, 2: Public, 3: Local User
Group, 4: User Directory Group
BYOD devices
2010-11-30T05:52:53.011+00:00


….


Mandatory attributes in Response
Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
55
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Relevant Data Views for a Device
Request
GET /device-apis/devices/1.0/deviceDataViews/
Definition

❖ Get all categories of data relevant for a Device.
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
https://services.fiberlink.com/device-apis/devices/1.0/deviceDataViews/1101234?deviceId=a12bc3
Sample Response

a2e13f

Device Summary
10


Hardware
10
HARDWARE_INVENTORY
/displaySection>



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

20

Custom Attributes
Software Installed
Package Distributions

30
40
50

Hardware Inventory
MaaS360 Services
Hardware Inventory
Operating System
Custom Attributes
Software Installed
Package Distributions

10
20
10
20
10
10
10

Device Summary

10

Hardware Inventory

20

Custom Attributes
Software Installed

30
40

Hardware Inventory
MaaS360 Services
Hardware Inventory
Operating System
Custom Attributes
Software Installed

10
20
10
20
10
10

Device Summary

10

Custom Attributes

20

Hardware Inventory
Security & Compliance
Custom Attributes

10
20
10

Platform = 2 (Mac)

Source = 2 & Any
Platform value

© Copyright IBM Corp. 2018. All rights reserved.
56
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Source = 1 or 3 &
Platform = 3 (iOS)

Source = 4 (BES)

Source = 1 or 3 and
Platform = 5 (Android)

Action History

30

Action History

10

Device Summary

10

Hardware Inventory
Custom Attributes
Network Information
Security & Compliance

20
30
40
50

Software Installed
Action History
Package Distributions

60
70
80

Hardware Inventory
Network Information
Security & Compliance
Hardware Inventory
Custom Attributes
Network Information
Security & Compliance
Device Restrictions
Software Installed
Action History
Package Distributions

10
20
30
10
10
10
10
20
10
10
10

Device Summary

10

Hardware Inventory
Custom Attributes
Network Information
Security & Compliance
Software Installed
Action History

20
30
40
50
60
70

Hardware Inventory
Network Information
Security & Compliance
Hardware Inventory
Custom Attributes
Network Information
Security & Compliance
Software Installed
Action History

10
20
30
10
10
10
10
10
10

Device Summary

10

Hardware Inventory
Custom Attributes
Network Information
Security & Compliance

20
30
40
50

Software Installed
Action History
Package Distributions

60
70
80

Hardware Inventory
Network Information
Security & Compliance
Hardware Inventory
Custom Attributes
Network Information
Device Security Status
Policy & Compliance
Passcode Settings
Accounts & Sync
Application Settings
Device Features
Software Installed
Action History
Package Distributions

10
20
30
10
10
10
10
20
30
40
50
60
10
10
10

Access Control
Customer Properties: Enable Device View
Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
57
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Relevant Actions for a Device
Request
GET /device-apis/devices/1.0/deviceActions/
Definition
❖ Get all relevant actions for a device.
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/deviceActions/1101234?deviceId=a1b2c3
Sample Response

a2e13f

Wipe
WIPE_DEVICE ++ 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
10
MDM ++ Computer, MDM, Exchange Server, Lotus Notes, BES


Mandatory attributes in Response
maas360DeviceID
actionName
actionID
actionType
actionID
REFRESH_DEVICE_INFORMATION
MDM_LOCATE
MDM_LOCK
MDM_CLEARPWD
CHANGE_POLICY
MDM_REMOVE_PROFILE
MDM_MESSAGE
ACTION_MDM_HIDE_DEVICE
MDM_RULESET_UPDATE
MDM_BUZZ
MDM_DISTRIBUTE_DOC
MDM_WIPE

Description
Refresh Device
Informatio
Locate Device
Lock Device
Reset Device
Passcode
Change Policy
Remove Control
Send Message
Hide Device
Record
Change Rule
Set
Buzz
Distribute Doc
Wipe Device

Platform
iOS, Android, Windows, Blackberry

Order
30

iOS, Android, Windows
iOS, Android, Windows
iOS, Android, Windows, Blackberry

40
50
60

iOS, Android, Windows, Blackberry
iOS, Android, Windows, Blackberry
Windows
Windows

110
120
130
160

Windows

170

Windows
Windows
iOS, Android, Windows, Blackberry

300
310
90

© Copyright IBM Corp. 2018. All rights reserved.
58
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

SELECTIVE_WIPE_DEVICE
APPROVE_DEVICE
BLOCK_DEVICE

Selective Wipe
Device
Exchange
Approve Device
Exchange Block
Device

iOS, Android, Windows

70

Windows
Windows

Source

Platform

Action

2 (Messaging System)

1 (Windows)
2 (Mac)
-

Mark as Inactive
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

3 (MDM + Messaging
System)

3 (iOS)

4 (BES)

4 (BlackBerry)

Selective Wipe = Blank
Selective Wipe Device
Selective Wipe = Pending or Complete
Revoke Selective Wipe
All the actions listed under iOS MDM and Messaging System
above
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.
59
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

Locate Device
Lock Device
Reset Device Passcode
Change Policy
Remove Android Control

Device Wiped = Blank
Wipe Device
Device Wiped = Pending
Cancel Pending Wipe

3 (MDM + Messaging
System)

5 (Android)

1 (MDM)
3 (MDM + Messaging
System)

7 (Symbian)
7 (Symbian)

Selective Wipe = Blank
Selective Wipe Device
Selective Wipe = Pending or Complete
Revoke Selective Wipe
All the actions listed under Android MDM and Messaging System
above
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.
60
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Device Name
Request
POST /device-apis/devices/1.0/setDeviceName/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Sets a name for a designated device, identified by the deviceID.
Parameters
Parameter Name
billingID
deviceID
deviceName

Required /
Optional
Required
Required
Required

Description
Customer ID number
Client Serial Number of the device
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)

Success
Description, in case of success/error

Mandatory attributes in Response
result
Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Edit

© Copyright IBM Corp. 2018. All rights reserved.
61
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Cloud Extender
Get Cloud Extender Clusters
Request
GET /device-apis/cloudExtender/1.0/getCEClusters/
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
billingID
clusterType

Required /
Optional
Required
Optional

Description
Customer identification number
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)


700c895a-6c6a-491a-9cbd-9df3235735d4
VPN
US Default VPN


432c895a-6c6a-674d-9cbd-9df32357784g
VPN
US Alternate VPN


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.
62
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Cloud Extender Cluster Configuration
Request
POST /device-apis/cloudExtender/1.0/getCEClusterConfig/
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

Description

billingID
clusterType

Required /
Optional
Required
Required

configKey

Optional

certMD5

Optional

Contact IBM MaaS360 Customer Support for currently
supported configKey options.
The MD5 checksum of CE Cluster Certificate

Customer identification number
Possible values:
VPN

Sample Request
https://services.fiberlink.com/device-apis/cloudExtender/1.0/getCEClusterConfig
/1101234?clusterType=VPN
Sample Response (XML and JSON)

0
Success
96e9b01a-1d29-4fc0-957d-45432fc0b715
protype104
VPN


VPN_CONFIG_DEF
{
"compLzo" : 1,
"fragment" : 1450,
"tlsAuth" : "sdfgh"
}


VPN_CONFIG_USER
{"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"}



Mandatory attributes in Response
-

errorCode

© Copyright IBM Corp. 2018. All rights reserved.
63
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

errorDescription
clusterGuid
clusterName
clusterType

© Copyright IBM Corp. 2018. All rights reserved.
64
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Cloud Extender Cluster Config
Request
POST /device-apis/cloudExtender/1.0/setCEClusterConfig/
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
billingID
clusterType
configKey1-4

configValue1

Required /
Optional
Required
Required
Required (at
least 1)
Required (at
least 1)

Description
Customer identification number
VPN
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.
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/deviceapis/cloudExtender/1.0/setCEClusterConfig/1101234?clusterType=VPN&configKey1=VPN_CONFIG_USER&c
onfigValue1={"server": "vpn.company.com", "ports": "1194”}
Sample Response (JSON or XML)

0
Success
96e9b01a-1d29-4fc0-957d-45432fc0b715
protype104
VPN


VPN_CONFIG_USER
{"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"}



Mandatory attributes in Response
errorCode
errorDescription
clusterGuid
clusterName
clusterType

© Copyright IBM Corp. 2018. All rights reserved.
65
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Join Cloud Extender Cluster
Request
POST /device-apis/cloudExtender/1.0/ joinCECluster/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Join an existing Cloud Extender cluster.
Parameters
Parameter Name
billingID
certMD5

Required /
Optional
Required
Required

clusterType

Optional

Description
Customer identification number.
The MD5 checksum of the target Cloud Extender
cluster’s X.509 certificate.
Possible values:
VPN

Sample Request
https://services.fiberlink.com/device-apis/cloudExtender/1.0/
joinCECluster/1101234?certMD5=ABCD1234EFGH5678&clusterType=VPN
Sample Response (XML)

0

joinCECluster
700c895a-6c6a-491a-9cbd-9df3235735d4
VPN
US Default VPN

Mandatory attributes in Response
errorCode
errorDescription

© Copyright IBM Corp. 2018. All rights reserved.
66
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Update Cloud Extender Cluster Name
Request
POST /device-apis/cloudExtender/1.0/updateCEClusterName/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Changes the name of a specified Cloud Extender cluster.
Parameters
Parameter Name
billingID
clusterGuid
newName

Required /
Optional
Required
Required
Required

Description
Customer identification number
The GUID of the target cluster
The new cluster name

Sample Request
https://services.fiberlink.com/deviceapis/cloudExtender/1.0/updateCEClusterName/1101234?clusterGuid=7b6bd5ee-9588-4144-ab1a898dc9e4edb5&newName=MarketingVPN2
Sample Response (XML)

updateCEClusterName
7b6bd5ee-9588-4144-ab1a-898dc9e4edb5
MarketingVPN2
VPN

Mandatory attributes in Response
CEClusterDetails
requestType
clusterGuid
clusterName

© Copyright IBM Corp. 2018. All rights reserved.
67
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add a New Cloud Extender Cluster
Request
POST /device-apis/cloudExtender/1.0/addNewCECluster/
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
billingID
requestType

Required /
Optional
Required
Required

Description
Customer identification number
Possible values:
GET_CSR_DETAILS
-

csr

Optional

clusterName

Optional

clusterType

Optional

GET_CERT

Only for use with requestType=GET_CERT
This is the CSR Data from the CECSRDetailsResponse to
the GET_CSR_DETAILS request.
For use with all requestTypes.
This is the VPN server name.
For use with all requestTypes.
Possible values:
VPN

Sample Request
https://services.fiberlink.com/deviceapis/cloudExtender/1.0/addNewCECluster/1101234?requestType=GET_CERT&clusterType=VPN
https://services.fiberlink.com/deviceapis/cloudExtender/1.0/addNewCECluster/1101234?requestType=GET_CSR_DETAILS&clusterType=VPN&cl
usterName=ExampleVPNServer

Sample Response (XML)
For GET_CSR_DETAILS

2003F9C7BF7741AD
/O=MaaS360/OU=M0042:S08:2028601/CN=MaaS360 VPN Server Identity
b564337371349af5ef4099214570381bf953b152/

For GET_CERT

0

700c895a-6c6a-491a-9cbd-9df3235735d4US Default VPNVPN
YUREAjCCAuqgA+kNUxc4ih01bPDfP==
MIIEAjCCAuqgA+kZzwDvNUxc4ih01bPDfPfQ==


© Copyright IBM Corp. 2018. All rights reserved.
68
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
69
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device Actions
Assign a user to a device
Request
POST /device-apis/devices/1.0/assignUserToDevice//
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
billingID

Required /
Optional
Required

deviceId
userName
domain
Email
phoneNumber
policySetName

Required
Required
Required
Required
Optional
Optional

rulesetName

Optional

Description
Billing ID of the account for which the webservice is being executed
Client Serial Number of the device

Only policies for the device platform are
accepted.
Name of the Ruleset that needs to be assigned

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/assignUserToDevice/1101234?billingID=12345&deviceId=a1b2c3&userName=jdoe&domai
n=example.com&Email=jdoe@us.example.com

Sample Response

Success
Description, in case of success/error

Mandatory attributes in Response
result
Access Control
Customer Properties: Manage iPhones
Access Rights: Device View - Edit

© Copyright IBM Corp. 2018. All rights reserved.
70
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Custom Attribute Value
Request
POST /device-apis/devices/1.0/setCustomAttributeValue//
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
billingID

Required /
Optional
Required

deviceId
customAttributeName

Required
Required

customAttributeValue

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Name of the custom attribute for which value is to be
set
Value to be set for the attribute

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/setCustomAttributeValue/1101234/

Sample Response

Success
Description, in case of success/error

Mandatory attributes in Response
result
Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Edit

© Copyright IBM Corp. 2018. All rights reserved.
71
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Refresh Device Information
Request
POST /device-apis/devices/1.0/refreshDeviceInformation//
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
billingID

Required /
Optional
Required

deviceId
dataType

Required
Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
72
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Send Message
Request
POST /device-apis/devices/1.0/sendMessage//
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
billingID

Required /
Optional
Required

deviceId
messageTitle
message

Required
Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Max. 30 chars
Max. 255 chars

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/sendMessage/1101234?deviceId=a1b2c3&messageTitle=message&message=hi

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
73
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Locate Device
Request
POST /device-apis/devices/1.0/locateDevice//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/locateDevice/1101234?deviceId=a1b2c3

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
10.2
31.5
2010-11-30T05:52:53.011+00:00
Description, in case of success/error

Mandatory attributes in Response
maas360DeviceID
Access Control
- Customer Properties: Manage Androids
- Access Rights: Help Desk Actions

© Copyright IBM Corp. 2018. All rights reserved.
74
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Lock Device
Request
POST /device-apis/devices/1.0/lockDevice//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/lockDevice/1101234?deviceId=a2e13f

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
75
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Reset Device Passcode
Request
POST /device-apis/devices/1.0/resetDevicePasscode//
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
billingID

Required /
Optional
Required

deviceId
devicePasscode

Required
Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
76
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Change Device Policy
Request
POST /device-apis/devices/1.0/changeDevicePolicy//
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
billingID

Required /
Optional
Required

maas360DeviceId
policyName

Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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

a2e13f
0 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
77
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Change Compliance Ruleset
Request
POST /device-apis/devices/1.0/changeRuleSet//
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Assigns a specified ruleset to a device
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId
rulesetName

Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Name of the Ruleset that needs to be assigned

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/changeRuleset/1001234?deviceId=androidc1a2b3c&rulesetName=foo

Sample Parameters
deviceId=androidc1a2b3c&rulesetName=foo&billingId=1001234
Sample Response

0 ## 0:success; 1:error
Successfully changed RuleSet : foo for device : androidc1a2b3c
androidc1a2b3c

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.
78
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Selective Wipe Device
Request
POST /device-apis/devices/1.0/selectiveWipeDevice//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/selectiveWipeDevice/1101234?deviceId=a1b2c3

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
79
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Revoke Selective Wipe
Request
POST /device-apis/devices/1.0/revokeSelectiveWipe//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/revokeSelectiveWipe/1101234?deviceId=a1b2c3
Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
80
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Wipe Device
Request
POST /device-apis/devices/1.0/wipeDevice//
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
billingID

Required /
Optional
Required

deviceId
notifyMe

Required
Optional

notifyUser

Optional

notifyOthers

Optional

preserveDataPlan

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Whether to notify the administrator on successful device
wipe.
Expected as a request parameter – “yes” value enables
this flag.
Whether to notify the user on successful device wipe
Expected as a request parameter – “yes” value enables
this flag.
Comma separated list of other email addresses to notify
on successful device wipe
Expected as a request parameter
(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¬ifyMe=yes¬ifyUser=yes¬ifyOthers=abc@example.com

Sample Response

a2e13f
0 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
81
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Cancel Pending Wipe
Request
POST /device-apis/devices/1.0/cancelPendingWipe//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/cancelPendingWipe/1101234
?deviceId=a2e13f

Sample Response

a2e13f
0 ## 0:success; 1:error
Description, in case of success/error

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.
82
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Approve Device in Messaging System
Request
POST /device-apis/devices/1.0/approveDeviceMessagingSystem//
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Approve the device in Messaging System (either Exchange, Notes or Gmail)
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId
ownership
deviceOwner

Required
Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Can be either “Corporate Owned” or “Employee Owned”
Name of the individual or group that owns the device

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/approveDeviceMessagingSystem/1101234?deviceId=a1b2c3
Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
83
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Block Device in Messaging System
Request
POST /device-apis/devices/1.0/blockDeviceMessagingSystem//
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Block the device in Messaging System (Exchange, Notes or Gmail)
Parameters
Parameter Name
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/blockDeviceMessagingSystem/1101234?deviceId=a2e13f

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
84
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Remove Device
Request
POST /device-apis/devices/1.0/removeDevice//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/removeDevice/1101234?deviceId=a2e13f

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
85
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Remove Device from Mailbox Server
Request
POST /device-apis/devices/1.0/removeDeviceMailboxServer//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/removeDeviceMailboxServer/1101234?deviceId=a2e13f

Sample Response

a2e13f
1 ## 0:success; 1:error
12345 ##Available only in case of success
Description, in case of success/error

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.
86
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Hide Device
Request
POST /device-apis/devices/1.0/hideDevice//
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
billingID

Required /
Optional
Required

deviceId

Required

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device

Sample Request
POST https://services.fiberlink.com/device-apis/devices/1.0/hideDevice/1101234?deviceId=a2e13f
Sample Response

a2e13f
1 ## 0:success; 1:error
Description, in case of success/error

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.
87
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Update Device Certificate
Request
POST /device-apis/devices/1.0/updateCert//
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
billingID

Required /
Optional
Required

Parameter Type
(Path/Query/Form)
Path

maas360DeviceId

Required

Query

actionType

Required

Query

comment

Optional

Query

Description
Billing ID of the account for
which the web-service is being
executed
Client Serial Number of the
device
Possible values:
Generate new Certificate
Republish existing Certificate

Sample Request
POST https://services.fiberlink.com/deviceapis/devices/1.0/updateCert/1001234?maas360DeviceId=ApplCCQL6FTRFFCJ&actionType=Generate new
Certificate&comment=testing

Sample Response

a2e13f
1 ## 0:success; 1:error
Description, in case of success/error

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.
88
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Check Action Status
Request
GET /device-apis/devices/1.0/checkActionStatus/
Definition
❖ Check the status of a prior executed action
Parameters
Parameter Name
billingID

Required /
Optional
Required

actionID

Required

Description
Billing ID of the account for which the web-service is
being executed
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

a2e13f
BBFL1234
smurphy
Wipe
Pending ## Pending, Complete, Failed, Executed in Exchange
Server, etc
admin@example.com
2010-11-30T05:52:53.011+00:00
10.1.2.12

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.
89
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search Action History (v1)
Request
GET /device-apis/devices/1.0/searchActionHistory/
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
billingID

Required /
Optional
Required

deviceId
actionType

Optional
Optional

actionExecutionTimeFrom
actionExecutionTimeTo
actionExecutedBy
actionStatus

Optional
Optional
Optional
Optional

complianceEventsOnly

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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
Starting time when the action was executed
Ending time when the action was executed
Administrator who executed the action
Possible values:
•
Pending
•
Complete
Failed
Possible values: Yes, No (Def)
If Yes, then return only Compliance Events
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page.

© Copyright IBM Corp. 2018. All rights reserved.
90
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/searchActionHistory/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response

1000
50
2

a2e13f
BBFL1234
iOS
Appl12345678
smurphy
Wipe
Pending ## Pending, Complete, Failed, Executed in
Exchange Server, etc
admin@example.com
2010-11-30T05:52:53.011+00:00
10.104.12.109




….


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.
91
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search Action History (v2)
Request
GET /device-apis/devices/2.0/searchActionHistory/
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
billingID

Required /
Optional
Required

deviceId
actionType

Optional
Optional

actionExecutionTimeFrom
actionExecutionTimeTo
actionExecutedBy
actionStatus

Optional
Optional
Optional
Optional

complianceEventsOnly

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
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
Starting time when the action was executed
Ending time when the action was executed
Administrator who executed the action
Possible values:
•
Pending
•
Complete
Failed
Possible values: Yes, No (Def)
If Yes, then return only Compliance Events
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page.

© Copyright IBM Corp. 2018. All rights reserved.
92
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Request
https://services.fiberlink.com/deviceapis/devices/2.0/searchActionHistory/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1
Sample Response



PERSONA_POL_UPDATE
4174790_ravjadav
2017-02-20 11:31:48.0
57666683
PENDING
Changed to: Select a Policy Set
ApplDLXNQ294FCM5
Mg'ipad

127.0.0.1
iOS
mahesh

1
1
1

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.
93
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Create New Device Custom Attribute
Request
POST https:///device-apis/devices/2.0/customAttributes/customer/
Definition
❖ Create new custom attributes for a given name and type (and enum values in case of enum type)
❖

Authorization header: MaaS token=””

Parameters
Parameter Name
billingId

Required /
Optional
Required

name
type

Required
Required

enumValues

Optional

defaultEnumValueIndex

Optional

Description
Billing ID of the account for which the web-service is
being executed
Name of the custom attribute being created
Type of custom attribute being created. Possible
values: boolean, date, enum, number, text
Values for enum, required only if attributeType is
enum
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":"",
"type":"",
"enumValues":["value1", "value2", ..],
"defaultEnumValueIndex":
}
Sample JSON Response
{
"billingId": ,
"name": "",
"responseCode": 
}
Response Code Messages
Response code
0
1
2
3
4

Message
Custom Attribute created
successfully
Unknown error occurred
while adding Custom
Attribute
Custom attribute name
requires at least one non
space character
No Custom Attribute type
available with the given
type
You have reached the
number of Custom

Scenario
When a Custom Attribute is created successfully
without any errors
When an internal error occurs
When an empty name is supplied
When the given type of Custom Attribute is invalid
When the number of Custom Attributes present
already reached the limit

© Copyright IBM Corp. 2018. All rights reserved.
94
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
Custom Attribute of type
enum requires at least one
non-empty enum value
Custom Attribute enum
values should be unique
Another attribute exists
with the same name
Custom Attribute name
exceeds maximum length

5
6
7
8
9

Custom Attribute name
does not support the
following special
characters: period (.),less
than (<) and greater than
(>)
Invalid default enum value
provided for custom
attribute

10

When the enum type custom attribute is requested
with no enum values provided
When duplicate enum values are provided
When the Custom Attribute name provided is already
in use
When the Custom Attribute name exceeds the
maximum number of allowed characters (currently
255)
When the Custom Attribute name contains invalid
characters

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.
95
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get All Device Custom Attributes for a Given Organization
Request
GET /device-apis/devices/2.0/customAttributes/customer/
Definition

❖ Get all device custom attributes for a given billing ID.
❖ Request headers: Authorization MaaS token=""
Parameters
Parameter Name
billingID

Required /
Optional
Required

Description
Billing ID of the account for which the web-service is
being executed

Sample Request
GET https:///device-apis/devices/2.0/customAttributes/customer/
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":"",
"type":""
},
{
"name":"",
"type":"",
"enumValues":["value1", "value2", ..],
"defaultEnumValue":
},
.
.
]
}

© Copyright IBM Corp. 2018. All rights reserved.
96
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Response Body Details:
Parameter Name
name
type

Possible
Values
boolean,
date, enum,
number, text

enumValues
defaultEnumValue

Description
Name of the custom attribute
Type of custom attribute

Values for enum, will only be present if type is enum
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.
97
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Device Enrollment
Create Device Enrollment
Request
POST /device-apis/devices/1.0/enrollDevice//
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
billingID

Required /
Optional
Required

userName
domain
emailAddress
country
phoneNumber
ownership

Required
Required
Required
Optional
Optional
Optional

emailUser
emailAdmin
emailOther

Optional
Optional
Optional

sendSMSUser
enrollWithMdm

Optional
Optional

workplacePolicy

Optional

platform

Optional

policySet

Optional

ruleSet
dataPlan

Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed

Possible values:
0: Corporate Owned
1: Employee Owned
2: Corporate Shared
3: Provide Later
Possible values: Yes, No
Possible values: Yes, No
Any other email address to which enrollment should be
sent
Possible values: Yes, No
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.
Workplace policy to be assigned. Supported only for
customers with Workplace policy defined
Possible values:
- iOS
- Android
- Windows Phone 7
- BlackBerry
- Windows
- Mac
Only Platforms corresponding to services enabled for the
billing account will be accepted
Only policies for the specified platform will be accepted.
Also for Windows Phone 7, Windows and Mac no policies
are accepted currently

© Copyright IBM Corp. 2018. All rights reserved.
98
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

overrideAuthMode

Optional

comments
customAttributes

Optional
Optional

authTypePostEnrollment

Optional

useAndroidWork

Optional

androidWorkAccountType

Optional

Relevant only for AD customers. Possible values:
- 0: Corporate Credentials
- 1: Passcode


attr1
true


< customAttributeName >attr2
val1


Applies to AD customers only. Can be used with
overrideAuthMode and usable with Passcode only value
(1). Possible values:
- 0: Corporate
- 1: Local
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.
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/deviceapis/devices/1.0/enrollDevice/1101234/?userName=example&
domain=example.com&emailAddress=abc@example.com
Sample Response

https://iqservices1v.fiberlink.com/dp/a.htm?t=1652-2231118&c=2014622
2014622
32brtr8

http://www.google.com/chart?cht=qr&chs=200x200&chl=https://iqservices1v.fiberlink.com/dp/a.htm?t
=1652-2231118&c=2014622
12126

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.
99
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Manage Device Enrollments
Request
GET /device-apis/devices/1.0/manageDeviceEnrollments/
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
billingID

Required /
Optional
Required

requestCreationFromDate

Optional

requestCreationToDate

Optional

partialUsername

Optional

status

Optional

partialAdminUsername

Optional

includeCustomAttributes

Optional

pageSize

Optional

pageNumber

Optional

enrollmentId

Optional

phoneNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Starting date from which the enrollment request was
created
Ending date on which the enrollment request was
created
Partial Username using which the enrollment was
created
Possible values:
0 - "New"
1 - "Pending"
2 - "Complete"
3 - "Failed"
4 - "Exceeded"
5 - "Expired"
6 - "Deleted"
7 - "PendingSecurityAssessment"
Partial Administrator Username of the Administrator
who created the enrollment request
Possible values: 0 (do not include in response; Default),
1 (include in response)
Limit number of requests returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page
Enrollment ID of the account for which the web-service
is being executed
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

1000
50
2

2010-11-30T05:52:53.011+00:00
iOS
Corporate

© Copyright IBM Corp. 2018. All rights reserved.
100
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

jsmith
jsmith@example.com
Corporate Policy
2
2010-11-30T05:52:53.011+00:00
James’ iPhone

admin@example.com
12126
9871235460
ApplCCQDKLC6DCP7


Boolean
true


Enum
one




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.
101
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Groups
Get User & Device Groups
Request
GET /group-apis/group/1.0/groups/customer/
Definition
❖ Get all Device Groups (Public, Private & MaaS360 defined) and User Groups available for the currently
logged-in Administrator
Parameters
Parameter Name
billingID

Required /
Optional
Required

Description
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

3

hsao_fladmin
2013-08-12 10:24:03.0
himanshu sao
341275
Hsao-test Group
3
2013-08-12 10:24:03.0


…


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.
102
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search Devices by Device Group
Request
GET /device-apis/devices/1.0/searchByDeviceGroup/
Definition
❖ Get devices belonging to a Device Group
❖

Get results on specified pages of the Result-set

Parameters
Parameter Name
deviceGroupId

Required /
Optional
Required

pageSize

Optional

pageNumber
billingID

Optional
Required

sortAttribute
sortOrder

Optional
Optional

Description
ID of the Device Group for which the devices need to be
retrieved
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default value:
50.
Results specific to a particular page. Default is first page
Billing ID of the account for which the web-service is
being executed
Keys: lastReported, installedDate
Keys: asc, dsc

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/searchByDeviceGroup/1101234?deviceGroupId=12345&pageSize=25&pageNumber=2&sort
Attribute=installedDate&sortOrder=asc
Sample Response

1000
50
2

a2e13f
BBFLLT3337
09026
Employee Owned
Stephen Murphy
smurphy
smurphy@example.com
Windows
1
Laptop
Lenovo
T400
Microsoft Windows XP
SP2
3456789019202019
8e380a56a937cce81620b143359d3404498dd638
09:AB:12:12:21:13
2010-11-30T05:52:53.011+00:00
2010-11-30T05:52:53.011+00:00
Active
Not Enrolled
ActiveSync Managed
Appl1234567
2010-11-30T05:52:53.011+00:00

© Copyright IBM Corp. 2018. All rights reserved.
103
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.



…


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.
104
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search Users by Group
Request
GET /user-apis/user/1.0/searchByGroup/customer//groupIdentifier/
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
billingID

Required /
Optional
Required

groupID
includeAllUsers

Required
Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
- 0: Include users with devices only (Default)
- 1: Include all users
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page

Sample Request
https://services.fiberlink.com/userapis/user/1.0/searchByGroup/customer/2047022/groupIdentifier/620532?includeAllUsers=0&pageSize=25
&pageNumber=1
Sample Response

1000
50
2

B3A139685EF3719620211A7A99AD0E34
abarnes
smurphy@example.com
Fiberlink
Active
Bangalore
0
0
Sep 10, 2015 6:56:34 PM
Sep 12, 2016 3:56:34 AM


12345
Sales
cn=Sales,DC=Acmecorp,DC=com##This has value
only for User Directory Groups

…



home
msn.com

© Copyright IBM Corp. 2018. All rights reserved.
105
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.





…



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.
106
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Group level distributions
Request
GET groupapis/group/1.0/distributions/customer//group//type/
Definition
❖ Returns
o
o
o
o
o
o
o
o

following types of distributions made on a User / Device Group
1: Automated Request
2: Policy
3: Rules
4: Apps
5: Docs
6: Corporate Doc Shares
7: Group Based Rules
8: Locations

Parameters
Parameter Name
customer

Required /
Optional
Required

group_identifier
type

Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Group for which details have to be retrieved
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/userapis/group/1.0/distributions/customer/1001234/group/1234/type/5/
Sample Response
For Apps:


App
usergrp
IOS_WEB_CLIP


For Docs:


Doc
apns_certs
txt


For Automated Enrollment Requests

© Copyright IBM Corp. 2018. All rights reserved.
107
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.



AutomatedRequest
ENROLLMENT


For Automated Activation Requests


AutomatedRequest
ACTIVATION


For Rule set


Rule
RuleSet_Mon16022015_101410


For Policies


Policy
Default Android MDM Policy
Android MDM


Mandatory attributes in Response
Access Control
Customer Properties: Enable Device View
Access Rights: Device View – Read Only

© Copyright IBM Corp. 2018. All rights reserved.
108
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Search Criteria Options
Request
GET https:///group-apis/group/2.0/searchCriteria/customer/
Definition
❖ Get All possible search criteria for a given organization
o Authorization header: MaaS token=
o Accepts XML or JSON headers
Parameters
Parameter Name
billing_id

Required /
Optional
Required

Description
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.
109
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

"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.
110
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Create Device Groups
Request
POST https:///group-apis/group/2.0/deviceGroups/customer/
Definition
❖ Create a device group with search criteria
o Authorization header: MaaS token=
o Accepts XML or JSON headers
Parameters
Parameter Name
billing_id

Required /
Optional
Required

Description
Billing ID of the account for which the web-service is
being executed

Sample JSON Request
{
"groupName" : "",
"groupDescription" : "",
"deviceStatus" : "",
"lastReported" : "",
"criteriaOperator" : "",
"deviceTypes" : [ "device type 1", "device type 2", ..]
"conditions" : [
{
"category" : "",
"attribute" : "",
"criteria" : "",
"value1" : "",
"value2" : ""
}
Sample Request Parameters
Parameter Name
groupName
groupDescription
deviceStatus

Required /
Optional
Required
Optional
Optional

lastReported

Optional

deviceTypes

Optional

criteriaOperator

Optional

conditions
category
attribute

Optional
Required
Required

criteria

Required

value1

Required

value2

Optional

Description
Name of the device being created.
Description of the group being created.
Status of the device being searched for. Default: Active
Devices
Search includes devices last reported in this time.
Default: Last 7 Days
Types of devices to include in search. Default: All
available types are included
Decides if the devices meet all or any one condition
provided. Default: All Conditions (AND)
Conditions for search criteria, maximum of 10
Category name on which condition is being constructed
Attribute name on which condition is being constructed.
Requires the category parameter.
Criteria to be used for comparison of values. Requires
the attribute parameter.
Value of the attribute. Requires the criteria parameter
and the attribute parameter.
Second value of the attribute. Use if criteria such as
“between” is used.

© Copyright IBM Corp. 2018. All rights reserved.
111
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample JSON Response
{
"response": {
"billingId": 40006999,
"groupIdentifier": 4491847,
"name": "fromWebService3",
"responseCode": 0
}
Response Code Messages
Response
code
0

Message

Scenario

Group created successfully

1

Unknown error occurred while
creating device group
Add device group workflow is
not supported
Group name contains one or
more following illegal
characters: & * < >
Group name is empty
Group description contains one
or more following illegal
characters: ^ & < >
Device group with the
provided name already exists
Invalid value provided for
deviceStatus
Invalid value provided for
lastReported
Invalid value operator
provided for criteriaOperator

When the group is created successfully without any
errors
When an internal error occurs

2
3

4
5

6
7
8
9

10
11
12
13
14
15
16

17
18

19

Invalid values provided for
deviceTypes
Number of conditions provided
exceed 10
Invalid value provided for
category
Invalid value provided for
attribute
Invalid value provided for
criteria
Two values are required for
"Between" criteria
At least one invalid value
provided for attribute of type
date/timestamp
At least one invalid value
provided for attribute of type
number/double
At least one invalid value
provided for attribute of type
integer
No value is provided in
condition for comparision

When the user doesn't have enough privileges to
create device group
When the group name contains illegal characters

When the group name that is provided is empty
When the group description contains illegal
characters
When a group already exists with the provided group
name
When the value provided for the deviceStatus is not
"Active Devices","Inactive Devices","All Devices"
When an invalid value is provided for lastReported
When the value provided for criteriaOperator
provided is not "All Conditions (AND)", "Any Condition
(OR)", "Across Conditions (Advanced)"
When the deviceTypes contain invalid or unavailable
values
When the number of conditions provided is more
than 10
When an invalid value is provided for category
When an invalid value is provided for attribute
When an invalid value is provided for criteria
When "Between" criteria is provided but only one
valid value is specified
When the value for date is not in epoch milliseconds
format or empty
When an invalid value is provided for attributes of
number/double format
When an invalid value is provided for attributes for
the integer format
When at least one value is not provided for
comparison in the condition

© Copyright IBM Corp. 2018. All rights reserved.
112
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

20
21

22
23

Second value provided in
condition unnecessarily
Invalid value provided for
enum type attribute
Invalid value provided for
boolean type attribute
Advanced criteriaOperator is
not yet supported

When non "Between" criteria is selected but second
value is provided
When an enum attribute is selected, but the
comparison value provided is not one of the values in
the enum definition
When enum attribute is selected, but the value
provided is not “Yes" or "No"
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.
113
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Create User Groups
Request
POST https:///group-apis/group/1.0/userGroups/customer/
Definition
❖ Create a user group
o Authorization header: MaaS token=
o application/x-www-form-urlencoded
Parameters
Parameter Name
billing_id

Required /
Optional
Required

userGroupName

Required

maas360UserIdsList

Optional

parentGroupIdsList

Optional

groupDescription

Optional

availableFor

Optional

Description
Billing ID of the account for which the web-service is
being executed
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
The user IDs of users who should be a part of this user
group.
The group IDs of the parent group. (Applies to nested
groups).
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
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.
114
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample XML Response (Success)

abc,def^a
9294173
abc_test_9

Sample XML Response (Failure)

6
abc_test_9

HTTP Status Code Errors
HTTP Status
code
403

Error code

Meaning

1

400
400
400

2
3
4

400

5

400

6

403

7

400
403

8
9

400

10

Unable to create group due to insufficient previlages
– Check that all required customer properties are
turned on.
billingId cannot be empty.
userGroupName cannot be empty.
userGroupName contains one or more of the
following invalid characters < > * , = & " or exceeds
54 characters in length.
groupDescription contains one or more of the
following invalid characters < > * = & " or exceeds
255 characters in length.
The user group with the provided name already
exists.
The nested groups feature is unavailable for the
customer.
parentGroupIdsList contains IDs in an invalid format
The customer does not support one or more of the
work flows specified inavailableFor.
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.
115
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

My WatchList
Get WatchLists
Request
GET /device-apis/devices/1.0/getWatchLists//
Definition
❖ Refresh the value of all WatchLists relevant for the account and return the latest values for these
Parameters
Parameter Name
billingID

Required /
Optional
Required

Description
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

50

INFO ##Possible values: INFO, SECURITY
Inactive Devices
dv_old_av_def

Desktop Management
Mobile Device Management ##
Possible values: Desktop Management, Mobile Device Management

”Devices Not Reported in Last 7 days.”
Inactive Devices
10


…


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.
116
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search by WatchList
Request
GET /device-apis/devices/1.0/searchByWatchList/
Definition
❖ Get devices that are included in a WatchList
❖

Get results on specified pages of the Result-set

Parameters
Parameter Name
watchListName

Required /
Optional
Required

pageSize

Optional

pageNumber
billingID

Optional
Required

Description
Name of the WatchList for which the devices need to be
retrieved
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default value:
50.
Results specific to a particular page. Default is first page
Billing ID of the account for which the web-service is
being executed

Sample Request
https://services.fiberlink.com/deviceapis/devices/1.0/searchByWatchList/?watchListName=dv_old_av_def&pageSize=50&pageNumb
er=2
Sample Response

1000
50
2

a2e13f
BBFLLT3337
09026
Employee Owned
Stephen Murphy
smurphy
smurphy@example.com
Windows
1
Laptop
Lenovo
T400
Microsoft Windows XP
SP2
3456789019202019
8e380a56a937cce81620b143359d3404498dd638
09:AB:12:12:21:13
2010-11-30T05:52:53.011+00:00
2010-11-30T05:52:53.011+00:00
Active
Not Enrolled
ActiveSync Managed
Appl1234567
2010-11-30T05:52:53.011+00:00



© Copyright IBM Corp. 2018. All rights reserved.
117
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

…


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.
118
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Policy
Get Relevant Policies for a Service
Request
GET /device-apis/devices/1.0/policies/
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
billingID

Required /
Optional
Required

service

Optional

Description
Billing ID of the account for which the web-service is
being executed
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

10

Corporate Policy
No
iOS MDM
Needs Publish
8
1
2010-11-30T05:52:53.011+00:00
2010-11-30T05:52:53.011+00:00


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.
119
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Enabled Services in a Persona Policy
Request
GET /policymgmt-apis/policies/2.0/enabledServices/customer//
Definition
❖ Returns all enabled services for a specified Persona policy
Parameters
Parameter Name
billingID

Required /
Optional
Required

policyName

Required

Description
Billing ID of the account for which the web-service is
being executed
Name of the Persona policy

Sample Request
https://services.fiberlink.com/policymgmtapis/policies/2.0/enabledServices/customer/1101234?policyName=Corporate
Sample Response

Secure Mail
Gateway for Browser

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.
120
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Compliance Rules
Search Compliance Events
Request
GET /device-apis/devices/1.0/searchComplianceEvents/
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
billingID

Required /
Optional
Required

deviceId
pageSize

Optional
Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Limit number of devices returned at one time.
(Default value is 50).
Recommended page sizes are 25, 50, 100, 200 & 250
Results specific to a particular page. Default is first
page.

Sample Request
For all devices: https://services.fiberlink.com/deviceapis/devices/1.0/searchComplianceEvents/?pageSize=25&pageNumber=1
Or
For specific device: https://services.fiberlink.com/securityapis/compliance/1.0/searchComplianceEvents/1101234?deviceId=a1b2c3&pageSize=25&pageNumber=1

Sample Response

1000
50
2

BBFL1234
iOS
Appl12345678
smurphy
Restrict Jailbroken and Rooted device 
Corporate Ruleset
Selective Wipe
Complete ## Pending, Complete, Failed, Executed in
Exchange Server, etc
2010-11-30T05:52:53.011+00:00


….

© Copyright IBM Corp. 2018. All rights reserved.
121
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.



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.
122
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Applications
Search Installed Apps
Request
GET /application-apis/installedApps/1.0/search/
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
partialAppName

Required /
Optional
Optional

appID
platform

Optional
Optional

pageSize

Optional

pageNumber

Optional

billingID

Required

Description
Partial or full App Name string that needs to be
searched for
Full AppID that needs to be searched for
Supported values:
- iOS
- Android
- BlackBerry
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page
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

1000
50
2

40
MaaS360
iOS
com.fiberlink.maas360forios
3


…


Mandatory attributes in Response
appName
platform
appID

© Copyright IBM Corp. 2018. All rights reserved.
123
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

majorVersions

Access Control
- Customer Properties: Enable Device View
- Access Rights: Device Views – View Only

© Copyright IBM Corp. 2018. All rights reserved.
124
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search Apps
Request
GET /application-apis/applications/1.0/search/
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
billingId

Required /
Optional
Required

pageSize

Optional

pageNumber

Optional

appName

Optional

appId
appType

Required
Optional

enterpriseRating
category

Optional
Optional

status
deviceType

Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page
Partial Application Name string that needs to be
searched for
Partial or full App ID for the app to be searched
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
Possible Values: 1, 2, 3, 4, 5
Partial or full category Name string that needs to be
searched for
Active or Deleted (Case insensitive)
Possible values:
1: Smartphone
2: Tablet
3: Smartphone, Tablet

Sample Request
GET https://services.fiberlink.com/applicationapis/applications/1.0/search/1101234?appName=webex&appType=3&status=active&pageSize=25&pageNu
mber=2
Sample Response

1
502
icon1.png
https://cdn.maas360.com/icon1.png
Webex Productivity Tool
com.sample.app
3

© Copyright IBM Corp. 2018. All rights reserved.
125
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

ptools.app
iOS
2
5.2.5
1
Games
1.106
active
1

2010-11-30T05:52:53.011+00:00
admin@acmecorp.com
2010-11-30T05:52:53.011+00:00


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
appVersionState

Value or definition
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.
126
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

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.
127
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get App Details
Request
GET /application-apis/applications/1.0/getAppDetails/
Definition
❖ Returns details for active iOS, macOS, and Android apps
Parameters
Parameter Name
billingID
appType

Required / Optional
Required
Optional

appId
appVersion

Required
Optional

Description
Customer identification number
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
Unique ID of app
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)

Webex Productivity Tool
com.webexiOS
2
ACTIVE
Games
1 ##1: 1: Smartphone, 2: Tablet, 3: Smartphone, Tablet

All devices

1
3
1.0
1
10.5
2010-11-30T05:52:53.011+00:00
admin@acmecorp.com2010-11-30T05:52:53.011+00:00
4.3


RESTRICT_DATA_BACKUP
Yes


0
maas360@fiberlink.com ## If App Discovery portal is enabled for the account
xyz

UR"L_Type'

© Copyright IBM Corp. 2018. All rights reserved.
128
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.




http://manifest

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
supportedOn

appDiscoveryPortal

secPolicy

Value or definition
1: Smartphone
2: Tablet
3: Smartphone and Tablet
Appears if it’s enabled for the account.
0: Not Available
1: View only
2: View and Request
Contains:
RESTRICT_DATA_BACKUP
REMOVE_APP_ON_MDM_CONTROL

© Copyright IBM Corp. 2018. All rights reserved.
129
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Response Key

INSTANT_INSTALL_TRANSPORT

appVersionState

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
Key contained in secPolicy. Has the following possible values:
0: All Networks
1: Wi-fi only
2: Wi-fi and In-network cellular
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.
130
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Search App Distributions
Request
GET /application-apis/applications/1.0/searchDistributions/
Definition
❖ Search for Managed Application Distributions – Search by Application Name, Application Type,
Distribution Status
❖

Relevant for iOS and Android

Parameters
Parameter Name
billingId

Required /
Optional
Required

pageSize

Optional

pageNumber

Optional

appId
appType

Required
Required

status

Optional

Description
Billing ID of the account for which the web-service is
being executed
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page
Unique ID of the application
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
Published, Expired or Stopped (case insensitive

Sample Request
GET https://services.fiberlink.com/applicationapis/applications/1.0/searchDistributions/1101234?appName=webex&appType=3&appId=com.sample.app
&status=published&pageSize=25&pageNumber=2
Sample Response

10
50
2

Give ExampleCo Tool - Fri Aug 28 10:07:58 GMT+00:00
2015
ExampleCo Productivity Tool
iOS
2
All Devices
published
2015-08-30T05:52:53.011+00:00
2015-09-30T00:00:00.011+00:00
admin@example.com
yes


…


Mandatory attributes in Response
distributionName

© Copyright IBM Corp. 2018. All rights reserved.
131
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

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.
132
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get App Distribution Details by Device
Request
GET /application-apis/applications/1.0/getAppDistributionByDevice/
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
billingId

Required /
Optional
Required

deviceId
appType

Optional
Required

appId
activeDistribution

Required
Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Client Serial Number of the device
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
Unique ID of the application distributed
Possible values:
- Yes: Default
- No
- Any
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page

Sample Request
GET https://services.fiberlink.com/applicationapis/applications/1.0/getAppDistributionByDevice/1101234?appId=com.sample.app&appType=2&
pageSize=25&pageNumber=2
Sample Response

100
50
2

Yes
a1b2c3
jsmith’s iPhone
Pending
user1
Yes


…



© Copyright IBM Corp. 2018. All rights reserved.
133
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
134
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Distribute App
Request
POST /application-apis/applications/1.0/distributeApp/
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
billingId

Required /
Optional
Required

appType

Required

appId
targetDevices

Required
Required

appVersion

Optional

deviceGroupId
deviceId
instantInstall

Optional
Optional
Required

sendEmail
sendNotification

Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
Unique ID of the application distributed
Possible values:
0: All Devices
1: Device Group
2: Specific Device
Version of app to be distributed, if more than one
version is stored
Required if targetDevices = 1
Required if targetDevices = 2
Possible values: Yes, No; Relevant only for appType = 1
or 2 (For others, this value is ignored)
Possible values: Yes, No
Possible values: Yes, No Relevant only for appType = 1
or 2 (For others, this value is ignored)

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/1.0/distributeApp/1007263?appType=1&appId=com.example&targetDevices=0&instantI
nstall=Yes&sendEmail=yes&sendNotification=Yes
Sample Response

Success
Application distributed successfully.

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.
135
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Delete App
Request
POST /application-apis/applications/1.0/deleteApp/
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
billingId

Required /
Optional
Required

appType

Required

appId

Required

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
Unique ID of the application

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/1.0/deleteApp/1007263?appType=1&appId=com.example

Sample Response

Success
Application deleted successfully.

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.
136
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Upgrade App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/upgradeApp/
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
billingId

Required /
Optional
Required

appType

Required

appId
maas360Hosted
appSource

Required
Optional
Optional

appSourceURL

Optional

appVersion

Optional

maintainAsAdditionalVersion
appAttributes
versionReleaseNotes
instantUpdate

Optional
Optional
Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
Unique ID of the application distributed
Default is Yes
The ipa/apk file to be uploaded.
If maas360Hosted = Yes, then this is mandatory
The URL where App is hosted.
If maas360Hosted = No, then this is mandatory
Version of app to be upgraded, if more than one
version is stored
Possible values: Yes, No (Default)
A description of what’s new in the upgrade
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:

com.cdw.cdw
1
Yes

5.2.5
true
The icons are now in color!
Yes


name
xyz



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.
137
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response

Success
Application upgraded successfully

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.
138
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Upgrade App (apps larger than 50 MB)
Request
POST /application-apis/applications/1.0/upgradeAppPlus/
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
billingId

Required /
Optional
Required

appType

Required

appId
maas360Hosted
appSource

Required
Optional
Optional

appSourceURL

Optional

maintainAsAdditionalVersion
appAttributes
versionReleaseNotes
instantUpdate

Optional
Optional
Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
Unique ID of the application distributed
Default is Yes
The ipa/apk file to be uploaded.
If maas360Hosted = Yes, then this is mandatory
The URL where App is hosted.
If maas360Hosted = No, then this is mandatory
Possible values: Yes, No (Default)
A description of what’s new in the upgrade
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:

com.cdw.cdw
1
Yes

true
The icons are now in color!
Yes


name
xyz



Part 2: Name = appSource; Value = upgrade file

Sample Response


© Copyright IBM Corp. 2018. All rights reserved.
139
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Success
Package upgrade request successful.
1422603013985

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.
140
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mark App as Primary
Request
POST /application-apis/applications/1.0/markAsPrimary/
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
billingId

Required /
Optional
Required

appType

Required

appId
appVersion
instantInstall

Required
Required
Optional

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
Unique ID of the application
Version of the App to be marked as Primary
Possible values: true, false

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/1.0/markAsPrimary/1007263?appType=1&appId=com.example&appVersion=4.0.1

Sample Response

Success
Requested App marked as Primary

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.
141
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Update Provisioning Profile
Request
POST /application-apis/applications/1.0/updateProvisioningProfile/
Content Type Header: multipart/form-data
Definition
❖ Update provisioning profile for iOS Enterprise app
Parameters
Parameter Name
billingId

Required /
Optional
Required

appType

Required

appId
provisioningProfile

Required
Required

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
Unique ID of the application distributed
Updated Provisioning profile for the App

Sample Request
POST https://services.fiberlink.com/applicationapis/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:

com.cdw.cdw
1

Part 2: Name = provisioningProfile; Value = upgrade file
Sample Response

Success
Provisioning profile updated successfully.
2013-11-03T05:30:20.011+00:00

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.
142
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Stop App Distribution
Request
POST /application-apis/applications/1.0/stopAppDistribution/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Stop a specific distribution of an app
❖

Relevant for iOS and Android

Parameters
Parameter Name
billingId

Required /
Optional
Required

appType

Required

appId
targetDevices

Required
Required

deviceGroupId
deviceId

Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
Possible values:
1: iOS Enterprise Application
2: iOS App Store Application
3: Android Enterprise Application
4: Android Market Application
Unique ID of the application distributed
Possible values:
0: All Devices
1: Device Group
2: Specific Device
Required if targetDevices = 1
Required if targetDevices = 2

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/1.0/stopAppDistribution/1007263?appType=1&appId=com.example&targetDevices=0
Sample Response

Success
Distribution stopped successfully.

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.
143
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add iTunes App Store App (v1)
Request
POST /application-apis/applications/1.0/addITunesApp/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a iTunes App Store app to MaaS360
Parameters
Parameter Name
billingId

Required /
Optional
Required

region
appName

Optional
Required

removeApp

Required

restrictDataBackup

Required

showInADP

Optional

appOwner

Optional

Description
Billing ID of the account for which the web-service is
being executed
Default is US
Full App Name of the app that needs to be added to
MaaS360
Remove App on MDM Control Removal and Selective
Wipe. Possible values: Yes, No
Restrict Data Backup to iTunes. Possible values: Yes,
No
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/1.0/addITunesApp/1007263?appName=sample&removeApp=Yes&restrictDataBackup=Ye
s
Sample Response

Success
Application uploaded successfully.
com.sample.app

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.
144
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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.
145
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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.
146
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add iTunes App Store App (v2)
Request
POST /application-apis/applications/2.0/addITunesApp/
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
billingId

Required /
Optional
Required

region
appName

Optional
Required

removeApp

Required

restrictDataBackup

Required

showInADP

Optional

appOwner

Optional

appAttributes

Optional

Description
Billing ID of the account for which the web-service is
being executed
Default is US
Full App Name of the app that needs to be added to
MaaS360
Remove App on MDM Control Removal and Selective
Wipe. Possible values: Yes, No
Restrict Data Backup to iTunes. Possible values: Yes,
No
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
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/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:

US
MyApp
Yes
Yes
0
owner@example.com


name
xyz


Email
abc@def.com




© Copyright IBM Corp. 2018. All rights reserved.
147
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response

Success
Application uploaded successfully.
com.sample.app

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.
148
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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.
149
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add iOS Enterprise App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/addIOSEnterpriseApp/
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

description
category
screenshot1
screenshot2
removeApp

Required /
Optional
Required
Optional
Optional, or
Required if
maas360Hosted=No
Optional, or
required if
maas360Hosted=No
Required
Optional
Optional
Optional
Required

restrictDataBackup

Optional

showInADP

Optional

appOwner

Optional, or
Required if
showInADP=1 or 2

billingID
maas360Hosted
appSource
appSourceURL

Description
Customer identification number
Possible values: Yes (default), No
The filepath of the ipa file to be uploaded
Mutually exclusive with appSourceURL
The URL of the hosted ipa file.
Mutually exclusive with appSource
Text description of the app
MaaS360 app catalog category
Uploads jpg, gif, or png
Uploads jpg, gif, or png
Possible values: Yes, No
Set to remove the app during MDM Control
Removal and Selective Wipe.
Possible values: Yes, No
Prevents backing up the app to iTunes.
Possible values: 0 (Not Available), 1 (View only), 2
(View & Request)
Use only if the App Discovery Portal is enabled for
the account.
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)

Yes

Download this app immediately. 
General
Yes
Yes
2

© Copyright IBM Corp. 2018. All rights reserved.
150
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

devteam@example.com

Sample Response

Success
Application uploaded successfully. 
com.sample.app

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.
151
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add iOS Enterprise App (apps more than 50 MB)
Request
POST /application-apis/applications/1.0/addIOSEnterpriseApp2/
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
billingID
maas360Hosted
appSource

description
category
screenshot1
screenshot2
removeApp

Required / Optional
Required
Optional
Optional, or Required
if maas360Hosted=No
Optional, or required
if maas360Hosted= No
Required
Optional
Optional
Optional
Required

showInADP

Optional

appOwner

Optional, or Required
if showInADP=1 or 2

appSourceURL

Description
Customer identification number
Possible values: Yes (default), No
The filepath of the ipa file to be uploaded
Mutually exclusive with appSourceURL
The URL of the hosted ipa file
Mutually exclusive with appSource
Text description of the app
MaaS360 app catalog category
Uploads jpg, gif, or png
Uploads jpg, gif, or png
Possible values: Yes, No
Set to remove the app during MDM Control
Removal and Selective Wipe.
Possible values: 0 (Not Available), 1 (View only),
2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
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)

Yes

Download this app immediately. 
General
Yes
Yes
2
devteam@example.com

Sample Response

Success

© Copyright IBM Corp. 2018. All rights reserved.
152
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Application uploaded successfully. 
com.sample.app

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.
153
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Enterprise App Upload Request Status

Request
GET /application-apis/applications/1.0/appUploadRequestStatus/?appUploadRequestId=1234
Definition
❖ Gets the status of large enterprise apps (more than 50 MB) uploaded – iOS or Android
Parameters
Parameter Name
billingId

Required /
Optional
Required

appUploadRequestId

Required

Description
Billing ID of the account for which the web-service is
being executed
Request ID which was given as a response in the large
Enterprise App upload APIs

Sample Request
https://services.fiberlink.com/applicationapis/applications/1.0/appUploadedRequestStatus/1007623?appUploadRequestId=1234

Sample Response

Success
Application uploaded successfully.
com.sample.app

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.
154
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Google Play App (v1)
Request
POST /application-apis/applications/1.0/addPlayApp/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a Google Play app to MaaS360
Parameters
Parameter Name
billingId

Required /
Optional
Required

appSourceURL
removeAppMDMRemoval
removeAppSelWipe
enforceAuthentication
enforceCompliance
showInADP

Required
Required
Required
Required
Required
Optional

appOwner

Optional

Description
Billing ID of the account for which the web-service is
being executed
Google Play URL for the app
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
Email Address of the App Owner who needs to be
intimated (Required if showInADP = 1 or 2)

Sample Request
POST https://services.fiberlink.com/applicationapis/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

Success
Application uploaded successfully.
com.sample.app

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.
155
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Google Play App (v2)
Request
POST /application-apis/applications/2.0/addPlayApp/
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
billingId

Required /
Optional
Required

appSourceURL
removeAppMDMRemoval
removeAppSelWipe
enforceAuthentication
enforceCompliance
showInADP

Required
Required
Required
Required
Required
Optional

appOwner

Optional

appAttributes

Optional

Description
Billing ID of the account for which the web-service is
being executed
Google Play URL for the app
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Relevant only If App Discovery Portal is enabled for the
account
Possible values:
0: Not Available
1: View only
2: View & Request
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/2.0/addPlayApp/customer/1007263
- Name = app_details; Value = XML file for attributes other than the file
Format for the XML is as follows:

https://play.google.com/store/apps/details?id=org.cocos2dx.NautilusCricket201
4
Yes
Yes
Yes
Yes
0
owner@example.com


name
xyz


Email
abc@def.com




© Copyright IBM Corp. 2018. All rights reserved.
156
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response

Success
Application uploaded successfully.
com.sample.app

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.
157
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Android Enterprise App (apps smaller than 50 MB)
Request
POST /application-apis/applications/1.0/addAndroidEnterpriseApp/
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
billingID
maas360Hosted
appSource

description
category
screenshot1
screenshot2
removeAppMDMRemoval

Required / Optional
Required
Optional
Optional, or Required
if maas360Hosted=Yes
Optional, or Required
if maas360Hosted= No
Required
Optional
Optional
Optional
Required

removeAppSelWipe

Required

enforceAuthentication
enforceCompliance
instantInstall
instantInstallTransport

Required
Required
Optional
Optional, or Required
if instantInstall=Yes
Optional

appSourceURL

showInADP

appOwner

Optional, or Required
if showInADP=1 or 2

Description
Customer identification number
Possible values: Yes (default), No
The filepath of the apk file to be uploaded
Mutually exclusive with appSourceURL
The URL of the hosted apk file
Mutually exclusive with appSource
Text description of the app
MaaS360 app catalog category
Uploads jpg, gif, or png
Uploads jpg, gif, or png
Possible values: Yes, No
Set to remove the app during MDM Control
Removal.
Possible values: Yes, No
Set to remove the app during Selective Wipe.
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Possible values: 0 (All networks), 1 (Wi-fi
only), 2 (Wi-fi and in-network cellular)
Possible values: 0 (Not Available), 1 (View
only), 2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
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)

Yes

Download this app immediately. 
General
Yes
Yes
Yes

© Copyright IBM Corp. 2018. All rights reserved.
158
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Yes
Yes
2
2
devteam@example.com

Sample Response

Success
Application uploaded successfully. 
1234

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.
159
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Android Enterprise App (apps larger than 50 MB)
Request
POST /application-apis/applications/1.0/addAndroidEnterpriseAppPlus/
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
billingID
maas360Hosted
appSource

description
category
screenshot1
screenshot2
removeAppMDMRemoval

Required / Optional
Required
Optional
Optional, or Required
if maas360Hosted=Yes
Optional, or Required
if maas360Hosted= No
Required
Optional
Optional
Optional
Required

removeAppSelWipe

Required

enforceAuthentication
enforceCompliance
instantInstall
instantInstallTransport

Required
Required
Optional
Optional, or Required
if instantInstall=Yes
Optional

appSourceURL

showInADP

appOwner

Optional, or Required
if showInADP=1 or 2

Description
Customer identification number
Possible values: Yes (default), No
The filepath of the apk file to be uploaded
Mutually exclusive with appSourceURL
The URL of the hosted apk file
Mutually exclusive with appSource
Text description of the app
MaaS360 app catalog category
Uploads jpg, gif, or png
Uploads jpg, gif, or png
Possible values: Yes, No
Set to remove the app during MDM Control
Removal.
Possible values: Yes, No
Set to remove the app during Selective Wipe.
Possible values: Yes, No
Possible values: Yes, No
Possible values: Yes, No
Possible values: 0 (All networks), 1 (Wi-fi
only), 2 (Wi-fi and in-network cellular)
Possible values: 0 (Not Available), 1 (View
only), 2 (View & Request)
Use only if the App Discovery Portal is enabled
for the account.
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)

Yes

Download this app immediately. 
General
Yes
Yes
Yes

© Copyright IBM Corp. 2018. All rights reserved.
160
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Yes
Yes
2
2
devteam@example.com

Sample Response

Success
Application uploaded successfully. 
1234

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.
161
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Mac App Store App
Request
POST /application-apis/macApps/2.0/addMacAppStoreApp/customer/
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
billingID

Required / Optional
Required

Region
appName

Optional
Required

removeWithSelectiveWipe

Required

removeWithMDMRemoval

Required

removeOnStopDist

Optional

Description
Billing ID of the account for which the webservice is being executed
Default: US
Full app name of the app that needs to be
added to MaaS360
Remove App on selective wipe. Possible
values: Yes or No. Default: Yes
Remove App on MDM Control Removal. Possible
values: Yes or No. Default: Yes
Remove App on Stopping Distribution. Possible
values: Yes or No. Default:No

Sample Request
POST https://services.fiberlink.com/applicationapis/macApps/2.0/addMacAppStoreApp/customer/1007263
Sample Request Value (Part 1)

US
MyApp
No
No
Yes

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.
162
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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.
163
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•
•
•
•
•
•
•
•
•
•
•
•
•
•

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

Success
Application uploaded successfully.
com.sample.app

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.
164
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Windows Dependency
Request
POST /application-apis/winApps/2.0/addWindowsDependency/customer/
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
billingID

Required / Optional
Required

appSource

Required

Description
Billing ID of the account for which the webservice is being executed
Dependency file to be uploaded

Sample Request
POST https://services.fiberlink.com/applicationapis/winApps/2.0/addWindowsDependency/customer/1007263
Sample Response

Success
Dependency uploaded successfully.
Microsoft.NET.Native.Runtime.1.1
1.1.23406.0
ARM,

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.
165
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Windows Enterprise App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseApp/customer/
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
billingID

Required / Optional
Required

maas360Hosted
appSource

Optional
Optional

appSourceURL

Optional

description
category
screenshot1
screenshot2
screenshot3
screenshot4
removeAppOnMDMRemoval

Required
Optional
Optional
Optional
Optional
Optional
Required

removeAppOnSelectiveWipe

Required

removeAppOnStopDistribution

Required

instantInstall

Optional

isUniversalApp

Required

pfn

Optional

showInADP

Optional

appOwner

Optional

Description
Billing ID of the account for which the webservice is being executed
Default: Yes
The ipa file to be uploaded. If maas360Hosted
= Yes, then this parameter is mandatory.
The URL where the app is hosted. If
maas360Hosted = No, then this parameter is
mandatory.

Remove App on MDM Control Removal.
Possible values: Yes or No
Remove App Selective Wipe. Possible values:
Yes or No
Remove App on Stop distribution. Possible
values: Yes or No
Instant install of the app on the device.
Possible values: Yes or No
Is the app uploaded a universal app. Possible
values: Yes or No
Package Family Name. Mandatory for universal
apps.
Relevant only If App Discovery Portal is
enabled for the account.
Possible values:
0: Not Available
1: View only
2: View & Request
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.
166
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

appAttributes

Optional

Sample Request
POST https://services.fiberlink.com/applicationapis/winApps/2.0/addWindowsEnterpriseApp/customer/1007263
Sample Request Value (Part 1)

Yes

Enterprise App
General
Yes
Yes
Yes
Yes
Yes
95b4d4a7-a5c2-4873-a769-7cdee54ecfce_z1fqjy1wgpzc2
2
owner@fiberlink.com

 name
xyz 


Sample Response

Success
Application uploaded successfully.
com.sample.app

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.
167
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Windows EXE App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseEXEApp/customer/
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
billingID

Required / Optional
Required

Description
Billing ID of the account for which the webservice is being executed

Sample Request
POST https://services.fiberlink.com/applicationapis/winApps/2.0/addWindowsEnterpriseEXEApp/customer/1007263
Sample Request Value

Yes

newDescriptiondgg8787gMAV
games
Yes
Yes
No
2
maas360@fiberlink.com
AppEXENEWAPPMAV
uninstallss.exe
installsss.exe
No
X64
Yes
6.89
EXE
UI
Yes
[{"file":[{"filePath":"C:\\Program Files
(x86)\\Evernote\\Evernote\\Evernote.exe","fileSize":"18040160"}]},
{"file":[{"filePath":"C:\\Program Files
(x86)\\Evernote\\Evernote\\Evernote.exe","fileSize":"18040160"}]}]



© Copyright IBM Corp. 2018. All rights reserved.
168
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mandatory attributes in Request
installationMode
supportedArchitecture
executionCommandUnInstall
installSuccessCriteria
o appName
o appVersion
o appIcon
Sample Response

Application Successfully Added
Success

Access Control
Customer Properties: ENABLE_NEW_APPS, WIN_DESKTOP_DEVICES
Access Rights: Apps - Manage Apps

© Copyright IBM Corp. 2018. All rights reserved.
169
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Windows MSI App
Request
POST /application-apis/winApps/2.0/addWindowsEnterpriseMSIApp/customer/
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
billingID

Required / Optional
Required

Description
Billing ID of the account for which the webservice is being executed

Sample Request
POST https://services.fiberlink.com/applicationapis/winApps/2.0/addWindowsEnterpriseMSIApp/customer/1007263
Sample Request Value

Yes

newDescriptiondgg8787gMAV
games
No
Yes
No
2
maas360@fiberlink.com
AppEXENEWAPPMAV
{930652F4-E661-40E2-BF23-C4B58913B223}
{930652F4-E661-40E2-BF23-C4B58913B223}
uninstallss.exe
installsss.exe
No
X64
Yes
6.89
EXE
UI
Yes


© Copyright IBM Corp. 2018. All rights reserved.
170
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mandatory attributes in Request
installationMode
supportedArchitecture
executionCommandUnInstall
installSuccessCriteria
o appName
o appVersion
o appIcon
Sample Response

Application Successfully Added
Success

Access Control
Customer Properties: ENABLE_NEW_APPS, WIN_DESKTOP_DEVICES
Access Rights: Apps - Manage Apps

© Copyright IBM Corp. 2018. All rights reserved.
171
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Windows Store App
Request
POST /application-apis/winApps/2.0/addWinStoreApp/customer/
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
billingID

Required / Optional
Required

maas360Hosted
appSourceURL
showInADP

Optional
Required
Optional

category

Optional

appOwner

Optional

appAttributes

Optional

Description
Billing ID of the account for which the webservice is being executed
Default: Yes
Windows Store URL of app to be added
Relevant only If App Discovery Portal is
enabled for the account.
Possible values:
0: Not Available
1: View only
2: View & Request
Additional categories to be assigned to app
other than the Store categories
Email address of the owner of the app who
needs to be intimated.
Required if showInADP = 1 or 2.
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)

Yes
https://www.microsoft.com/en-in/store/p/ted/9wzdncrfj07f
games
2
maas360@fiberlink.com


name
xyz


Email
abc@def.com




© Copyright IBM Corp. 2018. All rights reserved.
172
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response (XML)

Success
Application uploaded successfully.
234567
1.1.23406.0

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.
173
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Delete Windows Dependency
Request
DELETE /application-apis/winApps/2.0/deleteWindowsDependency/customer/
Definition
❖ Delete Windows Dependency file (appx or appxbundle).
Parameters
Parameter Name
billingID

Required / Optional
Required

dependencyName
dependencyVersion
dependencyArchitecture

Required
Required
Required

Description
Billing ID of the account for which the webservice is being executed
Dependency name to be deleted
Dependency version to be deleted
Dependency architecture to be deleted

Sample Request
DELETE https://services.fiberlink.com/applicationapis/winApps/2.0/deleteWindowsDependency/customer/1007263
Sample Response

Success
Dependency deleted successfully.

Definition
❖ Download Windows Dependency file (appx or appxbundle).
Parameters
Parameter Name
billingID

Required / Optional
Required

dependencyName
dependencyVersion
dependencyArchitecture

Required
Required
Required

Description
Billing ID of the account for which the webservice is being executed
Dependency name to be deleted
Dependency version to be deleted
Dependency architecture to be deleted

Sample Request
GET https://services.fiberlink.com/applicationapis/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.
175
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Category List
Request
GET /applications-api/applications/2.0/getCategoryList/customer/
Definition
❖ Get the list of all the app categories for the given billing ID.
Parameters
Parameter Name
billingID

Required / Optional
Required

Description
Billing ID of the account for which the webservice is being executed

Sample Request
POST https://services.fiberlink.com/applicationapis/applications/2.0/getCategoryList/customer/1007263
Sample Response (JSON)
{
"categories":
{
"category":["Administration","Administration Abc","Book","Books","Business","Casual"],
"count":6
}
}
Sample Response (XML)

Administration
Administration Abc
Book
Books
Business
Casual
6


© Copyright IBM Corp. 2018. All rights reserved.
176
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mark App as Featured
Request
POST /applications-api/applications/2.0/markAppAsFeatured/customer/
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
billingID

Required /
Optional
Required

appType

Required

appId
secondaryApp
appFullVersion
appVersion
featureSubtext
showAppAndFeaturedDescription

Required
Optional
Optional
Optional
Required
Optional

featuredBannerStyle

Optional

featuredFontColor

Required

Description
Billing ID of the account for which the webservice is being executed
Possible values:
1: iOS Enterprise Application
3: Android Enterprise Application
Unique ID of the application being upgraded
Default: No
Required if secondaryApp = Yes
Required if secondaryApp = Yes
Accepts string as the feature subtext
Possible values:
true
false (Default)
Possible values:
1: Basic
2: Detailed
Required if showAppAndFeaturedDescription =
true.
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)

com.cdw.cdw
1
Yes
1.2.3
4.5.6
Sample sub text
true
1
#2d9f4a


© Copyright IBM Corp. 2018. All rights reserved.
177
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response (XML)

Success
App marked as featured.


© Copyright IBM Corp. 2018. All rights reserved.
178
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Delete User Review and Update Rating
Request
DELETE /applications-api/applications/2.0/deleteReview/customer/

Definition
❖ Deletes user review of an app and updates its average.
Parameters
Parameter Name
billingId

Required /
Optional
Required

reviewId

Required

Description
Billing ID of the account for which the webservice is being executed
Review ID of the review to be deleted.

Sample Request
https://services.fiberlink.com/applicationapis/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
200 OK
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable

Description
Success
The web-service request was invalid.
Authentication for the web-service request
failed. Invalid credentials.
Web-service request is requesting a resource
that the server does not allow access to.
The requested resource is not found.
An internal server error occurred while
processing the request.
MaaS360 Web-service server is not reachable.
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.
179
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

List Featured Apps and Bundles Info
Request
GET applications/2.0/getFeaturedAppsAndBundles/customer/
Definition
❖ Lists featured apps and bundles info.
Parameters
Parameter Name
billingId

Required /
Optional
Required

Description
Billing ID of the account for which the webservice is being executed

Sample Request
https://services.fiberlink.com/applicationapis/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/cdncontent/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/cdncontent/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.
180
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

200
204
400
401

OK
No Content
Bad Request
Unauthorized

403 Forbidden
404 Not Found
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable

Success
The web-service request was invalid.
Authentication for the web-service request
failed. Invalid credentials.
Web-service request is requesting a resource
that the server does not allow access to.
The requested resource is not found.
An internal server error occurred while
processing the request.
MaaS360 Web-service server is not reachable.
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.
181
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

List Apps Bundles with their Apps Info
Request
GET applications/2.0/getAppBundlesWithApps/customer/
Definition
❖ Lists app bundles with their apps info.
Parameters
Parameter Name
billingId

Required /
Optional
Required

Description
Billing ID of the account for which the webservice is being executed

Sample Request
https://services.fiberlink.com/applicationapis/applications/2.0/getAppBundlesWithApps/customer/1007263
Sample Response
{
"bundleDetails": {
"count": 2,
"bundles": [
{
"description": "ZB2Sub",
"featuredBannerStyle": 0,
"featuredImageUrl": "",
"iconURL": "https://iq2services.fiberlink.com/cdncontent/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/cdncontent/softwares/10001589/1502280025723/46686440726446_7_test_rescaled/e7b007f648eea4fd364220
e18f1c52233119a840.jpeg",
"featuredName": "ZB1Text",
"featuredTextColor": "#ffffff",
"iconURL": "https://iq2services.fiberlink.com/cdncontent/softwares/10001589/1502279976450/46637319323003_5_test_rescaled/0406785c196625abebf6b1
494ebe94c38cf367bf.jpeg",

© Copyright IBM Corp. 2018. All rights reserved.
182
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

"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
200 OK
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable

Description
Success
The web-service request was invalid.
Authentication for the web-service request
failed. Invalid credentials.
Web-service request is requesting a resource
that the server does not allow access to.
The requested resource is not found.
An internal server error occurred while
processing the request.
MaaS360 Web-service server is not reachable.
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.
183
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Fetch All the Reviews
Request
GET applications/2.0/getAllReviews/customer/
Definition
❖ Fetches all the reviews.
Parameters
Parameter Name
billingId

Required /
Optional
Required

Description
Billing ID of the account for which the webservice 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
200 OK
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable

Description
Success
The web-service request was invalid.
Authentication for the web-service request
failed. Invalid credentials.
Web-service request is requesting a resource
that the server does not allow access to.
The requested resource is not found.
An internal server error occurred while
processing the request.
MaaS360 Web-service server is not reachable.
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.
184
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Application Publication Workflow (for use by App Ecosystem
Partners only)
Get the list of app events pending for review
Request
GET /applicationapis/appApproval/2.0/getAppsPendingReview/customer//vendor/?
Definition
❖ Get all app events pending for review or scan for a specific vendor ID.
Parameters
Parameter Name
billingID

Required /
Optional
Required

vendorOfferingId

Required

vendorSharedKey

Required

timestamp

Optional

Description
Billing ID of the account for which the web-service is
being executed
Unique id to represent the vendor offering. Created
during vendor on-boarding process.
Secret shared key, shared between vendor and Maas.
Created during vendor on-boarding process.
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=""
Response header
lastTimestamp
Sample Request
GET https://services.fiberlink.com/applicationapis/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.
185
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get details of each app that is pending for scan
Request
GET /applicationapis/appApproval/2.0/getAppDetailsForReview/customer//review/
Definition
❖ Get the details of each app that is pending for review or scan.
Parameters
Parameter Name
billingID

Required /
Optional
Required

reviewId

Required

Description
Billing ID of the account for which the web-service is
being executed
Unique id that is assigned to each review step.

Request Headers
Authorization: MaaS 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-2d106038-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.
186
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get binary of the app pending for review
Request
GET /application-apis/appApproval/2.0/getAppBinaryForReview/customer//review/
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
billingID

Required /
Optional
Required

reviewId

Required

Description
Billing ID of the account for which the web-service is
being executed
Unique id that is assigned to each review step.

Request Headers
Authorization: MaaS token=""
Response
Input stream of app binary
Response headers
Content-Disposition: attachment; filename=
checksum
fileSize 
Sample Request:
GET https://services.fiberlink.com/applicationapis/appApproval/2.0/getAppBinaryForReview/customer/1101234/review/f298521b-abd8-48eb-b073aeab9aad1033
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.
187
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Submit the app and results of the scan
Request
POST /applicationapis/appApproval/2.0/submitAppReviewResults/customer//review/
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
billingID

Required /
Optional
Required

reviewId
resultJson : result

Required
Mandatory

Description
Billing ID of the account for which the webservice is being executed
Unique id that is assigned to each review step.
Composed of pre-defined keys and custom keys.
Pre-defined keys:
Operationstatus, errcode, isresultappbinary

resultJson : result :
operationstatus

Mandatory

Custom keys:
Any
Indicates whether the vendor operation was
success/failure.
Possible values:
success, failure

resultJson : result : errcode

Mandatory

resultJson : result :
isbinaryupdated

Mandatory

Indicates the errorcode from vendor in case of
operation failure. Use "nil" in case operation was
successful.
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

resultJson : result : key 1,
key 2, key 3….

Optional

resultJson: resultDataURLs:
URLs : URL 1, URL 2, URL
3….

Optional

resultJson : result :
resultfilechecksum

Mandatory if
resultJson : result :
isresultfileavailable
= yes

App binary will be replaced automatically as soon
as App Administrator approves the result of the
app.
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
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
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.
188
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

resultFile

resultJson : result :
updatedBinaryChecksum
updatedBinaryApp

Optional,
Mandatory if
resultJson : result :
isresultfileavailable
= yes

Return document containing results of a scan such
as .doc, .pdf, .xls, .xml, .htm file.

Mandatory if
resultJson : result :
isbinaryupdated =
yes
Optional
Mandatory if
resultJson : result :
isbinaryupdated =
yes

Specify SHA2 checksum of return hardened or
wrapped app binary

Max file size: 2GB

Return hardened or wrapped app binary.
Max file size: 2GB

Request Headers
Authorization: MaaS 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/applicationapis/appApproval/2.0/submitAppReviewResults/customer/30074548/review/1a3e90d0-8aae-4a20-9e743231d4c7b639
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.
189
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample XML Response


Results uploaded successfully
Success


© Copyright IBM Corp. 2018. All rights reserved.
190
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

User
Search Users
Request
GET /user-apis/user/1.0/search/
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
partialUserName
domain
partialUserName
partialFullUserName
partialEmailAddress
includeAllUsers

Required /
Optional
Optional
Optional
Optional
Optional
Optional
Optional

source

Optional

match

Optional

pageSize

Optional

pageNumber

Optional

billingID

Required

includeCustomAttributes
authType

Optional
Optional

usersUpdatedAfterInEpochms

Optional

Description
Partial or full Username string
Full domain name string
Partial or full “UserName” string
Partial or full “Full UserName” string
Partial or full Email Address
Possible values:
- 0: Include users with devices only (Default)
- 1: Include all users
Possible values:
- 0: Local Directory
- 1: User Directory
Possible values:
- 0: Indicates Partial match for Username, Full Name
and Email Address (Default)
- 1: Indicates Exact match
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50.
Results specific to a particular page. Default is first
page
Billing ID of the account for which the web-service is
being executed
Possible values: 1, 0 (default)
Possible values:
- 0: Local Directory
- 1: User Directory
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

1000
50
2

B3A139685EF3719620211A7A99AD0E34

© Copyright IBM Corp. 2018. All rights reserved.
191
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

abarnes
abcd@example.com
ExampleDomain
Active
Bangalore
0
0
Sep 10, 2015 6:56:34 PM
Sep 12, 2016 3:56:34 AM


12345
Sales
cn=Sales,DC=Acmecorp,DC=com##This has value
only for User Directory Groups

…



home
msn.com




…


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.
192
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Local User Account
Request
POST /user-apis/user/1.0/addUser/customer/
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
customer

Required /
Optional
Required

fullname
userName
domain
email
phoneNumberCountry
phoneNumber
location

Optional
Required
Required
Required
Optional
Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed

Sample Request
POST https://services.fiberlink.com/userapis/user/1.0/addUser/customer/1007463?userName=abc&domain=example.com&email=abc@example.co
m

Sample Response

1 ## 0:success; 1:error
4D0E6C29440C9FD0DF22D24E97741B3B

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.
193
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Edit a Local User Account
Request
PUT /user-apis/user/1.0/editUser/customer//user/
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
customer

Required /
Optional
Required

user_identifier

Required

fullName
domain
email
phoneNumberCountry
phoneNumber
location

Optional
Optional
Optional
Optional
Optional
Optional

Description
Billing ID of the account for which the web-service is
being executed
MaaS360 User ID for the user account which needs to be
edited

Sample Request
PUT https://services.fiberlink.com/user-apis/user/1.0/editUser/customer/1007463/user/
5D74F9BF45C98E1CFCD241D093D73383

Sample Response

Success ## In case of any failure in action, this is set to Failed and description
has failure reasons.
User account uploaded successfully.

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.
194
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Add Groups to Local User Account
Request
PUT /user-apis/user/1.0/addGroups/customer//user/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Add a Local or User Directory Group to a Local user account
Parameters
Parameter Name
customer

Required /
Optional
Required

user_identifier

Required

groupIds

Required

Description
Billing ID of the account for which the web-service is
being executed
User Identifier of the user for whom we are adding
groups
Comma separated list of multiple Group IDs to be added

Sample Request
PUT https://services.fiberlink.com/userapis/user/1.0/addGroups/customer/1007463/user/99950C69056BF0971FCA5807F752C53

Sample Response

1 ## 1:success; 0:error
Description, in case of success/error
99950C69056BF0971FCA5807F752C53

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.
195
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Remove Groups from Local User Account
Request
DELETE /user-apis/user/1.0/removeGroups/customer//user/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Remove Local or User Directory Group from a Local user account
Parameters
Parameter Name
customer

Required /
Optional
Required

user_identifier

Required

groupIds

Required

Description
Billing ID of the account for which the web-service is
being executed
User Identifier of the user for which we are deleting
groups
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

1 ## 1:success; 0:error
Description, in case of success/error
99950C69056BF0971FCA5807F752C53

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.
196
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get AD Groups
Request
GET /user-apis/user/1.0/getADGroups/
Definition
❖ Returns all the AD Groups applicable for the user
Parameters
Parameter Name
billingID

Required /
Optional
Required

userName

Required

Description
Billing ID of the account for which the web-service is
being executed
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

Administrators
Help Desk
….

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.
197
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Change Persona Policy
Request
POST /user-apis/user/1.0/billingID//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
billingID

Required /
Optional
Required

user

Required

personaPolicy
domain

Required
Optional;
Required if
user isn’t
unique

Description
Billing ID of the account for which the web-service is
being executed.
Needs to be specified only in URL
Username for which Persona policy needs to be
changed
Needs to be specified only in URL
Name of the Persona policy assigned
Domain of the user. For example, “example.com”

Sample Request
POST https://services.fiberlink.com/userapis/user/1.0/billingID/1101234/user/jsmith/changePolicy?personaPolicy=marketing&domain=example.c
om

Sample Response

Success ##In case of any failure, this is set to Failed & description has details of
the error
Description comes here

Mandatory attributes in Response
status
Access Control
- Customer Properties: Enable User Management (Beta)
- Access Rights: Manage Users

© Copyright IBM Corp. 2018. All rights reserved.
198
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Custom Attribute Value for a User
Request
POST /user-apis/user/1.0/setCustomAttributes//
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Sets the value for a specified custom attribute for a user record
Parameters
Parameter Name
billingID

Required /
Optional
Required

userName
domain
attributeName

Required
Required
Required

attributeDistinguisedName

Required

attributeValue

Required

Description
Billing ID of the account for which the webservice is being executed
Name of the custom attribute for which value is
to be set
Distinguished name of the custom attribute for
which value is to be set
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

Success
Description, in case of success/error

Mandatory attributes in Response
result
Access Control
Customer Properties: Enable User Management (Beta)
Access Rights: Manage Users

© Copyright IBM Corp. 2018. All rights reserved.
199
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Update User Certificate
Request
POST /user-apis/user/1.0/updateUserCert/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Deliver a new User Certificate to all enrolled devices of the user
Parameters
Parameter Name
billingID

Required /
Optional
Required

Parameter Type
(Path/Query/Form)
Path

userName
domain

Required
Required

Query
Query

Description
Billing ID of the account for which
the web-service is being executed

Sample Request
POST https://services.fiberlink.com/userapis/user/1.0/updateUserCert/1001234?userName=user01&domain=forest02.acmecorp.local

Sample Response

1 ## 0:success; 1:error
Description, in case of success/error

Mandatory attributes in Response
actionStatus
Access Control
- Customer Properties: Enable User Management (Beta)
- Access Rights: Manage Users

© Copyright IBM Corp. 2018. All rights reserved.
200
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get User Custom Attributes
Request
GET /user-apis/user/1.0/userAttributes/
Definition
❖ Returns all user custom attributes defined for the account
Parameters
Parameter Name
billingID

Required /
Optional
Required

Description
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


SecureAttribute
SECUREATTRIBUTE
securefield1


TextAttribute
TEXTATTRIBUTE
string1


Access Control
- Customer Properties: Enable User Custom Attributes
- Access Rights: View Custom Attributes

© Copyright IBM Corp. 2018. All rights reserved.
201
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Delete User
Request
DELETE /user-apis/user/2.0/users/customer//user/
Definition
❖ Queue user for deletion.
Parameters
Parameter Name
billingId

Required /
Optional
Required

userIdentifier

Required

Description
Billing ID of the account for which the web-service is
being executed
User identifier for user deletion.

Sample Request
GET https://services.fiberlink.com/user-apis/user/1.0/userAttributes/1101234
Sample Response


SecureAttribute
SECUREATTRIBUTE
securefield1


TextAttribute
TEXTATTRIBUTE
string1


Access Control
- Customer Properties: ENABLE_WEB_SERVICES
- Access Rights: User Views - Add User and Device
HTTP Status Codes
HTTP
Status
code
202
500

400
403

400
400

Scenario

Error code

Meaning

User successfully
queued for deletion.
Internal server error

0

userIdentifier is
null/empty/invalid
Admin does not
have access to given
user
Education user

2

User has been queued for permanent
deletion.
User could not be queued for permanent
deletion. Please try again later or
contact support if problem persists.
Invalid user identifier.

User has/had CE
device

5

1

3

Admin does not have access to given
user.

4

This user is being managed via Apple
School Manager and cannot be deleted.
User cannot be deleted. User has or had
Cloud Extender devices mapped to
his/her name.

© Copyright IBM Corp. 2018. All rights reserved.
202
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
203
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Delete User Status
Request
GET /user-apis/user/2.0/deleteUserStatus/customer//user/
Definition
❖ Know the status of the user that was in the queue deletion.
Parameters
Parameter Name
billingId

Required /
Optional
Required

userIdentifier

Required

Description
Billing ID of the account for which the web-service is
being executed
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
200

Scenario

Error code

Meaning

User is in queue

0

200
200
200
200
200

User is in queue
User is in queue
User is in queue
User deletion failed
User deletion
completed
userIdentifier is
Invalid
Admin does not
have access to
given user
User Does not Exist
/ Deleted

1
2
3
4
5

User has been queued for permanent
deletion.
User deletion is started.
Device deletion is started.
User deletion is in progress.
User deletion failed.
User deleted successfully.

6

Empty User Identifier.

7

Admin does not have access to given
user.

8

Provided user does not exist. If user
identifier is correct, then user is
deleted.

400
403

400

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.
204
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Administrator
Create Administrator
Request
POST /account-provisioning/administrator/1.0/createAdministrator/
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
customerBillingID

Required /
Optional
Required

adminUsername
adminEmailAddress
roles

Required
Required
Required

firstName
lastName
countryCodePhoneNumber

Optional
Optional
Optional

phoneNumber
requestPassword

Optional
Optional

forceResetTempPassword

Optional

allowPortalLogin

Optional

Description
Billing ID of the account for which the web-service is
being executed
Username of the Administrator account to be created
Email Address of the Administrator account
Comma separated list of role(s) of the Administrator
account
First Name of the Administrator
Last Name of the Administrator
Country Code for the Phone Number of the
Administrator
Phone Number of the Administrator
Possible Options:
1 – Show password
0 (Default) – Don't show
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
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/accountprovisioning/administrator/1.0/createAdministrator/1101234?customerBillingID=1101234&adminUsernam
e=abc&adminEmailAddress=abc@example.com&roles=Help Desk
Sample Response

admin_acmecorp
1009001
ERROR_1001
Username already exists
0 ##0:Failure, 1: Success


© Copyright IBM Corp. 2018. All rights reserved.
205
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Mandatory attributes in Response
customerBillingId
adminUsername
status
Access Control
- Customer Properties: - Access Rights: Manage Administrators

© Copyright IBM Corp. 2018. All rights reserved.
206
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Check Administrator Account Availability
Request
GET /account-provisioning/account/1.0/ checkAdminAccountAvailability/
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
adminUsername

Required /
Optional
Required

Description
Administrator Username

Sample Request
POST https://services.fiberlink.com/account-provisioning/account/1.0/
checkAdminAccountAvailability/1101234?adminUsername=2001234_admin

Sample Response

2001234_admin
ERROR_1001
Username already exists
0## 1- Yes (User name is available for addition), 0- No (Username is
already taken)

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.
207
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Account
Provision New Customer Account
Request
POST /account-provisioning/account/1.0/createCustomerAccount/
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
billingId

Required /
Optional
Required

accountType
accountName
service

Required
Required
Optional

adminEmailAddress

Required

country

Optional

externalAccountID

Optional

password

Optional

defaultLanguage

Optional

Description
Billing ID of the Partner account for which the customer
account should be created
Possible values: Trial (Default), Customer
Display name for the Account
Possible values: MDM, SPS, MAM. If no value is
specified, MDM is assumed
Email Address of the primary administrator for the
account
Country name or country code where the customer
account is located. For example: India or IN
ID used by partner to identify partner’s customer. Limit
255 characters.
If specified, this will be set for the Administrator
account. Else, an autogenerated password will be set
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.
208
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Parameter Name
forceAdminAcceptEULA

Required /
Optional
Optional

sendWelcomeEmail

Optional

allowPortalLogin

Optional

committedLicenses
customerVertical

Optional
Optional

Description
Account Name for the account to be provisioned.
Default = No
Whether to send Welcome Email from MaaS360 or not.
Default = Yes
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)
Ignored if Account Type = Trial
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

1101234
Demo Customer1
2001234
2001234_admin
a1b2c3d4 ## Only when autogenerated
https://portal.fiberlink.com/

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.
209
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Check Account Name Availability
Request
POST /account-provisioning/account/1.0/ checkAccountNameAvailability/
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
accountName

Required /
Optional
Required

Description
Account Name

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/checkAccountNameAvailability/1101234?accountName=ExampleCo
Sample Response

ExampleCo
0## 1- Yes (Accout name is available for addition), 0- No (Account Name
is already taken)
1001
Exception …

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.
210
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Convert Trial into Customer Account
Request
POST /account-provisioning/account/1.0/convertToCustomer/
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
customerBillingId

Required /
Optional
Required

committedLicenses

Optional

Description
Billing ID of the trial account which needs to be
converted into customer account
This is integer field and will be null by default

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/convertToCustomer/1101234?customerBillingId=1101237

Sample Response

1101237
0 ## 1:success; 0:error
1001
Exception …

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.
211
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Expire an Account
Request
POST /account-provisioning/account/1.0/expireAccount/
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
customerBillingId

Required /
Optional
Required

Description
Billing ID of customer or trial account to be expired.

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/expireAccount/1101234?customerBillingId=1101235
Sample Response

1101234
0 ## 1:success; 0:error
1001
Exception …

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.
212
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Extend Trial Account
Request
POST /account-provisioning/account/1.0/extendAccount/
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
customerBillingId

Required /
Optional
Required

days

Optional

Description
Billing ID of trial account for which trial period is to be
extended.
•
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/accountprovisioning/account/1.0/extendAccount/1101234?customerBillingId=1101235
Sample Response

1101234
0 ## 1:success; 0:error
1001
Exception …

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.
213
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Customer Accounts
Request
POST /account-provisioning/account/1.0/searchCustomers/
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
partnerBillingId

Required /
Optional
Required

childPartnerBillingID

Optional

partialAccountName

Optional

externalAccountID

Optional

accountStatus

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of a partner for which the customer account
list is to be retrieved.
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.
Partial (Starts with) or full Customer Account Name
string to be searched for
Account ID for the customer in Partner’s Billing system.
Used for mapping accounts from Partner’s system to
MaaS360.
Possible values:
Trial
Customer
Expired
By default, all accounts are returned
Limit number of devices returned at one time.
Allowed page sizes: 25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular page. Default is first
page

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/searchCustomers/1101234?accountStatus=Trial

Sample Response

924
50
2

1101234
PARTNER ## or CUSTOMER
Example Corp
Trial ## Trial, Customer, Expired
Registration Process
2012-01-19

© Copyright IBM Corp. 2018. All rights reserved.
214
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

60 ## of days for trial accounts, null in case of customers
YYYY-MM-DD ## date when this account expires in
case of trial, null in case of customer
YYYY-MM-DD ## date when this
account got converted to a customer account, in case of customer; null, otherwise
100 ## -1 for null & otherwise
integer value
MDM
admin@example.com
English
A1B2C3
ExampleCo



Access Control
Customer Properties: Enable Provision New Customer
Access Rights: Onboard Partners

© Copyright IBM Corp. 2018. All rights reserved.
215
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Customer Account Configuration
Request
POST /account-provisioning/account/1.0/getCustomerConfig/
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
customerBillingId

Required /
Optional
Required

Description
Billing ID of customer for which the account
information is to be retrieved.

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/getCustomerConfig/1101234?customerBillingId=1101235
Sample Response

1101234
India
Example Corp
Trial ## Trial, Customer, Expired
100 ## -1 for null & otherwise integer value
60 ## of days for trial accounts, null in case of customers
YYYY-MM-DD ## date when this account expires in case of
trial, null in case of customer
admin@example.com
jsmith
English
naus100101extid
2012-01-19
0 ## 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)
Yes/No #1-Yes, 0 -No
7 #days
7
#days
0 ## one of three actions (0- Do
nothing, 1- Selectively Wipe, 2- Remove Control, 3 – Alert User)
50 ## Space in MBs
10.56 ##Space in MBs
1001
Exception details

Mandatory attributes in Response
billingId
accountStatus
Access Control
- Customer Properties: Enable Provision New Customer

© Copyright IBM Corp. 2018. All rights reserved.
216
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

Access Rights: Onboard Customers

© Copyright IBM Corp. 2018. All rights reserved.
217
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Customer Account Configuration
Request
POST /account-provisioning/account/1.0/setCustomerConfig/
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
customerBillingId

Required / Optional
Required

externalAccountID

Optional

committedLicenseCount

Required

adminEULASettings

Required

endUserReacceptEULAEnabl
ed

Required

endUserReacceptEULARemi
nderDuration

Required if
endUserReacceptEULAEna
bled is set to “Yes”

endUserReacceptEULADelay
AfterReminder

Required if
endUserReacceptEULAEna
bled is set to “Yes”

endUserReacceptEULAActio
n

Required if
endUserReacceptEULAEna
bled is set to “Yes”

country

Optional

allocatedSpace

Optional

Description
Billing ID of customer for which the account
information is provided
ID of a partner’s customer, unique only in the
partner’s scope
Committed number of licenses for this
customer id
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
•
This customer account has enforced end
users to re-accept EULA when the
applicable EULA changes
•
Possible values (Yes/No)
•
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
•
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
•
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 name or country code where the
customer account is located. For example:
India or IN
•
Values are in MBs
•
Possible values:
o 10
o 50
o 100
o 500

© Copyright IBM Corp. 2018. All rights reserved.
218
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Parameter Name

Required / Optional

defaultLanguage

Optional

customerVertical

Optional

Description
o 1000
o 5000
o 10000
o 25000
o 50000
o 100000
ISO language code: cs, de, en, es, fr, it, ja,
ko, nl, pl, pt, ru, zh-CN, zh-TW
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

1101234
0 ## 1:success; 0:error
Details of customer updated successfully
1001
Exception details

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.
219
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sign Apple MDM CSR request
Request
POST /provisioning-apis/provisioning/1.0/getSignedCSR/
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
billingId

Required /
Optional
Required

unsignedCSR

Required

Description
Billing ID of the account for which the web-service is
being executed
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.
220
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Upload Apple MDM Certificate
Request
POST /provisioning-apis/provisioning/1.0/uploadAppleMDMCert/
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
billingID

Required /
Optional
Required

Description
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

Success
Apple MDM Certificate has been uploaded successfully
2010-11-30T05:52:53.011+00:00
com.apple.mgmt.External.711f921c-84ef-4a27-a930-e19884dad4bf

Mandatory attributes in Response
status
certTopic
certExpiryDate
Access Control
- Customer Properties: - Access Rights: Services Configuration

© Copyright IBM Corp. 2018. All rights reserved.
221
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Device Enrollment Settings
Request
GET /provisioning-apis/provisioning/1.0/getDeviceEnrollSettings/
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
billingID

Required /
Optional
Required

Description
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

EXAMPLECO
0
https://m.dm/EXAMPLECO
acme
iPhone,iPad
Yes
http://services.fiberlink.com/usagePolicy/1009081
support@example.com
1-800-123-1234
Yes
1
admin@example.com

Mandatory attributes in Response
corporateID
userAuthenticationMode
Access Control
- Customer Properties: - Access Rights: Service Configuration

© Copyright IBM Corp. 2018. All rights reserved.
222
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Configure Device Enrollment Settings
Request
POST /provisioning-apis/provisioning/1.0/configureDeviceEnrollSettings/
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
billingID

Required /
Optional
Required

corporateID
userAuthenticationMode

Optional
Optional

defaultDomain
allowedDevicePlatforms

Optional
Optional

promptUsagePolicy
usagePolicy

Optional
Optional

corpSupportEmail
corpSupportPhone
alertAdmin
deviceTypesAlert

Optional
Optional
Optional
Optional

alertEmailAddresses

Optional

Description
Billing ID of the account for which the web-service is
being executed
Corporate Identifier for the account
Possible values:
0: Passcode
1: Corporate Active Directory
2: Two factor authentication
3: SAML
4: MaaS360 Local Account
Relevant only if userAuthenticationMode = 2 or 3
Comma separated list of values
Possible values:
iPhone
iPad
iPod
Android
OS X
BlackBerry
Windows Phone
Possible values: Yes, No
Required if promptUsagePolicy = Yes. This file is the
file that is uploaded.

Possible values: Yes, No
Possible values:
0: All Devices
1: Smartphones & Tablets only
2: Laptops & Desktops only
If alertAdmin = Yes, then at least 1 value is required.

Sample Request
POST https://services.fiberlink.com/provisioningapis/provisioning/1.0/configureDeviceEnrollSettings/1101234

© Copyright IBM Corp. 2018. All rights reserved.
223
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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:

him53
1
testADDomain
iphone,iPad,iPod,Android
support@example.com
123456
Yes
Yes
1
admin@example.com

- Part2: Name = usagePolicy; Value = usage policy file
Sample Response

Success
Device Enrollment Settings configured successfully. 

Mandatory attributes in Response
status
Access Control
- Customer Properties: - Access Rights: Services Configuration

© Copyright IBM Corp. 2018. All rights reserved.
224
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Provision New Partner Account
Request
POST /account-provisioning/account/1.0/createPartnerAccount/
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
billingId

Required /
Optional
Required

uniquePartnerNameInMaaS360
partnerDisplayName
partnerCode

Required
Required
Required

templateAccountID

Optional

adminEmailAddress

Required

country

Optional

password

Optional

allowPortalLogin

Optional

multipleAccountEmailDomains

Optional

leadNotificationEmailAddress

Required

sendWelcomeEmail

Optional

Description
Billing ID of the Partner account under which the new
Partner account should be created
Unique Partner Name used within MaaS360
Partner Name used for branding purposes in the portal
Unique 4 to 8 characters long (alphanumeric) code to
identify the partner in the Service Registration URL.
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
Email Address of the primary administrator for the
account
Country name or country code where the customer
account is located. For example: India or IN
If specified, this will be set for the Administrator
account. Else, an autogenerated password will be set
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)
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 <>_Email Prefix.
Email address to which new customer account creation
notification emails should be sent
Whether to send Welcome Email from MaaS360 or not.
Default = Yes

Sample Request
POST https://services.fiberlink.com/accountprovisioning/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.
225
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response

2001234
Demo Customer1
1101234
2001234_admin
a1b2c3d4 ## Only when autogenerated

https://portal.fiberlink.com/tryMDM/SK_TELK_MDM_C

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.
226
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Partner Account Configuration
Request
POST /account-provisioning/account/1.0/getPartnerAccountConfig/
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
parnterBillingId

Required /
Optional
Required

country

Optional

Description
Billing ID of partner for which the account information
is expected.
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/accountprovisioning/account/1.0/getPartnerAccountConfig/1101234?partnerBillingId=1101234
Sample Response

US1101234
ExampleCo Master Account
 ExampleCo Master Account
SK
admin@example.com
admin_master
https://portal.fiberlink.com/tryMDM/SK_CCAS_MDM_C
abc@fiberlink.com
60 ## of days for trial accounts, null in case of customers
abc.com, pqr.com ## comma separated domains
0 ## 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)
Yes/No
7 #days
7
#days
0 ## one of three actions (0- Do
nothing, 1- Selectively Wipe, 2- Remove Control, 3 – Alert user)
1001
Exception details

Mandatory attributes in Response
partnerBillingId
Access Control
- Customer Properties: Enable Provision New Partner

© Copyright IBM Corp. 2018. All rights reserved.
227
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

Access Rights: All rights related to Onboarding

© Copyright IBM Corp. 2018. All rights reserved.
228
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Set Partner Account Configuration
Request
POST /account-provisioning/account/1.0/setPartnerAccountConfig/
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
partnerBillingId

Required / Optional
Required

specialDomain

Optional

leadNotificationEmail

Required

trialDuration

Required

adminEULASettings

Required

endUserReacceptEULAEnabl
ed

Required

endUserReacceptEULARemi
nderDuration

Required if
endUserReacceptEULAEnabl
ed is set to “Yes”

endUserReacceptEULADelay
AfterReminder

Required if
endUserReacceptEULAEnabl
ed is set to “Yes”

endUserReacceptEULAActio
n

Required if
endUserReacceptEULAEnabl
ed is set to “Yes”

country

Optional

Description
Billing ID of partner for which the account
information is provided
Comma Separated values of domains. Only
applicable to partners
Emails for notifying if new customers/trial
sign up under the partner hierarchy
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
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
•
This customer account has enforced
end users to re-accept EULA when the
applicable EULA changes
•
Possible values (Yes/No)
•
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
•
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
•
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
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.
229
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Request
POST https://services.fiberlink.com/accountprovisioning/account/1.0/setPartnerAccountConfig/1101234?partnerBillingId=1101234&leadNotificationE
mail=abc@example1.com&trialDuratio=75&adminEULASettings=1&endUserReacceptEULAEnabled=No
Sample Response

1101234
US
0 ## 1:success; 0:error
Details of customer updated successfully
1001
Exception details

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.
230
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Customer’s Allowed Services
Request
GET /account-provisioning/service/1.0/getServicesInfo/< loggedInUserbillingId>?
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
loggedInUserbillingId
customerBillingId
serviceKey

Required /
Optional
Required
Required
Optional

Description
Billing ID of the query’s account
Billing ID of the customer account
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

SUCCESS
13


ACT_SYNC
Enable Exchange and Office365 integration
Disabled




BES
Enable Blackberry enterprise server integration
Disabled




DOCS_SERVICE
Documents management and distribution capability for a wide range of devices. 
Enabled



CONTENT_SYNC_USER
Enable content sync for user
DOCS_SERVICE
Disabled




© Copyright IBM Corp. 2018. All rights reserved.
231
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.





Sample Error Response

NOT_IN_HIERARCHY
Selected Customer 1224321 is not in hierarchy of parent: 1004952

Response Definitions
ServiceKey
MDM
ACT_SYNC
MAM_INT
SECURE_BROWSER
SECURE_EMAIL
APP_WRAPPING
WINDOWS_FILE_SHARE
SB_INTRANET_ACCESS
BES
DOCS_SERVICE
RPAS
TEM
MDM_C
ENTERPRISE_GATEWAY
EUP
ACT_SYNC_NOTES
CONTENT_SYNC_USER
SECURE_EDITOR
SECURE_VIEWER
DV
INT_DTM_BIGFIX_C

Description
Does not enable SPS or EAS
Exchange and Office365 integration. Manages only via
mail and are not enrolled in MDM.
Mobile Application Management
Secure Browser
Secure email
Connect to a Sharepoint through the MEG
Use the Secure Browser through the MEG
Blackberry enterprise server integration
Documents management and distribution
Email Access Gateway
Mobile expense management to track mobile data usage
Mobile Device Management
MaaS360 gateway
End User Portal
IBM Traveler and IBM Connections Cloud integration
Content sync for user
Secure editor (enables Viewer on Android)
Secure Viewer
Visibility services for Mac desktops and laptops
Advanced Patch Management using Bigfix

INT_DTM_LOCATE_C

Location tracking for Windows Desktops and Laptops

MAC
MAC_V
WINDOWS_DTM_C
WINDOWS_ENROLLMEN
T_MODE
EUP_ADD_DEVICE
APP_SECURITY
MALWARE_DETECT
WP_APP_SECURITY
ANDROID_MDM_C
BB_MDM
IPHONE_MDM_C
WIN_MOBILE
WIN7_PHONE
WINDOWS_PHONE_MDM
_C

Management for Mac desktops and laptops
Visibility services for Mac desktops and laptops
Management for Windows desktops and laptops
Windows 10 MDM
Show/hide Add Device Request Action in EUP
Mobile App security
Threat management, Trusteer
Workplace app security
Android device management
BlackBerry Device management
IOS device management
Manage Windows 8 devices
Manage Windows 7 phones
Manage Windows 10 devices

Parent Service

DOCS_SERVICE
DOCS_SERVICE
DOCS_SERVICE
WINDOWS_DTM
_C
WINDOWS_DTM
_C

WINDOWS_DTM
_C
EUP
MAM_INT
MAM_INT
MAM_INT
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C

© Copyright IBM Corp. 2018. All rights reserved.
232
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

ServiceKey
SB_INTRANET_ACCESS

Description
Secure browser gateway

SB_URL_FILTERING

URL filtering for Secure Browser

WINDOWS_SECURE_BR
OWSER
MAIL_CAL_APNS
SECURE_CHAT

Windows secure browser
Push notifications
Secure chat. This needs Secure Email to be enabled.

Parent Service
SECURE_BROW
SER
SECURE_BROW
SER
SECURE_BROW
SER
SECURE_MAIL
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/?&
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
billingID
serviceKey
customerBillingId

Required /
Optional
Required
Required
Required

Description
Billing ID of the logged in Partner account
See table “Parameter Keys” for allowed values.
Billing ID of the customer account

Parameter Keys
ServiceKey
MDM
ACT_SYNC

MAM_INT
SECURE_BROWSER
SECURE_EMAIL
APP_WRAPPING

Description
Does not enable SPS or EAS
Exchange and Office365 integration.
Manages only via mail and are not
enrolled in MDM.
Mobile Application Management
Secure Browser
Secure email

Parent Service

© Copyright IBM Corp. 2018. All rights reserved.
233
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

ServiceKey
WINDOWS_FILE_SHARE
SB_INTRANET_ACCESS
BES
DOCS_SERVICE
RPAS
TEM
MDM_C
ENTERPRISE_GATEWAY
EUP
ACT_SYNC_NOTES
CONTENT_SYNC_USER
SECURE_EDITOR
SECURE_VIEWER
DV
INT_DTM_BIGFIX_C
INT_DTM_LOCATE_C
MAC
MAC_V
WINDOWS_DTM_C
WINDOWS_ENROLLMENT_MODE
EUP_ADD_DEVICE
APP_SECURITY
MALWARE_DETECT
WP_APP_SECURITY
ANDROID_MDM_C
BB_MDM
IPHONE_MDM_C
WIN_MOBILE
WIN7_PHONE
WINDOWS_PHONE_MDM_C
SB_INTRANET_ACCESS
SB_URL_FILTERING
WINDOWS_SECURE_BROWSER
MAIL_CAL_APNS
SECURE_CHAT

Description
Connect to a Sharepoint through the
MEG
Use the Secure Browser through the
MEG
Blackberry enterprise server integration
Documents management and
distribution
Email Access Gateway
Mobile expense management to track
mobile data usage
Mobile Device Management
MaaS360 gateway
End User Portal
IBM Traveler and IBM Connections
Cloud integration
Content sync for user
Secure editor (enables Viewer on
Android)
Secure Viewer
Visibility services for Mac desktops and
laptops
Advanced Patch Management using
Bigfix
Location tracking for Windows Desktops
and Laptops
Management for Mac desktops and
laptops
Visibility services for Mac desktops and
laptops
Management for Windows desktops and
laptops
Windows 10 MDM
Show/hide Add Device Request Action
in EUP
Mobile App security
Threat management, Trusteer
Workplace app security
Android device management
BlackBerry Device management
IOS device management
Manage Windows 8 devices
Manage Windows 7 phones
Manage Windows 10 devices
Secure browser gateway
URL filtering for Secure Browser
Windows secure browser
Push notifications
Secure chat. This needs Secure Email
to be enabled.

Parent Service

DOCS_SERVICE
DOCS_SERVICE
DOCS_SERVICE

WINDOWS_DTM_C
WINDOWS_DTM_C

WINDOWS_DTM_C
EUP
MAM_INT
MAM_INT
MAM_INT
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C
SECURE_BROWSER
SECURE_BROWSER
SECURE_BROWSER
SECURE_MAIL
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.
234
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Response

SUCCESS
1224321
CONTENT_SYNC_USER

Mandatory attributes in Response
status
customerBillingId
serviceKey
Sample Error Response

FAILED
REQUIRED_PARAMETER_MISSING
Service Key is required for enabling service : 4169009



FAILED
4169009
CONTENT_SYNC_USER
NOT_A_SIMPLE_CUSTOMER
Selected customer with billing id: 75869 is not a Simple Customer


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.
235
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Disable a Service for a Customer
Request
POST /account-provisioning/service/1.0/disableService/?&
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
billingId
serviceKey
customerBillingId

Required /
Optional
Required
Required
Required

Description
Billing ID of the logged in Partner account
See table “Parameter Keys” for allowed values.
Billing ID of the customer account

Parameter Keys
ServiceKey
MDM
ACT_SYNC
MAM_INT
SECURE_BROWSER
SECURE_EMAIL
APP_WRAPPING
WINDOWS_FILE_SHARE
SB_INTRANET_ACCESS
BES
DOCS_SERVICE
RPAS
TEM
MDM_C
ENTERPRISE_GATEWAY
EUP
ACT_SYNC_NOTES
CONTENT_SYNC_USER
SECURE_EDITOR
SECURE_VIEWER
DV
INT_DTM_BIGFIX_C
INT_DTM_LOCATE_C
MAC
MAC_V
WINDOWS_DTM_C

Description
Does not enable SPS or EAS
Exchange and Office365 integration. Manages
only via mail and are not enrolled in MDM.
Mobile Application Management
Secure Browser
Secure email
Connect to a Sharepoint through the MEG
Use the Secure Browser through the MEG
Blackberry enterprise server integration
Documents management and distribution
Email Access Gateway
Mobile expense management to track mobile
data usage
Mobile Device Management
MaaS360 gateway
End User Portal
IBM Traveler and IBM Connections Cloud
integration
Content sync for user
Secure editor (enables Viewer on Android)
Secure Viewer
Visibility services for Mac desktops and laptops
Advanced Patch Management using Bigfix
Location tracking for Windows Desktops and
Laptops
Management for Mac desktops and laptops
Visibility services for Mac desktops and laptops
Management for Windows desktops and
laptops

Parent Service

DOCS_SERVICE
DOCS_SERVICE
DOCS_SERVICE
WINDOWS_DTM_
C
WINDOWS_DTM_
C

© Copyright IBM Corp. 2018. All rights reserved.
236
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

ServiceKey
WINDOWS_ENROLLMENT_MODE

Description
Windows 10 MDM

EUP_ADD_DEVICE
APP_SECURITY
MALWARE_DETECT
WP_APP_SECURITY
ANDROID_MDM_C
BB_MDM
IPHONE_MDM_C
WIN_MOBILE
WIN7_PHONE
WINDOWS_PHONE_MDM_C
SB_INTRANET_ACCESS

Show/hide Add Device Request Action in EUP
Mobile App security
Threat management, Trusteer
Workplace app security
Android device management
BlackBerry Device management
IOS device management
Manage Windows 8 devices
Manage Windows 7 phones
Manage Windows 10 devices
Secure browser gateway

SB_URL_FILTERING

URL filtering for Secure Browser

WINDOWS_SECURE_BROWSER

Windows secure browser

MAIL_CAL_APNS
SECURE_CHAT

Push notifications
Secure chat. This needs Secure Email to be
enabled.

Parent Service
WINDOWS_DTM_
C
EUP
MAM_INT
MAM_INT
MAM_INT
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C
MDM_C
SECURE_BROW
SER
SECURE_BROW
SER
SECURE_BROW
SER
SECURE_MAIL
SECURE_MAIL

Sample Request
POST https://services.fiberlink.com/account-provisioning/service/1.0/disableService/
1101234?serviceKey=MEM&customerBillingID=1224321
Sample Response

SUCCESS
4169009
CONTENT_SYNC_USER

Mandatory attributes in Response
status
customerBillingId
serviceKey
Sample Error Response

FAILED
REQUIRED_PARAMETER_MISSING
Service Key is required for disabling service : 4169009


FAILED
CONTENT_SYNC_USER
REQUIRED_PARAMETER_MISSING
customerBillingId is required for disabling service :
CONTENT_SYNC_USER



© Copyright IBM Corp. 2018. All rights reserved.
237
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

FAILED
416900987
CONTENT_SYNC_USER
NOT_A_SIMPLE_CUSTOMER
Selected customer with billing id: 9798638is not a Simple Customer

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.
238
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get User’s Enabled Services
Request
GET /account-provisioning/accountreporting/1.0/getUserReport/?
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
billingId
custBillingId
username
phoneNumber

Required /
Optional
Required
Required
Required*
Required*

Description
Billing ID of the Partner account
Billing ID of the Customer account
*Either a user name or a phone number is required.
*Either a user name or a phone number is required.

Sample Request
GET https://services.fiberlink.com/accountprovisioning/accountreporting/1.0/getUserReport/1101234?username=johndoe
Sample Response

1101234


johndoe
2


ANDROID9cf3876c63a8

DOC
EAS

Not Available


SEC1c2690863109a

MDM
SEB

Not Available






© Copyright IBM Corp. 2018. All rights reserved.
239
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Sample Error Response

 INPUT_NOT_VALID 
Customer Billing ID 1101234 is not valid


REQUIRED_PARAMETER_MISSING
 At least one of the parameters, username or phone number, is required for getting reports


Other errors include:

•
•

INPUT_COMBINATION_HAS_NO_DEVICES
NOT_A_SIMPLE_CUSTOMER

Response Definitions
ServiceKey
MDM

Full Name
Mobile Device Management

ACT_SYNC
MAM_INT

Email Managed (ActiveSync)
Devices
Mobile App Management

TEM

Mobile Expense Management

MALWARE_DETECT

Mobile Threat Management

CON

Mobile Content Cloud

SECURE_BROWSER

Secure Browser

SECURE_EMAIL

Secure Mail

SECURE_CHAT

Secure Chat

APP_WRAPPING

App Security

DOC
SECURE_EDITOR

Mobile Content Management
Secure Editor

CONTENT_SYNC_USER

Secure Doc Sync

WINDOWS_FILE_SHARE

MEG – Docs

SB_INTRANET_ACCESS

MEG – Browser

WP_APP_SECURITY

MEG – Apps

Notes
Devices managed by MDM, not including
SPS or EAS devices, are counted.
Devices that are managed only via mail
and are not enrolled in MDM are counted.
Devices that have the app catalog
available on the device, and have at least
one app deployed are counted.
Devices that have a MEM data plan
assigned to them are counted.
Devices that have Trusteer activated and
in use are counted.
Exists for billing purposes, does not require
enable service option.
Devices that have Secure Browser
installed are counted.
Devices that have Secure Mail installed
are counted.
Devices that have Secure Chat installed
are counted.
Devices with App Wrapping enabled are
counted
Every active device is counted.
Devices that have Secure Editor installed
are counted.
Devices that have Secure Doc Sync
enabled are counted.
Devices that connect to a Sharepoint
through the MEG are counted.
Devices that use the Secure Browser
through the MEG are counted.
Devices that use apps that use the
WorkPlace SDK are counted.

Mandatory attributes in Response
custbillingId

© Copyright IBM Corp. 2018. All rights reserved.
240
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

-

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.
241
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Reporting
Get List of Dashboards
Request
GET /reporting-apis/bi/1.0/getDashboards/{billingId}/
Definition
❖

Returns a list of dashboards.

Parameters (table)
Parameter Name
billingId

Required / Optional
Required

locale

Optional

customerBillingID

Optional

Description
Billing ID of the account for which the webservice is being executed
Locale in which the name of reports and
categories are to be displayed
Only available for Partner dashboards

Sample Request
GET https://services.fiberlink.com/reporting-apis/bi/1.0/getDashboards/1101234

Sample Response

2

MDM OVERVIEW
BI_IA_MDMO


< dashboardName>PLATFORM
BI_IA_PLATO


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.
242
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
billingId

Required / Optional
Required

dashboardCode

Required

locale

Optional

Description
Billing ID of the account for which this api
is being executed
The code of the dashboard for which this
api is being executed
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

4

Device Summary
Platform
BI_IA_MDMO_DEVICES_BY_PLATFORM


Device Summary
Managed Status
BI_IA_MDMO_DEVICES_BY_MANAGED_STATUS


Device Summary
Ownership
BI_IA_MDMO_DEVICES_BY_OWNERSHIP


Hardware Details
Details Report
BI_IA_MDMO_DEVICE_DETAILS_REPORT


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.
243
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
billingId

Required / Optional
Required

dashboardCode

Required

reportCode

Required

locale

Optional

customerBillingId

Optional

Description
Billing ID of the account for which this api is
being executed
The code of the dashboard for which this api
is being executed
The code of the report for which the details
are requested
Locale in which the name of filters are to be
displayed
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.
244
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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=
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
ise_api_version

Required /
Optional
Required

Description
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

mdminfo
3
/ise/mdm/api
http://example.com
3000
true
Example Co.
Example Co. Mobile Device Manager
5.5.5


© Copyright IBM Corp. 2018. All rights reserved.
245
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
paging
querycriteria

Required /
Optional
Required
Optional

Description
0 means first call or all records
Choose the query criteria category:
•
macaddress
•

value

filter

Optional

Required

compliance

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
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.
246
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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

attributes
2
0


000000000000

true

false
something not compliant
instruction on how to rememdiate

yes
true
false
Samsung
1234567890
A0123456789012
2b6f0cc904d137be2e1730235f5664094b831186
Android,4.3





© Copyright IBM Corp. 2018. All rights reserved.
247
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
paging
querycriteria

Required /
Optional
Required
Optional

Description
0 means first call or all records
Choose the query criteria category:
•
macaddress
•

value

filter

Optional

Required

compliance

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
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.
248
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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

attributes
2
0


000000000000

true

false
something not compliant
instruction on how to rememdiate

yes
true
false
Samsung
1234567890
A0123456789012
2b6f0cc904d137be2e1730235f5664094b831186
Android,4.3





© Copyright IBM Corp. 2018. All rights reserved.
249
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
actionType

Required /
Optional
Required

Description
Choose the action type, and upload an XML payload:
• full_wipe
•

corporate_wipe

•

pin_lock

Request payload:



 000000000000


Sample Request
https://services.fiberlink.com/ciscoise/action/actionType=pin_lock
Sample Response

action
2


000000000000

true
Not Compliant





© Copyright IBM Corp. 2018. All rights reserved.
250
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
sendmessage

Required /
Optional
Required

Description
Upload an XML payload for the message

Request payload:



 000000000000
 111111111111


Alert
Need your action in the next 10 minutes
Text body


Sample Request
https://services.fiberlink.com/ciscoise/sendmessage
Sample Response

sendmessage
2


000000000000

false
something happened, message is not sent



111111111111

true
 





© Copyright IBM Corp. 2018. All rights reserved.
251
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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/
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
billingId

Required / Optional
Required

authStatus

Optional

fromDate
toDate
pageSize

Optional
Optional
Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Status of the authentication
(Successful, Device
Authentication Failed, User
Authentication Failed)
Starting date for limit of audit
End date for limit of audit
Limit number of events returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default is first page

Sample XML Response

10
1
50

40005185_hs.harish
1493279650928
1493278946000
70.2
Windows Seven NT 6.1
Chrome 57.0.2987.133
208.76.135.129
Successful


Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only

© Copyright IBM Corp. 2018. All rights reserved.
252
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Roles Audit
Request
GET /account-provisioning/roles/1.0/getRolesAudit/customer/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of roles for a billing ID.
Parameters
Parameter Name
billingId

Required /
Optional
Required

fromDate
toDate

Optional
Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for which the web-service is
being executed
Start date for limit of audit (Required if toDate is used)
End date for limit of audit (Required if fromDate is
used)
Limit number of audits returned at one time. Allowed
page sizes: 25, 50, 100, 200, 250. Default value: 50
Results specific to a particular page. Default: first page

Sample XML Response

10
1
50

57605
Custom
Testing..!
Y
1491315257000
INSERT


INSERT
Change Compliance Rule Set
Device Management
Ability to change a compliance rule set through a Device View
action.




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.
253
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Services Audit
Request
GET /account-provisioning/service/1.0/getServicesAudit/customer/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides an audit of services for the billing ID.
Parameters
Parameter Name
billingId

Required / Optional
Required

serviceKey

Optional

fromDate
toDate
pageSize

Optional
Optional
Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Unique service name. For
example, ACT_SYNC_NOTES,
MAM_INT, MAC
Starting date for limit of audit
End date for limit of audit
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response

10
1
50

1493010852774
pragagar@in.ibm.com
10.104.23.168
MALWARE_DETECT
Enable threat management
MAM_INT
Enable IBM Traveler and IBM Connections Cloud
integration
ENABLE


Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only

© Copyright IBM Corp. 2018. All rights reserved.
254
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Deployment Settings Audit
Request
GET /account-provisioning/settings/1.0/getDeploymentSettingsAudit/customer/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of deployment settings for the billing ID.
Parameters
Parameter Name
billingId

Required / Optional
Required

fromDate
toDate
pageSize

Optional
Optional
Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Starting date for limit of audit
End date for limit of audit
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response

10
1
50


Yes
abc@gmail.com


ad

ipad, iphone
Yes
Enrollment

No




Yes
HELLO




Yes
abc@gmail.com



Yes
United States


© Copyright IBM Corp. 2018. All rights reserved.
255
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.


No

Yes

No


Yes
HLC Pvt. Ltd.
y@gmail.com
12345
No Bunk


Yes
All Devices
xyz@ymail.com
test@ymail.com

1493292365868
20014949_psoni170


No


maas_auth


Yes
All Devices
xyz@ymail.com




Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only

© Copyright IBM Corp. 2018. All rights reserved.
256
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Login Settings Audit
Request
GET /account-provisioning/settings/1.0/getLoginSettingsAudit/customer/
Content Type Header: application/x-wws-form-urlencoded
Definition
❖ Provides audits of login settings for the billing ID.
Parameters
Parameter Name
billingId

Required / Optional
Required

fromDate
toDate
pageSize

Optional
Optional
Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Starting date for limit of audit
End date for limit of audit
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response

10
1
50

1495440227523
20014960_hs.harish
SAML

http://WDADFS01.fiberlinkqa.local/adfs/services/trust
https://WDADFS01.fiberlinkqa.local/adfs/ls/
harish@gmail.com
Yes

No
No


abc@gmail.com

Yes



1495432342725
20014960_hs.harish
SAML

http://WDADFS01.fiberlinkqa.local/adfs/services/trust
https://WDADFS01.fiberlinkqa.local/adfs/ls/
abc@gmail.com
Yes

© Copyright IBM Corp. 2018. All rights reserved.
257
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.


No
Yes

Customer User Directory
No



Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only

© Copyright IBM Corp. 2018. All rights reserved.
258
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Notifications Settings Audit
Request
GET /account-provisioning/settings/1.0/getNotificationsSettingsAudit/customer/
Content Type Header: application/x-www-form-urlencoded
Definition
❖ Provides audits of notification settings for the billing ID.
Parameters
Parameter Name
billingId

Required / Optional
Required

status

Optional

fromDate
toDate
Status

Optional
Optional
Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Active/Inactive. If not provide
will return both
Starting date for limit of audit
End date for limit of audit
Enabled or Disabled. Default:
both
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response

2
1
50

1494565275161
20014949_muqbasha
208.76.135.129

MTC_DEVICE_ENROLLMENTS

Enabled


MTC_APP_DISTRIBUTION

Enabled



Access Control
Customer Properties: Enable Web Services
Access Rights: Device View - Read-only

© Copyright IBM Corp. 2018. All rights reserved.
259
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
billingId

Required / Optional
Required

fromDate

Optional

toDate

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Starting date for limit of audit
(Required if toDate is given)
End date for limit of audit
(Required if fromDate is given)
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response
Representation of actions taken on user group

10
1
50

RCB vs SRH new
3
40005325_psoni170
40005325_psoni170
1
0
0

POLICY
40005325_psoni170
1493165061378



Representation for changes done on User group (e.g. description/name change)

10
1
50

RCB vs SRH new
3
40005325_psoni170
1492681676983
40005325_psoni170

© Copyright IBM Corp. 2018. All rights reserved.
260
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

1
0
0

GROUP_EDIT
40005325_psoni170
1493165061378


f4a5d411-ddbd-4d12-b319-b4ff4d43015e



Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Read-only

© Copyright IBM Corp. 2018. All rights reserved.
261
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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
billingId

Required / Optional
Required

fromDate

Optional

toDate

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Starting date for limit of audit
(Required if toDate is given)
End date for limit of audit
(Required if fromDate is given)
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response
Representation of actions taken on Device group

10
1
50

Employee Owned Devices
2
40005325_psoni170
1492681676983
40005325_psoni170
1
0
0

ACTION_HIDE_DEVICE
Removed via Device Groups.Group Name: Employee Owned
Devices
40005325_psoni170
1492681677008
COMPLETED
1493286477062



Representation for changes done on Device group (e.g. description/name change)

10
1
50


© Copyright IBM Corp. 2018. All rights reserved.
262
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Copy of iOS Devices
2
40005325_psoni170
1492681654529
40005325_psoni170
1
0
0

CREATE_DEVICE_GROUP
1492682175993





Access Control
Customer Properties: Enable Device View
Access Rights: Device View - Read-only

© Copyright IBM Corp. 2018. All rights reserved.
263
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Admin Changes Audit
Request
GET account-provisioning/administrator/1.0/getAdminChangesAudit/customer/
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
billingId

Required / Optional
Required

accountStatus

Optional

fromDate

Optional

toDate

Optional

pageSize

Optional

pageNumber

Optional

Description
Billing ID of the account for
which the web-service is being
executed
Active/Inactive. If not provided
will return both
Starting date for limit of audit
(Required if toDate is given)
End date for limit of audit
(Required if fromDate is given)
Limit number of audits returned
at one time. Allowed page sizes:
25, 50, 100, 200, 250. Default
value: 50
Results specific to a particular
page. Default: first page

Sample XML Response

10
1
50

1492044920000
pragagar@in.ibm.com
UPDATE
208.76.135.129

hs.harish@in.ibm.com
40005185_hs.harish
Harishkumar

H



 Yes 
true
All Groups
1492044637000
Successful
Administrator
Help Desk

Harish





© Copyright IBM Corp. 2018. All rights reserved.
264
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Access Control
Customer Properties: Enable Web Services
Access Rights: Read-only

© Copyright IBM Corp. 2018. All rights reserved.
265
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Alerts
Create Alert
Request
POST https:///alert-apis/alerts/2.0/alerts/customer/
Definition
❖ Create an alert using search criteria
o Authorization header: MaaS token=
o Accepts XML or JSON headers
Parameters
Parameter Name
billing_id

Required /
Optional
Required

Description
Billing ID of the account for which the web-service is
being executed

Sample JSON Request
{
"name":"",
"description":"",
"type":"",
"availableFor":""
"deviceStatus" : "",
"lastReported" : "",
"criteriaOperator" : "",
"deviceTypes" : [ "device type 1", "device type 2", ..]
"conditions" : [
{
"category" : "",
"attribute" : "",
"criteria" : "",
"value1" : "",
"value2" : ""
}
}
Sample Request Parameters
Parameter Name
name
description
deviceStatus

Required /
Optional
Required
Required
Optional

lastReported

Optional

deviceTypes

Optional

criteriaOperator

Optional

conditions
category
attribute

Optional
Required
Required

Description
Name of the alert being created.
Description of the alert being created.
Status of the device being searched for. Default: Active
Devices
Search includes devices last reported in this time.
Default: Last 7 Days
Types of devices to include in search. Default: All
available types are included
Decides if the devices meet all or any one condition
provided. Default: All Conditions (AND)
Conditions for search criteria, maximum of 10
Category name on which condition is being constructed
Attribute name on which condition is being constructed.
Requires the category parameter.

© Copyright IBM Corp. 2018. All rights reserved.
266
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

criteria

Required

value1

Required

value2

Optional

type

Optional

availableFor

Optional

Criteria to be used for comparison of values. Requires
the attribute parameter.
Value of the attribute. Requires the criteria parameter
and the attribute parameter.
Second value of the attribute. Use if criteria such as
“between” is used.
Type of group being created. Possible values: Security,
Info
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
0
1
2
3
4

5

6
7
8
9

10
11
12
13

Message

Scenario

Alert created successfully
Unknown error occurred while
creating alert
Alerts are not enabled for this
billingId
Alert name requires at lease
one non-space character
Alert name does not support
the following special
characters: ampersand
(&),lesser than (<) and greater
than (>)
Alert description does not
support the following special
characters: ampersand
(&),lesser than (<) and greater
than (>)
Alert description requires at
lease one non-space character
Invalid value provided for
deviceStatus
Invalid value provided for
lastReported
Invalid value operator
provided for criteriaOperator

When an alert is created without any errors
When an internal error occurs

Invalid values provided for
deviceTypes
Number of conditions provided
exceed 10
Invalid value provided for
category
Invalid value provided for
attribute

When alerts are not enabled for the requested user
When an alert name is not provided or provided with
empty characters
When an alert name contains illegal characters

When an alert description contains illegal characters

When an alert description is not provided or provided
with empty characters
When the value provided for the deviceStatus is not
"Active Devices","Inactive Devices","All Devices"
When an invalid value is provided for lastReported
When the value provided for criteriaOperator
provided is not "All Conditions (AND)", "Any Condition
(OR)", "Across Conditions (Advanced)"
When deviceTypes provided contain invalid or
unavailable values
When the number of conditions provided is more
than 10
When an invalid value is provided for category
When an invalid value is provided for attribute

© Copyright IBM Corp. 2018. All rights reserved.
267
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

14
15
16

17
18

19
20
21

22
23
24
25

Invalid value provided for
criteria
Two values are required for
"Between" criteria
At least one invalid value
provided for attribute of type
date/timestamp
At least one invalid value
provided for attribute of type
number/double
At least one invalid value
provided for attribute of type
integer
No value is provided in
condition for comparision
Second value provided in
condition unnecessarily
Invalid value provided for
enum type attribute
Invalid value provided for
boolean type attribute
Advanced criteriaOperator is
not yet supported
Invalid value provided for
availableFor
Invalid alert type provided

When an invalid value is provided for criteria
When "Between" criteria is provided, but only one
valid value is specified
When the value for date is not in epoch milliseconds
format or empty
When an invalid value is provided for attributes of
number/double format
When an invalid value is provided for attributes of
Integer format
When at least one value is not provided for
comparison in th econdition
When non "Between" criteria is selected, but a
second value is provided
When an enum attribute is selected, but the
comparison value provided is not one of the values in
enum definition
When enum attribute is selected, but with a value
that is not "Yes" or "No"
When Advanced search criteria is provided, but it’s
not yet available for general use
When a value other than "Only Me","All
Administrators" is provided for availableFor
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.
268
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Platform-Specific APIs
Mac APIs
Get GA or Beta Version Details of Mac Apps
Request
GET https://${services-url}/mac-apis/mac-appservices/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": "\n\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
 \n"
},
{
"productName": "MAC_APP_CATALOGUE",
"type": "GA",
"version": "1.30",
"manifest": "\n\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
 \n"
},

© Copyright IBM Corp. 2018. All rights reserved.
269
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

{
"productName": "MAC_APP_CATALOGUE",
"type": "BETA",
"version": "1.40",
"manifest": "\n\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
 \n"
},
{
"productName": "MAC_PACKAGER",
"type": "GA",
"version": "1.40",
"manifest": "\n\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
 \n"
}
]
}

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 URLprefix, major version, and minor version in the template is substituted by the fabric task.

© Copyright IBM Corp. 2018. All rights reserved.
270
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Get Download Location of Mac Apps
Request
GET https://${services-url}/mac-apis/mac-appservices/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/cdncontent/agents/MAC_APP_CATALOGUE/AppCatalog_Signed.pkg"
}

© Copyright IBM Corp. 2018. All rights reserved.
271
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Change History
#

Date

1

03/06/2015

/applications/1.0/getAppDetails/

API

Existing

Type

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

4

03/06/2015

/devices/1.0/softwareInstalled/

Existing

Corrected Sample Request in documentation addIOSEnterpriseAppPlus instead of
appIOSEnterpriseAppPlus
Return additional attribute Manage Status for
apps installed on iOS device.

5

03/06/2015

/devices/1.0/enrollDevice/

Existing

1

06/06/2015

/devices/2.0/search/

New

Changes

Support for specifying optional attributes while
creating
Enrollment request - enrollWithMdm,
workplacePolicy
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

5

06/06/2015

/devices/1.0//hideDevice/

New

Hide device action on a device

6

06/06/2015

/devices/1.0/updateDeviceCert/

New

7

06/06/2015

/devices/1.0/searchActionHistory/

Existing

8

06/06/2015

/devices/1.0/enrollDevice/

Existing

Action to update Device Certificates issued to a
device
Support for optional search criteria - actionStatus,
actionBy, actionType , actionTimeFrom &
actionTimeTo
Support for specifying custom attribute values
when creating enrollment request

9

06/06/2015

/devices/1.0/manageDeviceEnrollments/

Existing

10

06/06/2015

/devices/1.0/policies/

Existing

11

06/06/2015

/applications/1.0/getAppDetails

Existing

Support for activation lock bypass for wipe

Return custom attribute values specified for
enrollment requests
Support for filtering by Windows Phone and
WorkPlace Persona policy
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

13

06/06/2015

/applications/1.0/upgradeApp

Existing

Support for new Optional search criteria –
activeDistribution
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.
272
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

19

06/06/2015

/applications/2.0/addPlayApp/

20

06/06/2015

/applications/1.0/addAndroidEnterpriseApp

21

06/06/2015

/applications/1.0/addAndroidEnterpriseAppPlus/

22

06/06/2015

/user/1.0/search/

New
Existing
New
Existing

Enhanced version of addPlayApp API to support
specifying App attributes
Support for specifying App attributes & categories
New API to add large android enterprise apps
greater than 50 MB
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

2

08/11/2015

/devices/1.0/manageDeviceEnrollments/

3

08/11/2015

/group-apis/group/1.0/groups/

New

4

08/11/2015

/user-apis/user/1.0/searchByGroup/

New

New API to assign a Compliance Ruleset for a
device
Support to search by phoneNumber and
phoneNumber & maaS360DeviceID in the
response
Returns User & Device Groups available to the
currently logged-in
Administrator
Returns users in a User Group

5

08/11/2015

/group-apis/group/1.0/distributions/

New

6

08/11/2015

/device-apis/devices/1.0/policies/

Existing

Existing

Returns various distributions on a User or Device
Group
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

11

08/11/2015

/user-apis/user/1.0/removeGroups/

New

12

08/11/2015

/user-apis/user/1.0/userAttributes/

New

13

08/11/2015

Existing

14

08/11/2015

15

08/11/2015

/accountprovisioning/account/1.0/getCustomerConfig/
/accountprovisioning/account/1.0/setCustomerConfig/
/device-apis/devices/1.0/searchActionHistory/

Add one or more User Groups to a Local user
account
Remove one or more User Groups from a Local
user account
Returns all user custom attributes defined for an
account
Return allocatedSpace & usedSpace attributes in
the response

16

08/11/2015

/deviceapis/devices/1.0/authenticateAdministrator

1

10/09/2015

2
3

Existing

Set allocatedSpace attribute for an account

Existing

Existing

1. Support for returning only
Compliance Events 2. Updated
some attributes in response –
deviceId, errorDescription
API deprecated & removed from documentation

/devices/2.0/search/customer/

Existing

Search API V2 is released

10/09/2015

/devices/1.0/mdSecurityCompliance/

Existing

10/09/2015

/accountprovisioning/account/1.0/getCustomerConfig/

Existing

Added workplace persona policy and compliance
keys
Added support for external account IDs

© Copyright IBM Corp. 2018. All rights reserved.
273
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

4

10/09/2015

Existing

Added support for external account IDs

10/09/2015

/accountprovisioning/account/1.0/setCustomerConfig/
/createCustomerAccount/

5

Existing

Added support for external account IDs

5

10/09/2015

/applications/1.0/getAppDetails/

Existing

6

10/09/2015

/applications/1.0/distributeApp/

Existing

Added “What’s New, package update time, and
screenshot URLs
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

Existing

Added ability to get enabled services in a Persona
Policy

11

10/09/2015

/policymgmtapis/policies/2.0/enabledServices/customer/
/searchCustomers/

Existing

12

10/09/2015

/reporting-apis/bi/1.0/getDashboards/

Existing

Added ability to get the list of customers for a
Partner
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/

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

Existing

Added preferred language

5

12/10/2015

/accountprovisioning/account/1.0/setCustomerConfig/
/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

New

Get User’s Enabled Services

2

09/07/2016

New

Enable a Service for a Customer

3

09/07/2016

/accountprovisioning/accountreporting/1.0/getUserReport/
/accountprovisioning/service/1.0/enableService/
accountprovisioning/service/1.0/disableService/

New

Disable a Service for a Customer

4

09/07/2016

/accountprovisioning/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

Existing

Added customerVertical parameter.

Existing

Updated Sample Request.

New

Assigns a specified user to a device

/account-provisioning/account/1.0/setCustomerConfig

1

02/08/2017

/accountprovisioning/account/1.0/setPartnerAccountConfig

Old Sample Request:
POST https://services.fiberlink.com/account-

© Copyright IBM Corp. 2018. All rights reserved.
274
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

provisioning/account/1.0/setPartnerAccountConfi
g/1101234

2

02/08/2017

/application-apis/applications/1.0/stopAppDistribution/

Existing

New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/setPartnerAccountConfi
g/
1101234?partnerBillingId=1101234
&leadNotificationEmail=abc@example1.com&tria
lDuratio=75
&adminEULASettings=1&endUserReacceptEULAE
nabled=No
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/stopAppDistribution/10072
63

3

02/08/2017

/device-apis/devices/1.0/getEnabledMaaS360Services/

Existing

4

02/08/2017

/device-apis/devices/1.0/computerNetworkInformation/

Existing

5

02/08/2017

/device-apis/devices/1.0/sendMessage/

Existing

New Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/stopAppDistribution/10072
63?appType=
1&appId=com.example&targetDevices=0
Added new Mandatory attributes in Response:
service
Added new Mandatory attributes in Response:
maas360DeviceID
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/sendMessage/1101234/

6

02/08/2017

/device-apis/devices/1.0/changeRuleSet/

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/sendMessage/1101234?deviceId
=
a1b2c3&messageTitle=message&message=hi
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/changeRuleset/1001234
New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/changeRuleset/1001234?deviceI
d=
androidc1a2b3c&rulesetName=foo
2. Changed parameter name.

7

02/08/2017

/application-apis/applications/1.0/distributeApp

Existing

Old parameter name: Maas360DeviceID
New parameter name: deviceId
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/distributeApp/1007263
New Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/distributeApp/

© Copyright IBM Corp. 2018. All rights reserved.
275
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

8

02/08/2017

/application-apis/applications/1.0/markAsPrimary

Existing

1007263?appType=1&appId=com.example&targe
tDevices
=0&instantInstall=Yes&sendEmail=yes&sendNotifi
cation
=Yes
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/markAsPrimary/1007263

9

02/08/2017

/user-apis/user/1.0/addUser/customer

Existing

New Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/markAsPrimary/
1007263?appType=1&appId=com.example&appV
ersion
=4.0.1
Updated Sample Request.
Old Sample Request:
POST /userapis/user/1.0/addUser/customer/1007463/

10

02/08/2017

/account-provisioning/account/1.0/getCustomerConfig

Existing

New Sample Request:
POST https://services.fiberlink.com/userapis/user/1.0/addUser/customer/1007463?userN
ame=
abc&domain=example.com&email=abc@example
.com
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/getCustomerConfig/110
1234
New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/getCustomerConfig/110
1234?
customerBillingId=1101235
2. Changed Mandatory attributes in Response.

11

02/08/2017

/account-provisioning/account/1.0/extendAccount

Existing

Old response: customerBillingId
New response: billingId
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/extendAccount/110123
4

12

02/08/2017

/accountprovisioning/account/1.0/checkAccountNameAvailability

Existing

New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/extendAccount/110123
4?
customerBillingId=1101235
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/checkAccountNameAvai
lability/

© Copyright IBM Corp. 2018. All rights reserved.
276
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

1101234

13

02/08/2017

/account-provisioning/account/1.0/expireAccount

Existing

New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/checkAccountNameAvai
lability/
1101234?accountName=ExampleCo
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/expireAccount/1101234

14

02/08/2017

/device-apis/devices/1.0/searchByDeviceGroup/

Existing

New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/account/1.0/expireAccount/1101234
?
customerBillingId=1101235
Changed Mandatory attributes in Response.

15

02/08/2017

/device-apis/devices/1.0/packageDistributionHistory/

Existing

16

02/08/2017

/device-apis/devices/1.0/locationHistory/

Existing

Old response: deviceID
New response: maas360DeviceID
Added new Mandatory attributes in Response:
maas360DeviceID
Changed parameter name.

Existing

Old parameter name: Maas360DeviceID
New parameter name: deviceId
1. Updated Sample Request.

17

02/08/2017

/device-apis/devices/1.0/enrollDevice/

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.

18

02/08/2017

/accountprovisioning/account/1.0/createCustomerAccount

Existing

Old parameter name: CustomAttributes
New parameter name: customAttributes
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning
/account/1.0/createCustomerAccount/1101234
New Sample Request:
POST https://services.fiberlink.com/accountprovisioning
/account/1.0/createCustomerAccount/1101234?
accountType=Customer&accountName=

© Copyright IBM Corp. 2018. All rights reserved.
277
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Demo
Customer1&adminEmailAddres=abc@example.co
m
Changed Mandatory attributes in Response.

19

02/08/2017

/account-provisioning/service/1.0/getServicesInfo

Existing

Old response:
billingID,partnerBillingID,adminUsernam
New response:
billingId,partnerBillingId,adminUserName
Updated Sample Request.
Old Sample Request:
GET https://services.fiberlink.com/accountprovisioning/
service/1.0/getServicesInfo/1224321

20

02/08/2017

/device-apis/devices/1.0/approveDeviceMessagingSystem

Existing

New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/service/1.0/getServicesInfo/1224321
?
loggedInUserbillingId=
1224321&customerBillingId=1224321
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/approveDeviceMessagingSystem
/
1101234

21

02/08/2017

/device-apis/devices/1.0/selectiveWipeDevice

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/approveDeviceMessagingSystem
/
1101234?deviceId=a1b2c3
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/selectiveWipeDevice/1101234/

22

23

02/08/2017

02/08/2017

/device-apis/devices/1.0/deviceActions

/device-apis/devices/1.0/locateDevice

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/selectiveWipeDevice/
1101234?deviceId=a1b2c3
Changed parameter name.

Existing

Old parameter name: deviceID
New parameter name: deviceId
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/locateDevice/1101234

24

02/08/2017

/device-apis/devices/1.0/hideDevice

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/locateDevice/1101234?deviceId=
a1b2c3
Updated Sample Request.
Old Sample Request:

© Copyright IBM Corp. 2018. All rights reserved.
278
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

POST https://services.fiberlink.com/deviceapis/devices/1.0/hideDevice/1101234/

25

26

02/08/2017

02/08/2017

/device-apis/devices/1.0/hardwareInventory

/application-apis/applications/1.0/addPlayApp

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/hideDevice/1101234?deviceId=a
2e13f
Changed Mandatory attributes in Response.

Existing

Old response: maas360DeviceID
New response: maas360DeviceId
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/addPlayApp/1007263

27

02/08/2017

/accountprovisioning/administrator/1.0/createAdministrator

Existing

New Sample Request:
POST https://services.fiberlink.com/applicationapis/
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
1. Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/accountprovisioning/administrator/1.0/createAdministrat
or/
1101234
New Sample Request:
POST https://services.fiberlink.com/accountprovisioning/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.

28

02/08/2017

/application-apis/applications/1.0/deleteApp

Existing

Old response: customerBillingID
New response: customerBillingId
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/applicationapis/applicatio
ns/1.0/deleteA
pp/1007263

29

02/08/2017

/device-apis/devices/1.0/blockDeviceMessagingSystem

Existing

New Sample Request:
POST https://services.fiberlink.com/applicationapis/applications/1.0/deleteApp/1007263?appTy
pe=
1&appId=com.example
Updated Sample Request.

© Copyright IBM Corp. 2018. All rights reserved.
279
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/blockDeviceMessagingSystem/1
101234/

30

02/08/2017

/device-apis/devices/1.0/revokeSelectiveWipe

Existing

New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/blockDeviceMessagingSystem/
1101234?deviceId=a2e13f
Updated Sample Request.
Old Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/revokeSelectiveWipe/1101234/
New Sample Request:
POST https://services.fiberlink.com/deviceapis/devices/1.0/revokeSelectiveWipe/1101234?d
eviceId=
a1b2c3
Updated Sample Request to:
POST https://services.fiberlink.com/applicationapis/applications/2.0/addPlayApp/customer/1007
263

31

02/08/2017

/application-apis/applications/2.0/addPlayApp

Existing

1

02/09/2017

/device-apis/devices/1.0/updateCert

Existing

Added Parameter Type (Path/Query/Form) to
Parameters table.

/user-apis/user/1.0/updateUserCert
1

03/02/2017

/account-provisioning/service/1.0/getServicesInfo

Existing

Updated sample response with new tag 
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

New

New API: Add Windows Dependency

3

03/24/2017

New

New API: Add Windows Enterprise App

4

03/24/2017

New

New API: Add Windows EXE App

5

03/24/2017

New

New API: Add Windows MSI App

6

03/24/2017

/applicationapis/winApps/2.0/addWindowsDependency/customer
/applicationapis/winApps/2.0/addWindowsEnterpriseApp/customer
/applicationapis/winApps/2.0/addWindowsEnterpriseEXEApp/customer
/applicationapis/winApps/2.0/addWindowsEnterpriseMSIApp/customer
/application-apis/winApps/2.0/addWinStoreApp/customer

New

New API: Add Windows Store App

7

03/24/2017

New

New API: Delete Windows Dependency

8

03/24/2017

New

New API: Download Windows Dependency

9

03/24/2017

/applicationapis/winApps/2.0/deleteWindowsDependency/customer
/applicationapis/winApps/2.0/downloadWindowsDependency/customer
/application-apis/applications/2.0/getCategoryList/customer

New

New API: Get Category List

10

03/24/2017

New

New API: Mark App as Featured

11

03/24/2017

/applicationapis/applications/2.0/markAppAsFeatured/customer
/application-apis/applications/1.0/getAppDetails

Existing

12

03/24/2017

/application-apis/applications/1.0/search

Existing

Added appVersionState and rawManifestUrl
parameters in response.
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.
280
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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//group//type/
Get Admin Login Reports: /account-provisioningws/administrator/1.0/getAdminLoginReports/customer/
Get Roles Audit: /accountprovisioning/roles/1.0/getRolesAudit/customer/
Get Services Audit: /accountprovisioning/service/1.0/getServicesAudit/customer/
Get Deployment Settings Audit: /accountprovisioning/settings/1.0/getDeploymentSettingsAudit/cus
tomer/
Get Login Settings Audit: /accountprovisioning/settings/1.0/getLoginSettingsAudit/customer/

Get Notifications Settings Audit: /accountprovisioning/settings/1.0/getNotificationsSettingsAudit/cus
tomer/

New

Added QRadar integration APIs for 10.62 platform
release.

Provision New Customer Account: /accountprovisioning/account/1.0/createCustomerAccount/

Get Customer Account Configuration: /accountprovisioning/account/1.0/getCustomerConfig/

Set Customer Account Configuration: /accountprovisioning/account/1.0/setCustomerConfig/

Provision New Partner Account: /accountprovisioning/account/1.0/createPartnerAccount/


Existing

Added support for optional country parameter.

07/26/2017 Create New Device Custom Attribute: /deviceapis/devices/2.0/customAttributes/customer/
07/26/2017 •
Create Device Groups: /groupapis/group/2.0/deviceGroups/customer/
•
Create User Groups: /groupapis/group/2.0/userGroups/customer/
•
Get Search Criteria Options: /groupapis/group/2.0/searchCriteria/customer/

New

Added new device web service for 10.63 platform
release.
Added new group web services for 10.63 platform
release.

07/26/2017

New

•

•
•

•

•

•

1

07/26/2017 •

•

•

•

2
3

4

Create Alert: /alert-apis/alerts/2.0/alerts/customer/

New

Added new group web service for 10.63 platform
release under new Alerts category.

© Copyright IBM Corp. 2018. All rights reserved.
281
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

5

07/26/2017

•

•

Get GA or Beta Version Details of Mac Apps: /macapis/mac-appservices/v1/generic/customer/{billing_id}/macAppVersions
/{APPS_REQUIRED}
Get Download Loaction of Mac Apps: /mac-apis/mac-appservices/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

/accountprovisioning/account/1.0/searchCustomers/

Existing

Replaced corporateID parameter with corporateId.

1

08/07/2017

/device-apis/devices/1.0/enrollDevice/

Existing

Added new optional parameter:
authTypePostEnrollment

1

08/10/2017

1

08/17/2017

/deviceapis/devices/2.0/customAttributes/customer/

Added new Device Actions web service for 10.64
platform release: Get All Device Custom
Attributes for a Given Organization

1

08/24/2017

•

Added new App Catalog web services for 10.64
platform release.

Changed IBM QRadar Integration heading to Admin
Audit

•
•

•

Delete User Review and Update Rating: /applicationapis/applications/2.0/deleteReview/customer/
List Featured Apps and Bundles Info: /applicationapis/applications/2.0/deleteReview/customer/
List App Bundles with their Apps Info: /applicationapis/applications/2.0/getAppBundlesWithApps/customer/<
billingId>
Fetch All the Reviews: /applicationapis/applications/2.0/getAllReviews/customer/

1

09/25/2017

Extend Trial Account: /accountprovisioning/account/1.0/extendAccount/

Existing

Added support for expired accounts and changed
the values of the days parameter.

2

09/25/2017

•

Delete User: userapis/user/2.0/users/customer//user/
Delete User Status: userapis/user/2.0/deleteUserStatus/customer//user/


New

Added new User web services for 10.64 platform
release.

Get Partner Account Configuration: /account-provisioning/
account/1.0/getPartnerAccountConfig/
Set Partner Account Configuration: /account-provisioning/
account/1.0/setPartnerAccountConfig/

Existing

Added new parameter: country

•

3

09/25/2017

•
•

4

09/25/2017

Create Device Enrollment: /device-apis/
devices/1.0/enrollDevice/

Existing

Added two new parameters for Android for Work
enrollment: useAndroidWork and
androidWorkAccountType

1

10/04/2017

Enable a Service for a Customer: /accountprovisioning/service/1.0/enableService/
?&

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.
282
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

•

•

INT_DTM_LOCATE_C, INT_DTM_BIGFIX_C,
WINDOWS_ENROLLMENT_MODE

Disable a Service for a Customer: /accountprovisioning/service/1.0/disableService/
?&
Get Customer’s Allowed Services: /accountprovisioning/service/1.0/getServicesInfo/<
loggedInUserbillingId>?

1

01/02/2018

Set Device Name: /deviceapis/devices/1.0/setDeviceName/

Existing

Changed API type from GET to POST.

1

01/03/2018

Search Devices by Device Group: /deviceapis/devices/1.0/searchByDeviceGroup/

Existing

Added two new parameters: sortAttribute and
sortOrder.

1

02/01/2018

Get Network Information for a Mobile Device: /deviceapis/devices/1.0/mdNetworkInformation/

Existing

Added Current MCC, Subscriber MCC, Current
MNC, Subscriber MNC to the sample response.

2

02/01/2018 •

Basic Search (v1): /deviceapis/devices/1.0/search/
Basic Search (v2): /deviceapis/devices/2.0/search/customer/

Existing

Added isSupervisedDevice to the sample
response.

•

3

02/01/2018

Wipe Device: /device-apis/devices/1.0/wipeDevice/

Existing

Added a new parameter to request:
preserveDataPlan

1

02/13/2018

Get Cellular Data Usage for a Device: /deviceapis/devices/1.0/cellularDataUsage/

Existing

Updated sample response with correct version
that uses decimals in integer values.

© Copyright IBM Corp. 2018. All rights reserved.
283
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
284
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
285
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

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.
286
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.

© Copyright IBM Corp. 2018. All rights reserved.
287
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule
Contract with IBM Corp.



---

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.7
Linearized                      : No
Page Count                      : 287
Language                        : en-US
Tagged PDF                      : Yes
XMP Toolkit                     : 3.1-701
Producer                        : Microsoft® Word 2016
Creator                         : PCUSER
Creator Tool                    : Microsoft® Word 2016
Create Date                     : 2018:03:16 12:56:55+05:30
Modify Date                     : 2018:03:16 12:56:55+05:30
Document ID                     : uuid:53ABCCA8-CC43-42D6-8658-86ED4F376A71
Instance ID                     : uuid:53ABCCA8-CC43-42D6-8658-86ED4F376A71
Author                          : PCUSER

EXIF Metadata provided by EXIF.tools