Licensing Schemas

Licensing.ActivateLicenseRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.ActivateLicenseResponse


{
  "success": true,
  "licenseToken": "string",
  "tokenExpireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "activeClientCount": 0,
  "maxClientCount": 0,
  "license": {
    "licenseId": "string",
    "licensingMode": 0,
    "expireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "supportExpireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "licenseKey": [
      0
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
licenseToken	string¦null	false	none	none
tokenExpireAt	Licensing.Timestamp	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none
license	Licensing.License	false	none	none

Licensing.DeactivateLicenseRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.DeactivateLicenseResponse


{
  "licenseId": "string",
  "activeClientCount": 0,
  "maxClientCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
licenseId	string¦null	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none

Licensing.Duration


{
  "seconds": 0,
  "nanos": 0
}

Properties

Name	Type	Required	Restrictions	Description
seconds	integer(int64)	false	none	none
nanos	integer(int32)	false	none	none

Licensing.HeartbeatRequest


{
  "licenseToken": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
licenseToken	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.HeartbeatResponse


{
  "active": true,
  "activeClientCount": 0,
  "maxClientCount": 0,
  "tokenExpireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "heartbeatInterval": {
    "seconds": 0,
    "nanos": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none
tokenExpireAt	Licensing.Timestamp	false	none	none
heartbeatInterval	Licensing.Duration	false	none	none

Licensing.License


{
  "licenseId": "string",
  "licensingMode": 0,
  "expireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "supportExpireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "licenseKey": [
    0
  ]
}

Properties

Name	Type	Required	Restrictions	Description
licenseId	string¦null	false	none	none
licensingMode	Licensing.LicensingMode	false	none	none
expireAt	Licensing.Timestamp	false	none	none
supportExpireAt	Licensing.Timestamp	false	none	none
licenseKey	[integer]¦null	false	none	none

Licensing.LicenseFormat

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3

Licensing.LicenseInfoRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.LicenseInfoResponse


{
  "licenseTokens": [
    {
      "token": "string",
      "licenseId": "string",
      "revoked": true,
      "clientId": "string",
      "clientAddr": "string",
      "clientName": "string",
      "machineId": "string",
      "issuedAt": {
        "seconds": 0,
        "nanos": 0
      },
      "expireAt": {
        "seconds": 0,
        "nanos": 0
      },
      "lastHearbeat": {
        "seconds": 0,
        "nanos": 0
      }
    }
  ],
  "licenseId": "string",
  "maxClientCount": 0,
  "activeClientCount": 0,
  "licensingMode": 0,
  "revoked": true,
  "issuedAt": {
    "seconds": 0,
    "nanos": 0
  },
  "expireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "supportExpireAt": {
    "seconds": 0,
    "nanos": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
licenseTokens	[Licensing.LicenseToken]¦null	false	read-only	none
licenseId	string¦null	false	none	none
maxClientCount	integer(int32)	false	none	none
activeClientCount	integer(int32)	false	none	none
licensingMode	Licensing.LicensingMode	false	none	none
revoked	boolean	false	none	none
issuedAt	Licensing.Timestamp	false	none	none
expireAt	Licensing.Timestamp	false	none	none
supportExpireAt	Licensing.Timestamp	false	none	none

Licensing.LicenseToken


{
  "token": "string",
  "licenseId": "string",
  "revoked": true,
  "clientId": "string",
  "clientAddr": "string",
  "clientName": "string",
  "machineId": "string",
  "issuedAt": {
    "seconds": 0,
    "nanos": 0
  },
  "expireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "lastHearbeat": {
    "seconds": 0,
    "nanos": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
token	string¦null	false	none	none
licenseId	string¦null	false	none	none
revoked	boolean	false	none	none
clientId	string¦null	false	none	none
clientAddr	string¦null	false	none	none
clientName	string¦null	false	none	none
machineId	string¦null	false	none	none
issuedAt	Licensing.Timestamp	false	none	none
expireAt	Licensing.Timestamp	false	none	none
lastHearbeat	Licensing.Timestamp	false	none	none

Licensing.LicensingMode

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2

Licensing.ReleaseLicenseRequest


{
  "licenseToken": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
licenseToken	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.ReleaseLicenseResponse


{
  "licenseId": "string",
  "activeClientCount": 0,
  "maxClientCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
licenseId	string¦null	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none

Licensing.Report


{
  "name": "string",
  "version": "string",
  "date": {
    "seconds": 0,
    "nanos": 0
  },
  "encrypted": true,
  "content": [
    0
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
version	string¦null	false	none	none
date	Licensing.Timestamp	false	none	none
encrypted	boolean	false	none	none
content	[integer]¦null	false	none	none

Licensing.RequestLicenseRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.RequestLicenseResponse


{
  "granted": true,
  "licenseToken": "string",
  "tokenExpireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "heartbeatInterval": {
    "seconds": 0,
    "nanos": 0
  },
  "activeClientCount": 0,
  "maxClientCount": 0,
  "license": {
    "licenseId": "string",
    "licensingMode": 0,
    "expireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "supportExpireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "licenseKey": [
      0
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
granted	boolean	false	none	none
licenseToken	string¦null	false	none	none
tokenExpireAt	Licensing.Timestamp	false	none	none
heartbeatInterval	Licensing.Duration	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none
license	Licensing.License	false	none	none

Licensing.SendReportRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string",
  "report": {
    "name": "string",
    "version": "string",
    "date": {
      "seconds": 0,
      "nanos": 0
    },
    "encrypted": true,
    "content": [
      0
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none
report	Licensing.Report	false	none	none

Licensing.SendReportResponse


{
  "success": true,
  "reportUid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
reportUid	string¦null	false	none	none

Licensing.Timestamp


{
  "seconds": 0,
  "nanos": 0
}

Properties

Name	Type	Required	Restrictions	Description
seconds	integer(int64)	false	none	none
nanos	integer(int32)	false	none	none

Licensing.ValidateLicenseRequest


{
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none

Licensing.ValidateLicenseResponse


{
  "success": true,
  "licenseToken": "string",
  "tokenExpireAt": {
    "seconds": 0,
    "nanos": 0
  },
  "activeClientCount": 0,
  "maxClientCount": 0,
  "license": {
    "licenseId": "string",
    "licensingMode": 0,
    "expireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "supportExpireAt": {
      "seconds": 0,
      "nanos": 0
    },
    "licenseKey": [
      0
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
licenseToken	string¦null	false	none	none
tokenExpireAt	Licensing.Timestamp	false	none	none
activeClientCount	integer(int32)	false	none	none
maxClientCount	integer(int32)	false	none	none
license	Licensing.License	false	none	none