Apple Licenses Management

Get details about all Apple Licenses accounts

This call gets details about all Apple Licenses accounts. If there are more than 50 Apple Licenses accounts, the system paginates the response.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/accounts

Response fields

Field

Description

hasMore

 

resultCount

 

results

 

    appleId

 

    description

 

    encryptedToken

 

    expireDateString

 

    id

 

    lastSyncedAt

 

    licenseSinceToken

 

    licenseSyncStatus

 

    name

 

    numDaysToExpire

 

    pendingDelete

 

    priority

 

    sTokenModifiedDate

 

    stoken

 

    userSinceToken

 

    userSyncStatus

 

totalCount

 

Sample request

curl -X GET \

  https://[Ivanti EPMM]/msa/v2/vpp/accounts \

  -H 'authorization: Basic AAAAG1pbjpNaTRtYW4xMQ==' \

Sample response

{

    "totalCount": 1,

    "resultCount": 1,

    "hasMore": false,

    "results": [

        {

            "id": 1,

            "name": "blue4",

            "description": "",

            "appleId": "",

            "sTokenModifiedDate": "2017-10-25",

            "licenseSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTA0tjA2NTAxNDIxFqhFgBO79RGgQAAAA==",

            "userSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTA0tjA2NTAxMjc3FqhFgB+vRUagQAAAA==",

            "lastSyncedAt": 1509303504000,

            "priority": 1,

            "userSyncStatus": true,

            "licenseSyncStatus": true,

            "stoken": "eyJleHBEYXRlIjoiMjAxOC0wOS0xNFQxNTozMToyOC0wNzAwIiwidG9rZW4iOiJhUXMrSnUvT2FJd2NKWjZ4akRDZ0pFQVd6UkZPWnovMk1rM3A5bHhmaXdoNmxDdTlSNDd4Zk9VZ2dXWnpPUzFUaVhmRThsSzMrd21VUVRWQTV2R2ROZnl6N3BRWURvY3RISmU2a0NLZWhvVT0iLCJvcmdOYW1lIjoiTW9iaWxlSXJvbiJ9",

            "encryptedToken": "V2DAtJ1y+hzMvsn5gosgeHvFPMBMHghkA8+/hbFokoH5JTh8oAoOAdHWkwn6LjCsG9Wca6gLa+h8mUZQiNN62bu+b+rLL6tadjy6ZZ4Xa9WlxbHgIXApC+6b59LIs/hhBdFjx2ysq8RkLtdqFTo7tIeu2kUIJaQEc/uWSZfWvSfSlZMeJqqhmLUY7KsPVXjJYQgSclwiO+6K9UhL0aJCbjRh9dkHysvhD6vt9b3ur30AcBtI+R3+lVjgydy0HGtNWvRMqv/wfOX2MtGJviG9v0uFl9nABjQGdBL72T/DmOtfaTygyLZfso6cShU2FWtGRUxtsQ+ZTVSUtSFk2im/2PnLM9nrBEDu1d44h+dqs=",

            "expireDateString": "September 14 2018",

            "pendingDelete": false,

            "numDaysToExpire": 320

        }

    ]

}

Get all Apple Licenses accounts

This call gets information about all Apple Licenses accounts, unpaginated.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/accounts/all

Response fields

Field

Description

results

 

        id

 

        name

 

        description

 

        appleId

 

        sTokenModifiedDate

 

        licenseSinceToken

 

        userSinceToken

 

        lastSyncedAt

 

        priority

 

        userSyncStatus

 

        licenseSyncStatus

 

        adminDeviceSpaceId

 

        deviceSpaceName

 

        deviceSpacePath

 

        expireDateString

 

        stoken

 

        numDaysToExpire

 

        encryptedToken

 

        pendingDelete

 

totalCount

 

resultCount

 

Sample request

