Application Settings

Get all Application Settings

This API returns the list of all application settings across all devices in the MobileIron system.

Example:

https://mycore.mobileiron.com/api/v1/appsettings

URI:
https://{host-name}/api/v1/appsettings

Returns list of all appsettings.

Http Method:

GET

Format:

xml, json

 

 

Response Status Code:

 

‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Request:

 

type

This will allow the user to filter the Application settings by type.

Application settings types -
EXCHANGE, WIFI, BOOKMARK, EMAIL, VPN, GENERAL, CALDAV, SUBCAL, WEBCLIP, SCEP, APN, RESTRICTION, CERTIFICATE, MDM, PROVISIONING, CARDDAV, CONFIGURATION, OTHER

 

Note: SCEP is the type used for all Certificate Enrollment settings.

Response:

 

<appSettingsWebServiceResponse>

 

    <messages>

 

        <message> 1 application settting(s) returned.</message>

Status Message.

Appsettings count is shown if the method execution is successful.

A descriptive error message is shown if the method execution failed.

    </messages>

 

<appsettings>

 

        <appsetting id="-4">

 

                <name> System - iOS MDM CA Certificate</name>

Application setting name.

                <description>This CA Certificate is distributed in conjunction with the system MDM profile. It is the certificate that the mobile device will trust for the purpose of accepting OTA MDM requests.</description>

Description.

                <appType>CERTIFICATE</appType>

Application type

                <deviceCount>2</deviceCount>

Number of devices for which the app setting is applied.

                <pendingCount>1</pendingCount>

Number of devices for which the app setting is pending.

                <quarantinedCount>0</quarantinedCount>

The number of devices that have had the corresponding configuration (i.e., profile) removed due to policy violations.

                <type>SYSTEM</type>

System or Admin generated.

<clearCertificateCacheForSCEPSetting>false</clearCertificateCacheForSCEPSetting>

Not currently used.

                 <labels>-4</labels>

The ID of a label to which this app setting is assigned. This entry appears once for each label to which the app setting is assigned.

                  <labelNames>iOS</labelNames>

The displayed name of a label to which this app setting is assigned. This entry appears once for each label to which the app setting is assigned.

                <properties>

Configuration properties for the appsetting

                    <entry>

 

                      <key>CERT_SERIAL_NUMBER0</key>

 

                      <value>10863527040561121251</value>

 

                    </entry>

 

                      <entry>

 

                          <key>CERTPATH0</key>

 

                          <value>/mi/files/groups/9002/99415d0e64ca8708/b34aab3122e3410e98a2ef5a078806ce</value>

 

                    </entry>

 

                    <entry>

 

                        <key>ENABLE_MIRRORING</key>

This setting is to disable or enable iOS mirroring.

                        <value>false</value>

 

                    </entry>

 

                    <entry>

 

                        <key>SUPPORT_MULTIPLE_CONSUMERS</key>

This setting is a property pertaining to SCEP settings. It indicates if the SCEP setting is being consumed by multiple app settings, for example, like Exchange and vpn.

    If CACHE_KEYS=TRUE, SUPPORT_MULTIPLE_CONSUMERS is usually FALSE/NULL (both will work)
    If CACHE_KEYS=FALSE, SUPPORT_MULTIPLE_CONSUMERS is FALSE if it is being consumed by only one app setting, and TRUE if it is being consumed by multiple apps.

                        <value>false</value>

 

                    </entry>

 

                    ….

Can have multiple entries.

                </properties>

 

        </appsetting>

 

    </appsettings>

 

</appSettingsWebServiceResponse>

 

Get Application Settings by Device UUID

This API returns the list of all application settings for a given device uuid in the MobileIron system.

Example:

https://mycore.mobileiron.com/api/v1/appsettings/devices/12849438-0d74-3c30-6b7d-121a3da8645d

URI:
https://{host-name}/api/v1/appsettings/devices/{deviceuuid}

Returns list of all appsettings by device uuid.

Http Method:

GET

Format:

xml, json

 

 

Response Status Code:

 

‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:

 

<appSettingsWebServiceResponse>

 

    <messages>

 

        <message> 1 application settting(s) returned.</message>

Status Message.

Appsettings count is shown if the method execution is successful.

A descriptive error message is shown if the method execution failed.

    </messages>

 

<appsettings>

 

        <appsetting id="-4">

 

                <name> System - iOS MDM CA Certificate</name>

Application setting name.

                <description>This CA Certificate is distributed in conjunction with the system MDM profile. It is the certificate that the mobile device will trust for the purpose of accepting OTA MDM requests.</description>

Description.

                <appType>CERTIFICATE</appType>

Application type

                <deviceCount>0</deviceCount>

This field is not applicable for this request.

                <pendingCount>0</pendingCount>

This field is not applicable for this request.

                <type>SYSTEM</type>

System or Admin generated.

                <state>67</state>

67 = ASCII "C" = Current

68 = ASCII "D" = Deleted

<clearCertificateCacheForSCEPSetting>false</clearCertificateCacheForSCEPSetting>

 

                <properties>

Configuration properties for the appsetting

                    <entry>

 

                      <key>CERT_SERIAL_NUMBER0</key>

 

                      <value>10863527040561121251</value>

 

                    </entry>

 

                      <entry>

 

                          <key>CERTPATH0</key>

 

                          <value>/mi/files/groups/9002/99415d0e64ca8708/b34aab3122e3410e98a2ef5a078806ce</value>

 

                    </entry>

 

                    ….

Can have mulitiple entires.

                </properties>

 

        </appsetting>

 

    </appsettings>

 

</appSettingsWebServiceResponse>