Reference

Reference | baramundi Connect

Credit note: The information provided in this document is subject to constant change. We cannot guarantee that the
information given in this document is complete or correct. The contents of this document must not otherwise be used without
explicit written consent from baramundi software AG, irrespective of the manner or the means, electronic or mechanical, by
which this occurs.
Copyright © 2001, 2020 baramundi software AG. All rights reserved.
BARAMUNDI SOFTWARE AG, BEIM GLASPALAST 1, 86153 AUGSBURG

www.baramundi.com Page 2/120

 Reference | baramundi Connect

Revision History
Version Author Description
bMS 2020 R2 SF - Extended EndpointEnrollment controller by optional
bConnect V1.0 “EmailLanguageId” property. Change in default behavior: If the
parameter for the email language is not specified, the English
default template is used.
- Extended VPPUsersController by optional “EmailLanguageId”
property.
- Extended Endpoint by properties:
“EmailLanguageId”
“EmailRecipient”
- Extended VPPUser by optional “EmailLanguageId” property
bMS 2020 R2 SKL - Extended Endpoint by property
bConnect V1.0 “DedicatedDeviceModeEnabled”
bMS 2020 R2 MMU - Extended Endpoint by properties
bConnect V1.1 “LastUpdateInventoryDate”
“UpdateInventorySource”
“MissingCriticalUpdatesCount”
“MissingSecurityUpdatesCount”
“MissingOtherUpdatesCount”
“LastSuccessfulUpdateDate”
“LastSuccessfulUpdateSource”
bMS 2020 R2 ACH - Extended Endpoint by property
bConnect V1.0 “HasAppleAppUpdates”
bMS 2020 R2 BRI - Extended steps for windows job by step MicrosoftUpdateInventory
bConnect V1.0
bMS 2020 R2 MLA - Introduced MicrosoftUpdateInventories Controller
bConnect V1.0
bMS 2020 R2 FK - Extended Endpoint by properties
bConnect V1.0 “AppleManagementMode”,
“ManagedAppleId”
bMS 2020 R2 AC - Introduced VPPUsers and VPPLicenseAssociations Controller
bConnect V1.0
bMS 2020 R2 DK / - Introduced UniversalDynamicGroups Controller
bConnect V1.0 PWE - Extended controller Endpoints by parameter UniversalDynamicGroup
bMS 2020 R1 FHI - Extended Endpoint by properties
bConnect V1.0 “VirusAndThreadProtectionStatus”,
“AutomaticUpdateStatus”,
“FirewallAndNetworkProtectionStatus”,
“AppAndBrowserControlStatus”,
“WindowsSecurityServiceStatus”,
“UserAccountControlStatus”,
“SecurityCenterUser”
bMS 2020 R1 CB - Description of how credentials can be passed in the URL has been
bConnect V1.0 removed
bMS 2020 R1 MWA - Introduced ServerStateController
bConnect V1.0
bMS 2020 R1 MWA/ - Extended JobInstanceController by TimePeriod query to filter by
bConnect V1.0 DS LastActionTime.
bMS 2020 R1 MLA - Introduced EndpointEnrollment controller
bConnect V1.0 FHI - Extended controller Endpoints by IndustrialData

www.baramundi.com Page 3/120

 Reference | baramundi Connect

bMS 2019 R2 AC / - Updating the “Category” and “Name” properties of a VariableDefinition

bConnect V1.0 TST/ object will not change the ID of that object anymore
FHI/ - Kiosk job controller extended with request to create kiosk job with user
KGR principal name as target
- New supported VariableDefinition scopes “AdObject”, “Bulletin” and
“Component”
- PrimaryIP can be set for a Windows Endpoint via POST and PATCH;
- CustomStateText and CustomStateType can be set in a PATCH-
request for a Windows Endpoint
- Extended controller Endpoints by property “TPMData”
- Extended controller Endpoints by property “IsSecureBootEnabled”
- Extended controller Endpoints by property “StorageMedium”
- Introduced EndpointSecrets controller
ACH - Added support for “Comments” property on creating Endpoints
bMS 2019 R1 MSC / - Introduced VariableDefinitions controller and the corresponding object
bConnect V1.0 SSC / VariableDefinition
AC / - Extended object Applications by property “Parameters”
FHI / - Extended object Applications by property “SoftwareDependencies”
TST - Extended object Applications by property “SoftwareLicenseActions”
- Extended controller Jobs by the ability to delete Job objects
- New Controller for Kiosk job releases.
- Search controller now supports AD objects.
bMS 2018 R2 TK / - Endpoint objects of type WindowsEndpoint no longer require a
bConnect V1.0 FHI / Hardware Inventory for the properties “Manufacturer”, “SerialNumber”
PWE and “ModelName”
- Endpoint objects of type NetworkEndpoint now support the property
"SerialNumber"
- Newly created applications will use the “LocalSystem” security context
instead of “LocalInstallUser” for installation by default
- Added support for driver packages in “HardwareProfiles”
- Added controller SoftwareScanRuleCounts and object
SoftwareScanRuleCount
- Extended controller Endpoints by the ability to filter by “Registered
User”
- Extended controller Jobs by the ability to filter by “Kiosk User”
- Extended controller JobInstance by the ability to set “initiator”
- Extended controller JobInstance by the ability to filter by “Endpoint”
and “Kiosk User”
- Extended object Job by property “DisplayName” and “IconId”
- Added Controller “Images”
- Added Category to “Job”
- Extended object JobInstance by property “JobDefinitionDisplayName”
bMS 2018 CB / - Extended JobInstance enumeration “BmsNetState” by new value 11
bConnect V1.0 JSC - Updated documentation of controller Endpoints concerning Windows
Endpoint Options on POST method
- Updated documentation of controller Endpoints concerning the
optional Windows Endpoint property “PrimaryUser” on POST and
PATCH method
bMS 2017 DS / - Added controller InventoryDataSnmpScans and corresponding object
bConnect V1.0 CB / DataSnmp
RE - Added controller InventoryDataHardwareScans and corresponding
object DataHardware
- Extended the Type of an InventoryOverview object by the value
“Hardware”
- Extended controller Applications by the ability to create, update and
delete an application

www.baramundi.com Page 4/120

 Reference | baramundi Connect

- Extended object Application by property “AUT”

- Extended types of endpoint by NetworkEndpoint
- Extended object Endpoint by property “SnmpData”
- Extended controllers Endpoints and Search to support the new
endpoint type NetworkEndpoint
- Extended endpoint property Mode by value “Dynamic”
- Extended endpoint property LastChannel by values “AutoLAN” and
“AutoInternet”
- Added support for new job steps ApplicationConfigureJobStep and
ApplicationRemoveConfigurationJobStep
bMS 2016 R2 DS / - Added controllers BootEnvironments, Applications , Apps, Icons,
bConnect V1.0 TK / InventoryAppScans
CB - Extended Search controller by the ability to look for objects of type
Application and App
- Extended OrgUnits controller by adding the scope for bMC nodes
Applications and Apps
- Extended object Endpoint by properties “Mode”, “LastChannel”,
“ExtendedInternetMode”, “InstalledSoftware”, “OSVersionPatchLevel”,
“OSReleaseId” and “OSServiceBranch”
- Extended object Job by properties “Steps” and
“SupportEndpointsInInternetMode”
- Extended object JobInstance by property “Steps”
- Extended Variables controller by scope “Software” and
“Hardwareprofile”
bMS 2016 OKR / - Added support for custom header “Client-Request-ID” and standard
bConnect V1.0 TK / header “Accept-Encoding”
CB - Added new controllers DynamicGroups, StaticGroups and
HardwareProfiles
- Extended controller OrgUnits by the ability to create, update or delete
org unit objects
- Extended the controller OrgUnits by adding the scope for nodes Static
Groups and Dynamic Groups
- Extended object OrgUnit by properties “Extension” and “HierarchyPath”
- Extended controller Endpoints by the ability to update endpoints by id
- Extended controller Endpoints by actions to request all endpoints of
static or dynamic groups
- Extended object Endpoint by property “PublicKey”
- Extended the scope of controller Variables for org units variables (Org
units of node Logical Groups only)
- Extended controller Variables by property “Type” (type of a variable)
- Extended the scope of the controller Search by org units as well as
dynamic and groups
- Extended object Job by the property “Destructive”
- Extended object JobInstance by the properties “EndpointName” and
“JobDefinitionName”
bMS 2015 R2 CB - Added column “Since bMS” with appropriate bMS version for all
bConnect V1.0 actions
- Added codings for Endpoint property “ClientAgentState”
- Endpoint properties “Owner” and “ComplianceCheckCategory” marked
for endpoint creation access (“C”)
- Deleted UserJobOptions Flag 0x00000020 (part of Endpoint property
“Options”)
- Extended JobInstance enumeration “BmsNetState” by new value 10
- Extended object SearchResult by new property “Deactivated”
- Further minor corrections

www.baramundi.com Page 5/120

 Reference | baramundi Connect

bMS 2015 CB - Added new controllers Variables, InventoryDataRegistryScans,

bConnect V1.0 InventoryDataFileScans, InventoryDataWMIScans,
InventoryDataCustomScans and InventoryOverviews
- Extended controller Endpoints by an action to delete an endpoint
- Extended controller JobInstances by an action to request all existing job
instances of a specific job
- Extended controller JobInstances by an action to start, stop or resume
a specific job instance
- Extended controller JobInstances by an action to delete a specific job
instance
- Added simple bConnect integration samples for PowerShell, Visual
Basic Script and C#
- Added support of properties “Manufacturer”, “Serial Number” and
“Model Name” for endpoints of type WindowsEndpoint. Requirement is
at least one successful executed Hardware Inventory with the bMS.
- Some properties of different object types were marked as
DEPRECATED. They might be removed in the next bConnect version.
bMS 2014 R2 CB - Added controllers Search and OrgUnits
bConnect V1.0 - Extended controller Endpoints, Jobs and JobInstances by support for
endpoints of type Android, WindowsPhone8, iOS and Mac
- Extended controller Endpoints by an action to request all endpoints of
a specific org unit
- Extended controller Endpoints by an action to create an endpoint with
specified parameters
- Extended controller JobInstances by an action to request all existing job
instances of a specific endpoint
bMS 2014 CB - Initial documentation of the bConnect interface in English.
bConnect V1.0

www.baramundi.com Page 6/120

 Reference | baramundi Connect

TABLE OF CONTENTS

1 Overview ......................................................................................................................... 10
2 Configuration................................................................................................................... 11
3 Calling Syntax ................................................................................................................. 13
4 Authentication & Headers ............................................................................................... 15
4.1 Authentication ...................................................................................................... 15
4.2 Headers ............................................................................................................... 15
5 Controllers and actions ................................................................................................... 16
5.1 Controller Version ................................................................................................ 17
5.2 Controller Info ...................................................................................................... 18
5.3 Controller Search ................................................................................................. 19
5.4 Controller OrgUnits .............................................................................................. 20
5.5 Controller DynamicGroups .................................................................................. 22
5.6 Controller UniversalDynamicGroups ................................................................... 25
5.7 Controller StaticGroups ....................................................................................... 26
5.8 Controller Endpoints ............................................................................................ 29
5.9 Controller Jobs ..................................................................................................... 34
5.10 Controller JobInstances ....................................................................................... 36
5.11 Controller HardwareProfiles ................................................................................. 39
5.12 Controller BootEnvironment ................................................................................. 40
5.13 Controller Variables ............................................................................................. 41
5.14 Controller Apps .................................................................................................... 44
5.15 Controller Icons .................................................................................................... 44
5.16 Controller Applications ......................................................................................... 45
5.17 Controller InventoryDataRegistryScans ............................................................... 48
5.18 Controller InventoryDataFileScans ...................................................................... 49
5.19 Controller InventoryDataWMIScans .................................................................... 50
5.20 Controller InventoryDataCustomScans ............................................................... 51
5.21 Controller InventoryDataHardwareScans ............................................................ 52
5.22 Controller InventoryDataSnmpScans .................................................................. 53
5.23 Controller InventoryOverviews ............................................................................. 53
5.24 Controller InventoryAppScans ............................................................................. 54
5.25 Controller SoftwareScanRules ............................................................................. 55
5.26 Controller SoftwareScanRuleCounts ................................................................... 56
5.27 Controller EndpointInvSoftware ........................................................................... 57
5.28 Controller Images ................................................................................................ 58
5.29 Controller VariableDefinitions .............................................................................. 59
5.30 Controller KioskJobs ............................................................................................ 62
5.31 Controller EndpointSecrets .................................................................................. 63
5.32 Controller EndpointEnrollment ............................................................................. 64
5.33 Controller ServerState ......................................................................................... 66
5.34 Controller VPPUsers ............................................................................................ 67

www.baramundi.com Page 7/120

 Reference | baramundi Connect

5.35 Controller VPPLicenseAssociations .................................................................... 68

5.36 Controller MicrosoftUpdateInventories ................................................................ 70
6 Simple integration samples ............................................................................................. 72
6.1 Windows PowerShell ........................................................................................... 72
6.2 Visual Basic Script (VBS) .................................................................................... 73
6.3 C# ........................................................................................................................ 74
7 Properties of object types ............................................................................................... 76
7.1 Version ................................................................................................................. 76
7.2 Info ....................................................................................................................... 76
7.3 SearchResult ....................................................................................................... 77
7.4 OrgUnit ................................................................................................................ 78
7.5 DynamicGroup ..................................................................................................... 79
7.6 UniversalDynamicGroup ...................................................................................... 79
7.7 StaticGroup .......................................................................................................... 79
7.8 Endpoint ............................................................................................................... 80
7.9 NewEndpoint ....................................................................................................... 91
7.10 Job ....................................................................................................................... 92
7.11 JobInstance ......................................................................................................... 96
7.12 BootEnvironment ................................................................................................. 99
7.13 HardwareProfile ................................................................................................. 100
7.14 ObjectVariables ................................................................................................. 101
7.15 App .................................................................................................................... 102
7.16 Icon .................................................................................................................... 102
7.17 Application ......................................................................................................... 103
7.18 Inventory ............................................................................................................ 110
7.19 InventoryOverview ............................................................................................. 112
7.20 InventoryApp ...................................................................................................... 113
7.21 SoftwareScanRule ............................................................................................. 114
7.22 SoftwareScanRuleCount ................................................................................... 114
7.23 EndpointInvSoftware .......................................................................................... 114
7.24 EndpointInfo ....................................................................................................... 114
7.25 Image ................................................................................................................. 115
7.26 VariableDefinition ............................................................................................... 115
7.27 KioskJob ............................................................................................................ 116
7.28 EndpointSecrets ................................................................................................ 116
7.29 EnrollmentData .................................................................................................. 116
7.30 ServerState ........................................................................................................ 117
7.31 VPPUser ............................................................................................................ 117
7.32 VPPLicenseAssociation ..................................................................................... 118
7.33 MicrosoftUpdateInventories ............................................................................... 118
7.34 MicrosoftUpdateEndpointInventory .................................................................... 118
7.35 MicrosoftUpdateInventoryInformation ................................................................ 119

www.baramundi.com Page 8/120

 Reference | baramundi Connect

© 2020 baramundi software AG

The content of this document is subject to change without notice.
Statements concerning technical features are not binding and are for information only.
DocID: BMS-20200-bCO-200609-EN

Management Board: Dipl.-Ing. (FH) Uwe Beikirch | Dr. Lars Lippert

Chairman of the Supervisory Board: Dr. Dirk Haft
Registered office and court: Augsburg, HRB no. 2064 | VAT identification number: DE 210294111

www.baramundi.com Page 9/120

 Reference | baramundi Connect

1 Overview
baramundi Connect (abbr. bConnect) is a REST web server, that gives you the opportunity to
request data objects (like endpoints, jobs, etc.) out of the baramundi Management Suite and
to create new or modify data objects with the baramundi Management Suite (bMS). Only an
application that is using a HTTP web client with a version 1.1 or above is needed for access.

The REST web server expects an authentication according to the BasicAuthentication method.
The provided credentials as well as the data are transmitted securely using SSL/TLS
encryption. Beside the authentication against the Active Directory (in domains) or local rights
(in work groups) the credentials are also used for authorization in the baramundi Management
Suite. The scope of operations supported by bConnect and the results are therefore limited to
the configured rights of the specified user in the baramundi Management Suite.

JSON and XML are the two data formats supported by bConnect. They can be configured
either over the URL or in the HTTP request header. If no format is specified, JSON is used as
default.

Current Version of bConnect is 1.0 in baramundi Management Suite 2020.

www.baramundi.com Page 10/120

 Reference | baramundi Connect

2 Configuration
bConnect is listening on HTTPS standard port 443 for incoming requests. The port can be
configured in the view Interfaces of module Configuration, if required. Therefore you need to
switch to the edit mode by selecting the menu point Edit in the context menu or in the menu
bar as shown in Figure 1. If a HTTPS port number different from the default is used, it has to
be set explicitly in the request URL.

Figure 1 – Interface configuration

The same view provides the possibility to activate or deactivate the bConnect service. If Yes
is configured for “bConnect Module active”, the service is listening to incoming requests.
Otherwise it is deactivated. A restart of the baramundi Management Server (bServer) is
necessary for changes to take effect.

As bConnect is using the HTTPS protocol by default for communication a valid server
certificate needs to be bound to the configured port. By default the baramundi Mobile Devices
Module, automatically creates a certificate for the baramundi Root Certification Authority (CA)
and an appropriate server certificate – even no license for baramundi Mobile Devices is
available. The server certificate is automatically bound to the standard HTTPS port 443. With
default configuration bConnect and baramundi Mobile Devices Module share the same port.
Since it is not possible to bind more than one certificate to a port, they also share the same
server certificate. Hence no further settings are required when using default configuration.

Changing the communication port number for bConnect requires an appropriate binding of the
certificate, which can be either done with Internet Information Server (IIS) or “netsh” on
command line. The usage of an external server certificate, e.g. bought from public Certification
Authority or self-created, requires a different port number and a new appropriate binding.

www.baramundi.com Page 11/120

 Reference | baramundi Connect

Some web clients or underlying libraries check the complete certificate chain by default. To
avoid problems it is recommended to import the certificates of all CAs down to the Root CA
to the Trusted Root Certification Authorities store of the machine, the web client is running
on. The certificate of the baramundi Root CA used for baramundi Mobile Devices can be
exported over the corresponding configuration site.

www.baramundi.com Page 12/120

 Reference | baramundi Connect

3 Calling Syntax
bConnect exposes over so called Controller several actions for requests. Each controller
handles usually all requests concerning a specific object type. Therefore the bConnect API
consist of several controllers where each of them provides specific actions according to the
object type they represent.

The Info and Version controller provide general or version information of bConnect and can be
requested with URLs of the following scheme:
https://<BMSServer>:<Port>/bConnect/<Controller>.

The other controller provide functionality to manage bMS objects (e.g. endpoint, job). The URL
requests for this controller must include the bConnect version number:
https://<BMSServer>:<Port>/bConnect/v<bConnect Version>/<Controller>.

If the HTTPS standard port number 443 is configured for bConnect (default configuration), the
port declaration is voluntary for the URL. Otherwise the port is mandatory.

bConnect supports only JSON and XML data format. If it is not possible to specify the data
format in the HTTP-Header, e.g. because using a browser, it can be appended as an extension
to the controller in the URL as follows:
https://<BMSServer>:<Port>/bConnect/<Controller >.<Format>
https://<BMSServer>/bConnect/v<bConnect Version>/< Controller >.<Format>

If XML format is used for POST, PUT and PATCH-Requests the elements must be sorted
alphabetically and the following namespaces must be appended as attributes to the root
element.
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BCo
nnect.DataModel"

Different controller actions can be requested by appropriate HTTP methods and additional
parameter(s) in the URL. All parameters specified for a specific action are mandatory. A
parameter is a key-value-pair connected over the “=”-sign. They must be appended (without
blanks) with a “?”-sign at the end of the base URL and in case of multiple they must be
concatenated (without blanks) with a “&”-sign.

In case a specific resource is identifiable by its ID it can be addressed for all supported actions
either by appending the ID as further segment in the URL or as parameter.
https://<BMSServer>:<Port>/bConnect/<Controller >.<Format>/<ID>?param1=1234
https://<BMSServer>:<Port>/bConnect/<Controller >.<Format>?id=<ID>&param2=4567

www.baramundi.com Page 13/120

 Reference | baramundi Connect

Further request examples (HTTP method “GET” only):

• https://bmsserver.customer.net/bConnect/Info

• https://bmsserver.customer.net/bConnect/Version.xml

• https://bmsserver.customer.net/bConnect/v1.0/endpoints.json

• https://bmsserver.customer.net/bConnect/v1.0/jobinstances.xml/9d6a3f49-5c66-40c6-ae80-
d6bd85fe3628 (equal to example below)