curl -X GET \

  https://[Ivanti EPMM]/msa/v2/vpp/accounts/all \

  -H 'Authorization: Basic aaahZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": [

        {

            "id": 1,

            "name": "blue2",

            "description": "",

            "appleId": "",

            "sTokenModifiedDate": "2018-03-07",

            "licenseSinceToken": "H4sIAAAAAAAAAKtWKKksSFWwVVAqzsxLTvXNT8lMy0xNUbJWUMhMg/GCwVKZOTmZxUCVhqZGBiYm5gYWQMLcWqEWAMa806BDAAAA",

            "userSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTE3NDY1NTYwlqhFgA5krZ0gQAAAA==",

            "lastSyncedAt": 1520447135000,

            "priority": 1,

            "userSyncStatus": true,

            "licenseSyncStatus": true,

            "adminDeviceSpaceId": 1,

            "deviceSpaceName": "Global",

            "deviceSpacePath": "/1/",

            "expireDateString": "March 07 2019",

            "stoken": "eyJleHBEYXRlIjoiMjAxOS0wMy0wN1QxMDoxNjo0NC0wODAwIiwidG9rZW4iOiJtMXZEYTViZkltZHp1VER1WTU2TFE2RDhaSWtxTS9JbmQ0ZEdNU1Q4aFZQU3c1YmxST2JCVlhHTzdoczZmTElWZlo2c0JxTDY1WXdSVHNEZDNuZDBza3NzQlk4SGNIU1FNSTNLVFlhQUxtRT0iLCJvcmdOYW1lIjoiTW9iaWxlSXJvbiJ9",

            "numDaysToExpire": 364,

            "encryptedToken": "V2DFgLCX40+25VSLrtLll+pm4xlIoeCFa0XRgL+2aD/lKcx8Iq1kPRJHIsNtjoi0URflwjkqdwcxGeUHotL9YUF/UVA7uSgfnBeWDt+TYQAS2wEDOTMN51sl+zBUz5G4mW+xI1CoWzBm+SLzgOop5M7mXJ9e7A6PGU0w+YTTZ3+YN6K2bd0x9rkM3ofQKbVqycre0J5hLWpH00PgZv2vri9isbIZVaBLOdNrNJEtn6iQbAKpERaSjZ2X67gwkOgwGLkoF9wt3DA4mFGmVBZgFafpeNXizI6A3IMDZtNzyYVxHkCasaoWl5Gu85x/RQx0GaCGpCmL7XkvH7766pg43hyYS3yV/OKr53uck1kdU=",

            "pendingDelete": false

        },

        {

            "id": 2,

            "name": "blue4",

            "description": "",

            "appleId": "",

            "sTokenModifiedDate": "2018-03-07",

            "licenseSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTE3NDY1NQYqK4WANa6ArGBAAAA",

            "userSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTE3NDY1NTMwlqhFgBJHVa8gQAAAA==",

            "lastSyncedAt": 1520447135000,

            "priority": 2,

            "userSyncStatus": true,

            "licenseSyncStatus": true,

            "adminDeviceSpaceId": 1,

            "deviceSpaceName": "Global",

            "deviceSpacePath": "/1/",

            "expireDateString": "March 07 2019",

            "stoken": "eyJleHBEYXRlIjoiMjAxOS0wMy0wN1QxMDoxNzowNC0wODAwIiwidG9rZW4iOiJzZFdEQ1pYbTJHa3dMSEdKRXJkZENvWm11ZzloOGFBTnN2OFlJdTQxWmg3VlAxdUZpSHJKRW1LWGZaY0h3b1FKamN3ZUdMZjJiQysvYXRBaU5QaUFpMzNSWTNMRlVJNFFSNkFldEFVeDh5MD0iLCJvcmdOYW1lIjoiTW9iaWxlSXJvbiJ9",

            "numDaysToExpire": 364,

            "encryptedToken": "V2DJvIUXcIQxzVnFl7+8eCa6xTA35j3obOvusY28+eBgBPo1ADPcyWdctCOxjP8BS1X7sOBuO/W5MHTf0R2aSWDxZyRPKiLTZp2ERR+7Z5Zq+baV/p132wV65ppvKg94EIlf/xk//M8asBtGifmUZksa3dUvOGuWSCQ8ZZwnKsU8JiK8lP6UTiEjyDAVgt27VzEIsYRuX/p0iZwQwqHsF0Qa/Wh5hEHLFjQaPMgjfAP8jwxXvIU1gM8gm2gsmZxXoj/7f5Zkaw4Y14DBTLGgsB08jZ0gTc5Dtl+R211qXkg1baJ6OxtEnh4fQWcbOQaeJAieoJfA/BpvTE5Tby5TFZpF/wJDaHkRsDhYh6hxE=",

            "pendingDelete": false

        }

    ],

    "totalCount": 2,

    "resultCount": 2

}

