Licensing Resource

Provides access to licensing information

GET /{tenantGuid}/api/v1/licensing

Available Since:
12.8.0

Get licensing information.

Samples

Sample request

  GET /SRP00000/api/v1/licensing

Sample response body

  
  {
    "organizationStatus" : {
      "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", "..." ]
    },
    "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" : "SUBSCRIPTION",
        "expirationDate" : "2017-01-01T11:04:30.45Z",
        "aboutToExpire" : false,
        "quantity" : 10
      },
      "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..."
      }
    }
  }

Response Codes
Code Condition Data type
200 OK (even if connection to licensing infrastructure is not available).
Response Body
Media type Data type
application/vnd.blackberry.licensing-v1+json Licensing Information (JSON)