• https://bmsserver.customer.net/bConnect/v1.0/jobinstances.xml?id=9d6a3f49-5c66-40c6-
ae80-d6bd85fe3628 (equal to example above)

• https://bmsserver.customer.net/bConnect/v1.0/jobinstances.json?endpointid=26f8284e-538d-
422a-9b01-7597382bb71d&jobid=104196a1-1862-45fe-be3f-b312fcfc1ca9&startifexists=false

www.baramundi.com Page 14/120

 Reference | baramundi Connect

4 Authentication & Headers

4.1 Authentication
To be able to use the bConnect module, it is mandatory to authenticate with each request
your identity with the use of username and password. Both need to be specified in
ISO-8859-1 encoding. Currently only authentication method Basic Authentication is
supported. Therefore the credentials needs to be passed in the appropriate format in the
designated HTTP request header or in the URL as mentioned above.

4.2 Headers
With each API call you can set specific request headers. With bMS 2016 two further headers
are supported.

4.2.1 Request Header

Header Description Since bMS
Accept-Encoding A standard HTTP request header, which contains a list of 2016
supported (compression) encodings by the web client. The
encoding type of the response data is specified in the HTTP
response header “Content-Encoding”.
Currently the (compression) encodings “gzip” and “deflate” are
supported by bConnect.
Client-Request-ID A custom HTTP request header, which contains a unique ID (in 2016
general a GUID) generated by the requester. It will be returned
unchanged in the header of the corresponding response.
This header helps in certain scenarios to keep track on
assignment of a request and corresponding response.

4.2.2 Response Header

Header Description Since bMS
Content-Encoding A standard HTTP response header, which contains the 2016
(compression) encoding type used on the response data. The
encoding type is specified with the HTTP request header
“Accept-Encoding”.
Currently the (compression) encodings “gzip” and “deflate” are
supported by bConnect.
Client-Request-ID A custom HTTP response header, which contains a unique ID 2016
(in general a GUID) generated by the requester. It will be
returned (unchanged) as received in the corresponding HTTP
request header.
This header helps in certain scenarios to keep track on
assignment of a response and corresponding request.

www.baramundi.com Page 15/120

 Reference | baramundi Connect

5 Controllers and actions

Each controller, like Endpoints or Jobs, is addressed with an explicit base URL. Using different
HTTP methods or adding parameters to the URL requests different actions of the specified
controller. Therefore different result is returned in the response. Controllers and parameters
used in the URL are case insensitive.

The response data format is either configured over the .JSON or .XML extension in the URL
(case insensitive) or over the Accept-field in the HTTP header. In latter case an extension must
not be specified in the URL.

The response code of each request is a standard HTTP status code, e.g. one of the following:

• 200 ➔ OK

• 201 ➔ Created

• 204 ➔ No Content

• 400 ➔ Bad Request

• 401 ➔ Unauthorized

• 403 ➔ Forbidden

• 404 ➔ Not Found

• 405 ➔ Method Not Allowed

• 411 ➔ Length Required

• 415 ➔Unsupported Media Type

• 500 ➔ Internal Server Error

• 501 ➔ Not Implemented

• 503 ➔ Service Unavailable

baramundi software AG reserves the right to extend bConnect by new controllers, to extend
existing controllers by new actions, to extend object types by new properties and to skip
transmission of properties with value null without notification or change of the bConnect
version number.

www.baramundi.com Page 16/120

 Reference | baramundi Connect

5.1 Controller Version

The Version controller provides actions concerning the Version object. Version is a bConnect
internal object type which contains the current (newest) bConnect version and an array with
all still supported versions.

To request the Version object the URL must not contain version information and the provided
user does not need configured rights in the baramundi Management Suite (bMS).

URL: https://<bmsserver>:<port>/bConnect/Version

Method URL parameters Description Since bMS

GET None Returns an object of type Version. 2014

Properties of Version.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/version.json

Result:
{
"SupportedVersions":["1.0"],
"CurrentVersion":"1.0"
}

• GET-Request:
https://bmsserver.customer.net/bConnect/version.xml

Result:
<Version>
<CurrentVersion>1.0</CurrentVersion>
<SupportedVersions>
<d2p1:string>1.0</d2p1:string>
</SupportedVersions>
</Version>

www.baramundi.com Page 17/120

 Reference | baramundi Connect

5.2 Controller Info

The Info controller provides actions concerning the Info object. Info is a bConnect internal
object type which provides general information about the bConnect web server.

To request the Info object the URL must not contain version information and the provided user
does not need configured rights in the baramundi Management Suite (bMS).

URL: https://<bmsserver>:<port>/bConnect/Info

Method URL parameters Description Since bMS

GET None Returns an object of type Info. 2014

Properties of Info.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/info.json

Result:
{
"Description":"Interface to baramundi Management Server",
"Company":"baramundi software AG",
"Copyright":"Copyright (c) 2015 R2 baramundi software AG",
"bConnectVersion":"1.0",
"bMSVersion":"15.2.314.0",
"UserContext":"user@customer.net"
}

• GET-Request:
https://bmsserver.customer.net/bConnect/info.xml

Result:
<Info>
<Company>baramundi software AG</Company>
<Copyright>Copyright (c) 2015 R2 baramundi software AG</Copyright>
<Description>Interface to baramundi Management Server</Description>
<UserContext>user@customer.net</UserContext/>
<bConnectVersion>1.0</bConnectVersion>
<bMSVersion>15.2.314.0</bMSVersion>
</Info>

www.baramundi.com Page 18/120

 Reference | baramundi Connect

5.3 Controller Search

The Search controller provides actions to search over objects of the bMS. The search results
are stored in SearchResult objects. Currently supported objects are of type Endpoint, Job,
OrgUnit, DynamicGroup, StaticGroup, Application, AD object and App.

The Search controller looks for org units only in nodes “Logical groups”, “Dynamic groups”,
“Static groups”, “Jobs”, “Applications” and “Apps”.

To request SearchResult objects data the URL must contain the bConnect version information.
Only those objects can be scanned, the specified user has at least configured read rights on.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Search

Method URL parameters Description Since bMS

GET Type=<object type> Returns a list of SearchResult objects. Type 2014 R2
& specifies the objects to search over. Types
Term=<search term> “endpoint”, “job”, “orgunit”, “group” (for
static and dynamic groups), “adobject” and
“software” (for applications and apps) are
supported.
Term specifies the search string (at least
two characters) to look for in the objects of
the specified type.
To request the whole object the ID of the
SearchResult object can be used.
Works similar to the search in the bMC.

Properties of Search.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/search.json?type=endpoint&term=test
Result:
[{
"Id": "d9d4b3d9-8265-4001-ab23-993228a18b2f",
"Name": "TestWindows",
"AdditionalInfo": "",
"Type": "1",
"Deactivated": null
}]

www.baramundi.com Page 19/120

 Reference | baramundi Connect

5.4 Controller OrgUnits

The OrgUnits controller provides actions concerning the OrgUnit objects, the organizational
unit objects, of the bMS.

To request OrgUnit objects data the URL must contain the bConnect version information. Only
those OrgUnit objects the specified user has at least configured read rights on will be available.

Previously, only organizational units contained in the well-known org units LogicalGroups and
JobManagement could be requested. In bMS 2016 StaticGroups and DynamicGroups as well
as in bMS 21016R2 Applications and Apps were added to the scope of this controller. A request
for other elements than these six root org units or its children will lead to a HTTP response
code NotFound (e.g. a request with the ParentGuid of one of these six root org units).

To create an OrgUnit object with HTTP method POST the appropriate rights (create object,
modify) must be given for the specified parent org unit to the specified user. To update an
OrgUnit object with HTTP method PATCH the user needs the appropriate rights (modify) for
the specified object and if ParentId is specified also for the new parent org unit.

URL: https://<bmsserver>:<port>/bConnect/v1.0/OrgUnits

Method URL parameters Description Since bMS

GET None Returns a list of all available OrgUnit 2014 R2
objects.
GET OrgUnit=<org unit id> Returns a list of OrgUnit objects, contained 2014 R2
in the specified organizational unit. Sub
units are not considered.
GET ID=<org unit id> Finds an OrgUnit object by ID. 2014 R2
POST None Creates a new OrgUnit object according to 2016
(Mandatory and optional properties the specified mandatory and optional
must be specified in the appropriate data.
format in the HTTP body. In case of Mandatory properties:
XML, the elements must be sorted • Name (unique in parent org unit)
alphabetically and the appropriate • ParentId (id of a org unit)
namespaces must be appended as Optional properties:
attributes to the root element.) • Comment
• Extension (for org units of node
Logical Groups only)
See properties of OrgUnit for further
information.
PATCH ID=<org unit id> Updates the specified properties of the 2016
(The properties that are to be OrgUnit object by ID.
updated must be specified in the Optional properties:
appropriate format in the HTTP body. • Name (unique in parent org unit)
In case of XML, the elements must • ParentId (id of a org unit)
be sorted alphabetically and the • Comment
appropriate namespaces must be • Extension
appended as attributes to the root See properties of OrgUnit for further
element.)
information.
DELETE ID=<id> Deletes an OrgUnit object by ID. 2016

www.baramundi.com Page 20/120

 Reference | baramundi Connect

Properties of OrgUnit.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/orgunits.json?id=a79851ff-3c9e-4973-b828-
ced7c6a39f4b
Result:
{
"Id": "a79851ff-3c9e-4973-b828-ced7c6a39f4b",
"ParentId": " b2ef5159-d8b8-4e9e-92fe-96889cec8491",
"Name": "MyJobs ",
"GuidParent": "b2ef5159-d8b8-4e9e-92fe-96889cec8491",
"Comment": "",
"HierarchyPath": "JobManagement\MyJobs",
"Extension": null
}

www.baramundi.com Page 21/120

 Reference | baramundi Connect

5.5 Controller DynamicGroups

The DynamicGroups controller provides actions concerning the DynamicGroup objects. Unlike
LogicalGroups, DynamicGroups act as views, combining all endpoints of type
WindowsEndpoints matching certain conditions defined by a SQL statement. One endpoint can
be in several DynamicGroups.

To request DynamicGroup data, the URL must contain the bConnect version information. Only
DynamicGroup objects with effective read-access for the specified user will be available with
GET method.

To create a DynamicGroup object with HTTP method POST the appropriate rights (create
object, modify) must be given for the specified parent org unit to the user. If the property
ParentId is not specified the root node for dynamic groups is used.

To update a DynamicGroup object with HTTP method PATCH the user needs the appropriate
rights (modify) for the specified object and if ParentId is specified also for the new parent org
unit.

URL: https://<bmsserver>:<port>/bConnect/v1.0/DynamicGroups

Method URL parameters Description Since bMS

GET None Returns a list of all available 2016
DynamicGroup objects.
GET OrgUnit=<org unit id> Returns a list of DynamicGroup objects, 2016
contained in the specified organizational
unit. Sub units are not considered.
GET ID=<dynamic group id> Finds a DynamicGroup object by ID. 2016
POST None Creates a new DynamicGroup object 2016
according to the specified mandatory and
(Mandatory and optional properties optional data.
must be specified in the appropriate
Mandatory properties:
format in the HTTP body. In case of
XML, the elements must be sorted • Name (unique in parent org unit)
alphabetically and the appropriate • Statement (valid SQL)
namespaces must be appended as Optional properties:
attributes to the root element.)
• ParentId (id of an org unit)
• Comment
See properties of DynamicGroup for further
information.
PATCH ID=<dynamic group id> Updates the specified properties of a 2016
DynamicGroup object by ID.
(The properties that are to be updated Optional properties:
must be specified in the appropriate
format in the HTTP body. In case of
• Name (unique in parent org unit)
XML, the elements must be sorted • Statement (valid SQL)
alphabetically and the appropriate • ParentId (id of an org unit)
namespaces must be appended as
• Comment
attributes to the root element.)
See properties of DynamicGroup for further
information.
DELETE ID=<dynamic group id> Deletes a DynamicGroup object by ID. 2016

Properties of DynamicGroup.

www.baramundi.com Page 22/120

 Reference | baramundi Connect

Examples:
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/DynamicGroups.json?id=643E6070-E31A-
4DE2-8372-900965047B39
Result:
{
"Id":"643E6070-E31A-4DE2-8372-900965047B39",
"ParentId":"BDE918DC-89C0-458A-92F7-0BB9147A2706",
"Name":"64-bit systems",
"Statement":" WHERE \r\n(\r\n (machine.arch =
'x64')\r\n)\r\n",
"Comment":"",
“HierarchyPath”:”Dynamic Groups”
}

• POST-Request:
https://bmsserver.customer.net /bConnect/v1.0/dynamicgroups.xml

Body (xml format):

<DynamicGroup
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>A group of all English systems.</Comment>
<Name>English systems</Name>
<ParentId>BDE918DC-89C0-458A-92F7-0BB9147A2706</ParentId>
<Statement>WHERE ( machine.lcid = 1033 )</Statement>
</DynamicGroup>

Result:
<DynamicGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>A group of all English systems.</Comment>
<Id>D32CE263-AD72-4D86-B093-5796AC7F7D3F</Id>
<Name>English systems</Name>
<ParentId>BDE918DC-89C0-458A-92F7-0BB9147A2706</ParentId>
<Statement>WHERE ( machine.lcid = 1033 )</Statement>
</DynamicGroup>

• PATCH-Request:
https://bmsserver.customer.net /bConnect/v1.0/dynamicgroups?id=D32CE263-AD72-4D86-
B093-5796AC7F7D3F

Body (json format):

{
"Name":"Systems with englisch lcid",
"Comment":""
}

www.baramundi.com Page 23/120

 Reference | baramundi Connect

Result:
{
"Id":"41068A9F-405E-49BB-891B-65FAF1107CD9",
"ParentId":"BDE918DC-89C0-458A-92F7-0BB9147A2706",
"Name":"Systems with englisch lcid","Statement":"WHERE ( machine.lcid = 1033 )",
"Comment":""
}

• DELETE-Request:
https://bmsserver.customer.net /bConnect/v1.0/dynamicgroups.json?id=D32CE263-AD72-
4D86-B093-5796AC7F7D3F

Result: No Content.

www.baramundi.com Page 24/120

 Reference | baramundi Connect

5.6 Controller UniversalDynamicGroups

The UniversalDynamicGroups controller provides actions concerning the
UniversalDynamicGroup objects. UniversalDynamicGroups act as views, combining endpoints
of all types which match the configured conditions. One endpoint can be in several
UniversalDynamicGroups.

To request UniversalDynamicGroup data, the URL must contain the bConnect version
information. Only UniversalDynamicGroup objects with effective read-access for the specified
user will be available with GET method.

URL: https://<bmsserver>:<port>/bConnect/v1.0/UniversalDynamicGroups

Method URL parameters Description Since bMS

GET None Returns a list of all available 2020 R2
UniversalDynamicGroup objects.
GET OrgUnit=<org unit id> Returns a list of UniversalDynamicGroup 2020 R2
objects, contained in the specified
organizational unit. Sub units are not
considered.
GET ID=<universal dynamic group Finds a UniversalDynamicGroup object by 2020 R2
id> ID.
IsArgusSynced=<true / false> Optional for all GET methods: 2020 R2
If “true”, only Universal Dynamic Groups
synchronized with Argus Cockpit will be
returned
If “false”, only Universal Dynamic Groups
not synchronized with Argus Cockpit will
be returned

Properties of UniversalDynamicGroup.

Examples:
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/UniversalDynamicGroups.json?id=643E6070-
E31A-4DE2-8372-900965047B39
Result:
{
"Id":"643E6070-E31A-4DE2-8372-900965047B39",
"ParentId":"BDE918DC-89C0-458A-92F7-0BB9147A2706",
"Name":"64-bit systems",
"DisplayName":"64-bit systems",
“IsArgusSynced”:”true”
"Comment":"",
“HierarchyPath”:”Dynamic Groups”
}

www.baramundi.com Page 25/120

 Reference | baramundi Connect

5.7 Controller StaticGroups

The StaticGroups controller provides actions concerning the StaticGroup objects. Like
DynamicGroups, StaticGroups act as views and can be used to manually group all type of
endpoints outside of the logical group structure. One endpoint can be in several StaticGroups.

To request StaticGroup data, the URL must contain the bConnect version information. Only
StaticGroup objects with effective read-access for the specified user will be available with GET
method.

To create a StaticGroup object with HTTP method POST the appropriate rights (create object,
modify) must be given for the specified parent org unit to the user. If property ParentId is not
specified the root node for static groups is used.

To update a StaticGroup object with HTTP method PATCH the user needs the appropriate
rights (modify) for the specified object and if ParentId is specified also for the new parent org
unit.

URL: https://<bmsserver>:<port>/bConnect/v1.0/StaticGroups

Method URL parameters Description Since bMS

GET None Returns a list of all available StaticGroup 2016
objects.
GET OrgUnit=<org unit id> Returns a list of StaticGroup objects, 2016
contained in the specified organizational
unit. Sub units are not considered.
GET ID=<static group id> Finds a StaticGroup object by ID. 2016
POST None Creates a new StaticGroup object 2016
according to the specified mandatory and
(Mandatory and optional properties optional data.
must be specified in the appropriate
Mandatory properties for StaticGroups:
format in the HTTP body. In case of
XML, the elements must be sorted • Name (unique in parent org unit)
alphabetically and the appropriate Optional properties:
namespaces must be appended as • ParentId (id of an org unit)
attributes to the root element.)
• EndpointIds
• Comment
See properties of StaticGroup for further
information.
PATCH ID=<static group id> Updates specified properties of a 2016
StaticGroup object by ID.
(The properties that are to be updated Optional properties:
must be specified in the appropriate
format in the HTTP body. In case of
• Name (unique in parent org unit)
XML, the elements must be sorted • ParentId (id of an org unit)
alphabetically and the appropriate • EndpointIds
namespaces must be appended as
• Comment
attributes to the root element.)
See properties of StaticGroup for further
information.
DELETE ID=<static group id> Deletes a StaticGroup object by ID. 2016

Properties of StaticGroup.

www.baramundi.com Page 26/120

 Reference | baramundi Connect

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/StaticGroups.json?id=41F24185-71DB-47F0-
B036-05C5C2616479
Result:
{
"Id": "41F24185-71DB-47F0-B036-05C5C2616479",
"ParentId": "5020494B-04D3-4654-A256-80731E953746",
"Name": "Server Group A",
"Comment": "",
"EndpointIds":
[
"4B3C0BBE-C7BC-4CF8-9598-0CD86DB3639A",
"CC14E396-3919-4EDE-B302-D2FAD35B0986",
"D13F5074-E773-4445-93F1-ACE372B54A21"
]
}

• POST-Request:
https://bmsserver.customer.net /bConnect/v1.0/staticgroups

Body (xml format):

<StaticGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>A group of servers.</Comment>
<EndpointIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/
Serialization/Arrays">
<d3p1:string>CC28388A-5156-4BDE-A411-C2A5AD42EA9E</d3p1:string>
<d3p1:string>37762ED0-9A20-4E44-8EA4-A97FF4625439</d3p1:string>
</EndpointIds>
<Name>Server Group B</Name>
<ParentId>5020494B-04D3-4654-A256-80731E953746</ParentId>
</StaticGroup>

Result:
<StaticGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>A group of servers.</Comment>
<EndpointIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/
Serialization/Arrays">
<d3p1:string>CC28388A-5156-4BDE-A411-C2A5AD42EA9E</d3p1:string>
<d3p1:string>37762ED0-9A20-4E44-8EA4-A97FF4625439</d3p1:string>
</EndpointIds>
<Id>1B3B05B0-2DDD-4847-89CF-2E726BB918AE</Id>
<Name>Server Group B</Name>
<ParentId>5020494B-04D3-4654-A256-80731E953746</ParentId>
</StaticGroup>

www.baramundi.com Page 27/120

 Reference | baramundi Connect

• PATCH-Request:
https://bmsserver.customer.net /bConnect/v1.0/staticgroups?id=1B3B05B0-2DDD-4847-89CF-
2E726BB918AE

Body (xml format):

<StaticGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>Updated the name of this group.</Comment>
<Name>Server Group NEW</Name>
</StaticGroup>

Result:
<StaticGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comment>Updated the name of this group.</Comment>
<EndpointIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/
Serialization/Arrays">
<d3p1:string>CC28388A-5156-4BDE-A411-C2A5AD42EA9E</d3p1:string>
<d3p1:string>37762ED0-9A20-4E44-8EA4-A97FF4625439</d3p1:string>
</EndpointIds>
<Id>1B3B05B0-2DDD-4847-89CF-2E726BB918AE</Id>
<Name>Server Group NEW</Name>
<ParentId>5020494B-04D3-4654-A256-80731E953746</ParentId>
</StaticGroup>

• DELETE-Request:
https://bmsserver.customer.net /bConnect/v1.0/staticgroups.json?id=1B3B05B0-2DDD-4847-
89CF-2E726BB918AE