Get details about specific Apple Licenses account

This call gets information about a specific Apple Licenses accounts.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/accounts/{id}

Request parameters

Parameter

Description

Sample Value

id

Required

Parameter Type: Query

Data Type: Number

ID of the Apple Licenses account.

1

Response fields

Field

Description

results

 

        id

 

        name

 

        description

 

        appleId

 

        sTokenModifiedDate

 

        licenseSinceToken

 

        userSinceToken

 

        lastSyncedAt

 

        priority

 

        userSyncStatus

 

        licenseSyncStatus

 

        adminDeviceSpaceId

 

        deviceSpaceName

 

        deviceSpacePath

 

        expireDateString

 

        stoken

 

        numDaysToExpire

 

        encryptedToken

 

        pendingDelete

 

Sample request

curl -X GET \

  https://[Ivanti EPMM]/msa/v2/vpp/accounts/1 \

  -H 'Authorization: Basic aaahZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": {

        "id": 1,

        "name": "blue2",

        "description": "",

        "appleId": "",

        "sTokenModifiedDate": "2018-03-07",

        "licenseSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTEwsDY1MzQ3FqhFgBv7PE2gQAAAA==",

        "userSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTEwsDY1MzMyFqhFgBNwA+zgQAAAA==",

        "lastSyncedAt": 1520448035000,

        "priority": 1,

        "userSyncStatus": true,

        "licenseSyncStatus": true,

        "adminDeviceSpaceId": 1,

        "deviceSpaceName": "Global",

        "deviceSpacePath": "/1/",

        "expireDateString": "March 07 2019",

        "stoken": "eyJleHBEYXRlIjoiMjAxOS0wMy0wN1QxMDoxNjo0NC0wODAwIiwidG9rZW4iOiJtMXZEYTViZkltZHp1VER1WTU2TFE2RDhaSWtxTS9JbmQ0ZEdNU1Q4aFZQU3c1YmxST2JCVlhHTzdoczZmTElWZlo2c0JxTDY1WXdSVHNEZDNuZDBza3NzQlk4SGNIU1FNSTNLVFlhQUxtRT0iLCJvcmdOYW1lIjoiTW9iaWxlSXJvbiJ9",

        "numDaysToExpire": 364,

        "encryptedToken": "V2DPNTJs5g/xs9fGfdNPW7Oukg84d7DT6uUb9Q/8c+52WrunoICEel/JuVxVuFOxVvfc0oUB/FhcF4D17GOh7HMGgzxbcYsIIi/TIadEUpJp9CQZQ7kGU6G9fwLK2h7ndtwA+Z9qQmR93GR1PV8N8ydhKQgwy6c+rQYmfu5/+bsO2t38D6nYtUgEYkV+f24BppiP5Op9PCteDYZOCpmoyacHSeNnfFoLVFqx2n0pzDJ4ajEONETDLle2727vdwOs7XgDdhGYxj0qR9EPjepTfCx0hLva9BGq+xbm0ygZihEvayDvTNwAP6eQL7qkV0v+SMZXA41Zgs18WCV6YevSkmBJQ5oUI7OEFuXoubsr8=",

        "pendingDelete": false

    }

}

Get all licenses for a specific Apple Licenses account

This call retrieves information about a specific Apple Licenses account.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/accounts/{accountId}/licenses

Request parameters

Parameter

Description

Sample Value

accountId

Required

Parameter Type: Query

Data Type: Number

