v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Software Licenses

Create a Software License

Create a Software License with the provided name and description

post/v2/software-license

Request body

namestring required

Indicates of the name of the software license

descriptionstring required

Indicates a description for the software license

type'PER_DEVICE' | 'PER_USER' | 'CUSTOM' required

Indicates the type of the software license

purchaseDateinteger required

Indicates the purchase date of the software license in unix epoch milliseconds

publisherIdinteger required

Identifier of the publisher

vendorIdinteger required

Identifier of the vendor

quantityinteger required

Indicates the quantity of the software license

currentUsageinteger required

Indicates the current usage of the software license

assignedLicensesobject nullable

Indicates the ids of the assigned licensees

unassignedLicensesobject nullable

Indicates the ids of the unassigned licensees

notestring nullable

Indicates a note about the software license

costMode'TOTAL' | 'PER_LICENSE' nullable

Indicates the cost mode of the software license

costnumber nullable

Indicates the cost of the software license

Example request

{
  "type": "PER_DEVICE",
  "purchaseDate": 1672531199000,
  "usageMonitoring": {
    "binaries": [
      {
        "osType": "WINDOWS",
        "binaryNames": [
          "chrome.exe",
          "firefox.exe"
        ]
      }
    ]
  }
}

Response

The Software License that was created

idinteger
namestring
descriptionstring
type'PER_DEVICE' | 'PER_USER' | 'CUSTOM'
automatedboolean
purchaseDateinteger
publisherIdinteger
vendorIdinteger
quantityinteger
currentUsageinteger
expiredboolean
daysToExpireinteger
notestring
perLicenseCostnumber
totalCostnumber
costMode'TOTAL' | 'PER_LICENSE'
firstFoundAtinteger
lastUsageAtinteger