Apple VPP Account Resource

Provides Apple VPP account management functions.

GET /{tenantGuid}/api/v1/vppAccounts

Available Since:
12.18.0

Get details of Apple VPP accounts from a query.

Samples

Sample 1 request

Get all Apple VPP accounts with the name of VPP-token-version-3. 

 GET /SRP00000/api/v1/vppAccounts?query=name=VPP-token-version-3

Sample response 1 body

 
 {
    "vppAccounts": [
     {
       "guid": "17c24f36-b724-4591-9624-e76bb197b466",
       "name": "VPP-token-version-3",
       "accountHolderInfo": "Company Acme, Montreal office, Canada",
       "tokenExpiryDate": "2028-04-20T04:04:00.000Z",
       "autoUpdateNewAppVersions": true,
       "token": "57b32e41506964c8b65221e7406a49252b4016802db6a54"
    },
    {
       "guid": "2cdb56be-ef5a-4755-8db5-feb97ec0dcc5",
       "name": "VPP-token-version-3",
       "accountHolderInfo": "For Beta testing only",
       "tokenExpiryDate": "2025-04-20T04:04:00.000Z",
       "autoUpdateNewAppVersions": false,
       "token": "403b58509153af825a1754892706c2603829b3743d8331"
    }
    ]
 }

Sample 2 request

Get all Apple VPP accounts with an expiry date before Jan 1, 2027 00:00:00. 

 GET /SRP00000/api/v1/vppAccounts?query=tokenExpiryDate<=2027-01-01T00:00:00.000Z

Sample response 2 body

 
 {
    "vppAccounts": [
     {
       "guid": "2cdb56be-ef5a-4755-8db5-feb97ec0dcc5",
       "name": "VPP-token-version-3",
       "accountHolderInfo": "Company Acme, Toronto office, Canada",
       "tokenExpiryDate": "2026-04-20T04:04:00.000Z",
       "autoUpdateNewAppVersions": false,
       "token": "383b585039836f829904948327717fa0382922873c4384"
    },
    {
       "guid": "6359d1fc-6b8b-4920-ae0e-9c8405cb08b5",
       "name": "Beta 6 Test",
       "accountHolderInfo": "For Beta testing only",
       "tokenExpiryDate": "2025-04-20T04:04:00.000Z",
       "autoUpdateNewAppVersions": false,
       "token": "403b58509153af825a1754892706c2603829b3743d8331"
    }
    ]
 }

Sample 3 request

Get all Apple VPP accounts with the name VPP-token-version-3 and an expiry date before Jan 1, 2027 00:00:00 and after Jan 1, 2026 00:00:00. 

 GET /SRP00000/api/v1/vppAccounts?query=name=VPP-token-version-3,tokenExpiryDate<2027-01-01T00:00:00.000Z,tokenExpiryDate>=2026-01-01T00:00:00.000Z

Sample response 3 body

 
 {
    "vppAccounts": [
     {
       "guid": "2cdb56be-ef5a-4755-8db5-feb97ec0dcc5",
       "name": "VPP-token-version-3",
       "accountHolderInfo": "Company Acme, Toronto office, Canada",
       "tokenExpiryDate": "2026-04-20T04:04:00.000Z",
       "autoUpdateNewAppVersions": false,
       "token": "383b585039836f829904948327717fa0382922873c4384"
    }
    ]
 }

Sample 4 request

Get all Apple VPP accounts with an expiry date before Jan 1, 2015 00:00:00. 

 GET /SRP00000/api/v1/vppAccounts?query=tokenExpiryDate<=2015-01-01T00:00:00.000Z

Sample response 4 body

 
 {
    "vppAccounts": [
    ]
 }

Request Parameters
Name Location Description
query query Query parameter for filtering the results. The format is <field name>=<query value>, for example name=VPP-token-version-3. Multiple field-value pairs can be provided in the query with each pair separated with a comma, in which case only Apple VPP accounts matching all the criteria provided will be included in the response. Querying for empty/null values is not supported.

By default, a case-insensitive exact match will be performed for each field in the query.

Special characters (comma, backslash) in query values must be escaped with a backslash.

The following table describes the fields that can be used in the query.

> or >= for the minimum date, and/or < or <= for the maximum date. For example: tokenExpiryDate>=2021-07-01T00:00:00.000Z,tokenExpiryDate<2021-07-31T00:00:00.000Z
Field Type Description
name string The name of the Apple VPP account.
tokenExpiryDate string The Apple VPP account token expiry date.
Response Codes
Code Condition Data type
200 OK.
Response Body
Media type Data type Description
application/vnd.blackberry.vppaccounts-v1+json Apple VPP account (JSON)

GET /{tenantGuid}/api/v1/vppAccounts/{vppAccountGuid}

Available Since:
12.18.0

Get details of an Apple VPP account by GUID.

Sample request

Get the Apple VPP account with the guid of 6359d1fc-6b8b-4920-ae0e-9c8405cb08b5. 

 GET /SRP00000/api/v1/vppAccounts/6359d1fc-6b8b-4920-ae0e-9c8405cb08b5

Sample response body

 
 {
    "guid": "6359d1fc-6b8b-4920-ae0e-9c8405cb08b5",
    "name": "VPP-token-version-3",
    "accountHolderInfo": "Company Acme, Toronto office, Canada",
    "tokenExpiryDate": "2026-04-20T04:04:00.000Z",
    "autoUpdateNewAppVersions": true,
    "token": "383b585039836f829904948327717fa0382922873c4384"
 }

Request Parameters
Name Location Description
vppAccountGuid path GUID of the Apple VPP account to get
Response Codes
Code Condition Data type
200 OK.
404 Apple VPP account not found
Response Body
Media type Data type Description
application/vnd.blackberry.vppaccount-v1+json Apple VPP account (JSON)