Target Apple Licenses account ID for which to get license information.

1

Response fields

Field

Description

results

 

    name

 

    version

 

    totalCount

 

    usedCount

 

    adamId

 

    canImport

 

    platformType

 

    imported

 

totalCount

 

resultCount

 

Sample request

curl -X GET \

  https://[Ivanti EPMM]/msa/v2/vpp/accounts/1/licenses \

  -H 'authorization: Basic AAAAZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": [

        {

            "name": "Quick Note",

            "version": null,

            "totalCount": 2,

            "usedCount": 0,

            "adamId": 414848186,

            "canImport": true,

            "platformType": "L",

            "imported": true

        },

        {

            "name": "Twitter",

            "version": "7.10",

            "totalCount": 11,

            "usedCount": 0,

            "adamId": 333903271,

            "canImport": true,

            "platformType": "I",

            "imported": false

        },

       ...

    ],

    "totalCount": 38,

    "resultCount": 38

}

Start a Apple Licenses license full sync for Apple Licenses Account

This call initiates a full sync of the target Apple Licenses account.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

POST

Request URI

msa/v2/vpp/accounts/{accountId}/fullsync

Request parameters

Parameter

Description

Sample Value

accountId

Required

Parameter Type: Query

Data Type: Number

Target Apple Licenses account ID for which to sync licenses.

 

Response fields

Field

Description

results

 

Sample request

curl -X POST \

  https://[Ivanti EPMM]/msa/v2/vpp/accounts/1/fullsync \

  -H 'authorization: Basic ssssZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": 0

}

Add an Apple license account

This call adds an Apple license account.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

POST

Request URI

msa/v2/vpp/accounts

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

description

Parameter Type:Body

Data Type: String

License description.

 

name

Parameter Type:Body

Data Type: String

Device space ID of the administrator.

 

sToken

Parameter Type:Body

Data Type: String

sToken value.

 

Response fields

Field

Description

results

 

Sample request

$ curl --location --request POST 'https://<Ivanti EPMM>/msa/v2/vpp/accounts?adminDeviceSpaceId=1' \ > --header 'Authorization: Basic xxxxxZG1pbjpjRzhKcDdWUA==' \ > --header 'Content-Type: application/json' \ > --data-raw '{ > "name": "vivTest1", > "sToken": "eyJleHBEYXRlIjoiMjAyMy0xMS0wN1QyMjowNDoxOCswMDAwIiwidG9rZW4iOiJyS1J6a1BBNUJHcmZnWnRkTTJzbGh1M0JOVTdlYVNKY2FyNU5uTHVYbi9BRmtpK1JwaWRIR3oyT0c5YnRBOEJRaXJYSU1yTDZmQm5TNThRd3BTNXNRaldua1JNci9BdW5vNGkxZXhaSnBDeFp3S1k5cEVFcXJOT3lZWCtLcjlFL3FLR3JSU1JQbFZMUVdkNTBFT0o3M0dCMjUvZnVJQWM1NXRHb1ljdE5acmk5elptUWhPV210c0tTSm5hR0xTamgiLCJvcmdOYW1lIjoiTU9CSUxFSVJPTiwgSU5DLiJ9", > "description":"test" > }'

Sample response

Returns ID of new VPP account.

Delete an Apple license account

This call deletes an Apple license account.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

DELETE

Request URI

msa/v2/vpp/accounts/{accountId}

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

accountId Parameter Type:Path

Data Type: String

Apple ID for which to delete the license.

 

Response fields

Field

Description

results

 

Add a Apple Licenses label to an app

This call applies a Apple Licenses label to an app.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

PUT

Request URI

msa/v2/vpp/apps/labels

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

catalogId

Required

Parameter Type: Request body

Data Type: Long

Catalog ID of the app to apply to a label.

119

vppAccountId

Required

Parameter Type: Request body

Data Type: Integer

ID of the target Apple Licenses account.

1

labelIds

Required

Parameter Type: Request body

Data Type: array[Long]

ID of the label or labels to which to apply the app.

-6