Result: No Content.

www.baramundi.com Page 28/120

 Reference | baramundi Connect

5.8 Controller Endpoints

The Endpoints controller provides actions concerning the Endpoint objects, the managed
clients, of the bMS. All endpoint types, like Windows, Network, Android, WindowsPhone, iOS and
Mac are supported. Android, WindowsPhone, iOS and Mac endpoints are of type
BmsNetEndpoint.

To request Endpoint object data the URL must contain the bConnect version information. Only
those Endpoint objects, the specified user has at least configured read rights on, will be
available.

To create an Endpoint object with HTTP method POST in the specified organizational unit
(OrgUnit) the appropriate rights (create object) must be given for the specified parent org unit
to the user. To update an Endpoint object with HTTP method PATCH the user needs the
appropriate rights (modify) for the specified object and if ParentId is specified also for the new
parent org unit. Endpoints of type NetworkEndpoint cannot be created or updated.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Endpoints

Method URL parameters Description Since

bMS
GET None Returns a list of all available Endpoint 2014
objects.
GET OrgUnit=<org unit id> Returns a list of Endpoint objects, 2014 R2
contained in the specified organizational
unit. Sub units are not considered.
GET UniversalDynamicGroup= Returns a list of Endpoint objects, 2020 R2
<universal dynamic group id> contained in the specified universal
dynamic group.
GET DynamicGroup= Returns a list of Endpoint objects, 2016
<dynamic group id> contained in the specified dynamic group.
GET StaticGroup= Returns a list of Endpoint objects, 2016
<static group id> contained in the specified static group.
GET ID=<endpoint id> Finds an Endpoint object by ID. 2014
GET User=<user_principal_name> Returns a list of Endpoint objects filtered by 2018 R2
the specified “Registered User”
PubKey=<true / false> Optional for all GET methods: 2016
If “true”, the returned objects will contain
also the appropriate public key of the
endpoint certificate (if stored for the client).
Applies to endpoints of type Windows only.
InstalledSoftware=<true / false> Optional for all GET methods: 2016 R2
If “true”, the returned endpoint objects will
contain a list of the installed software with
the bMS
SnmpData=<true / false> Optional for all GET methods: 2017R1
If “true”, the returned endpoint objects will
contain the appropriate SNMP data (if
SNMP data are available)
POST None Creates a new Endpoint object according to 2014 R2
the specified mandatory and optional data.
Mandatory properties for all endpoint types:

www.baramundi.com Page 29/120

 Reference | baramundi Connect

