1. Home
2. Resources
3. Licensing

Licensing Resource

Provides access to licensing information

  GET /SRP00000/api/v1/licensing
 

  
  {
    "organizationStatus" : {
      "orgId":"999000000"
      "overallComplianceStatus" : "VALID",
      "connectedToLicensingInfrastructure" : true,
      "groupLicensing" : false,
      "licensingInfrastructureLastContact" : "2017-01-01T11:04:30.45Z"
    },
    "messageOfTheDay" : {
      "contentType" : "text/html",
      "message" : "PGgyPk1lc3NhZ2UgZnJvbSBCbGFja0JlcnJ5PC9oMj4NCjxwPk5ldyBvZmZlcmluZyBmcm9tIEJsYWNrQmVycnkgc2VlIDogPGEgaHJlZj0iaHR0cDovL3d3dy5ibGFja2JlcnJ5LmNvbS8iPiBodHRwOi8vd3d3LmJsYWNrYmVycnkuY29tLyA8L2E+IDwvcD4="
    },
    "licensedServices" : [{
      "id" : "watchdox.blackberry.com",
      "name" : "BlackBerry Workspaces",
      "description" : "BlackBerry Workspaces",
      "inGracePeriod" : true,
      "gracePeriodDaysRemaining" : 15,
      "compliant" : true,
      "activatedFeatures" : [ "MDM_CONTROLS, enterprise.watchdox.blackberry.com", "..." ],
      "complianceStateDescription" : "In compliance",
      "complianceStateDescriptionDetails" : "This service is in compliance."
    }],
    "licensedUsage" : [{
      "id" : "gsc.license.blackberry.com",
      "name" : "BlackBerry Enterprise Mobility Suite - Content Edition",
      "totalServerLicenses" : 500,
      "availableServerLicenses" : 450,
      "usedServerLicenses" : 50,
      "usedSimLicenses" : 25,
      "totalLicensesInUse" : 75,
      "trial" : true,
      "trialDaysRemaining" : 15,
      "licenseInfo" : [{
        "type" : "TRIAL",
        "expirationDate" : "2019-05-30T11:04:30.45Z",
        "aboutToExpire" : true,
        "quantity" : 10,
        "statusType" : "WARNING",
        "statusDescription" : "10 trial licenses expire on 05/30/2019"
      }, {
        "type" : "SUBSCRIPTION",
        "aboutToExpire" : false,
        "quantity" : 50,
        "statusType" : "INFO",
        "statusDescription" : "50 Subscription licenses start on 06/01/2019 and end on 05/31/2020"
      }],
      "featureUsage" : [{
        "id" : "MDM_CONTROLS",
        "consumed" : 10
      }]
    }],
    "unlicensedUsage" : {
      "consumedTotal" : 10,
      "features" : [{
        "id" : "enterprise.watchdox.blackberry.com",
        "name" : "WatchDox Enterprise Edition",
        "description" : "WatchDox Enterprise Edition"
      }],
      "suggestedLicenses" : [{
        "id" : "gsc.license.blackberry.com",
        "name" : "BlackBerry Enterprise Mobility Suite - Content Edition",
        "description1" : "Activation types: Work and personal - Corporate...",
        "description2" : "Suite includes: UEM, secure browser..."
      }]
    }
  }
  
 

  GET /SRP00000/api/v1/licensing/groups
 

  
 {
     "organizationStatus": {
         "orgId":"999000000"
         "overallComplianceStatus": "VALID",
         "connectedToLicensingInfrastructure": true,
         "groupLicensing": true,
         "licensingInfrastructureLastContact": "2018-01-10T00:47:55.974Z"
     },
     "groupLicensing": {
         "unassignedLicenses": [
             {
                 "orderId": "HP_17:606",
                 "purchaseDetails": [
                     {
                         "sku": "EMS.MT.SOD.AD",
                         "description": "BlackBerry Enterprise Mobility Suites - Management Edition Monthly - Device Based",
                         "quantity": 4,
                         "startDate": "2017-02-06T00:00:00.000Z",
                         "endDate": "2018-02-06T23:59:59.000Z"
                     }
                 ]
             }
         ],
         "groups": [
             {
                 "guid": "705c7b4c-a85b-44f0-9fbd-5a2345c21a9a",
                 "groupName": "IT Admin Group",
                 "numberOfUsers": 0,
                 "licensedServices": [
                     {
                         "id": "EMM",
                         "name": "UEM",
                         "description": "UEM",
                         "inGracePeriod": false,
                         "compliant": true,
                         "activatedFeatures": [
                             "gd.good.com",
                             "AFW_DIVIDE_DUAL_SPACE",
                             "MANAGING_SEPARATE_WORKSPACE_ONLY"
                         ]
                     },
                     {
                         "id": "uem.blackberry.com",
                         "name": "BlackBerry Unified Endpoint Management (UEM)",
                         "description": "BlackBerry Unified Endpoint Management (UEM)",
                         "inGracePeriod": false,
                         "compliant": true,
                         "activatedFeatures": [
                             "uem.blackberry.com"
                         ]
                     },
                     {
                         "id": "vpnauth.blackberry.com",
                         "name": "BlackBerry 2FA",
                         "description": "BlackBerry 2FA",
                         "inGracePeriod": false,
                         "compliant": true,
                         "activatedFeatures": []
                     }
                 ],
                 "licensedUsage": [
                     {
                         "id": "gsma.license.blackberry.com",
                         "name": "BlackBerry Enterprise Mobility Suite - Management Edition",
                         "totalServerLicenses": 10,
                         "availableServerLicenses": 10,
                         "usedServerLicenses": 0,
                         "usedSimLicenses": 0,
                         "totalLicensesInUse": 0,
                         "trial": false,
                         "licenseInfo": [
                             {
                                 "type": "PERPETUAL",
                                 "aboutToExpire": false,
                                 "quantity": 0
                             },
                             {
                                 "type": "SUBSCRIPTION",
                                 "expirationDate": "2018-02-06T23:59:59.000Z",
                                 "aboutToExpire": true,
                                 "quantity": 10
                             }
                         ],
                         "featureUsage": [
                             {
                                 "id": "AFW_DIVIDE_DUAL_SPACE",
                                 "consumed": 0
                             },
                             {
                                 "id": "MANAGING_SEPARATE_WORKSPACE_ONLY",
                                 "consumed": 0
                             },
                             {
                                 "id": "gd.good.com",
                                 "consumed": 0
                             },
                             {
                                 "id": "uem.blackberry.com",
                                 "consumed": 0
                             }
                         ]
                     }
                 ]
             }
         ]
     }
 }