Response fields

Field

Description

{}

 

Sample request

curl -X PUT \

  'https://eapp297.auto.mobileiron.com/msa/v2/vpp/apps/labels?adminDeviceSpaceId=1' \

  -H 'accept: application/json' \

  -H 'authorization: Basic 5555G1pbjpZbDNNczB0dg==' \

  -H 'content-type: application/json' \

  -d '{"catalogId":119,"vppAccountId":1,"labelIds":[-6]}'

Sample response

{}

Remove a Apple Licenses label from an app

This call removes a Apple Licenses label from an app.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

DELETE

Request URI

msa/v2/vpp/apps/labels

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

catalogId

Required

Parameter Type: Request body

Data Type: Number

Catalog ID of the app to delete from a label.

119

vppAccountId

Required

Parameter Type: Request body

Data Type: Number

ID of the target Apple Licenses account.

1

labelIds

Required

Parameter Type: Request body

Data Type: Number

ID of the label or labels from which to delete the app.

-6

Response fields

Field

Description

{}

 

Sample request

curl -X DELETE \

  'https://[Ivanti EPMM]/msa/v2/vpp/apps/labels?adminDeviceSpaceId=1' \

  -H 'accept: application/json' \

  -H 'authorization: Basic 5555ZG1pbjpZbDNNczB0dg==' \

  -H 'content-type: application/json' \

  -d '{"catalogId":119,"vppAccountId":1,"labelIds":[-6]}'

Sample response

{}

Get Apple Licenses account summary for specific app

This call gets a combined summary of Apple Licenses Details with all accounts for a specific App, including cumulative license counts.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/apps/{catalogId}/summary

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

catalogId

Required

Parameter Type: Request body

Data Type: Number

Catalog ID of the app.

121

Response fields

Field

Description

results

 

    numDeviceLicenses

 

    numUserLicenses

 

    numVPPAccounts

 

    numAvailableLicenses

 

    numUsedLicenses

 

    numTotalLicenses

 

    catalogId

 

    iconFile

 

        fileName

 

        uuid

 

        url

 

    appIcon

 

    appName

 

Sample request

curl -X GET \

  'https://[Ivanti EPMM]/msa/v2/vpp/apps/121/summary?adminDeviceSpaceId=1' \

  -H 'Accept: application/json' \

  -H 'Authorization: Basic aaaaZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": {

        "numDeviceLicenses": 0,

        "numUserLicenses": 0,

        "numVPPAccounts": 1,

        "numAvailableLicenses": 5,

        "numUsedLicenses": 0,

        "numTotalLicenses": 5,

        "catalogId": 121,

        "iconFile": {

            "fileName": "logo.png",

            "uuid": "d31ae54a-2af8-43e5-8249-5a9745b96193",

            "url": "/mifs/image/app.html?command=getAppArtifact&action=getAppArtifact&appid=121&uuid=d31ae54a-2af8-43e5-8249-5a9745b96193&ext=PNG"

        },

        "appIcon": null,

        "appName": "IKEA Catalog"

    }

}

Get list of Apple Licenses accounts available for specific app

This call gets the list of Apple Licenses Accounts available for the specific app.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/apps/{catalogId}/vppaccounts

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

catalogId

Required

Parameter Type: Request body

Data Type: Number

Catalog ID of the app.

121

Response fields

 

Field

Description

results

 

        id

 

        name

 

        description

 

        appleId

 

        sTokenModifiedDate

 

        licenseSinceToken

 

        userSinceToken

 

        lastSyncedAt

 

        priority

 

        userSyncStatus

 

        licenseSyncStatus

 

        adminDeviceSpaceId

 

        deviceSpaceName

 

        deviceSpacePath

 

        expireDateString

 

        stoken

 

        numDaysToExpire

 

        encryptedToken

 

        pendingDelete

 

totalCount

 

resultCount

 

Sample request