(Mandatory and optional properties must • Type,

be specified in the appropriate format in
the HTTP body. In case of XML, the
• DisplayName
elements must be sorted alphabetically
and the appropriate namespaces must be Optional properties for all endpoint types:
appended as attributes to the root • GuidOrgUnit (id of parent org unit)
element.)
• Comments
Additional mandatory for
WindowsPhoneEndpoint:
• PrimaryUser (users email-Address
or Down-Level Logon name (e.g.
domain\user))
Optional for WindowsEndpoint:
• HostName(15 chars, IETF RFC 952)
(DisplayName by default)
• Options (Format: decimal; When
creating an endpoint, the settings
for Automatic Usage Tracking
(0x00000100) and Energy
Management (0x00000200) cannot
be set manually. The default
settings from the database will be
taken. Depending on their values,
the default value for Options is one
of 50, 306, 562 or 818.)
• PrimaryMAC (M = one hex digit,
Format: MM:MM:MM:MM:MM:MM)
• Domain
• GuidBootEnvironment
• GuidHardwareProfile
• Mode
• ExtendedInternetMode
• PrimaryUser (Principal or Down-
Level Logon name (e.g.
domain\user)
• PrimaryIP (primary IP-address of an
endpoint)
Optional for MacEndpoint:
• HostName (is set after enrollment if
empty)
Optional for BmsNetEndpoint:
• PrimaryUser (except
WindowsPhone; users email-
Address or Down-Level Logon
name (e.g. domain\user))
• Owner (default 0)
• ComplianceCheckCategory (default
0)
• AndroidEnterpriseProfileType (only
valid for type Android)
• AppleManagementMode (only valid
for type Ios)
• ManagedAppleId (only valid for Ios
and when AppleManagementMode
is set to UserEnrollment)
Additional mandatory for IndustrialEndpoint

www.baramundi.com Page 30/120

 Reference | baramundi Connect

• IndustrialData
• EmailLanguageId
• EmailRecipient

See properties of Endpoint for further

information. The returned object is of type
NewEndpoint.
PATCH ID=<endpoint id> Updates the specified properties of the 2016
Endpoint object by ID.
(The properties that are to be updated Optional properties for all endpoint types:
must be specified in the appropriate
format in the HTTP body. In case of XML,
• DisplayName,
the elements must be sorted • GuidOrgUnit (id of parent org unit)
alphabetically and the appropriate • Comments
namespaces must be appended as Optional for WindowsEndpoint:
attributes to the root element.)
• HostName (15 chars, IETF RFC 952)
• Options (Format: decimal)
• PrimaryMAC (Format see POST)
• Domain
• GuidBootEnvironment
• GuidHardwareProfile
• PublicKey (without spaces)
• Mode
• ExtendedInternetMode
• PrimaryUser (Principal or Down-
Level Logon name (e.g.
domain\user)
• PrimaryIP (primary IP-address of an
endpoint)
• CustomStateText (a user defined
string; prefixed and suffixed
whitespaces are not supported)
• CustomStateType (a user defined
integer value)
Optional for MacEndpoint:
• HostName
Optional for BmsNetEndpoint:
• PrimaryUser (users email-Address
or Down-Level Logon name (e.g.
domain\user))
• Owner (default 0)
• ComplianceCheckCategory (default
0)
• SerialNumber
Optional for IndustrialEndpoint
• IndustrialData

See properties of Endpoint for further

information. The returned object is of type
Endpoint
DELETE ID=<endpoint id> Deletes the Endpoint object by ID.

Properties of Endpoint.

www.baramundi.com Page 31/120

 Reference | baramundi Connect

Examples:

• GET-Request:
https://bmsserver.customer.net /bConnect/v1.0/endpoints.json?id=bd4a57c1-efe2-45bb-bf4a-
58a5f4164d52

Result:
{
"Id":"bd4a57c1-efe2-45bb-bf4a-58a5f4164d52",
"GuidGroup":"b2ef5159-d8b8-4e9e-92fe-96889cec8491",
"DisplayName":"vm-cb-ws2008R2",
"HostName":"vm-cb-ws2008R2",
…
}

• POST-Request:
https://bmsserver.customer.net /bConnect/v1.0/endpoints.xml

Body (xml format):

<Endpoint
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<DisplayName>DeviceDisplayName</DisplayName>
<GuidGroup>b2ef5159-d8b8-4e9e-92fe-96889cec8491</GuidGroup>
<HostName>DeviceHostName</HostName>
<Options>563</Options>
<PrimaryMAC>12:34:56:78:90:12</PrimaryMAC>
<Type>1</Type>
</Endpoint>

Result:
<NewEndpoint xmlns:i="…" xmlns="…">
<Endpoint>
<Activity i:nil="true"/>
<DisplayName>DeviceDisplayName</DisplayName>
…
<GuidGroup>B2EF5159-D8B8-4E9E-92FE-96889CEC8491</GuidGroup>
<HostName>DeviceHostName</HostName>
<Options>563</Options>
<PrimaryMAC>12:34:56:78:90:12</PrimaryMAC>
…
<Type>1</Type>
…
</Endpoint>
<EnrollmentToken i:nil="true" />

www.baramundi.com Page 32/120

 Reference | baramundi Connect

<TokenValidUntil i:nil="true" />

</NewEndpoint>

• DELETE-Request:

https://bmsserver.customer.net /bConnect/v1.0/endpoints.json?id=bd4a57c1-efe2-45bb-bf4a-
58a5f4164d52

Result: No Content.

www.baramundi.com Page 33/120

 Reference | baramundi Connect

5.9 Controller Jobs

The Jobs controller provides actions concerning the Job objects, the jobs, of the bMS. Jobs
for all endpoint types are supported. Job objects can be of type WindowsJob or BmsNetJob,
depending of the endpoint type they are created for. Jobs of type WindowsJob are for
endpoints of type WindowsEndpoint whereas jobs of type BmsNetJob are for endpoints of type
AndroidEndpoint, WindowsPhoneEndpoint, iOSEndpoint or MacEndpoint. Since 2016R2 it is
also possible to request the steps for types WindowsJob and BmsNetJob.

To request Job object data the URL must contain the bConnect version information. Only those
Job objects the specified user has at least configured read rights on will be available.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Jobs

Method URL parameters Description Since bMS

GET None Returns a list of all available Job objects. 2014
GET OrgUnit=<org unit id> Returns a list of all available Job objects, 2014
contained in the specified organizational
unit. Sub units are not considered.
GET ID=<job id> Finds a Job object by ID. 2014
GET User=<user_principal_name> Returns a list of all released Job objects for 2018 R2
the specified user
Steps = <true / false> Optional for all GET methods: 2016 R2
If “true”, the returned job objects will also
contain the steps.
DELETE ID=<job id> Deletes the Job object by ID. 2019

Properties of Job.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/jobs.json?id=104196a1-1862-45fe-be3f-
b312fcfc1ca9

Result:
{
"Id":"104196a1-1862-45fe-be3f-b312fcfc1ca9",
"GuidParent":"a12994b1-7691-4f15-b149-98abbc721f67",
"Name":"HW-Inventory (Default)",
"State":2,
"JobCount":1,
"Interval":"0",
…
…
"MinBandwidth":100000000,
"JobExecutionTimeout":0,
"JobProperties":
{
"MaxDelayMinutes":"90",

www.baramundi.com Page 34/120

 Reference | baramundi Connect

"Retries":"0",
"RetryInterval":"0"
}
}
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/jobs.json?id=104196a1-1862-45fe-be3f-
b312fcfc1ca9&steps=true

Result:

{
"Id":"104196a1-1862-45fe-be3f-b312fcfc1ca9",
"Type":6,
…
…
…
"Steps":
[{
"Properties":
{
"ScanProfileName":"Vulnerability Scan: Windows (Community)"
},
"Sequence":1,
"Type":"ComplianceScan"
},
{
"Properties":
{
"Name":"[Default Software Template]"
},
"Sequence":2,
"Type":"InventoryScan"
}],
"SupportEndpointsInInternetMode":false
}

www.baramundi.com Page 35/120

 Reference | baramundi Connect

5.10 Controller JobInstances

The JobInstances controller provides actions concerning the JobInstance objects, formerly the
job targets, of the bMS. Job instances for all endpoint types are supported.

To request JobInstance object data the URL must contain the bConnect version information.
Only those JobInstance objects, the specified user has at least configured read rights on their
Endpoint, will be available.

To create a JobInstance the specified user needs read rights for the specific Endpoint and Job
objects in the bMS. Furthermore the user needs the right to assign the Endpoint object a job
and the right to assign the specific Job object.

URL: https://<bmsserver>:<port>/bConnect/v1.0/JobInstances

Method URL parameters Description Since bMS

GET None Returns a list of all available JobInstance 2014
objects.
GET EndpointID=<endpoint id> Returns a list of all JobInstance objects of 2014 R2
the specified endpoint.
GET JobId=<job id> Returns a list of all JobInstance objects of 2015
the specified job.
GET ID=<job instance id> Finds a JobInstance object by ID. 2014
GET EndpointID=<endpoint id> Assigns the specified endpoint the specified 2014
& job by creating a new JobInstance object,
JobID=<job id> which is configured to be started a soon as
& possible. If this JobInstance object exists
StartIfExists=<false/true> already it is returned and the parameter
“StartIfExists” specifies with the value “true”
DEPRECATED to start it if it is not running yet.
(use POST instead)
Not supported on Endpoints of type
Industrial
Initiator=<name> Optional for assignment:
Sets assignment initiator to “<name> via
<bConnectUser>”

Example:
MyThirdPartyTool via admin@domain.com
GET EndpointID=<endpoint id> Returns a list of all JobInstance objects of 2018R2
& Jobs released for the specified user.
User=<user_principal_name> User must be the registered user of the
specified Endpoint.
GET TimePeriod=<seconds> Returns a list of all JobInstance objects 2020
whose TimeLastAction is at most
TimePeriod seconds ago.
Steps = <true / false> Optional for all above GET methods: 2016 R2
If true, the returned job objects will also
contain the steps.
GET ID=<job instance id> Starts, resumes or stops the specified 2015
& JobInstance object, according to the
cmd=<start/stop/resume> specified command.
To “start” a JobInstance object successfully,
it must not have the state “Running”.

www.baramundi.com Page 36/120

 Reference | baramundi Connect

To “stop” a JobInstance object successfully,

it must not have the state “Finished” with
success.
Resuming a JobInstance object applies for
endpoints of type WindowsEndpoints only.
To “resume” a JobInstance object
successfully, it must have one of the
following states:
- Not “Running” and flag “Resume”
- “Finished” and flag “Warning” or “Error”
- Flags “Rescheduled” and “Error”
For endpoints of type WindowsEndpoint the
commands “start” and “resume” will be
effectively only if the baramundi
Management Server is running.

POST None Creates a new JobInstance object using the 2020

mandatory data. Mandatory properties are:
• EndpointId
• JobDefinitionId
StartIfExists=<false/true> Optional for POST: 2020
If a JobInstance for the specified Endpoint
and Job already exists and this parameter is
set to true, the JobInstance will be started
again.
DELETE ID=<job instance id> Deletes a JobInstance object specified by ID. 2015
For endpoints of type WindowsEndpoint the
JobInstance object must not have the state
“Running”.
For endpoints of type BmsNetEndpoints a
running JobInstance object is canceled first
and afterwards deleted.

Properties of JobInstance.

Examples:

• GET-Request (start job instance):

https://bmsserver.customer.net/bConnect/v1.0/jobinstances?Id=EB6A02C3-BDCF-49EA-BD71-
C12BB5C3561D&cmd=start

Result: No data.

• POST-Request:
https://bmsserver.customer.net/bConnect/v1.1/jobinstances
Request:
{
"EndpointId": "AAFF8188-A10A-436C-9AEB-92D88BB31CCA",
"JobDefinitionId": "E4B87F22-F0D8-4F13-92AD-485044743329"
}

www.baramundi.com Page 37/120

 Reference | baramundi Connect

Result:
{
"Id": "8DBF2A27-FE91-46C6-0000-000000086A9C",
"EndpointId": "AAFF8188-A10A-436C-9AEB-92D88BB31CCA",
"EndpointName": "bConnect-Device",
"JobDefinitionId": "E4B87F22-F0D8-4F13-92AD-485044743329",
"JobDefinitionName": "Inventur",
"TimeStart": "2020-02-24T09:48:12.8463917Z",
"TimeLastAction": "2020-02-24T09:48:12.8463917Z",
"StateText": "Job assigned",
"Properties": {},
"Initiator": "user@domain.net",
"EndpointCategory": 7,
"JobDefinitionDisplayName": ""
}

• DELETE-Request:
https://bmsserver.customer.net/bConnect/v1.0/jobinstances?Id=EB6A02C3-BDCF-49EA-BD71-
C12BB5C3561D

Result: No data.

www.baramundi.com Page 38/120

 Reference | baramundi Connect

5.11 Controller HardwareProfiles

The HardwareProfiles controller provides actions concerning the available HardwareProfile
objects defined in the bMS.

To request HardwareProfile objects the URL must contain the bConnect version information.
Only those HardwareProfile objects can be read, the specified user has at least configured read
rights on.

URL: https://<bmsserver>:<port>/bConnect/v1.0/HardwareProfiles

Method URL parameters Description Since bMS

GET None Returns a list of all available HardwareProfile 2016
objects.
GET ID=<hardware profile id> Finds a HardwareProfile object by ID. 2016

Properties of HardwareProfile.

www.baramundi.com Page 39/120

 Reference | baramundi Connect

5.12 Controller BootEnvironment

The BootEnvironment controller provides actions concerning the Boot Environments objects
of the bMS.

To request BootEnvironment object data the URL must contain the bConnect version
information. Only those BootEnvironment objects, the specified user has at least configured
read rights on, will be available.

URL: https://<bmsserver>:<port>/bConnect/v1.0/BootEnvironment

Method URL parameters Description Since bMS

GET None Returns a list of all available Boot 2016R2
Environment objects.
GET ID=<id> Returns a single Boot Environment object 2016R2
with the specified ID.

Properties of BootEnvironment

www.baramundi.com Page 40/120

 Reference | baramundi Connect

5.13 Controller Variables

The Variables controller provides actions concerning the Variable objects of all bMS objects
that support variables. These ObjectVariables are certain instances of corresponding
VariableDefinition objects which can be managed with the controller VariableDefinitions.

To request Variable object data the URL must contain the bConnect version information. Only
those Variable objects can be read, the specified user has at least configured read rights on
the corresponding object in the bMS. To set a new value for a Variable object, the specified
user needs modify rights on the corresponding object in the bMS.

With bMS 2015 job objects of type WindowsJob, org units in node Logical Groups and all
endpoint objects supported reading and modification of their variables over bConnect. Since
Version 2016R2 it is also possible to read and modify variables for Software (Windows
Application only) and HardwareProfile objects.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Variables

Method URL parameters Description Since bMS

GET Scope=<scope> Returns a list of ObjectVariables of 2015
corresponding objects specified by Scope.
One ObjectVariables object contains all
variables of the specific bMS object.
Currently supported scopes are “Device,
“MobileDevice”, “OrgUnit”, “Job”, “Software”
and “HardwareProfile”.
(Check properties of ObjectVariables for
more information)
GET Scope=<scope> Returns a list of ObjectVariables of 2015
& corresponding objects specified by Scope.
Category=<var category> Only the variables of the specified Category
are supplied in the ObjectVariables objects.
GET Scope=<scope> Returns a list of ObjectVariables of 2015
& corresponding objects specified by Scope.
Category=<var category> Only the variables of the specified Category
& and Name are supplied in the
Name=<var name> ObjectVariables objects.
GET Scope=<scope> Returns an ObjectVariables object with the 2015
& variables of the object specified by
ObjectId=<object id> ObjectId.(e.g. ID of a WindowsEndpoint)
The specified object must match with the
specified scope for a successful result.
GET Scope=<scope> Returns an ObjectVariables object specified 2015
& by ObjectId.(e.g. ID of a WindowsEndpoint)
ObjectId=<object id> The specified object must match with the
& specified scope. Only variables with the
Category=<var category> specified Category will be returned.
GET Scope=<scope> Returns an ObjectVariables object specified 2015
& by ObjectId.(e.g. the ID of a
ObjectId=<object id> WindowsEndpoint)
& The specified object must match with the
Category=<var category> specified scope.

www.baramundi.com Page 41/120

 Reference | baramundi Connect

& Only variables with the specified Category

Name=<var name> and Name will be returned.
PUT None Updates the specific Variable objects, 2015
specified by scope, object id, category and
name with the specified values.
The specified parameters need to be
passed in the body of the HTTP-Request.
The data needs to be in the same format as
returned by a HTTP-Request with Method
GET.
See properties of ObjectVariables for further
information.
The returned object is of type
ObjectVariables containing all the variables
of the specified object.
The Property UseDefault is considered for
endpoints of type BmsNetEndpoint only and
is false by default.

Properties of ObjectVariables.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/variables.xml?scope=device&objectid=AA61A5
22-6EE6-4623-A47C-7A35D270F0DF

Result:

<ObjectVariables xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<ObjectId>AA60A522-6EE6-4623-A47C-7A35D270F0DF</ObjectId>
<Scope>Device</Scope>
<Variables>
<Variable>
<Category>Location</Category>
<Name>Building</Name>
<UseDefault>false</UseDefault>
<Value>Building1</Value>
<Type>String</Type>
</Variable>
…
<Variable>
<Category> Location </Category>
<Name>Room</Name>
<UseDefault>false</UseDefault>
<Value>Laboratory</Value>
<Type>String</Type>
</Variable>
</Variables>
</ObjectVariables>

www.baramundi.com Page 42/120

 Reference | baramundi Connect

• PUT-Request:
https://bmsserver.customer.net/bConnect/v1.0/variables.xml
Body (xml format):
<ObjectVariables xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<ObjectId>AA60A522-6EE6-4623-A47C-7A35D270F0DF</ObjectId>
<Scope>Device</Scope>
<Variables>
<Variable>
<Category>Location</Category>
<Name>Building</Name>
<UseDefault>false</UseDefault>
<Value>OtherBuilding</Value>
</Variable>
</Variables>
</ObjectVariables>

Result:
<ObjectVariables xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<ObjectId>AA60A522-6EE6-4623-A47C-7A35D270F0DF</ObjectId>
<Scope>Device</Scope>
<Variables>
<Variable>
<Category>Location</Category>
<Name>Building</Name>
<UseDefault>false</UseDefault>
<Value>OtherBuilding</Value>
</Variable>
…
<Variable>
<Category> Location </Category>
<Name>Room</Name>
<UseDefault>false</UseDefault>
<Value>Laboratory</Value>
</Variable>
</Variables>
</ObjectVariables>

www.baramundi.com Page 43/120

 Reference | baramundi Connect

5.14 Controller Apps

The Apps controller provides actions concerning the App objects, of the bMS. All sorts of apps
for endpoints of type BmsNetEndpoint are supported.
To request App object data the URL must contain the bConnect version information. Only those
App objects, the specified user has at least configured read rights on, will be available.
URL: https://<bmsserver>:<port>/bConnect/v1.0/Apps

Method URL parameters Description Since bMS

GET None Returns a list of all available App objects. 2016R2
GET OrgUnit=<org unit id> Returns a list of App objects, contained in 2016R2
the specified organizational unit.
Sub units are not considered.
GET EndpointID=<id> Returns a list of App objects that are 2016R2
installed on the specified endpoint.
GET ID=<id> Returns a single App objects by ID. 2016R2

Properties of Apps.

5.15 Controller Icons

The Icons controller provides actions concerning the icons of the available apps in the bMS.
This means the apps to install on devices as well as the inventoried ones.

To request Icons object data the URL must contain the bConnect version information. Only
those Icon objects, the specified user has at least configured read rights on the appropriate
App or InventoryApp object, will be available.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Icons

Method URL parameters Description Since bMS

GET None Returns a list of all available Icon objects. 2016R2
GET Scope=<scope> Returns a list of all Icon objects depending 2016R2
on the chosen scope.
If scope is ”App", a list of Icon objects of all
available and installable App objects will be
returned.
If scope is "Inventory", a list of Icon objects
of inventoried app objects will be returned.
GET AppID=<app id> Returns a single Icon object specified by an 2016R2
App ID.

Properties of Icons.

www.baramundi.com Page 44/120

 Reference | baramundi Connect

5.16 Controller Applications

The Applications controller provides actions concerning the Application objects, of the bMS.
These are the software products, including Managed Software products that are installed on
endpoints of the type WindowsEndpoint.

To request Application object data the URL must contain the bConnect version information.
Only those Application objects, the specified user has at least configured read rights on, will
be available.

To create an Application object with HTTP method POST in the specified organizational unit
(OrgUnit) the appropriate rights (create object) must be given for the specified parent org unit
to the user. To update an Application object with HTTP method PATCH the user needs the
appropriate rights (modify) for the specified object and if ParentId is specified also for the new
parent org unit.

URL: https://<bmsserver>:<port>/bConnect/v1.0/Applications

Method URL parameters Description Since bMS

GET None Returns a list of all available Application 2016R2
objects.
GET OrgUnit=<org unit id> Returns a list of Application objects, 2016R2
contained in the specified organizational
unit.
Sub units are not considered.
GET EndpointID=<endpoint id> Returns a list of Application objects that are 2016R2
installed with the bMS on the specified
endpoint.
GET ID=<id> Returns an Application object by ID. 2016R2
POST None Creates a new Application object according 2017
to the specified mandatory and optional
(Mandatory and optional properties data.
must be specified in the appropriate Mandatory properties:
format in the HTTP body. In case of • Name
XML, the elements must be sorted • Vendor
alphabetically and the appropriate • ValidForOS
namespaces must be appended as See properties of Applications for further
attributes to the root element.) information.
PATCH ID=<application id> Updates the specified properties of the 2017
Application object by ID.
Optional properties for all Application types:
(The properties that are to be
• Name
updated must be specified in the
• Comment
appropriate format in the HTTP
• Vendor
body. In case of XML, the elements
• Category
must be sorted alphabetically and
the appropriate namespaces must
• ParentId
be appended as attributes to the
• Version
root element.)
• ValidForOS
• EnableAUT
• Installation
• Uninstallation
• ConsistencyChecks

www.baramundi.com Page 45/120

 Reference | baramundi Connect

• Cost
• Files
• SecurityContext
• Licenses
• AUT
• SoftwareDependencies
• SoftwareLicenseActions
• Parameters
See properties of Applications for further
information. The returned object is of type
Application
DELETE ID=<application id> Deletes the Application object by ID. 2017

Properties of Applications.

Examples:

• POST-Request:
https://bmsserver.customer.net /bConnect/v1.0/applications.json

Body (json format):

{
"Name": "Office Application",
"Comment": "Alternative Office App",
"Vendor": "fsf",
"Category": "basic set",
"ParentId": "C36331A7-259C-4544-BC0F-804BEE3C3D67",
"Version": "1.2.3.4",
"ValidForOS": [
"WindowsXP_x64",
"WindowsServer2003_x64",
"WindowsVista_x64",
"WindowsServer2008_x64",
"Windows7_x64",
"Windows8",
"WindowsServer2012_x64",
"Windows10_x64"
],
"Installation": {
"Command": "InstallCommand.exe",
"Parameter": "/s",
"Engine": "baramundi Deploy Script",
"EngineFile": "{DIP}\\Scripts\\BDS\\ Office_App.bds ",
"Options": {
"AllowReinstall": false,
"UsebBT": true,
"VisibleExecution": "NeedsDesktop",
"CopyLocally": false,
"DisableInputDevices": true,
"DontSetAsInstalled": true,
"MapShare": false,
"Target": "C:\\",
"RebootBehaviour": "DeferrableReboot"
},
"UserSettings": {

www.baramundi.com Page 46/120

 Reference | baramundi Connect

"ExecuteAtEveryLogin": false,
"baramundiDeployScript": "{DIP}\\Scripts\\BDS\\Office_App_Ubds.bds",
"ValidForInstallUser": false,
"RunbDSVisible": false,
"CopyScriptToClient": false
}
},
"SoftwareDependencies": [
{
"DependencyId": "B9E90391-AECC-44D5-8FF6-3AFCD4F0683E",
"DependencyType": "InstallBeforeIfNotInstalled",
"ValidForOS": [
"Windows7_x64",
"WindowsServer2008R2_x64",
"Windows8_x64",
"WindowsServer2012_x64",
"Windows10_x64",
"WindowsServer2016_x64"
]
}
],
"SecurityContext": "LocalInstallUser",
"Parameters": [
{
"Name": "MaxParralelUsers",
"Type": "Number",
"Value": "2",
"DefaultValue": "3"
}
]
}

www.baramundi.com Page 47/120

 Reference | baramundi Connect

5.17 Controller InventoryDataRegistryScans

The InventoryDataRegistryScans controller provides actions concerning Inventory objects with
data of a registry scan. This data is gathered in the bMS with a Software scan.

To request Inventory objects with registry scan data the URL must contain the bConnect
version information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the node Inventoried Files and the corresponding endpoint in the
bMS. To delete Inventory objects the specified user needs read rights on the node Inventoried
Files as well as read and modify rights on the endpoint. Inventory Registry scan data can be
managed for endpoints of type WindowsEndpoint only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataRegistryScans

Method URL parameters Description Since bMS

GET None Returns a list of all available Inventory 2015
objects with the registry scan data.
GET EndpointID=<endpoint id> Returns the Inventory object with the 2015
registry scan data of the endpoint with the
specified ID.
DELETE EndpointID=<endpoint id> Deletes all registry scan data of the endpoint 2015
with the specified ID.

Properties of Inventory.

Properties of DataRegistry.

www.baramundi.com Page 48/120

 Reference | baramundi Connect

5.18 Controller InventoryDataFileScans

The InventoryDataFileScans controller provides actions concerning Inventory objects with data
of a file scan. This data is gathered in the bMS with a software scan.

To request Inventory objects with file scan data the URL must contain the bConnect version
information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the node Inventoried Files and the corresponding endpoint in the
bMS. To delete Inventory objects the specified user needs read rights on the node Inventoried
Files as well as read and modify rights on the endpoint. Inventory file scan data can be
managed for endpoints of type WindowsEndpoint only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataFileScans

Method URL parameters Description Since bMS

GET None Returns a list of all available Inventory 2015
objects with the file scan data.
GET EndpointID=<endpoint id> Returns the Inventory object with the file 2015
scan data of the endpoint with the specified
ID.
DELETE EndpointID=<endpoint id> Deletes all file scan data of the endpoint with 2015
the specified ID.

Properties of Inventory.

Properties of DataFile.

www.baramundi.com Page 49/120

 Reference | baramundi Connect

5.19 Controller InventoryDataWMIScans

The InventoryDataWMIScans controller provides actions concerning Inventory objects with
data of a WMI scan.

To request Inventory objects with WMI scan data the URL must contain the bConnect version
information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the corresponding endpoint. Inventory WMI scan data can be read
for endpoints of type WindowsEndpoint only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataWMIScans

Method URL parameters Description Since bMS

GET None Returns a list of all available Inventory 2015
objects with WMI scan data.
GET TemplateName=<name of Returns a list of all available Inventory 2015
the WMI scan template> objects with WMI scan data of scans
executed with the specified inventory
template.
GET TemplateName=<name of Returns a list of all available Inventory 2015
the WMI scan template> objects with WMI scan data of the latest
& scan executed with the specified inventory
Scan=<scan term> template. As scan term only “Latest” is
supported at the moment.
GET EndpointID=<endpoint id> Returns an Inventory object with WMI scan 2015
data of the endpoint with the specified ID.
GET EndpointID=<endpoint id> Returns the Inventory object with WMI scan 2015
& data, gathered with the specified inventory
TemplateName=<name of template only, of the endpoint of the
the scan template> specified ID.
GET EndpointID=<endpoint id> Returns the Inventory object with WMI scan 2015
& data, gathered with the specified inventory
TemplateName=<name of template at the specified time or the latest
the scan template> scan only, of the endpoint of the specified
& ID. As scan term only “Latest” is supported
Scan=<scan term / time> at the moment. The scan time must be
specified as UTC time in the format “yyyy-
MM-ddThh:mm:ssZ” (y=year, M=month,
d=day, h=hours, m=minutes, s=seconds).
The scan time of the scans can be obtained
over the InventoryOverviews controller.

Properties of Inventory.

Properties of DataWMI.

www.baramundi.com Page 50/120

 Reference | baramundi Connect

5.20 Controller InventoryDataCustomScans

The InventoryDataCustomScans controller provides actions concerning Inventory objects with
data of a Custom scan.

To request Inventory objects with custom scan data the URL must contain the bConnect
version information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the corresponding endpoint. Inventory Custom scan data can be read
for endpoints of type WindowsEndpoint only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataCustomScans

Method URL parameters Description Since bMS

GET None Returns a list of all available Inventory 2015
objects with Custom scan data.
GET TemplateName=<name of Returns a list of all available Inventory 2015
the used scan template> objects with Custom scan data of scans
executed with the specified inventory
template.
GET TemplateName=<name of Returns a list of all available Inventory 2015
the scan template> objects with Custom scan data of the latest
& scan executed with the specified inventory
Scan=<scan term> template. As scan term only “Latest” is
supported at the moment.
GET EndpointID=<endpoint id> Returns an Inventory object with Custom 2015
scan data of the endpoint with the specified
ID.
GET EndpointID=<endpoint id> Returns the Inventory object with Custom 2015
& scan data, gathered with the specified
TemplateName=<name of inventory template only, of the endpoint of
the scan template> the specified ID.
GET EndpointID=<endpoint id> Returns the Inventory object with Custom 2015
& scan data, gathered with the specified
TemplateName=<name of inventory template at the specified time or
the scan template> the latest scan only, of the endpoint of the
& specified ID. As scan term only “Latest” is
Scan=<scan term / time> supported at the moment. The scan time
must be specified as UTC time in the format
“yyyy-MM-ddThh:mm:ssZ” (y=year,
M=month, d=day, h=hours, m=minutes,
s=seconds).
The scan time of the scans can be obtained
over the InventoryOverviews controller.

Properties of Inventory.

Properties of DataCustom.

www.baramundi.com Page 51/120

 Reference | baramundi Connect

5.21 Controller InventoryDataHardwareScans

The InventoryDataHardwareScans controller provides actions concerning Inventory objects
with data of a hardware scan.

To request Inventory objects with hardware scan data the URL must contain the bConnect
version information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the corresponding endpoint. Inventory hardware scan data can be
requested for the following types of endpoints (Windows, iOS, Android, WindowsPhone and
Mac).

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataHardwareScans

Method URL parameters Description Since bMS

GET EndpointID=<endpoint id> Returns an Inventory object with hardware 2017
scan data of the endpoint with the specified
ID.
GET EndpointID=<endpoint id> Returns the Inventory object with hardware 2017
& scan data, gathered with the specified
TemplateName=<name of inventory template only, of the endpoint of
the scan template> the specified ID. If endpoint is not of type
WindowsEndpoint the parameter
“TemplateName” is ignored.
GET EndpointID=<endpoint id> Returns the Inventory object with Custom 2017
& scan data, gathered with the specified
TemplateName=<name of inventory template at the specified time or
the scan template> the latest scan only, of the endpoint of the
& specified ID. As scan term only “Latest” is
Scan=<scan term / time> supported at the moment. The scan time
must be specified as UTC time in the format
“yyyy-MM-ddThh:mm:ssZ” (y=year,
M=month, d=day, h=hours, m=minutes,
s=seconds).
For endpoints of type WindowsEndpoint the
scan time of the scans can be obtained over
the InventoryOverviews controller.
If endpoint is not of type WindowsEndpoint
the parameter “TemplateName” and “Scan”
are ignored.

Properties of Inventory.

Properties of DataHardware.

www.baramundi.com Page 52/120

 Reference | baramundi Connect

5.22 Controller InventoryDataSnmpScans

The InventoryDataSnmpScans controller provides actions concerning Inventory objects with
data of a SNMP scan. This data is gathered in the bMS with a SNMP job.

To request Inventory objects with SNMP scan data the URL must contain the bConnect version
information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the node Inventoried Files and the corresponding endpoint in the
bMS.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryDataSnmpScans

Method URL parameters Description Since bMS

GET EndpointID=<endpoint id> Returns the Inventory object with the SNMP 2017
scan data of the endpoint with the specified
ID.
Properties of Inventory.

Properties of DataSnmp.

5.23 Controller InventoryOverviews

The InventoryOverviews controller provides actions concerning InventoryOverview objects. It
contains overview data of Custom, WMI and Hardware scans executed on a specific client.

To request InventoryOverview objects the URL must contain the bConnect version information.
Only those InventoryOverview objects can be read, the specified user has at least configured
read rights on the corresponding endpoint. InventoryOverview objects can be read for
endpoints of type WindowsEndpoint only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryOverviews

Method URL parameters Description Since bMS

GET None Returns a list of all available 2015
InventoryOverview objects.
GET EndpointID=<endpoint id> Returns the InventoryOverview object of the 2015
endpoint with the specified ID.

Properties of InventoryOverview

www.baramundi.com Page 53/120

 Reference | baramundi Connect

5.24 Controller InventoryAppScans

The InventoryAppScans controller provides actions concerning Inventory objects with data of
a mobile device app scan.

To request Inventory objects with app scan data the URL must contain the bConnect version
information. Only those Inventory objects can be read, the specified user has at least
configured read rights on the corresponding endpoints of type Android, iOS and WindowsPhone
only.

URL: https://<bmsserver>:<port>/bConnect/v1.0/InventoryAppScans

Method URL parameters Description Since bMS

GET None Returns a list of all available Inventory 2016R2
objects with app scan data.
GET EndpointID=<endpoint id> Returns a list of all available Inventory 2016R2
objects with app scan data of scans
executed on an endpoint specified by ID.

Properties of Inventory.

Properties of InventoryApp.

www.baramundi.com Page 54/120

 Reference | baramundi Connect

5.25 Controller SoftwareScanRules

The SoftwareScanRules controller provides actions concerning the SoftwareScanRule objects
that are created as result of the client software inventory, of the bMS. SoftwareScanRule
objects are available for endpoints of type WindowsEndpoint only.

To request SoftwareScanRule object data the URL must contain the bConnect version
information and the specified user needs at least configured read rights on the node “Software
scan rules” in the module Inventory.

URL: https://<bmsserver>:<port>/bConnect/v1.0/SoftwareScanRules

Method URL parameters Description Since bMS

GET None Returns a list of all available 2014
SoftwareScanRule objects.

Properties of SoftwareScanRule.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/softwarescanrules.xml

Result:
<ArrayOfSoftwareScanRule>
<SoftwareScanRule>
<Category>ManagedSoftware</Category>
<Comment/>
<Id>006548b4-d65b-4e6a-870e-a9f1eb8542f5</Id>
<IsMswRule>true</IsMswRule>
<Protected>true</Protected>
<Rules>chlcdfkeanhekcdakeigla…hlniifpakf</Rules>
<SoftwareManufacturer>VideoLan</SoftwareManufacturer>
<SoftwareName>VLC</SoftwareName>
<SoftwareVersion>2.1.1-x64</SoftwareVersion>
</SoftwareScanRule>
<SoftwareScanRule>
<Category/>
<Comment/>
…
<SoftwareVersion>5.0.0.16964</SoftwareVersion>
</SoftwareScanRule>
…
…

</ArrayOfSoftwareScanRule>

www.baramundi.com Page 55/120

 Reference | baramundi Connect

5.26 Controller SoftwareScanRuleCounts

The SoftwareScanRuleCounts controller provides actions to get SoftwareScanRuleCount
objects that provide the endpoints which match the software scan rule along with a count.
SoftwareScanRuleCount objects are available for endpoints of type WindowsEndpoint only.

To request SoftwareScanRuleCount object data the URL must contain the bConnect version
information and the specified user needs at least configured read rights on the node “Licenses”
in the module Licenses.

URL: https://<bmsserver>:<port>/bConnect/v1.0/SoftwareScanRuleCounts

Method URL parameters Description Since bMS

GET None Returns a list of
all available 2018 R2
SoftwareScanRuleCount objects.

Properties of SoftwareScanRuleCount.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/softwarescanrulecounts.xml

Result:
<ArrayOfSoftwareScanRuleCount>
<SoftwareScanRuleCount>
<InstalledCount>50</InstalledCount>
<InstalledEndpoints>
<EndpointInfo>
<Id>17B65E8A-DBF3-456C-B5A5-38E596F01C20</Id>
<Name>WIN10-ENT</Name>
</EndpointInfo>
</InstalledEndpoints>
<SoftwareScanRule>
<Category>ManagedSoftware</Category>
<Comment/>
<Id>006548b4-d65b-4e6a-870e-a9f1eb8542f5</Id>
<IsMswRule>true</IsMswRule>
<Protected>false</Protected>
<Rules>chlcdfkeanhekcdakeigla…hlniifpakf</Rules>
<SoftwareManufacturer>Oracle</SoftwareManufacturer>
<SoftwareName>Java JRE</SoftwareName>
<SoftwareVersion>8.0.111.14-x64</SoftwareVersion>
</SoftwareScanRule>
</SoftwareScanRuleCount>
</ArrayOfSoftwareScanRuleCount>

www.baramundi.com Page 56/120

 Reference | baramundi Connect

5.27 Controller EndpointInvSoftware

The EndpointInvSoftware controller provides actions concerning the EndpointInvSoftware
objects, which contain the link between endpoints and inventoried software, of the bMS.
EndpointInvSoftware objects are available for endpoints of type WindowsEndpoint only.

To request EndpointInvSoftware object data the URL must contain the bConnect version
information and the specified user needs at least configured read rights for the corresponding
Endpoint objects and the node “Software scan rules” in the module Inventory.

URL: https://<bmsserver>:<port>/bConnect/V1.0/EndpointInvSoftware

Method URL parameters Description Since bMS

GET None Returns a list of all available 2014
EndpointInvSoftware objects.

Properties of EndpointInvSoftware.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/endpointinvsoftware.xml

Result:
<ArrayOfEndpointInvSoftware>
<EndpointInvSoftware>
<ConflictedRules>0</ConflictedRules>
<GuidEndpoint>26c2712a-7f5e-4307-b675-8139accf4b4d</GuidEndpoint>
<GuidRule>04b2928e-645b-4a99-8a2c-746fdc2c122d</GuidRule>
<InventoryPath>$Registry$</InventoryPath>
<InventoryVersion>8.8.9.237</InventoryVersion>
<LastSeen>2013-05-22T09:30:56+02:00</LastSeen>
</EndpointInvSoftware>
<EndpointInvSoftware>
<ConflictedRules>0</ConflictedRules>
<GuidEndpoint>26c2712a-7f5e-4307-b675-8139accf4b4d</GuidEndpoint>
<GuidRule>0574135c-901d-4b70-8f4c-f18d911068f5</GuidRule>
<InventoryPath>$Registry$</InventoryPath>
<InventoryVersion>6.2 SP0 x64-EN</InventoryVersion>
<LastSeen>2013-05-22T09:30:56+02:00</LastSeen>
</EndpointInvSoftware>
…
</ArrayOfEndpointInvSoftware>

www.baramundi.com Page 57/120

 Reference | baramundi Connect

5.28 Controller Images

The Images controller provides actions concerning the Image objects. Image objects are
supported on Jobs.

To request Images object data the URL must contain the bConnect version information.

URL: https://<bmsserver>:<port>/bConnect/V1.0/Images

Method URL parameters Description Since bMS

GET Id Returns an Image. 2018 R2

Properties of Image.

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/images.xml?Id=B227BAACC41C9D51BD03B8
23E785A084

Result:
<Image>
<Id>B227BAACC41C9D51BD03B823E785A084</Id>
<MimeType>image/jpeg</MimeType>
<Data>…</Data>
</Image>

www.baramundi.com Page 58/120

 Reference | baramundi Connect

5.29 Controller VariableDefinitions

The VariableDefinitions controller provides functionality to read, create, update and delete
custom variables. These custom variables are available as ObjectVariables for the
corresponding bMS objects, which do support variables.

Note: The deletion of a VariableDefinition object will also delete all its corresponding
ObjectVariable instances.

To request VariableDefinition object data the URL must contain the bConnect version
information.

URL: https://<bmsserver>:<port>/bConnect/V1.0/VariableDefinitions

Method URL parameters Description Since bMS

GET None Returns all custom variables as a list of 2019
VariableDefinition objects. (Check
properties of VariableDefinition for more
information)
GET ID=<vardef id> Returns a single VariableDefinition object 2019
with the specified ID
GET Scope=<vardef scope> Returns custom variables with the given 2019
Scope as a list of VariableDefinition
objects. Currently supported scopes are
“Device, “MobileDevice”, “OrgUnit”, “Job”,
“Software”, “HardwareProfile”, “AdObject”,
“Bulletin” and “Component”
GET Scope=<vardef scope> Returns custom variables with the given 2019
& Scope and Category as a list of
Category=<vardef category> VariableDefinition objects
GET Scope=<vardef scope> Returns a single VariableDefinition object 2019
& with the given Scope, Category and Name
Category=<vardef category>
&
Name=<vardef name>
POST None Creates a new VariableDefinition object 2019
according to the specified mandatory and
(Mandatory and optional properties optional data.
must be specified in the appropriate Mandatory properties:
format in the HTTP body. In case of • Scope
XML, the elements must be sorted • Category
alphabetically and the appropriate • Name
namespaces must be appended as • Type
attributes to the root element.)
PATCH ID=<vardef id> Updates the specified properties of the 2019
(The properties that are to be updated VariableDefinition object by ID.
must be specified in the appropriate Optional properties:
format in the HTTP body. In case of • Category
XML, the elements must be sorted • Name
alphabetically and the appropriate • Value
namespaces must be appended as • Comments
attributes to the root element.)
DELETE ID=< vardef id > Deletes a VariableDefinition object by ID. 2019

www.baramundi.com Page 59/120

 Reference | baramundi Connect

Examples:

• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/variabledefinitions

Result:
<ArrayOfVariableDefinition>
<VariableDefinition>
<Category>Location</Category>
<Comments></Comments>
<Id>07311C36-668C-4794-BD60-C79DD4A3D191</Id>
<Name>Cost center</Name>
<Scope>Device</Scope>
<Type>Checkbox</Type>
<Value>1</Value>
</VariableDefinition>
<VariableDefinition>
<Category>Location</Category>
<Comments/>
<Id>292F4106-6CBD-410D-8527-FB2B979A828F</Id>
<Name>Building</Name>
<Scope>Device</Scope>
<Type>String</Type>
<Value></Value>
</VariableDefinition>
<VariableDefinition>
<Category>Warranty data</Category>
<Comments/>
<Id>95371B4C-3F14-4ADA-9F8D-C13ED7F2878E</Id>
<Name>Inventory id</Name>
<Scope>Device</Scope>
<Type>String</Type>
<Value></Value>
</VariableDefinition>
…
</ArrayOfVariableDefinition>

• PATCH-Request:
https://localhost:443/bconnect/v1.0/variabledefinitions.xml?id=0E3D4C92-96F3-4260-BBFD-
6D5218FDB087

Body (xml format):

<VariableDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<Comments>default value updated</Comments>

www.baramundi.com Page 60/120

 Reference | baramundi Connect

<Value>new default value</Value>

</VariableDefinition>

Result:
<VariableDefinition>
<Category>Location</Category>
<Comments>default value updated</Comments>
<Id>0E3D4C92-96F3-4260-BBFD-6D5218FDB087</Id>
<Name>Building</Name>
<Scope>Device</Scope>
<Type>String</Type>
<Value>new default value</Value>
</VariableDefinition>

www.baramundi.com Page 61/120

 Reference | baramundi Connect

5.30 Controller KioskJobs

The KioskJobs controller provides functionality to read, create and delete job releases. They
are available as KioskJob objects.

URL: https://<bmsserver>:<port>/bConnect/V1.0/KioskJobs

Method URL parameters Description Since bMS

GET User=<user_principal_name> Returns a list of all released KioskJob 2019
objects for the specified user
GET EndpointId=<endpoint id> Returns a list of all released KioskJob 2019
objects for the specified endpoint. Result
also includes all inherited releases.
GET GroupId=<group id> Returns a list of all released KioskJob 2019
objects for the specified group. Result also
includes all inherited releases
GET JobDefinitionId =<job id> Returns a list of all released KioskJob 2019
objects for the specified job definition.
POST JobDefinitionId=<job id> Release a job for endpoint, group or user. 2019
&
TargetId=<endpoint id / group
id / user id>
POST JobDefinitionId=<job id> Release a job for user. 2019 R2
&
User=<user_principal_name>
DELETE KioskJobId=<kiosk job id> Delete KioskJob 2019

Examples:
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/KioskJobs?endpointId=E4D6F70F-290C-4B0E-
B9A9-D823171FF5E3

Result:
[{
"Id": "4",
"AssignedObjectId": "E4D6F70F-290C-4B0E-B9A9-D823171FF5E3",
"AssignedObjectName": "Windows PC",
"AssignedObjectType": "WindowsEndpoint",
"JobDefinitionId": "A57D8D92-D088-4FBF-BDE3-38FE3102297D",
"JobDefinitionName": "Windows-Scan",
"JobDefinitionDisplayName": "Windows-Scan",
"JobDefinitionCategory": "",
"JobDefinitionSupportedPlatforms": [
"Windows"
]
}
]

www.baramundi.com Page 62/120

 Reference | baramundi Connect

5.31 Controller EndpointSecrets

The EndpointSecrets controller provides functionality to read and update disk encryption
information. They are available as EndpointSecrets objects.

URL: https://<bmsserver>:<port>/bConnect/V1.0/EndpointSecrets

Method URL parameters Description Since bMS

GET EndpointId=<endpoint id> Returns the BitLocker unlock pin and 2019 R2
Volume secret information
PATCH EndpointId=<endpoint id> Optional properties: 2019 R2
• Pin

Examples:
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/EndpointSecrets?endpointId=E4D6F70F-290C-
4B0E-B9A9-D823171FF5E3

Result:
{
"EndpointId": "E4D6F70F-290C-4B0E-B9A9-D823171FF5E3",
"Pin": "123456",
"VolumeSecretEntries": [
{
"VolumeId": "\\\\?\\Volume{1bc10a7f-b18c-3591-c322-075836942588}\\",
"VolumeName": "System (C:)",
"IsSystemVolume": true,
"GeneratedRecoveryKey": "123456-789012-345678-901234-567890-123456-789012",
"InventoryRecoveryKey": "123456-789012-345678-901234-567890-123456-789012",
"InventoryTimestamp": "2019-10-10T09:14:33Z"
}
]
}

www.baramundi.com Page 63/120

 Reference | baramundi Connect

5.32 Controller EndpointEnrollment

The EndpointEnrollment controller provides functionality to trigger enrollment state of a
Windows endpoint. This means the endpoint will be set to Internet mode, the public key (if
existing) is deleted and the enrollment data is generated / overwritten. By specifying an e-mail
recipient, you can also have a corresponding e-mail with the enrollment information sent
automatically.

URL: https://<bmsserver>:<port>/bConnect/V1.0/EndpointEnrollment

Method URL parameters Description Since bMS

POST sync=<true / false> Sets mode of the endpoint to Internet, 2020 R1
deletes its stored public key (if existing)
(Mandatory and optional properties and generates / overwrites the enrollment
must be specified in the appropriate
data of this endpoint.
format in the HTTP body. In case of
XML, the elements must be sorted
alphabetically and the appropriate By specifying an e-mail recipient, you can
namespaces must be appended as also have a corresponding e-mail with the
attributes to the root element.)
enrollment information sent automatically.
The optional EmailLanguageId parameter
sets which e-mail template is used for the
enrollment message.
Default available mail templates are “de-
DE” and “en-US”. If the email language is
not specified, the English template (“en-
US”) will be used.

The optional URL parameter "sync"

specifies whether to wait until the email
has been successfully sent to the
configured SMTP server (default: sync =
false).

Returns an EnrollmentData object.

Mandatory Properties:
• EndpointId
Optional Properties:
• EmailRecipient
• EmailLanguageId

Example:
• POST-Request:
https://bmsserver.customer.net/bConnect/v1.0/EndpointEnrollment.json

Request body:

{
"EndpointId" : " E4D6F70F-290C-4B0E-B9A9-D823171FF5E3",
"EmailRecipient" : "user@customer.com",
"EmailLanguageId": "de-DE"
}

www.baramundi.com Page 64/120

 Reference | baramundi Connect

Result:
{
"EndpointId": " E4D6F70F-290C-4B0E-B9A9-D823171FF5E3",
"InstallCommand":
"ManagementAgent_setup.exe /Q OPTIONS=655667 INTERNET_MODE=1
INTERNET_SERVER=172.16.5.55 INTERNET_SERVERPORT=443
INTERNET_SERVERKEY=\"308201223…\" SERVERKEY=\"308201223…\"
ENROLLMENT_TOKEN_DATA=\"ChF5dX…\"",
"ValidUntil": "\"2019-12-19T14:41:18.717792500Z\""
}

www.baramundi.com Page 65/120

 Reference | baramundi Connect

5.33 Controller ServerState

The ServerState controller provides functionality to read the current state of the baramundi
server and its sub services.

URL: https://<bmsserver>:<port>/bConnect/V1.0/ServerState

Method URL parameters Description Since bMS

GET None Returns a ServerState object, which 2020 R1
represents the current state of the
baramundi server and its sub services

Example:
• GET-Request:
https://bmsserver.customer.net/bConnect/v1.0/ServerState.json

Result:
{
"Name": "bmsserver.customer.net ",
"ExecutionState": "Running",
"Services": [
{
"Name": "Active Directory Connector",
"ExecutionState": "Running",
"StateText": []
},
...
{
"Name": "Windows Software Inventory",
"ExecutionState": "Running",
"StateText": [
"Idle"
]
}
]
}

www.baramundi.com Page 66/120

 Reference | baramundi Connect

5.34 Controller VPPUsers

The VPPUsers controller provides functionality to read, create and delete (retire) Apple VPP
users.

Note: In order to use the VPPUsers controller a valid VPP token must be imported.

To request VPPUser object data the URL must contain the bConnect version information.

URL: https://<bmsserver>:<port>/bConnect/V1.0/VPPUsers

Method URL parameters Description Since bMS

GET None Returns VPP users as a list of VPPUser 2020 R2
objects. (Check properties of VPPUser for
more information)
GET ID=<vpp user id> Returns a single VPPUser object by ID. 2020 R2
GET Email=<VPP user email> Returns the VPP users as a list of VPPUser 2020 R2
objects, where the email address matches
with the given parameter
GET ManagedAppleId=<VPP user Returns the VPP users as a list of VPPUser 2020 R2
managed Apple Id> objects, where the managed Apple Id
matches with the given parameter
GET UserId=<VPP user UserId> Returns the VPP users as a list of VPPUser 2020 R2
objects, where the userId (assigned by
Apple) matches with the given parameter
GET ItunesStoreHash=<VPP user Returns the VPP users as a list of VPPUser 2020 R2
Itunes store hash> objects, where the Itunes store hash
matches with the given parameter
POST sendInvitationMail=<True, if an Creates a new VPPUser object according 2020 R2
invitation mail should be sent to the specified data.
to the given Email address,
otherwise False> Mandatory properties:
• IsManagedAppleId
An email will only be sent in • Email (if ‘IsManagedAppleId’ is
case of a non-managed Apple- False)
Id. If the email language is not • ManagedAppleId (if
specified, the English template ‘IsManagedAppleId’ is True)
(“en-US”) will be used. Optional properties:
• EmailLanguageId (default
(Mandatory and optional properties available Values are “de-DE” and
must be specified in the appropriate “en-US”)
format in the HTTP body. In case of
XML, the elements must be sorted
alphabetically and the appropriate
namespaces must be appended as
attributes to the root element.)
DELETE ID=<vpp user id> Deletes/retires a VPPUser object by ID. 2020 R2
PATCH ID=<vpp user id> Updates a set of properties of the Job with 2020R2
the specified ID.

www.baramundi.com Page 67/120

 Reference | baramundi Connect

Examples:

• POST-Request:
https://localhost:443/bconnect/v1.0/vppusers.json?sendInvitationMail=true

Body (json format):

{
"Email": "Jones.Dow@myprivatemail.com",
"IsManagedAppleId": false,
"EmailLanguageId": "de-DE"
}

Result:
{
"Id": "BF945C04-1A13-4F44-BCE6-FC998AE819FB",
"Email": "Jones.Dow@myprivatemail.com ",
"ManagedAppleId": null,
"EmailLanguageId": "de-DE",
"ItunesStoreHash": "",
"InviteUrl":
"https://buy.itunes.apple.com/WebObjects/MZFinance.woa/wa/associateVPPUserWit
hITSAccount?cc=de&l=en&inviteCode=fdbf5fb69b4feba7222edfb6&mt=8",
"Status": "Registered",
"UserId": "94675313",
"IsManagedAppleId": false
}

5.35 Controller VPPLicenseAssociations

The VPPLicenseAssociations controller provides functionality to read, create and delete VPP
license associations.

Note: In order to use the VPPLicenseAssociations controller a valid VPP token must be
imported.

To request VPPLicenseAssociation object data the URL must contain the bConnect version
information.

URL: https://<bmsserver>:<port>/bConnect/V1.0/VPPLicenseAssociations

Method URL parameters Description Since bMS

GET None Returns VPP license associations as a list 2020 R2
of VPPLicenseAssociation objects. (Check
properties of VPPLicenseAssociation for
more information)
GET ID=<vpp license association Returns a single VPPLicenseAssociation 2020 R2
id> object by ID.
GET EndpointId=<endpoint id> Returns the VPP license associations as a 2020 R2
list of VPPLicenseAssociation objects,
where the endpoint id matches with the
given parameter
GET UserId=<VPP user UserId> Returns the VPP license associations as a 2020 R2
list of VPPLicenseAssociation objects,

www.baramundi.com Page 68/120

 Reference | baramundi Connect

where the user id matches with the given

parameter
POST None Creates new VPPLicenseAssociation 2020 R2
objects according to the specified data.
(Mandatory and optional properties
must be specified in the appropriate Mandatory properties:
format in the HTTP body. In case of • BundleId
XML, the elements must be sorted • ClientUserIdStr
alphabetically and the appropriate
namespaces must be appended as
attributes to the root element.)
DELETE ID=<vpp license association id> Deletes a VPPLicenseAssociation object by 2020 R2
ID. This call will disassociate the VPP
license of the given bundle identifier from
the VPP user.
DELETE UserId=<VPP user UserId> Deletes all VPPLicenseAssociation objects 2020 R2
of the given VPP user. This call will
disassociate all VPP licenses of the VPP
user.

Examples:

• POST-Request:
https://localhost:443/bconnect/v1.0/vpplicenseassociations.xml

Body (xml format):

<VPPLicenseAssociation xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<BundleId>com.baramundi.bmdenroll</BundleId>
<ClientUserIdStr>2E97E7C1-CEF9-4611-A8BB-3E90ADFFE8A8</ClientUserIdStr>
</VPPLicenseAssociation>

Result:
<VPPLicenseAssociation xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/Baramundi.Bms.Server.Connector.Rest.BC
onnect.DataModel">
<AdamId>593959012</AdamId>
<BmsNetEndpoint i:nil="true" />
<BundleId>com.baramundi.bmdenroll</BundleId>
<ClientUserIdStr>2E97E7C1-CEF9-4611-A8BB-3E90ADFFE8A8</ClientUserIdStr>
<Id>D04ABB35-16B2-499C-AF3B-440A1A07C3BE</Id>
<LicenseIdStr>561967974</LicenseIdStr>
<SerialNumber i:nil="true" />
<ShouldBeDisassociated>false</ShouldBeDisassociated>
</VPPLicenseAssociation>

www.baramundi.com Page 69/120

 Reference | baramundi Connect

5.36 Controller MicrosoftUpdateInventories

The MicrosoftUpdateInventories controller provides the functionality to read the Microsoft
Update Inventory data of the Windows endpoints. This includes the missing and installed
updates found with the last Microsoft Update Inventory job.

To request MicrosoftUpdateInventories object data the URL must contain the bConnect version
information.

URL: https://<bmsserver>:<port>/bConnect/V1.0/MicrosoftUpdateInventories

Method URL parameters Description Since bMS

GET None Returns installed and missing updates 2020 R2
as a list of MicrosoftUpdateInventories
objects for all Windows endpoints.
(Check properties of
MicrosoftUpdateInventories for more
information).
GET EndpointId=<endpoint id> Returns installed and missing updates 2020 R2
as a list of MicrosoftUpdateInventories
objects for the specified Windows
endpoint.
GET GroupID=<group id> Returns installed and missing updates 2020 R2
as a list of MicrosoftUpdateInventories
objects for all windows endpoints within
the specified group. By default, only
endpoints that are directly in this group
are returned. For the inclusion of
subgroup endpoints, see below.
ExtendedInformation=<true/false> Optional for all GET methods: If "true", 2020 R2
the returned objects also contain the
corresponding
Description=<Description> and
MoreInfoUrls=<MoreInfoUrls>
properties.
Recursive=<true/false> Optional for GET method with GroupID 2020 R2
parameter: If “true”, installed and
missing updates are returned as a list of
MicrosoftUpdateInventories objects for
all windows endpoints within the
corresponding group and their
subgroups. If not specified this
parameter is taken as “false” by default.

www.baramundi.com Page 70/120

 Reference | baramundi Connect

Examples:

• GET-Request:
https://<bmsserver>:<port>/bConnect/V1.0/MicrosoftUpdateInventories?GroupID=036D9C03-
4F3E-47E9-8123-2E8B0456C4C7&Recursive=true

Result:

{
"Endpoints": [
{
"EndpointID":"A61C9A21-DB8D-498C-9F9C-7B28E9DF9B9B",
"UpdateInformation": [
{
"IsInstalled":False,
"UpdateId":"C2A8FCE2-B93A-4FC0-95EA-16B783F341F4",
"RevisionNumber":"200",
"Classification":"Security Updates",
"Products": [
"Windows 10"
],
"Title":"2020-02 Security Update for Adobe Flash Player for Windows 10 (KB4537759)",
"Type":"Software",
"SupportURL":"https://support.microsoft.com/help/4537759",
"LastDeploymentChangeTime":"2019-01-15T00:00:00Z",
"MsrcSeverity":"Critical",
…
}]}

www.baramundi.com Page 71/120

 Reference | baramundi Connect

6 Simple integration samples

6.1 Windows PowerShell
Simple PowerShell script to request available bMS org units over bConnect.
For this sample the Windows PowerShell version 4.0 is required.
# Simple script to request available bMS org units over bConnect
# ! Windows PowerShell 4.0 required !

# credentials
$username = "<domain>\<user>"
$password = "<password>" | ConvertTo-SecureString -asPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential($username,$password)

# configuration
$server = "<baramundi server>" # bramundi Management Server as specified in the
bound certificate
$version = "v1.0" # current version of bConnect
$outputformat = "json" # request the data in json format
$controller = "orgunits" # an existing controller
$attributes = "" # starting with '?'

$url = "https://" + $server + "/bConnect/" + $version + "/" + $controller + "." +

$outputformat + $attributes

# request
$response = Invoke-WebRequest -Uri $url -Credential $creds

# HTTP status codes: 200=OK; 400=bad request; 403=unauthorized; 500=internal server error;
$stat = $response.statuscode;
write-host "Status:" $stat "$([char]10)"

# de-serialize response data and evaluate and output data

$jsonobjects = $response.Content | ConvertFrom-Json
foreach($line in $jsonobjects)
{
write-host "Id:" $line.Id
write-host "Name:" $line.Name
write-host "GuidParent:" $line.GuidParent "$([char]10)"
}

www.baramundi.com Page 72/120

 Reference | baramundi Connect

6.2 Visual Basic Script (VBS)

Simple Visual Basic script to request available bMS org units over bConnect.
Dim httpObj
Set httpObj = CreateObject("MSXML2.ServerXMLHTTP")

'credentials
user = "<user>" 'user authorized in baramundi Management Suite
password = "<password>" 'password for the user above
'configuration
server = "<baramundi server>" 'baramundi Management Server as specified in the bound
certificate
version = "v1.0" 'current version of bConnect
outputformat = "xml" 'request the data in xml or json format
controller = "orgunits" 'an existing controller
attribues = "" 'starting with '?'

url = "https://" & server & "/bConnect/" & version & "/" & controller & "." & outputformat
& attribues

'request
httpObj.Open "GET", url, False, user, password
httpObj.setOption 2, 13056 'suppress cert warning
httpObj.SetRequestHeader "pragma", "no-cache" 'avoid caching
httpObj.SetRequestHeader "Cache-Control", "no-cache, no-store" 'avoid caching
httpObj.send

'HTTP status codes: 200=OK; 400=bad request; 403=unauthorized; 500=internal server error;
plot = "HTTPS response status code: " & httpObj.Status & vbCrLf & vbCrLf

'check response data only if request was successful

If 200 = httpObj.Status then
'de-serialize response data to xml object
Dim objXML
set objXML = CreateObject("Microsoft.XMLDOM")
objXML.async = "false"
objXML.loadXML(httpObj.responsetext)
'evaluate and output data
Dim nodes
Set nodes = objXML.documentElement.selectNodes("//OrgUnit")
For Each node In nodes
plot = plot & "OrgUnit:" & vbCrLf
plot = plot & "Id = " & node.SelectSingleNode("./Id").text & vbCrLf
plot = plot & "Name = " & node.SelectSingleNode("./Name").text &
vbCrLf
plot = plot & "GuidParent = " &
node.selectSingleNode("./GuidParent").text & vbCrLf
plot = plot & vbCrLf
Next
End If

Set httpObj = Nothing

wscript.echo plot

www.baramundi.com Page 73/120

 Reference | baramundi Connect

6.3 C#
Simple sample in C# to request available bMS org units over bConnect. Used with .NET
Framework 4.5.
namespace bConnectSample
{
using System;
using System.IO;
using System.Net;
using Newtonsoft.Json;

internal class Program

{
public static bool AcceptAllCertifications(object sender,
System.Security.Cryptography.X509Certificates.X509Certificate certification,
System.Security.Cryptography.X509Certificates.X509Chain chain,
System.Net.Security.SslPolicyErrors sslPolicyErrors)
{
return true; // check here for valid server certificate
}

private static void Main(string[] args)

{
ICredentials creds = new NetworkCredential() // credentials
{
UserName = "<user>", // user authorized in baramundi Management Suite
Password = "<password>" // password for the user above
};

// configuration
string server = "<baramundi server>"; // baramundi Management Server
string version = "v1.0"; // current version of bConnect
string outputformat = "json"; // request the data in xml format
string controller = "orgunits"; // an existing controller
string attribtues = ""; // starting with '?'

string url = "https://" + server + "/bConnect/" + version + "/" + controller + "."

+ outputformat + attribtues;

// Create a request for the URL.

WebRequest request = WebRequest.Create(url);
request.Method = "GET";
request.Credentials = creds;
ServicePointManager.ServerCertificateValidationCallback = new
System.Net.Security.RemoteCertificateValidationCallback(AcceptAllCertifications);

try
{
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
StreamReader streamReader = new StreamReader(response.GetResponseStream());
var results = JsonConvert.DeserializeObject<dynamic>(streamReader.ReadToEnd());

www.baramundi.com Page 74/120

 Reference | baramundi Connect

foreach (var orgUnit in results)

{
Console.WriteLine("Id:\t\t{0}", orgUnit.Id);
Console.WriteLine("Name:\t\t{0}", orgUnit.Name);
Console.WriteLine("GuidParent:\t{0}\n", orgUnit.GuidParent);
}

streamReader.Close();
response.Close();
}
catch (WebException ex)
{
Console.WriteLine(ex.Message);
}

Console.Read();
}
}
}

www.baramundi.com Page 75/120

 Reference | baramundi Connect

7 Properties of object types

This chapter provides information about the properties of the objects used with bConnect. In
the column Access of the specific object type for each property the access right for object
creation=C, reading=R and updating=U is stated, depending on the actions the corresponding
controller supports.

7.1 Version
Property Data type Access Description
SupportedVersions List of String (*) R List of supported versions
CurrentVersion String (*) R Current version of bConnect
(*) must not be null for reading access

7.2 Info
Property Data type Access Description
bConnectVersion String (*) R Current version of bConnect
Description String (*) R Simple description of bConnect
Company String (*) R baramundi Software AG
Copyright String (*) R Copyright …
bMSVersion String (*) R Current version of the bMS
UserContext String (*) R Context this request is processed in
(*) must not be null for reading access

www.baramundi.com Page 76/120

 Reference | baramundi Connect

7.3 SearchResult
Property Data type Access Description
Id String (*) R Unique ID of a found object. Use this
ID to load the whole object
Name String (*) R Name of an object found
Type Int (*) R Type of an object found (see coding
below)
AdditionalInfo String R Additional data of an object found
Deactivated Bool (**) R For endpoints only: The endpoint is
deactivated (Windows) or not
managed (mobile endpoints, Macs).
(*) must not be null for reading access
(**) applies for endpoints only
Codings:

[Type]
0 Unknown
1 WindowsEndpoint endpoint of type WindowsEndpoint
2 AndroidEndpoint BmsNetEndpoint
3 iOSEndpoint BmsNetEndpoint
4 MacEndpoint BmsNetEndpoint
5 WindowsPhoneEndpoint BmsNetEndpoint
6 WindowsJob for endpoints of type WindowsEndpoint only
7 BmsNetJob for endpoints of type BmsNetEndpoint only
8 OrgUnit different nodes (including Logical Goups)
9 DynamicGroup for endpoints of type WindowsEndpoint only
10 StaticGroup for endpoints of all endpoint types
11 Application for endpoints of type WindowsEndpoint only
12 App for endpoints of type BmsNetEndpoint only
16 NetworkEndpoint endpoint of type NetworkEndpoint
17 AD Object user or user group

www.baramundi.com Page 77/120

 Reference | baramundi Connect

7.4 OrgUnit
Property Data type Access Description
Id String R ID of an org unit
Comment String R/C/U Freely editable text field
Extension Extension (*) R/C/U Extended data for org units of node
Logical Groups
GuidParent DEPRECATED String R ID of a superior org unit
(use ParentId instead)
HierarchyPath String R Path of an org unit in the organizational
hierarchy
Name String R/C/U Name of an org unit
ParentId String R/C/U ID of a superior org unit
(*) applies for org units of node Logical Groups only

7.4.1 Extension
Property Data type Access Description
DIP String R/C/U DIP list, separated by semi-colon
Domain String R/C/U Windows domain name
LocalAdminPassword String R/C/U Password for a local administrator
(must be encrypted with baramundi
Cryptor)
EnableDHCP Bool R/C/U If set the network settings will be
provided by the dhcp server
SubnetMask String R/C/U If not EnableDHCP: Network mask
DefaultGateway String R/C/U If not EnableDHCP: Standard gateway
DnsServer String R/C/U If not EnableDHCP: DNS 1
DnsServer2 String R/C/U If not EnableDHCP: DNS 2
DnsDomain String R/C/U If not EnableDHCP: DNS domain
WinsServer String R/C/U If not EnableDHCP: WINS 1
WinsServer2 String R/C/U If not EnableDHCP: WINS 2
AutoInstallJobs List of String R/C/U List of job IDs for auto installation
(see object type Job)
HardwareProfiles List of String R/C/U List of hardware profile IDs (see object
type HardwareProfile)
InheritAutoInstallJobs Bool R/C/U If set, the auto install jobs of parent org
unit will be inherited (see object type
Job)
RequestableJobs List of String R/C/U List of job ids (for Kiosk; see object
type Job)

www.baramundi.com Page 78/120

 Reference | baramundi Connect

7.5 DynamicGroup
Property Data type Access Description
Id String R ID of a dynamic group
Comment String R/C/U Freely editable text field
HierarchyPath String R Path of a dynamic group in the
organizational hierarchy
Name String R/C/U Name of a dynamic group
ParentId String R/C/U ID of a superior org unit
Statement String R/C/U SQL statement of a dynamic group
(only WHERE clause can be defined;
target is always the table “machine”)

7.6 UniversalDynamicGroup
Property Data type Access Description
Id String R ID of a universal dynamic group
Comment String R Freely editable text field
HierarchyPath String R Path of a universal dynamic group in
the organizational hierarchy
DisplayName String R Display Name of a universal dynamic
group
Name String R Name of a universal dynamic group
ParentId String R ID of a superior org unit
IsArgusSynced Bool R If true, a universal dynamic group is
synchronized to Argus Cockpit

7.7 StaticGroup
Property Data type Access Description
Id String R ID of a static group
Comment String R/C/U Freely editable text field
EndpointIds List of String R/C/U List of endpoint IDs linked to the static
group
HierarchyPath String R Path of a static group in the
organizational hierarchy
Name String R/C/U Name of a static group
ParentId String R/C/U ID of a superior org unit

www.baramundi.com Page 79/120

 Reference | baramundi Connect

7.8 Endpoint
For bMS 2014 R2 the Endpoint object has been extended for mobile devices (Android,
WindowsPhone, iOS) and Mac devices. Hence the property Type specifies if the endpoint is
of type WindowsEndpoint, AndroidEndpoint, WindowsPhoneEndpoint, iOSEndpoint,
MacEndpoint or NetworkEndpoint.

Property Data type Acces Description

s
Id String (*) R ID of an endpoint.
Type Int (*) R/C Type of an endpoint (see coding
below)
GuidGroup DEPRECATED String R/C ID of Logical Group, a client should be
(use GuidOrgUnit instead) managed with
DisplayName String (*) R/C/U Display name of an endpoint.
HostName String R/C/U Host name of an endpoint.
Domain String R/C/U LAN manager domain an endpoint
should be in, after an operating
system installation
PrimaryMAC String R/C/U Primary MAC-address of an endpoint.
Supported format:
MM:MM:MM:MM:MM:MM
Each «M» stands for one
hexadecimal number (0 to F)
MACList String (**) R List of all MAC-addresses of an
endpoint
LogicalMAC String (**) R Logical MAC-address of an endpoint
LAAList DEPRECATED String (**) R List of locally administrated MAC-
addresses
PrimaryIP String (**) R/C/U Primary IP-address of an endpoint
IPList String (**) R List of all IP-addresses of an endpoint
GuidHardwareProfile String (**) R/C/U Hardware profile‘s ID of an endpoint
OperatingSystem String R Name of an installed OS
Options UInt (**) R/C/U Options of an endpoint (see coding
below)
Comments String R/C/U Freely editable text field
PrimaryUser String R/C/U Primary user of an endpoint
ClientAgentState Int (**) R State of the agent on an endpoint (see
coding below)
Activity String R Current activity of the client agent
LastChange DateTime (**) R Date and time of last change
LastSeen DateTime R Date and time of last successful
communication with the client agent
OSVersionString String R Full name of the installed OS
OSVersionMajor Int (**) R Major version of the installed OS
OSVersionMinor Int (**) R Minor version of the installed OS
OSVersionBuild Int (**) R Build number of the installed OS
LastUser String R Last logged on user
IEVersionString String (**) R Version of the installed Internet
Explorer.
CPUDescription String (**) R Description of the CPU.
CPUType String (**) R Information about the CPU type.

www.baramundi.com Page 80/120

 Reference | baramundi Connect

CPUSpeed Int (**) R Information about the CPU speed in

MHz.
TotalMemory Int (**) R Information about the installed
memory in MB
DriveCSize DEPRECATED Int (**) R Size of C: drive
DriveCFree DEPRECATED Int (**) R Free space on C: drive
DriveDSize DEPRECATED Int (**) R Size of D: drive.
DriveDFree DEPRECATED Int (**) R Free space on D: drive
DriveESize DEPRECATED Int (**) R Size of E: drive
DriveEFree DEPRECATED Int (**) R Free space on E: drive
GuidOrgUnit String (*) R/C/U ID of a parent org unit
CustomStateType Int (**) R/U Freely editable user defined state type
CustomStateTime DateTime (**) R Time of the last change of a freely
editable user defined state type
CustomStateText String (**) R/U Freely editable user defined state type
BMSServer DEPRECATED String (**) R Responsible baramundi Management
Server
BootCounter DEPRECATED Int (**) R Client reboot counter
ClientAgentVersion String (**) R Client agent version
GuidJobPreinstallApp String (**) R ID of the configured pre-install
DEPRECATED application
GuidJobPostinstallApp String (**) R ID of the configured post-install
DEPRECATED application
Priority DEPRECATED Int (**) R Used priority
GuidBootEnvironment String (**) R/C/U If set, the giving boot environment
will boot during the next start. For
booting without PXE, this value must
be left empty.
LocaleId Int (**) R Localization ID of the client OS
Architecture String (**) R Clients CPU architecture
CurrentUserSID String R SID of the current user
WOLSent DEPRECATED DateTime (**) R Date and time WOL signal was sent
last time
LastBoot DateTime (**) R Date and time of the clients last boot
event
EnergyScheme String (**) R Name of the active energy scheme
EnergySchemeId String (**) R ID of the current energy scheme
OSVersionSPMajor Int (**) R Service pack level of the installed OS
DEPRECATED
(use OSVersionString instead)
CPUCountPhysical Int (**) R Number of physical CPUs
CPUCountLogical Int (**) R Number of logical Cores
CPUCountTotalCores Int (**) R Number of physical CPU cores
Manufacturer String R Manufacturer of the device
ModelName String R Model name of the device
ManagementState Int (***) R Management state of the device (see
coding below)
UniqueDeviceId String (***) R Unique device ID
UserCategory (***) R/U Free text category

Owner Int (***) R/C/U Owner type of the device (see coding
below)
ComplianceState Int (***) R Compliance state of an endpoint (see
coding below)

www.baramundi.com Page 81/120

 Reference | baramundi Connect

ComplianceCheckCategory Int (***) R/C/U Compliance category of the device

(see coding below)
ComplianceCheckDisabledFrom DateTime (***) R/U Date and time the compliance check
is disabled
ComplianceCheckDisabledUntil DateTime (***) R/U Date and time the compliance check
is re-enabled
SerialNumber String R/C Serial number of the device
PublicKey String (**) R/U Public key of the client certificate
ExtendedInternetMode Bool (**) R/C/U If set Extended Internet Mode is
enabled
LastChannel String (**) R Type of the last channel used for
communication (see coding below)
Mode String (**) R/C/U Type of the currently configured
mode (see coding below)
InstalledSoftware List of <Software> R List of the software installed with the
baramundi Management Suite on the
client
OSVersionPatchLevel String (**) R Patch level of the operating system
(Revision ID)
Applies for Windows 10 systems only
OSReleaseId String (**) R Distinguishable ID for Windows 10
systems (e.g. “1507”, “1511”, …)
Applies for Windows 10 systems only
OSServiceBranch String (**) R The current branch the Windows 10
system is connected to (e.g. “LTSB”,
“CBB”, “CB”)
Applies for Windows 10 systems only
SNMPData SNMPDeviceData R SNMP data of the device
TPMData TPMData (**) R TPM inventory data
IsSecureBootEnabled Bool (**) R Secure boot enabled on this client
StorageMedia List of R Inventoried Storages
<StorageMedium>
IndustrialData IndustrialData R/C/U Additional data for Industrial
Endpoints
AndroidEnterpriseProfileType Int (***) R/C Type of android enterprise profile
(see coding below)
VirusAndThreadProtectionStatus String R The aggregation of all antivirus
products for this computer
(see coding below)
AutomaticUpdateStatus String R The automatic update settings for
this computer
(see coding below)
FirewallAndNetworkProtectionSt String R The aggregation of all firewalls for
atus this computer
(see coding below)
AppAndBrowserControlStatus String R The settings that restrict the access
of web sites in each of the Internet
zones for this computer
(see coding below)
WindowsSecurityServiceStatus String R The running state of the WSC service
on this computer
(see coding below)
UserAccountControlStatus String R The User Account Control (UAC)
settings for this computer
(see coding below)

www.baramundi.com Page 82/120

 Reference | baramundi Connect

SecurityCenterUser String R Last logged on user (except

installation user)
(see coding below)
AppleManagementMode Int (***) R/C Type of iOS Management (see coding
below)
ManagedAppleId String R/C The managed AppleId
HasAppleAppUpdates Bool (****) R Flag to check if the apple device has
app updates which can be installed
LastUpdateInventoryDate DateTime (**) R Date and time of the last executed
update inventory
UpdateInventorySource String (**) R Update metadata source of the last
inventory (see coding below)
MissingCriticalUpdatesCount Int (**) R Number of missing critical (defined
by bMS) updates
MissingSecurityUpdatesCount Int (**) R Number of missing security (defined
by bMS) updates
MissingOtherUpdatesCount Int (**) R Number of missing updates, which
are neither critical nor security
updates
LastSuccessfulUpdateDate DateTime (**) R Date and time of the last successfully
executed update deploy job step
(only applies to update job steps
controlling the Windows Update
Agent)
LastSuccessfulUpdateSource String (**) R Update metadata source of the last
successful update deploy job step
(see coding below)
BitLockerNetworkUnlockStatus String (**) R Status of Network Unlock Feature on
Client. (see coding below)
DedicatedDeviceModeEnabled Bool (***) R Enabled if the device is a Dedicated
Device (Android Enterprise) or has
Dedicated Device Mode enabled
(iOS).
EmailRecipient String (***) C The email address for the recipient of
the enrollment email.
EmailLanguageId String (***) C The Identifier of the email template,
which will be used for the email
enrollment message sent to the
Reciepient email. Default available
templates are “de-DE” and “en-US”.
DisplayVersion String R The DisplayVersion of the installed
windows operating system. (Filled
from Windows 20H2)
(*) must not be null for reading access
(**) applies for WindowsEndpoint only
(***) applies for BmsNetEndpoint only
(***) applies for AppleEndpoints only

Codings:

[Mode]
LAN LAN only
Internet Internet only
Dynamic Device selects dynamically the appropriate channel

[LastChannel]

www.baramundi.com Page 83/120

 Reference | baramundi Connect

LAN LAN channel used by device in LAN mode

Internet Internet channel used by device in Internet mode
AutoLAN LAN channel selected automatically by device in Dynamic mode
AutoInternet Internet channel selected automatically by device in Dynamic mode

[VirusAndThreadProtectionStatus]
[AutomaticUpdateStatus]
[AppAndBrowserControlStatus]
[WindowsSecurityServiceStatus]
[UserAccountControlStatus]
[SecurityCenterUser]
Unknown The status of the security provider could not be determined.
Good The status of the security provider category is good and does not
need user attention.
NotMonitored The status of the security provider category is not monitored by WSC.
Poor The status of the security provider category is poor and the computer
may be at risk.
Snooze The security provider category is in snooze state. Snooze indicates
that WSC is not actively protecting the computer.

[Type]
0 Unknown
1 WindowsEndpoint
2 AndroidEndpoint
3 iOSEndpoint
4 MacEndpoint
5 WindowsPhoneEndpoint
16 NetworkEndpoint
18 IndustrialEndpoint

[ClientAgentState]
-1 Unchanged
0 Unknown
1 Not Installed
3 Running
4 Rebooting

[Options]
0x00000001 Admits an OS installation
0x00000002 Inherits auto installation
Bit 3-4 PrimaryUserUpdateOptions (see below)
Bit 5-6 UserJobOptions (see below)
0x00000100 Automatic Usage Tracking is active
0x00000200 Energy Management is active
0x80000000 Client is deactivated (read only flag)

[PrimaryUserUpdateOptions]
0x00000000 Primary user will be updated at the next announce (default).
0x00000004 Do not use the primary user.
0x00000008 Always update the primary user.
0x0000000C Never update the primary user.

[UserJobOptions]
0x00000000 Always execute user related jobs.

www.baramundi.com Page 84/120

 Reference | baramundi Connect

0x00000010 Never execute user related jobs.

0x00000030 Execute user related jobs if the primary user is logged in (default).

[ManagementState]
0 Unknown
1 Enrollable
2 Enrolling
3 Managed
4 Unmanaged

[Owner]
-2 Unknown
0 Company
1 Private

[ComplianceState]
0 Unknown
1 Compliant
2 Not compliant, just a info
3 Not compliant, a warning
4 Not compliant, severe
5 Compliance inactive

[ComplianceCheckCategory]
0 active Compliance is activated for the device
1 inactive Compliance is deactivated for the device
2 temporarily inactive Compliance is temporarily deactivated for the device

[AndroidEnterpriseProfileType]
0 None (Android Legacy Device)
1 Fully managed device
2 Work Profile
4 Dedicated Device

[AppleManagementMode]
0 None (Will default to DeviceEnrollment for iOS Devices)
1 DeviceEnrollment
2 UserEnrollment

[BitLockerNetworkUnlockStatus]
0 Deactivated
BitLocker Network Unlock is not active, User needs to enter BitLocker PIN at startup.

1 OtherCertificate
BitLocker Network Unlock is active, but not configured for using with bMS. Installed BitLocker
Network Unlock Certificate is unknown.

2 Activated
BitLocker Network Unlock is active, System boots without requesting PIN, if connected per LAN

3 NotSupported
BitLocker Network Unlock is not supported on device.

www.baramundi.com Page 85/120

 Reference | baramundi Connect

4 Unknown
BitLockerNetworkUnlock status was not inventorised yet.

[LastSuccessfulUpdateSource, UpdateInventorySource]
WSUS
Windows Online
Microsoft Online

7.8.1 TPMData
Property Data type Access Description
Version String R TPM version
TPMStatus Int R 0 : Not available
1 : Deactivated
2 : Enabled
3 : Activated
IsOwned Bool R Indicates whether the TPM has an
owner

7.8.2 StorageMedium
Property Data type Access Description
Index Int R Disk index
Name String R Disk name
ByteSize ULong R Total size in bytes
BusType Int R Bus type (see coding below)
PartitionStyle Int R 0 : Unknown
1 : MBR (Master boot record)
2 : GPT (GUID partition table)
StorageVolumes List of R Volumes on this disk
<StorageVolumes>

[BusType]

0 Unknown
1 SCSI
2 ATAPI
3 ATA
4 IEEE1394
5 SSA
6 FibreChannel
7 USB
8 RAID
9 ISCSI
10 SAS
11 SATA
12 SD
13 MMC
14 Virtual
15 FileBackedVirtual
16 StorageSpaces
17 NVMe

www.baramundi.com Page 86/120

 Reference | baramundi Connect

7.8.3 StorageVolumes
Property Data type Access Description
DriveLetter String R Current volume letter
Label String R Volume label
FileSystem String R NTFS, ReFS, FAT32 or CSVFS
FileSystemType Int R File system type (see coding below)
ByteSize ULong R Total size in bytes
ByteSizeRemaining ULong R Free space in bytes
IsSystemVolume Bool R Contains operating system
BitLockerVolumeData BitLockerVolumeData R BitLocker data
VolumeID String R Volume ID
PartitionType String R Type of the partition

[FileSystemType]

0 Unknown
1 FAT
2 FAT32
3 NTFS
4 EXFAT
5 CSVFS
6 ReFS

www.baramundi.com Page 87/120

 Reference | baramundi Connect

7.8.4 BitLockerVolumeData
Property Data type Access Description
ConversionStatus Int R Conversion status (see coding below)
EncryptionPercentage Int R Encryption progress in percent
SuspendCount Int R Suspend BitLocker for n reboots
BitLockerVersion Int R 0 : Unknown
1 : Vista
2 : Win7+
ProtectionStatus Int R 0 : Unprotected
1 : Protected
2 : Unknown
LockStatus Int R 0 : Unknown
1 : Unlocked
2 : Locked

[ConversionStatus]

0 Fully decrypted
1 Fully encrypted
2 Encryption in progress
3 Decryption in progress
4 Encryption paused
5 Decryption paused
6 Unknown

7.8.5 Software
Property Data type Access Description
Id String R Unique ID of a software
Name String R Name of a software
Version String R Version of a software
Package String R Identifier of a software
Manufacturer String R Name of the manufacturer

www.baramundi.com Page 88/120

 Reference | baramundi Connect

7.8.6 SNMPDeviceData
Property Data type Access Description
SNMPName String R Name of a device
Description String R Description of a device
VendorId Int R SNMP ID of a vendor
UpTime String R The time since a device has been
running. Format:
days.hours:minutes:sec.millisec
PrimaryMAC String R Primary MAC address of a device
LastContact DateTime R Date and time of last successful
communication with a device
Comment String R Freely editable text field
PrimaryIP String R Primary IP address of a device
DetectionRules List of R Detection Rules that apply for a device
<DetectionRule>

7.8.6.1 DetectionRule

Property Data type Access Description

TypeId String R Id of a rule
Name String R Name of a rule

7.8.7 IndustrialData
Property Data type Access Description
GatewayType Int R/C Device type
Url String R/C/U Web interface URL
Port int R/C/U Communication port
SnmpConfiguration SnmpConfiguration R/C/U SNMP configuration
LastInventory DateTime R Last inventory date
ModelType String R Model type
IndustrialCPU String R CPU description
FirmwareVersion String R Firmware version
HardwareVersion String R Hardware version
OrderNumber String R Order number
UpTime Long R Uptime
Contact String R Contact person
Location String R Location

www.baramundi.com Page 89/120

 Reference | baramundi Connect

7.8.8 SnmpConfiguration
Property Data type Access Description
Version Int R/C/U SNMP version
1: V1
2: V2c
3: V3
Community String R/C/U Community
Required for V1 and V2c
Username String R/C/U Username
Required for V3
Authentication Int R/C/U Authentication Type:
0 : None
1: MD5 (96 Bit)
2: SHA (96 Bit)
3: SHA (196 or 256 Bit)
AuthenticationPassword String C/U Authentication password
Required for Authentication > 0
Encryption Int R/C/U Encryption algorithm:
0: DES
1: AES
2: 3DES
3: AES (192 Bit)
4: AES (256 Bit)
EncryptionPassword String C/U Encryption password
Required for Encryption > 0

www.baramundi.com Page 90/120

 Reference | baramundi Connect

7.9 NewEndpoint
Property Data type Access Description
EnrollmentToken String R Token for enrollment (null for
endpoints of type WindowsEndpoints)
TokenValidUntil DateTime R Validity time for created token (null for
endpoints of type WindowsEndpoints)
Endpoint Endpoint R Newly created endpoint object

www.baramundi.com Page 91/120

 Reference | baramundi Connect

7.10 Job
For bMS 2014 R2 the Job object has been extended for mobile (Android, iOS,
WindowsPhone) and Mac devices. Hence the property Type specifies if the Job object is for
endpoint of type WindowsEndpoint or BmsNetEndpoint (Android, WindowsPhone, iOS, Mac).
Property Data type Access Description
Id String (*) R Unique ID of a job
Type DEPRECATED Int (*) R Type of a job (see coding below)
GuidParent String (*) R ID of a superior org unit
Name String (*) R Name of a job
State DEPRECATED UInt (**) R State of a job (see coding below)
JobCount Int (**) R Number of max job executions
Interval DEPRECATED String (**) R Intervals of job executions if
JobCount >1
Initiator String (**) R User, who had created the job.
Options UInt (**) R Job options (see coding below)
Validity DEPRECATED String (**) R Validity of a job
Comments String (**) R Freely editable text field
Priority Int (**) R Priority of a job
MaxConcurrentTargets Int (**) R Max number of simultaneous job
instances
Unlocksequence String (**) R Unlock sequence of a job
MinBandwidth Int (**) R Minimal bandwidth for job execution
JobExecutionTimeout Int (**) R Timeout for job execution
JobProperties List of <Key, R Further properties of a job
Value> (**)
AssignOnEndpointCreation Bool (***) R If true, a job is assigned automatically
to new devices
Description String (*) R Description of a job
RemoveInstanceAfterCompletion Bool (***) R If true, the job instance is removed
DEPRECATED after completion
RepeatOnFailure Bool (***) R If set the job is repeated on failure
Repetition Int (***) R Interval of job execution
RequiredComplianceLevel Int (***) R Required compliance level for a job
ShowInKiosk Bool (***) R Show job in Kiosk
CanRunOnMobileDevice R If true a job for a mobile device,
otherwise if CanRunOnMac is false
also a job for WindowsEndpoint
device.
CanRunOnMac R If true a job for a Mac device,
otherwise if CanRunOnMobileDevice is
false also a job for WindowsEndpoint
device
Destructive Bool (***) R If true, a job contains destructive
steps (e.g. Wipe, OS-Install, ...)
SupportEndpointsInInternetMode Bool (**) R If true, a job can be executed on an
endpoint that is in the internet mode
Steps List of <Step> R Step can be type of Application or
Common
DisplayName String R DisplayName of a Job
IconId String R Id of associated Image
Category String R Category of a job
(*) must not be null for reading access, (**) applies for WindowsJob only, (***) applies for BmsNetJob only

www.baramundi.com Page 92/120

 Reference | baramundi Connect

Codings:
[Type] DEPRECATED
0 Unknown
6 WindowsJob Valid for WindowsEndpoints only (use instead properties
CanRunOnMac = false AND CanRunOnMobileDevice = false)
7 BmsNetJob Valid for Android, WindowsPhone8, iOS and MacEndpoints (use instead
properties CanRunOnMac = true OR CanRunOnMobileDevice = true)

[State] DEPRECATED
0 Unknown
1 Inactiv
2 Activ

[Options]
0x00000001 UseWakeOnLan
0x00000002 Cancel, if an error occurs
0x00000004 Passive mode
0x00000008 If the job is done start screen saver
0x00000010 If the job is done shut down the system
0x00010000 Show always the information window
0x00020000 Log off other users before a job will be executed
0x00040000 Force a logoff
0x00080000 Hide the information window
0x00200000 User can delay a job execution
0x00400000 User can deny a job execution

[RequiredComplianceLevel]
0 Unknown
1 Compliant
2 Not compliant, just a info
3 Not compliant, a warning
4 Not compliant, severe
5 Compliance inactive

7.10.1 Step (Common)

Property Data type Access Description
Sequence Int R Sequence number of the step
beginning with 1
Type String R Type of the Step (see Type)
Properties List of <Key, R Additional properties
Value>

www.baramundi.com Page 93/120

 Reference | baramundi Connect

7.10.2 Step (Application)

Property Data type Access Description
Sequence Int R Sequence number of the step
beginning with 1
Type String R Step type (see Type)
Properties List of <Key, list R Additional properties of Type <Key, list
of <Property>> of <Property>>

7.10.2.1 Property

Property Data type Access Description

Id String R Unique ID of a Property
Name String R Name of a Property
Sequence Int R Sequence number of the Property
beginning with 1

7.10.3 Type
[Type]
Unknown

Steps for WindowsJob:

CloningBackup
SoftwareDeploy
SoftwareDeployUninstall
InventoryScan
PatchScan
ManagedSoftwareScan
PXEBoot
OSInstall
CloningImaging
CloningSysprep
WipeDisk
PersonalBackup
PersonalRestore
DesasterBackup
DesasterRestore
Citrix_AppConfig_ServerConfig
Citrix_Publish
Citrix_Retract
Citrix_ServerInstallation
ApplyEnergyPolicy
ServerSideAction
ComplianceScan
VirtualizationControlVM
VirtualizationCreateVMFromProfile
PatchManagement
Deploy
ManagedSoftware
NetworkScan

www.baramundi.com Page 94/120

 Reference | baramundi Connect

MicrosoftUpdateInventory

Steps for BmsNetJob:

ApplicationExecuteJobStep
ApplicationInstallJobStep
ApplicationUninstallJobStep
ApplicationConfigureJobStep
ApplicationRemoveConfigurationJobStep
ExecuteCommandJobStep
HardwareInventoryJobStep
SoftwareInventoryJobStep
LockJobStep
UnlockJobStep
ProfileInstallJobStep
ProfileJobStep
ProfileUninstallJobStep
ServerSideActionJobStep
SSHExecutionJobStep
OSUpdateJobStep
WaitJobStep
WipeJobStep

www.baramundi.com Page 95/120

 Reference | baramundi Connect

7.11 JobInstance
For bMS 2014 R2 the JobInstance object has been extended to expose properties for mobile
(Android, iOS, WindowsPhone) and Mac devices too.

Property Data type Access Description

Id String (*) R Unique ID of a job instance
EndpointId String (*) R Unique ID of an endpoint
EndpointName String R Name of the corresponding endpoint
JobDefinitionId String (*) R Unique ID of a job
JobDefinitionName String R Name of the corresponding job
TimeStart DateTime R Starting time of execution
TimeNext DateTime R Time of the next execution
TimeLastAction DateTime R Time last action occurred
Executed Int R Number of executions
Retried Int R Number, how many times a job
execution was tried
HasDenied Int R Number, how many times a job was
denied
State DEPRECATED UInt (**) R State of a job instance (see coding
(use BmsNetState instead) below)
StateText String R The state of a job instance as text (for
all endpoint types)
Properties List of <Key, R Additional properties
Value>
Created DateTime R Creation time of a job instance
ExecutionCountError Int R Number, how many times a job
execution failed
ExecutionCountSuccess Int R Number, how many times a job
execution succeeded
ExecutionDate DateTime R Time of the next execution
Initiator String R User context the job instance was
created with
BmsNetState Int R State of job instance for BmsNet
endpoint (see coding below)
EndpointCategory Int R Endpoint category of a job instance
Steps List of <Step> R Step can be type of
ApplicationInstance or
CommonInstance
JobDefinitionDisplayName String R DisplayName of the corresponding job
(*) must not be null for reading access
(**) applies for WindowsJobInstance only
Codings:

[EndpointCategory]
-1 Any
0 Unknown
1 MicrosoftWindows
2 GoogleAndroid
3 AppleIOS,
4 AppleMac
5 WindowsPhone
6 Network
7 Industrial

www.baramundi.com Page 96/120

 Reference | baramundi Connect

[State] DEPRECATED (use BmsNetState instead)

A job instance state consists of a status (lower 8 bits) and a so-called state flag (upper 24 bits). The
mask of job instance states is 0x000000FF. That means, just the below 8 bits can be used for coding
the state.

0 Unknown
1 Inactive
2 Active
5 Running
6 Paused
7 Finished
0x00000100 Resume Job steps will not be new created.
0x00000200 Warning Cancels with warning
0x00000400 Error Cancels with error
0x00000800 Rebooting Client new start
0x00001000 RetryFailed Retry failed
0x00002000 Waiting Waiting for event to proceed
0x00004000 Connecting Server connects to client
0x00008000 Delayed Job on client is delayed (locked workstation)
0x00010000 Rescheduled Job has been re-planned
0x00020000 Preparing Job preparation phase
0x00040000 Initializing Job initializing phase
0x00080000 Rebooted Client rebooted
0x00100000 WaitingForBootClient Job waits for a boot client connection.
0x00200000 OtherJobActive Another Job is active for this client
0x00400000 ConnectFailed Attempt to connect failed
0x00800000 PreconditionFailed Set when Preconditions do not apply
0x01000000 DownloadsFinished Job instance has finished downloading files via bBT
0x02000000 DownloadingFiles Job instance is downloading files via bBT
0x04000000 UBDSExecuteOnEachLogin UBDS Option ExecuteOnEachLogin is set
0x08000000 RescheduledForShutdown Job rescheduled to time of the shutdown
0x10000000 ExecuteShutdownJob Shutdown Job ready for execution

[BmsNetState]
-1 Unknown
0 Assigned
1 Running
2 FinishedSuccess
3 FinishedError
4 FinishedCanceled
5 ReScheduled
6 ReScheduledError
7 WaitingForUser
8 RequirementsNotMet
9 Downloading
10 SkippedDueToIncompatibility
11 NonBlockingWaitingForUser

www.baramundi.com Page 97/120

 Reference | baramundi Connect

7.11.1 Step (CommonInstance)

Property Data type Access Description
Sequence Int R Sequence number of the step
beginning with 1
Type String R Type of the Step (see Type)
Properties List of <Key, R Additional properties
Value>
TimeLastAction DateTime Time, the last action was done
State Int Current state of the step (see State)
StateText String A text that has further information

7.11.2 Step (ApplicationInstance)

Property Data type Access Description
Sequence Int R Sequence number of the step
beginning with 1
Type String R Type of the Step (see Type)
Properties List of <Key, list R Additional properties of Type <Key, list
of <Property>> of <Property>>
TimeLastAction DateTime Time, the last action was done
State Int Current State of the step (see State)
StateText String A text that has further information

7.11.3 State
[State]
0 Assigned
1 Running
2 FinishedSuccess
3 FinishedError
4 FinishedCanceled
5 ReScheduled
6 ReScheduledError
7 WaitingForUser
8 RequirementsNotMet
9 Downloading
10 SkippedDueToIncompatibility

www.baramundi.com Page 98/120

 Reference | baramundi Connect

7.12 BootEnvironment
This object type applies for endpoints of type WindowsEndpoint only.

Property Data type Access Description

Id String R Unique ID of a boot environment
Name String R Name of a boot environment
Bootpath String R Path in which the Windows PE files
will be placed
Comment String R Freely editable text field
Architecture String (*) R Processor architecture of the boot
environment
Type String R Defines the type of the boot
environment (see coding below)
AutoConfirmStep Bool R If true, the started image will not
confirm this step
ShowInBootMenu Bool R If true, the boot environment will be
shown in the boot menu
ReinstallSystem Bool R If true, the boot environment will
reinstall the system
NetworkBootstrapProgram String (**) R Selected network bootstrap program
for the boot environment
(*) for other platforms than UEFI this value is null
(**) for UEFI platforms this value is null

Codings:
[Type]
Unknown
DOS
WinPE
WinPE_UEFI
Custom

www.baramundi.com Page 99/120

 Reference | baramundi Connect

7.13 HardwareProfile
This object type applies for endpoints of type WindowsEndpoint only.

Property Data type Access Description

Id String R ID of a hardware profile
CpuSpeed String R Speed of the installed CPU in MHz
CpuType String R Type of the installed CPU
Comment String R Freely editable text field
IgnoreOnAutoDetect Bool R If set, the hardware profile will be
ignored on auto detection
JoinDomainAfterSetup Bool R If true, a domain join is executed after
the setup
Manufacturer String R Hardware manufacturer
Memory String R Size of available memory in MByte
Model String R Hardware model
Name String R Name of a hardware profile
UseManualDriverAssignment Bool R If true, the driver package stored in the
DriverPath will be used for drivers
DriverPath String R Path to driver packages

www.baramundi.com Page 100/120

 Reference | baramundi Connect

7.14 ObjectVariables
Property Data type Access Description
ObjectId String R Unique ID of the object the variables
belong to (e.g. an endpoint)
Scope String R Scope of the variables (e.g. Device)
Variables List of R List of all variables of an object
<Variable>

Codings:

[Scope]
Device Covers endpoints of type WindowsEndpoint and MacEndpoint
MobileDevice Covers endpoints of type Android, WindowsPhone and iOSEndpoint
Job Covers jobs of type WindowsJob
OrgUnit Covers org units in node Logical Groups only
Software Covers software (applications) for Windows clients only
Hardwareprofile Covers hardware profiles

7.14.1 Variable
Property Data type Access Description
Category String R Category of a variable
Name String R Name of a variable
Value String R/U Value of a variable
UseDefault Bool (*) R/U If true the default variable value (from
variable definition) is used
Type String R The type of a variable (see coding
below)
(*) applies for BmsNetEndpoints only

Codings:

[Type]
Unknown
Number
String
Date
Checkbox
Dropdownbox
DropdownListbox
Filelink
Folder
Password
Certificate

www.baramundi.com Page 101/120

 Reference | baramundi Connect

7.15 App
This object type applies for endpoints of type AndroidEndpoint, iOSEndpoint and
WindowsPhoneEndpoint only.

Property Data type Access Description

Id String R Unique ID of an app
Name String R Name of an app
Version String R Version of an app
Plattform String R Supported platforms of the app
Package String R Identifier of the app
StoreId String R Unique Store ID of an app
FileSize Long R File size of an app
Account String R Account of an app
VPPManagedOS Bool (*) R If true, the app is managed by the bMS
VPPRedemptionCodes Bool (*) R If true, there are redemption codes for
the app available
Licenses List of R List of item properties with data type
<AppLicenseCo AppLicenseCounter
unter>
ParentId String R Unique ID of a parent org unit
(*) if the platform does not support this property the value is null

7.15.1 AppLicenseCounter
Property Data type Access Description
TotalInstalledOn Int R Number of devices the app is installed
on
InUse Int R Number of devices where the app is in
use
TotalLicense Int R Number of available licenses
FreeLicense Int R Number of free licenses

7.16 Icon
Property Data type Access Description
Id String R Unique ID of an app
Data Array of Bytes R The apps binary icon data

www.baramundi.com Page 102/120

 Reference | baramundi Connect

7.17 Application
This object type applies for endpoints of type WindowsEndpoint only.

Property Data type Access Description

Id String R/C Unique ID of an application
Name String R/C/U Name of an application
Comment String R/C/U Freely editable text field
ParentId String R/C/U ID of the parent org unit
Version String R/C/U Version of an application
Vendor String R/C/U Vendor of an application
Category String R/C/U Category of an application
ValidForOS List of String R/C/U List of all supported operating
systems of an application (see coding
below)
EnableAUT Bool R/C/U If set, AUT is enabled for this
application
Installation InstallationData R/C/U Object of the type InstallationData
Uninstallation UninstallationD R/C/U Object of the type UninstallationData
ata
ConsistencyChecks String R/C/U Consistency checks of an application
Files List of R/C/U List of ApplicationFile objects
ApplicationFile
Cost Float R/C/U Purchase cost
SecurityContext String R/C/U Context of the execution (see coding
below)
Licenses List of R/C/U List of ApplicationLicense objects
ApplicationLice
nse
MSW Bool R If true, the application is a managed
software
AUT List of R/C/U Rules used for application usage
AUTFileRule tracking
SoftwareDependencies List of R/C/U List of SoftwareDependency objects
SoftwareDepen (Application must exist)
dency
SoftwareLicenseActions List of R/C/U List of SoftwareLicenseAction objects
SoftwareLicens
eAction
Parameters List of R/C/U List of Parameter objects
Parameter

Codings:

[SecurityContext]
AnyUser
InstallUser
LocalInstallUser
LocalSystem
LoggedOnUser
RegisteredUser
SpecifiedUser

www.baramundi.com Page 103/120

 Reference | baramundi Connect

[ValidForOS]
NT4
Windows2000
WindowsXP
WindowsServer2003
WindowsVista
WindowsServer2008
Windows7
WindowsServer2008R2
WindowsXP_x64
WindowsServer2003_x64
WindowsVista_x64
WindowsServer2008_x64
Windows7_x64
WindowsServer2008R2_x64
Windows8
Windows8_x64
WindowsServer2012_x64
Windows10
Windows10_x64
WindowsServer2016_x64
WindowsServer2019_x64

7.17.1 ApplicationLicense
Property Data type Access Description
Count Int R/C/U Count of all available licenses
LicenseKey String R/C/U Key of the license
Offline Int R/C/U Count of all offline licenses
Online Int R Count of all online licenses

7.17.2 ApplicationFile
Property Data type Access Description
Source String R/C/U Source of the file
Type String R/C/U Type of the file (see coding below)

Codings:

[Type]
FolderWithSubFolders
SingleFolder
File

www.baramundi.com Page 104/120

 Reference | baramundi Connect

7.17.3 InstallationData
Property Data type Access Description
Command String R/C/U Installation / Uninstallation command
Parameter String R/C/U Parameters for installation /
uninstallation
Response File String R/C/U Source of the response file after
installation / uninstallation
Engine String R/C/U Name of the installation /
uninstallation engine
EngineFile String R/C/U Source of the installation /
uninstallation engine
Options InstallApplicatio R/C/U InstallApplicationOption
nOption
UserSettings InstallUserSetti R/C/U InstallUserSettings
ngs

Codings:

[Engine]
baramundi Deploy Package
Rational Visual Test 6.5
baramundi Deploy Script

7.17.3.1 InstallApplicationOption

Property Data type Access Description

RebootBehaviour String R/C/U Behaviour after reboot (see coding
below)
AllowReinstall Bool R/C/U If set, reinstallation is allowed
UsebBT Bool R/C/U If set, bBT is supported
VisibleExecution String R/C/U Shows in which cases the
execution of this software is visible
(see coding below)
CopyLocally Bool R/C/U If set, installation files should be
copied to local filesystem
DisableInputDevices Bool R/C/U If set, no input devices will be
available during installation
DontSetAsInstalled Bool R/C/U If set, this application shouldn’t be
shown as installed, after installation
MapShare Bool R/C/U If set, installation share will be
connected for installation
Target String R/C/U Target file

Codings:

[RebootBehaviour]
NoReboot
Reboot
AppReboot
DeferrableReboot

www.baramundi.com Page 105/120

 Reference | baramundi Connect

[VisibleExecution]
Silent
NeedsDesktop
VisibleWhenUserLoggedOn

7.17.3.2 InstallUserSettings

Property Data type Access Description

baramundiDeployScript String R/C/U Path to the deploy script that needs
to be executed during installation
ValidForInstallUser Bool R/C/U If true, also valid for install user
RunbDSVisible Bool R/C/U If true, bDS will be executed visible
CopyScriptToClient Bool R/C/U If true, script will be copied to the
client before execution
ExecuteAtEveryLogin Bool R/C/U If true, script will be executed at
every login

7.17.4 UninstallationData
Property Data type Access Description
Command String R/C/U Installation / Uninstallation command
Parameter String R/C/U Parameters for installation /
uninstallation
Response File String R/C/U Source of the response file after
installation / uninstallation
Engine String R/C/U Name of the installation /
uninstallation engine
EngineFile String R/C/U Source of the installation /
uninstallation engine
Options UninstallApplica R/C/U UninstallApplicationOption
tionOption
UserSettings UninstallUserSe R/C/U UninstallUserSettings
ttings

Codings:

[Engine]
baramundi Deploy Package
Rational Visual Test 6.5
baramundi Deploy Script

7.17.4.1 UninstallApplicationOption

Property Data type Access Description

RebootBehaviour String R/C/U Behaviour after Reboot (see
codings below)
RemoveUnknownSoftware Bool R/C/U If true, unknown software will be
uninstalled
UsebBT Bool R/C/U If true, bBT is supported

www.baramundi.com Page 106/120

 Reference | baramundi Connect

VisibleExecution String R/C/U Shows in which cases the

execution of this software is visible
(see coding below)
CopyLocally Bool R/C/U If true, installation files are copied
to local file system
DisableInputDevices Bool R/C/U If true, no input devices will be
available during installation

Codings:

[VisibleExecution]
Silent
NeedsDesktop
VisibleWhenUserLoggedOn

[RebootBehaviour]
NoReboot
Reboot
AppReboot
DeferrableReboot

7.17.4.2 UninstallUserSettings

Property Data type Access Description

baramundiDeployScript String R/C/U Path to the deploy script that needs
to be executed during installation
ValidForInstallUser Bool R/C/U If true, also valid for install user
RunbDSVisible Bool R/C/U If true, bDS will be executed visible
CopyScriptToClient Bool R/C/U If true, script will be copied to client
before execution

7.17.5 AUTFileRule
Property Data type Access Description
FileName String R/C/U Name of the file
FileSize ULong R/C/U Size of the file
Date String R/C/U Timestamp as Date of the file
CRC ULong R/C/U Checksum of the file
Version String R/C/U Version of the file
Company String R/C/U Company of the file
ProductName String R/C/U Product name of the file
InternalName String R/C/U Internal name of the file
Language String R/C/U Language of the file
ProductVersion String R/C/U Product version of the file
FileDescription String R/C/U File description of the file
FileVersionNumeric String R/C/U Numerical file version
CommandLine String R/C/U Command line parameters

www.baramundi.com Page 107/120

 Reference | baramundi Connect

7.17.6 SoftwareDependency
Property Data type Access Description
DependencyId String R/C Unique ID of the dependency
(software Unique ID)
DependencyAppName String R Name of the application
DependencyType String R/C Type of the dependency (see coding
below)
ValidForOS List of Strings R/C List of all supported operating
systems of the dependency (see
coding below)

[DependencyType]
InstallBeforeIfNotInstalled
AlwaysInstallAfterwards
AlwaysInstallBefore
DeinstallBeforeIfInstalled
ErrorIfNotInstalled
ErrorIfInstalled

[ValidForOS]
NT4
Windows2000
WindowsXP
WindowsServer2003
WindowsVista
WindowsServer2008
Windows7
WindowsServer2008R2
WindowsXP_x64
WindowsServer2003_x64
WindowsVista_x64
WindowsServer2008_x64
Windows7_x64
WindowsServer2008R2_x64
Windows8
Windows8_x64
WindowsServer2012_x64
Windows10
Windows10_x64
WindowsServer2016_x64

7.17.7 SoftwareLicenseAction
Property Data type Access Description
AlarmCount int R/C Count, when the alarm is executed.
AlarmAction String R/C Action of the alarm
ContinueInstall bool R/C If false, the application won’t be
installed, if less than ‘AlarmCount’
licenses are available

www.baramundi.com Page 108/120

 Reference | baramundi Connect

[AlarmAction]
LogInfo
LogWarning

7.17.8 Parameter
Property Data type Access Description
Name String R/C Name of the parameter
Type String R/C The type of the parameter
Value String R/C The actual value of the parameter
DefaultValue String R/C The default value of the parameter
when Value is not set

[Type]
Unknown
Number
String
Date
Checkbox
Dropdownbox
DropdownListbox
Filelink
Folder
Password
Certificate

www.baramundi.com Page 109/120

 Reference | baramundi Connect

7.18 Inventory
This object type applies for all endpoint types.

Property Data type Access Description

EndpointId String R Unique ID of the endpoint
Scans List of R List of available inventory scans for an
InventoryScan endpoint

7.18.1 InventoryScan
Property Data type Access Description
Time DateTime R Scan execution time (in UTC)
Template String R Name of the template used for the
inventory scan
Data List of R Inventory data is one of following
InventoryData> types: DataRegistry, DataFile,
DataWMI, DataCustom and
DataHardware

7.18.2 DataRegistry
Property Data type Access Description
Name String R Name of a scanned registry entry
Version String R Version of a scanned registry entry
Company String R Responsible Company
ProductName String R Name of a product the entry is for

7.18.3 DataFile
Property Data type Access Description
Name String R Name of a scanned file
Path String R Path of a scanned file
Size Long R Size of a scanned file in Bytes
LastWriteTime DateTime R Last time the file was modified
Version String R Version of a scanned file
Company String R Manufacturer of a scanned file
ProductName String R Product a scanned file is part of
ProductVersion String R Version of a product
OriginalName String R Internal name of a scanned file
Description String R Description of a scanned file

www.baramundi.com Page 110/120

 Reference | baramundi Connect

7.18.4 DataWMI
Property Data type Access Description
ClassName String R Corresponding WMI class name
Items List of <Item> R List of found items with data type Item

7.18.4.1 Item

Property Data type Access Description

Child DataWMI R Possible child data
Properties List of R List of item properties with data type
<Property> Property.

7.18.5 DataCustom
Property Data type Access Description
Name String R Custom name of a root node
Properties List of R List of custom node properties with
<Property> type Property
SubNodes List of R List of SubNodes with data type
<DataCustom> DataCustom

7.18.6 DataHardware
Property Data type Access Description
Name String R Name of a root node
Properties List of R List of node properties with type
<Property> Property
SubNodes List of< R List of SubNodes with data type
DataHardware> DataHardware

7.18.6.1 Property

Property Data type Access Description

Name String R Property name
Value String R Property value

7.18.7 DataSnmp
Property Data type Access Description
Name String R Name of a SNMP property
ObjectId String R SNMP object identifier
PropertyId String R Id of a SNMP property
Found Bool R True if the object was found
Value String R Value of a SNMP property

www.baramundi.com Page 111/120

 Reference | baramundi Connect

7.19 InventoryOverview
This object type applies for endpoints of type WindowsEndpoint only.

Property Data type Access Description

EndpointId String R ID of an endpoint
Scans List of <Scan> R List of scan objects of an endpoint

7.19.1 Scan
Property Data type Access Description
Template String R Name of a used template
Time DateTime R Date and time of a scan (in UTC)
Type String R Inventory Type (see coding below)

Coding:

[Type]
Unknown
Custom
WMI
Hardware

www.baramundi.com Page 112/120

 Reference | baramundi Connect

7.20 InventoryApp
This object type applies for endpoints of type AndroidEndpoint, iOSEndpoint and
WindowsPhoneEndpoint only.

Property Data type Access Description

Id String R Unique ID of an App
Name String R Name of the App
Version String R Version of the App
Build String R Build number of the App
Plattform String R Supported platform for the App
Package String R Identifier of the App
IsRunable Bool (*)(***) R If set, the App is runnable and
whitelisted on the device
LocalPath String (*)(**) R Local installation path of the app
VPPManagedOS Bool (*)(***) R If set, the App is managed by the bMS
VPPRedemptionCodes Bool (*)(***) R If set, there are redemption codes for
the app available
Licenses List of R List of item properties with data type
AppLicenseCou AppLicenseCounter
nter
(*) if the platform does not support the property, the value is null.
(**) only supported on Mac OS X devices
(***) only supported on iOS and Mac OS X

www.baramundi.com Page 113/120

 Reference | baramundi Connect

7.21 SoftwareScanRule
Property Data type Access Description
Id String (*) R Unique ID of a software scan rule
SoftwareManufacturer String (*) R Manufacturer of a software
SoftwareName String (*) R Name of a software
SoftwareVersion String (*) R Version of a software
Protected Bool R True, if scan rule is protected
Comment String R Freely editable text field
Rules DEPRECATED String R The rule to detect a software
Category String R Category of the software
IsMswRule Bool R True, if scan rule is for
ManagedSoftware product
(*) must not be null for reading access

7.22 SoftwareScanRuleCount
Property Data type Access Description
SoftwareScanRule SoftwareScanR R SoftwareScanRule object that a
ule object detection rule that identifies installed
and deployed software
InstalledCount String R Cumulated count of deployed and
inventoried software
InstalledEndpoints List of R The Endpoints which match the scan
EndpointInfo rule
objects

7.23 EndpointInvSoftware
Property Data type Access Description
GuidEndpoint String (*) R Unique ID of an endpoint
GuidRule String (*) R Unique ID of a software scan rule
LastSeen DateTime(*) R Last time a software was detected on
an endpoint
InventoryPath String R Inventory path
InventoryVersion String R Inventory version
ConflictedRules DEPRECATED String R List of IDs of conflicted scan rules
(*) must not be null for reading access

7.24 EndpointInfo
Property Data type Access Description
Id String R Unique ID of an endpoint
Name String R Name of the endpoint

www.baramundi.com Page 114/120

 Reference | baramundi Connect

7.25 Image
Property Data type Access Description
Id String R Unique ID of an image
MimeType String R Image Internet Media Type
Data Array of Bytes R The binary icon data

7.26 VariableDefinition
Property Data type Access Description
Id String R/C Unique ID of a custom variable
Scope String R/C Scope of a custom variable (e.g.
MobileDevice)
Category String R/C/U Category of a custom variable
Name String R/C/U Name of a custom variable
Type String R/C/U Type of a custom variable (see coding
below)
Value String R/C/U The default value of a custom variable
Comments String R/C/U Freely editable text field

Codings:

[Type]
Unknown
Number
String
Date
Checkbox
Dropdownbox
DropdownListbox
Filelink
Folder
Password
Certificate

[Scope]
Device Covers endpoints of type WindowsEndpoint and MacEndpoint
MobileDevice Covers endpoints of type Android, WindowsPhone and iOSEndpoint
Job Covers jobs of type WindowsJob
OrgUnit Covers org units in node Logical Groups only
Software Covers software (applications) for Windows clients only
Hardwareprofile Covers hardware profiles
AdObject Covers Active Directory users and groups
Bulletin Covers patch bulletins
Component Covers hardware components

www.baramundi.com Page 115/120

 Reference | baramundi Connect

7.27 KioskJob
Property Data type Access Description
Id long R/D Unique ID of the job release
AssignedObjectId String R/C Unique Id of endpoint, group or user
AssignedObjectName String R Name of endpoint, group or user
AssignedObjectType String R Types:
WindowsEndpoint
MacEndpoint
IOSEndpoint
AndroidEndpoint
WP8Endpoint
LegacyGroup (Logical Group)
ADObject (User or AD-Group)
JobDefinitionId String R/C Unique Id of the released job
JobDefinitionName String R Name of the released job
JobDefinitionDisplayName String R (Kiosk) Display name of the released
job
JobDefinitionCategory String R Category of the released job
JobDefinitionSupportedPlatforms List of Strings R Supported device platforms of the
released job

7.28 EndpointSecrets
Property Data type Access Description
EndpointId String R Unique ID of the endpoint
Pin String R/P BitLocker unlock pin
VolumeSecretEntries List of R Volume secrets
<VolumeSecretEntry>

7.28.1 VolumeSecretEntry
Property Data type Access Description
VolumeId String R Unique ID of the volume
VolumeName String R Name of the volume
IsSystemVolume Bool R Operation system on volume
GeneratedRecoveryKey String R Generated recovery key sent to
endpoint
InventoryRecoveryKey String R Inventoried recovery key
InventoryTimestamp DateTime R Last inventory time

7.29 EnrollmentData
Property Data type Access Description
EndpointId String R Unique ID of the endpoint
InstallCommand String R Specific install command for the given
endpoint
ValidUntil String R Timestamp until the enrollment data is
valid

www.baramundi.com Page 116/120

 Reference | baramundi Connect

7.30 ServerState
Property Data type Access Description
Name String R Name of the baramundi server
ExecutionState ExecutionState R The current execution state of the
baramundi server (see below)
Services List of ServiceState R The states of the sub services of the
server

[ExecutionState]

0 Unknown
1 Stopped
2 StoppedNotConfigured
3 Starting
4 Running
5 RunningNotConfigured
6 MaintenanceMode
7 Warning
8 Stopping
9 RestartRequired
10 NotLicensed

7.30.1 ServiceState
Property Data type Access Description
Name String R Name of the service (The name of the
service may change in future
releases.)
ExecutionState ExecutionState R The current execution state of the
service (see above)
StateText List of String R The current state text of the service

7.31 VPPUser
Property Data type Access Description
Id String R Unique ID of the VPP user
Email String R/C The email address of the VPP user
ManagedAppleId String R/C The managed Apple ID of the VPP
user
ItunesStoreHash String R The hash of the user's iTunes Store ID
InviteUrl String R The URL for VPP users to complete
the registration process
Status String R Status of a VPP user (see coding
below)
UserId String R An Id assigned by Apple upon user
registration
IsManagedAppleId Bool R/C True, if the VPP user is associated
with a managed Apple Id
ADObjectId String R The Id of the AD-User, if an AD-User
has been attached to the VPP user

www.baramundi.com Page 117/120

 Reference | baramundi Connect

EmailLanguageId String R/C/U The Identifier of the email template,

which will be used for the email
enrollment message sent to the
Reciepient email. Default available
templates are “de-DE” and “en-US”.

Property can only be updated if

IsManagedAppleId is false.

Codings:

[Status]
Registered
Associated
Retired
Deleted

7.32 VPPLicenseAssociation
Property Data type Access Description
Id String R Unique ID of the VPP license
association
ClientUserIdStr String R/C The unique ID of the associated VPP
user
LicenseIdStr String R The identifier of the assigned license
BmsNetEndpoint String R The unique ID of the associated
Mobile Endpoint
SerialNumber String R The serial number of the associated
Mobile Endpoint
AdamId String R The unique identifier for a product in
the iTunes Store
ShouldBeDisassociated Bool R True, if the VPP license is marked for
disassociation, otherwise False
BundleId String R/C The unique bundle ID of the
associated app

7.33 MicrosoftUpdateInventories
Property Data type Access Description
Endpoints List of R Inventoried Microsoft
MicrosoftUpdateEndpointInventory updates of Windows
endpoints

7.34 MicrosoftUpdateEndpointInventory
Property Data type Access Description
EndpointID String R Unique ID of the
Windows endpoint
UpdateInformation List of R Inventoried
MicrosoftUpdateInventoryInformation Microsoft updates
of the Windows
endpoint

www.baramundi.com Page 118/120

 Reference | baramundi Connect

7.35 MicrosoftUpdateInventoryInformation
Property Data type Access Description
IsInstalled Bool R Indicates whether the update is
installed or not
UpdateId String R Revision-independent identifier of the
update
RevisionNumber String R Revision number of the update
Classification String R Classification of the update
Products List of String R Collection of the product names that
are associated with the update
Title String R Title of the update
Type String R Specifies the update type (see below)
SupportURL String R Hyperlink to the support information
for the update
LastDeploymentChangeTime String R Last published date of the update on
the server that deploys the update (in
UTC)
MsrcSeverity String R Microsoft Security Response Center
severity rating of the update.
Is null when not set.
KBArticleIDs List of String R Collection of Microsoft Knowledge
Base article IDs that are associated
with the update
MoreInfoUrls List of String R Collection of hyperlinks to more
information about the update
SecurityBulletinIDs List of String R Collection of the security bulletin IDs
that are associated with the update
CveIDs List of String R Collection of common vulnerabilities
and exposures (CVE) IDs that are
associated with the update
Description String R Description of the update

[Type]
Software
Driver

[MsrcSeverity]
Low,
Medium,
High,
Critical

www.baramundi.com Page 119/120

 Reference | baramundi Connect

www.baramundi.com Page 120/120