curl -X GET \

  'https://[Ivanti EPMM]/msa/v2/vpp/apps/121/vppaccounts?adminDeviceSpaceId=1' \

  -H 'Accept: application/json' \

  -H 'Authorization: Basic aaaaZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": [

        {

            "id": 1,

            "name": "blue2",

            "description": "",

            "appleId": "",

            "sTokenModifiedDate": "2018-03-07",

            "licenseSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTU2MTMwszSzFqhFgBU2ojzgQAAAA==",

            "userSinceToken": "H4sIAAAAAAAAAKtWMFCwVdBQUNC0VlAoyS9JzHFKLEnOSC12yy/NS3EGEiVAeQOQZGVBKpCpVJyZl5zqm5+SmZaZmqKEogtZeWYaTE0wWENmTk5mMVDO0NTIwMTU2MTMwtzU2FqhFgDCFPrKgQAAAA==",

            "lastSyncedAt": 1520453468000,

            "priority": 1,

            "userSyncStatus": true,

            "licenseSyncStatus": true,

            "adminDeviceSpaceId": 1,

            "deviceSpaceName": "",

            "deviceSpacePath": "",

            "expireDateString": "March 07 2019",

            "stoken": "eyJleHBEYXRlIjoiMjAxOS0wMy0wN1QxMDoxNjo0NC0wODAwIiwidG9rZW4iOiJtMXZEYTViZkltZHp1VER1WTU2TFE2RDhaSWtxTS9JbmQ0ZEdNU1Q4aFZQU3c1YmxST2JCVlhHTzdoczZmTElWZlo2c0JxTDY1WXdSVHNEZDNuZDBza3NzQlk4SGNIU1FNSTNLVFlhQUxtRT0iLCJvcmdOYW1lIjoiTW9iaWxlSXJvbiJ9",

            "numDaysToExpire": 364,

            "encryptedToken": "V2DMgs34fNkRL0R2NrM/i+PuhaAJQkhgJhf3fmiNA8Wj0+VPRqzphylyQnY0b7VgmuAdC3bUmI341XyMVl9h3nb/mNot77AP/ZWVZBXbxzqq+Yrey9X4AWtElmL7u17FQv3y6Y1f/eYRdFxMOe4OtaXyZgIdfLDXtf92D70nq7/zgwCit01xAP3dNtwB+hvDqtk8I2wTbvoY9b5hpe08YVicUMuS+igZkH4RAlNvkXZwYjamBx2ohILlqIvJp3dENpN3FXUATcxdrC2lypihSH3qKGlLpMnYhztLZ9bQcK/vhn3kP7iBfHd3QGaTHxjnNSfnW7vvlACef6B8i4tpPbtxBZZfqr9jnBPyCg1oc=",

            "pendingDelete": false

        }

    ],

    "totalCount": 1,

    "resultCount": 1

}

Get Apple Licenses labels available for specific app

This call gets the list of Apple Licenses Labels available for the specific app.

Required role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: App Management

Roles Description: Manage App Licenses

HTTP method

GET

Request URI

msa/v2/vpp/apps/{catalogId}/vpplabels

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

catalogId

Required

Parameter Type: Request body

Data Type: Number

Catalog ID of the app.

121

Response fields

Field

Description

results

 

        appCatalogId

 

        labelId

 

        labelName

 

        labelDescription

 

        vppAccountId

 

        vppAccountName

 

        appCatalogId

 

        labelId

 

        labelName

 

        labelDescription

 

        vppAccountId

 

        vppAccountName

 

totalCount

 

resultCount

 

Sample request

curl -X GET \

  'https://[Ivanti EPMM]/msa/v2/vpp/apps/121/vpplabels?adminDeviceSpaceId=1' \

  -H 'Accept: application/json' \

  -H 'Authorization: Basic aaaaZG1pbjpZbDNNczB0dg==' \

Sample response

{

    "results": [

        {

            "appCatalogId": 0,

            "labelId": -20,

            "labelName": "Signed-Out",

            "labelDescription": "Label for devices that are in a multi-user signed-out state.",

            "vppAccountId": null,

            "vppAccountName": null

        },

      ...

               ],

    "totalCount": 9,

    "resultCount": 9

}