10Duke Entitlement API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Manage licenses and entitlements

Base URLs:

• http://my-api.10duke.com/api/ent/v1.exp

• https://my-api.10duke.com/api/ent/v1.exp

Web: 10Duke Software

Authentication

• HTTP Authentication, scheme: bearer

• oAuth2 authentication.

  • Flow: authorizationCode
  • Authorization URL = /user/oauth20/authz
  • Token URL = /user/oauth20/token

Scope	Scope Description
https://apis.10duke.com/ent/product	View and manage products.
https://apis.10duke.com/ent/provision	View and provision licenses.
https://apis.10duke.com/ent/manage	Manage access to licenses (consuming groups, assignment management etc.)
https://apis.10duke.com/ent/user	Access individual user license information
https://apis.10duke.com/ent/consume	Consume licenses (e.g. use /authz)

consumer

Gets groups that have been added as consumers of licenses of the entitlement

Code samples

curl -X GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups \
  -H 'Accept: application/json'

GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups HTTP/1.1
Host: my-api.10duke.com
Accept: application/json

var headers = {
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const headers = { 
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups',
  {
    method: 'GET',
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Accept' => 'application/json'
}
result = RestClient.get 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}
r = requests.get('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/consuming-groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /organizations/{orgId}/entitlements/{entId}/consuming-groups

Gets organization groups members of which can consume licenses contained by the entitlement

Parameters

Parameter	In	Type	Required
orgId - Id of organization that owns entitlements and licenses to manage	path	string(uuid)	true
entId - Globally unique entitlement id or 'any' in cases where system can multiple entitlements can be accepted.	path	string	true

Example responses

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "name": "string",
    "type": "string",
    "description": "string"
  }
]

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to view or manage organization groups	OK	Inline
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

Response Schema

Status Code 200

Name	Type	Required
anonymous - Array of organization groups	[allOf]	false

allOf

|» *anonymous* - Base for all resource objects described by the API|ResourceBase|false| |»» id - Unique id of the resource. In create request id is never required, server generates id if not given.|string(uuid)|false| |»» created - Instant when the resource has been created|string|false| |»» authorId - Id of user that created the resource|string(uuid)|false| |»» modified - Instant when the resource has been last modified|string|false| |»» editorId - Id of user that has made the last modification on the object|string(uuid)|false|

and

|» *anonymous* - No description|object|false| |»» organizationId - Id of the organization owning this group|string(uuid)|false| |»» name - Group name|string|false| |»» type - Group type. The type is formal and is used by application logic. Predefined reserved type values are: employees, enterpriseEmployees and licenseConsumers.|string|false| |»» description - Description of the group|string|false|

license

Lists licenses of the entitlement

Code samples

curl -X GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses \
  -H 'Accept: application/json'

GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses HTTP/1.1
Host: my-api.10duke.com
Accept: application/json

var headers = {
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const headers = { 
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses',
  {
    method: 'GET',
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Accept' => 'application/json'
}
result = RestClient.get 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}
r = requests.get('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /organizations/{orgId}/entitlements/{entId}/licenses

Gets all licenses contained by entitlement

Parameters

Parameter	In	Type	Required
orgId - Id of organization that owns entitlements and licenses to manage	path	string(uuid)	true
entId - Globally unique entitlement id or 'any' in cases where system can multiple entitlements can be accepted.	path	string	true
includeCredits - Instructs to include license credit information in the response. If not specified, no credit information is returned.	query	string	false
includeEffectiveModel - Instructs to include license model details in the response. If not specified, no details are returned.	query	boolean	false

Enumerated Values

Parameter	Value
includeCredits	all
includeCredits	valid
includeCredits	latestExpiration

Example responses

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
    "licensedItem": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "string",
          "aggregatedItems": []
        }
      ]
    },
    "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
    "licenseModelName": "string",
    "effectiveLicenseModel": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "description": "string",
      "assignedLicenseConstraint": {
        "requireReservation": true,
        "allowReassign": true
      },
      "concurrentSessions": {
        "maxCache": 0,
        "maxCheckOut": 0,
        "maxTotal": 0,
        "leaseTrackingMode": "ignoreLeaseId",
        "sessionAnchors": [
          "Hardware"
        ],
        "additionalAnchors": [
          "Hardware"
        ]
      },
      "leaseTimeBehavior": {
        "leaseTimeCache": 0,
        "leaseTimeCheckOut": 0,
        "refreshTimeCache": 0,
        "refreshTimeCheckOut": 0,
        "cooldownTime": 0,
        "incrementModel": "relative",
        "allowLeaseExtension": true,
        "allowLeaseRelease": true
      },
      "licenseLockingBehavior": {
        "lockMode": "noLocking"
      },
      "licensePoolBehavior": {
        "behavior": "singlePool"
      },
      "scopedLicenseConstraint": {
        "scopeType": "project",
        "allowLateBinding": true,
        "scopedCreditType": "License"
      },
      "seatCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "useCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
        "trackingMode": "consumptionSessions"
      },
      "useTimeConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "versionConstraint": {
        "matcher": "exact"
      }
    },
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "seatsTaken": 0,
    "seatsReserved": 0,
    "seatsTotal": 0,
    "seatCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "seatCount": 0,
        "seatsConsumed": 0
      }
    ],
    "useCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useCount": 0,
        "countUsed": 0
      }
    ],
    "useTimeCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useTime": 0,
        "timeUsed": 0
      }
    ]
  }
]

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to read information of licenses along with credits granted for consuming the licenses	OK	LicensesWithCredits
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

Gets current usage of the license

Code samples

curl -X GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage \
  -H 'Accept: application/json'

GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage HTTP/1.1
Host: my-api.10duke.com
Accept: application/json

var headers = {
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const headers = { 
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage',
  {
    method: 'GET',
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Accept' => 'application/json'
}
result = RestClient.get 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}
r = requests.get('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/usage

Returns usage and users who are currently consuming the license

Parameters

Parameter	In	Type	Required
orgId - Id of organization that owns entitlements and licenses to manage	path	string(uuid)	true
entId - Globally unique entitlement id or 'any' in cases where system can multiple entitlements can be accepted.	path	string	true
licenseId - Globally unique license id or 'any' in cases where system can multiple licenses can be accepted.	path	string	true

Example responses

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0,
  "seatCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "seatCount": 0,
      "seatsConsumed": 0
    }
  ],
  "useCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useCount": 0,
      "countUsed": 0
    }
  ],
  "useTimeCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useTime": 0,
      "timeUsed": 0
    }
  ],
  "users": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "lastSignOn": "1999-01-01T00:01:02.345Z",
      "nickname": "string",
      "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
      "phoneNumber": "string",
      "professionalTitle": "CEO",
      "assignments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "validFrom": "2019-08-24T14:15:22Z",
          "validUntil": "2019-08-24T14:15:22Z",
          "type": "reserved",
          "sessions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "created": "1999-01-01T00:01:02.345Z",
              "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
              "modified": "2019-02-02T01:02:03.456Z",
              "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
              "validFrom": "2019-08-24T14:15:22Z",
              "validUntil": "2019-08-24T14:15:22Z",
              "leases": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "created": "1999-01-01T00:01:02.345Z",
                  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                  "modified": "2019-02-02T01:02:03.456Z",
                  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                  "validFrom": "2019-08-24T14:15:22Z",
                  "validUntil": "2019-08-24T14:15:22Z",
                  "mode": "string"
                }
              ],
              "anchors": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "created": "1999-01-01T00:01:02.345Z",
                  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                  "modified": "2019-02-02T01:02:03.456Z",
                  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                  "type": "string",
                  "externalId": "string",
                  "externalName": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to get current license usage	OK	LicenseUsage
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

Gets user's assignments to the license

Code samples

curl -X GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments \
  -H 'Accept: application/json'

GET http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments HTTP/1.1
Host: my-api.10duke.com
Accept: application/json

var headers = {
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const headers = { 
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  {
    method: 'GET',
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Accept' => 'application/json'
}
result = RestClient.get 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}
r = requests.get('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments

Returns user's assignments to the license

Parameters

Parameter	In	Type	Required
orgId - Id of organization that owns entitlements and licenses to manage	path	string(uuid)	true
entId - Globally unique entitlement id or 'any' in cases where system can multiple entitlements can be accepted.	path	string	true
licenseId - Globally unique license id or 'any' in cases where system can multiple licenses can be accepted.	path	string	true
userId - Id of a user or "me" to refer to authenticated user	path	string	true

Example responses

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved"
  }
]

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to get or update get user's license assignments	OK	LicenseAssignments
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

Manages user's license assigments

Code samples

curl -X PUT http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments HTTP/1.1
Host: my-api.10duke.com
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  method: 'put',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const inputBody = '[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved"
  }
]';
const headers = { 
  'Content-Type':'application/json',
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  {
    method: 'PUT',
    body: inputBody,
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}
result = RestClient.put 'http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
r = requests.put('http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /organizations/{orgId}/entitlements/{entId}/licenses/{licenseId}/users/{userId}/assignments

Sets desired assignment state for the user. To deny license use include single assignment with type "denied" to request body with desired validity, if validity information is not provided deny applies immediately and is indefinite. To reserve a license seat or seats include one or more assignments with type "reserved" to body with desired validity, if validity is not provided seat reservation applies immediately and is indefinite. To clear possible deny or reservation state include single assignment with type "floating" to request body, without validity (notice that when license model requires named seat, users in "floating" state are not able to consume the license).

Body parameter

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved"
  }
]

Parameters

Parameter	In	Type	Required
body - License assignments to set.	body	LicenseAssignments	true
orgId - Id of organization that owns entitlements and licenses to manage	path	string(uuid)	true
entId - Globally unique entitlement id or 'any' in cases where system can multiple entitlements can be accepted.	path	string	true
licenseId - Globally unique license id or 'any' in cases where system can multiple licenses can be accepted.	path	string	true
userId - Id of a user or "me" to refer to authenticated user	path	string	true

Example responses

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved"
  }
]

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to get or update get user's license assignments	OK	LicenseAssignments
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

user

Gets current usage of the license

Code samples

curl -X GET http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses \
  -H 'Accept: application/json'

GET http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses HTTP/1.1
Host: my-api.10duke.com
Accept: application/json

var headers = {
  'Accept':'application/json'
};
$.ajax({
  url: 'http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
});

const fetch = require('node-fetch');
const headers = { 
  'Accept':'application/json'
};
fetch('http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses',
  {
    method: 'GET',
    headers: headers
  })
.then(function(res) {
    return res.json();
  })
.then(function(body) {
    console.log(body);
  })
;

require 'rest-client'
require 'json'
headers = {
  'Accept' => 'application/json'
}
result = RestClient.get 'http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses',
  params: {},
  headers: headers
p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}
r = requests.get('http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses',
  params = {},
  headers = headers)
print r.json()

URL obj = new URL("http://my-api.10duke.com/api/ent/v1.exp/users/{userId}/available-licenses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /users/{userId}/available-licenses

Returns usage and users who are currently consuming the license

Parameters

Parameter	In	Type	Required
userId - Id of a user or "me" to refer to authenticated user	path	string	true
version - Version of a product	query	string	false
product - Name of a product	query	string	false
includeCredits - Instructs to include license credit information in the response. If not specified, no credit information is returned.	query	string	false
includeEffectiveModel - Instructs to include license model details in the response. If not specified, no details are returned.	query	boolean	false

Enumerated Values

Parameter	Value
includeCredits	all
includeCredits	valid
includeCredits	latestExpiration

Example responses

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
    "licensedItem": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "string",
          "aggregatedItems": []
        }
      ]
    },
    "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
    "licenseModelName": "string",
    "effectiveLicenseModel": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "description": "string",
      "assignedLicenseConstraint": {
        "requireReservation": true,
        "allowReassign": true
      },
      "concurrentSessions": {
        "maxCache": 0,
        "maxCheckOut": 0,
        "maxTotal": 0,
        "leaseTrackingMode": "ignoreLeaseId",
        "sessionAnchors": [
          "Hardware"
        ],
        "additionalAnchors": [
          "Hardware"
        ]
      },
      "leaseTimeBehavior": {
        "leaseTimeCache": 0,
        "leaseTimeCheckOut": 0,
        "refreshTimeCache": 0,
        "refreshTimeCheckOut": 0,
        "cooldownTime": 0,
        "incrementModel": "relative",
        "allowLeaseExtension": true,
        "allowLeaseRelease": true
      },
      "licenseLockingBehavior": {
        "lockMode": "noLocking"
      },
      "licensePoolBehavior": {
        "behavior": "singlePool"
      },
      "scopedLicenseConstraint": {
        "scopeType": "project",
        "allowLateBinding": true,
        "scopedCreditType": "License"
      },
      "seatCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "useCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
        "trackingMode": "consumptionSessions"
      },
      "useTimeConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "versionConstraint": {
        "matcher": "exact"
      }
    },
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "seatsTaken": 0,
    "seatsReserved": 0,
    "seatsTotal": 0,
    "seatCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "seatCount": 0,
        "seatsConsumed": 0
      }
    ],
    "useCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useCount": 0,
        "countUsed": 0
      }
    ],
    "useTimeCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useTime": 0,
        "timeUsed": 0
      }
    ],
    "owner": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "lastSignOn": "1999-01-01T00:01:02.345Z",
      "nickname": "string",
      "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
      "phoneNumber": "string",
      "professionalTitle": "CEO"
    },
    "assignments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "type": "reserved"
      }
    ]
  }
]

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Responses

Status	Meaning	Schema
200 - Response of a request to get available licenses	OK	LicensesWithOwnerAndSingleUserAssignments
404 - Object not found	Not Found	ApiError
default - Unexpected error	Default	ApiError

Schemas

LicenseOrder

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "orderNumber": "string",
  "orderDate": "2019-08-24T14:15:22Z",
  "canceled": true,
  "metadata": "string",
  "orderLines": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "lineNumber": "string",
      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
      "productCode": "string",
      "quantity": 0,
      "orderValidFrom": "2019-08-24T14:15:22Z",
      "orderValidUntil": "2019-08-24T14:15:22Z",
      "metadata": "string",
      "licenseOrderId": "eb374c48-c15d-46aa-b528-09eb8219017e"
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» orderNumber - Order number or identifier in the client system	string	false
» orderDate - Date and time of order	string(date-time)	false
» canceled - Indicates if this order has been canceled	boolean	false
» metadata - Data attached by the client system to the order. This metadata is not used by this system, but is provided for the client applications to add any technical or human readable metadata.	string	false
» orderLines - No description	[LicenseOrderLine]	false

LicenseOrderLine

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "lineNumber": "string",
  "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  "productCode": "string",
  "quantity": 0,
  "orderValidFrom": "2019-08-24T14:15:22Z",
  "orderValidUntil": "2019-08-24T14:15:22Z",
  "metadata": "string",
  "licenseOrderId": "eb374c48-c15d-46aa-b528-09eb8219017e"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» lineNumber - Order line number or identifier in the client system	string	false
» productId - Id of the ordered product package	string(uuid)	false
» productCode - Product code or identifier in the client system	string	false
» quantity - The ordered quantity	integer(int32)	false
» orderValidFrom - Order / ordered license validity start time. If not specified or null, order is not considered to be valid and the ordered line can not be consumed.	string(date-time)	false
» orderValidUntil - Order / ordered license validity end time. If not specified or null, the ordered license can be consumed indefinitely.	string(date-time)	false
» metadata - Data attached by the client system to the order line. This metadata is not used by this system, but is provided for the client applications to add any technical or human readable metadata.	string	false
» licenseOrderId - Id of the order	string(uuid)	false

LicensedItem

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "name": "string",
  "displayName": "string",
  "description": "string",
  "type": "string",
  "aggregatedItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": []
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» name - Unique name or identifier of the licensed item. This is used when checking licenses.	string	false
» displayName - Name of the licensed item for human audience	string	false
» description - Description of the licensed item	string	false
» type - Licensed item type, can be used as additional metadata for grouping licensed items	string	false
» aggregatedItems - No description	LicensedItems	false

LicensedItems

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - List of licensed items	[LicensedItem]	false

LicenseScope

{
  "type": "string",
  "externalId": "string",
  "externalName": "string"
}

Properties

Name	Type	Required
type - Scope type	string	false
externalId - External scope identifier	string	false
externalName - External scope name	string	false

LicenseScopes

[
  {
    "type": "string",
    "externalId": "string",
    "externalName": "string"
  }
]

Properties

Name	Type	Required
anonymous - List of license scopes, one per scope type	[LicenseScope]	false

License

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceWithValidity	false

and

Name	Type	Required
anonymous - No description	object	false
» active - Indicates if the license can be consumed. If not specified or null, license is considered as active.	boolean	false
» entitlementId - Id of entitlement containing the license	string(uuid)	false
» licensedItem - No description	LicensedItem	false
» licenseModelId - Id of license model	string(uuid)	false
» licenseModelName - Name of license model	string	false
» effectiveLicenseModel - No description	LicenseModel	false
» scopeBindings - No description	LicenseScopes	false
» seatsTaken - Number of seats in taken, including consumed seats and also non-consumed named seats	integer(int64)	false
» seatsReserved - Number of seats reserved for named seats	integer(int64)	false
» seatsTotal - Total number of seats currently available in license credits. This value only represents number of seats provisioned, not taking current seat usage into account.	integer(int64)	false

LicenseWithCredits

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0,
  "seatCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "seatCount": 0,
      "seatsConsumed": 0
    }
  ],
  "useCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useCount": 0,
      "countUsed": 0
    }
  ],
  "useTimeCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useTime": 0,
      "timeUsed": 0
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	License	false

and

Name	Type	Required
anonymous - No description	object	false
» seatCountCredits - No description	SeatCountCredits	false
» useCountCredits - No description	UseCountCredits	false
» useTimeCredits - No description	UseTimeCredits	false

LicensesWithCredits

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
    "licensedItem": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "string",
          "aggregatedItems": []
        }
      ]
    },
    "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
    "licenseModelName": "string",
    "effectiveLicenseModel": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "description": "string",
      "assignedLicenseConstraint": {
        "requireReservation": true,
        "allowReassign": true
      },
      "concurrentSessions": {
        "maxCache": 0,
        "maxCheckOut": 0,
        "maxTotal": 0,
        "leaseTrackingMode": "ignoreLeaseId",
        "sessionAnchors": [
          "Hardware"
        ],
        "additionalAnchors": [
          "Hardware"
        ]
      },
      "leaseTimeBehavior": {
        "leaseTimeCache": 0,
        "leaseTimeCheckOut": 0,
        "refreshTimeCache": 0,
        "refreshTimeCheckOut": 0,
        "cooldownTime": 0,
        "incrementModel": "relative",
        "allowLeaseExtension": true,
        "allowLeaseRelease": true
      },
      "licenseLockingBehavior": {
        "lockMode": "noLocking"
      },
      "licensePoolBehavior": {
        "behavior": "singlePool"
      },
      "scopedLicenseConstraint": {
        "scopeType": "project",
        "allowLateBinding": true,
        "scopedCreditType": "License"
      },
      "seatCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "useCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
        "trackingMode": "consumptionSessions"
      },
      "useTimeConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "versionConstraint": {
        "matcher": "exact"
      }
    },
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "seatsTaken": 0,
    "seatsReserved": 0,
    "seatsTotal": 0,
    "seatCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "seatCount": 0,
        "seatsConsumed": 0
      }
    ],
    "useCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useCount": 0,
        "countUsed": 0
      }
    ],
    "useTimeCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useTime": 0,
        "timeUsed": 0
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - Licenses with credits granted for consuming the licenses	[LicenseWithCredits]	false

Organization

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "name": "string",
  "type": "string",
  "description": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» name - Name of the organization	string	false
» type - Type of the organization	string	false
» description - Description of the organization	string	false

UserIdentityBase

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» displayName - Full name in displayable form, possibly including title and suffixes	string	false

UserProfile

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "lastSignOn": "1999-01-01T00:01:02.345Z",
  "nickname": "string",
  "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
  "phoneNumber": "string",
  "professionalTitle": "CEO"
}

Properties

allOf

Name	Type	Required
anonymous - No description	UserIdentityBase	false

and

Name	Type	Required
anonymous - No description	object	false
» email - Primary registered email address (contact information)	string	false
» firstName - First name (given name)	string	false
» lastName - Last name (family name)	string	false
» lastSignOn - Instant when the user signed on last time	string	false
» nickname - Nick name (casual name)	string	false
» picture - URL of user's profile picture	string	false
» phoneNumber - Preferred telephone number	string	false
» professionalTitle - Professional title or status, as relevant to describing role of the user in the system	string	false

TechnicalActor

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string",
  "username": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	UserIdentityBase	false

and

Name	Type	Required
anonymous - No description	object	false
» username - Username	string	false

LicenseSessionAnchor

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "type": "string",
  "externalId": "string",
  "externalName": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» type - Anchor type	string	false
» externalId - External anchor identifier	string	false
» externalName - External name	string	false

LicenseSessionAnchors

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "type": "string",
    "externalId": "string",
    "externalName": "string"
  }
]

Properties

Name	Type	Required
anonymous - Anchors of a license session	[LicenseSessionAnchor]	false

LicenseLease

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "mode": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceWithValidity	false

and

Name	Type	Required
anonymous - No description	object	false
» mode - Lease mode online or offline.	string	false

LicenseLeases

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "mode": "string"
  }
]

Properties

Name	Type	Required
anonymous - License leases of a license session. The latest lease is always found from the first index i.e. array is never empty	[LicenseLease]	false

LicenseSession

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "leases": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "mode": "string"
    }
  ],
  "anchors": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceWithValidity	false

and

Name	Type	Required
anonymous - No description	object	false
» leases - No description	LicenseLeases	false
» anchors - No description	LicenseSessionAnchors	false

LicenseSessions

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "leases": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "mode": "string"
      }
    ],
    "anchors": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - License sessions	[LicenseSession]	false

LicenseAssignment

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "type": "reserved"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceWithValidity	false

and

Name	Type	Required
anonymous - No description	object	false
» type - Type of the license assignment, floating, reserved or denied	string	false

Enumerated Values

Property	Value
type	reserved
type	denied
type	floating

LicenseAssignments

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved"
  }
]

Properties

Name	Type	Required
anonymous - License seat assignments	[LicenseAssignment]	false

LicenseAssignmentWithSessions

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "type": "reserved",
  "sessions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "leases": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "validFrom": "2019-08-24T14:15:22Z",
          "validUntil": "2019-08-24T14:15:22Z",
          "mode": "string"
        }
      ],
      "anchors": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ]
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseAssignment	false

and

Name	Type	Required
anonymous - No description	object	false
» sessions - No description	LicenseSessions	false

LicenseAssignmentsWithSessions

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "type": "reserved",
    "sessions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "leases": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "created": "1999-01-01T00:01:02.345Z",
            "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
            "modified": "2019-02-02T01:02:03.456Z",
            "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
            "validFrom": "2019-08-24T14:15:22Z",
            "validUntil": "2019-08-24T14:15:22Z",
            "mode": "string"
          }
        ],
        "anchors": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "created": "1999-01-01T00:01:02.345Z",
            "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
            "modified": "2019-02-02T01:02:03.456Z",
            "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ]
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - License assignments with sessions	[LicenseAssignmentWithSessions]	false

LicenseOwner

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "lastSignOn": "1999-01-01T00:01:02.345Z",
  "nickname": "string",
  "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
  "phoneNumber": "string",
  "professionalTitle": "CEO"
}

Properties

Name	Type	Required
objectType - Type of the owner	string	true

oneOf

Name	Type	Required
anonymous - No description	UserProfile	false

xor

Name	Type	Required
anonymous - No description	Organization	false

xor - discriminator: objectType

Name	Type	Required
anonymous - No description	any	false

LicenseUser

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "lastSignOn": "1999-01-01T00:01:02.345Z",
  "nickname": "string",
  "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
  "phoneNumber": "string",
  "professionalTitle": "CEO"
}

Properties

oneOf

Name	Type	Required
anonymous - No description	UserProfile	false

xor

Name	Type	Required
anonymous - No description	TechnicalActor	false

xor - discriminator: objectType

Name	Type	Required
anonymous - No description	any	false

LicenseUserWithAssignmentsAndSessions

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "lastSignOn": "1999-01-01T00:01:02.345Z",
  "nickname": "string",
  "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
  "phoneNumber": "string",
  "professionalTitle": "CEO",
  "assignments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "type": "reserved",
      "sessions": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "validFrom": "2019-08-24T14:15:22Z",
          "validUntil": "2019-08-24T14:15:22Z",
          "leases": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "created": "1999-01-01T00:01:02.345Z",
              "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
              "modified": "2019-02-02T01:02:03.456Z",
              "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
              "validFrom": "2019-08-24T14:15:22Z",
              "validUntil": "2019-08-24T14:15:22Z",
              "mode": "string"
            }
          ],
          "anchors": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "created": "1999-01-01T00:01:02.345Z",
              "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
              "modified": "2019-02-02T01:02:03.456Z",
              "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
              "type": "string",
              "externalId": "string",
              "externalName": "string"
            }
          ]
        }
      ]
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseUser	false

and

Name	Type	Required
anonymous - No description	object	false
» assignments - No description	LicenseAssignmentsWithSessions	false

LicenseUsersWithAssignmentsAndSessions

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "lastSignOn": "1999-01-01T00:01:02.345Z",
    "nickname": "string",
    "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
    "phoneNumber": "string",
    "professionalTitle": "CEO",
    "assignments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "type": "reserved",
        "sessions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "created": "1999-01-01T00:01:02.345Z",
            "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
            "modified": "2019-02-02T01:02:03.456Z",
            "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
            "validFrom": "2019-08-24T14:15:22Z",
            "validUntil": "2019-08-24T14:15:22Z",
            "leases": [
              {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "created": "1999-01-01T00:01:02.345Z",
                "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                "modified": "2019-02-02T01:02:03.456Z",
                "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                "validFrom": "2019-08-24T14:15:22Z",
                "validUntil": "2019-08-24T14:15:22Z",
                "mode": "string"
              }
            ],
            "anchors": [
              {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "created": "1999-01-01T00:01:02.345Z",
                "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                "modified": "2019-02-02T01:02:03.456Z",
                "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                "type": "string",
                "externalId": "string",
                "externalName": "string"
              }
            ]
          }
        ]
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - Users consuming a license and related license assignments	[LicenseUserWithAssignmentsAndSessions]	false

LicenseUsage

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0,
  "seatCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "seatCount": 0,
      "seatsConsumed": 0
    }
  ],
  "useCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useCount": 0,
      "countUsed": 0
    }
  ],
  "useTimeCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useTime": 0,
      "timeUsed": 0
    }
  ],
  "users": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "lastSignOn": "1999-01-01T00:01:02.345Z",
      "nickname": "string",
      "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
      "phoneNumber": "string",
      "professionalTitle": "CEO",
      "assignments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "validFrom": "2019-08-24T14:15:22Z",
          "validUntil": "2019-08-24T14:15:22Z",
          "type": "reserved",
          "sessions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "created": "1999-01-01T00:01:02.345Z",
              "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
              "modified": "2019-02-02T01:02:03.456Z",
              "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
              "validFrom": "2019-08-24T14:15:22Z",
              "validUntil": "2019-08-24T14:15:22Z",
              "leases": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "created": "1999-01-01T00:01:02.345Z",
                  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                  "modified": "2019-02-02T01:02:03.456Z",
                  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                  "validFrom": "2019-08-24T14:15:22Z",
                  "validUntil": "2019-08-24T14:15:22Z",
                  "mode": "string"
                }
              ],
              "anchors": [
                {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "created": "1999-01-01T00:01:02.345Z",
                  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
                  "modified": "2019-02-02T01:02:03.456Z",
                  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
                  "type": "string",
                  "externalId": "string",
                  "externalName": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseWithCredits	false

and

Name	Type	Required
anonymous - No description	object	false
» users - No description	LicenseUsersWithAssignmentsAndSessions	false

LicenseWithOwner

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0,
  "seatCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "seatCount": 0,
      "seatsConsumed": 0
    }
  ],
  "useCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useCount": 0,
      "countUsed": 0
    }
  ],
  "useTimeCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useTime": 0,
      "timeUsed": 0
    }
  ],
  "owner": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "lastSignOn": "1999-01-01T00:01:02.345Z",
    "nickname": "string",
    "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
    "phoneNumber": "string",
    "professionalTitle": "CEO"
  }
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseWithCredits	false

and

Name	Type	Required
anonymous - No description	object	false
» owner - No description	LicenseOwner	false

LicenseWithOwnerAndSingleUserAssignments

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
  "licensedItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ]
  },
  "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
  "licenseModelName": "string",
  "effectiveLicenseModel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "description": "string",
    "assignedLicenseConstraint": {
      "requireReservation": true,
      "allowReassign": true
    },
    "concurrentSessions": {
      "maxCache": 0,
      "maxCheckOut": 0,
      "maxTotal": 0,
      "leaseTrackingMode": "ignoreLeaseId",
      "sessionAnchors": [
        "Hardware"
      ],
      "additionalAnchors": [
        "Hardware"
      ]
    },
    "leaseTimeBehavior": {
      "leaseTimeCache": 0,
      "leaseTimeCheckOut": 0,
      "refreshTimeCache": 0,
      "refreshTimeCheckOut": 0,
      "cooldownTime": 0,
      "incrementModel": "relative",
      "allowLeaseExtension": true,
      "allowLeaseRelease": true
    },
    "licenseLockingBehavior": {
      "lockMode": "noLocking"
    },
    "licensePoolBehavior": {
      "behavior": "singlePool"
    },
    "scopedLicenseConstraint": {
      "scopeType": "project",
      "allowLateBinding": true,
      "scopedCreditType": "License"
    },
    "seatCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "useCountConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
      "trackingMode": "consumptionSessions"
    },
    "useTimeConstraint": {
      "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
    },
    "versionConstraint": {
      "matcher": "exact"
    }
  },
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatsTaken": 0,
  "seatsReserved": 0,
  "seatsTotal": 0,
  "seatCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "seatCount": 0,
      "seatsConsumed": 0
    }
  ],
  "useCountCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useCount": 0,
      "countUsed": 0
    }
  ],
  "useTimeCredits": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "active": true,
      "allowedVersions": "string",
      "allowedVersionsDescription": "string",
      "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
      "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
      "scopeBindings": [
        {
          "type": "string",
          "externalId": "string",
          "externalName": "string"
        }
      ],
      "useTime": 0,
      "timeUsed": 0
    }
  ],
  "owner": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "lastSignOn": "1999-01-01T00:01:02.345Z",
    "nickname": "string",
    "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
    "phoneNumber": "string",
    "professionalTitle": "CEO"
  },
  "assignments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "validFrom": "2019-08-24T14:15:22Z",
      "validUntil": "2019-08-24T14:15:22Z",
      "type": "reserved"
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseWithOwner	false

and

Name	Type	Required
anonymous - No description	object	false
» assignments - No description	LicenseAssignments	false

LicensesWithOwnerAndSingleUserAssignments

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "entitlementId": "79a605b5-f302-4c5d-bbc7-cbd58f1a9b0d",
    "licensedItem": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created": "1999-01-01T00:01:02.345Z",
          "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
          "modified": "2019-02-02T01:02:03.456Z",
          "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "string",
          "aggregatedItems": []
        }
      ]
    },
    "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
    "licenseModelName": "string",
    "effectiveLicenseModel": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "description": "string",
      "assignedLicenseConstraint": {
        "requireReservation": true,
        "allowReassign": true
      },
      "concurrentSessions": {
        "maxCache": 0,
        "maxCheckOut": 0,
        "maxTotal": 0,
        "leaseTrackingMode": "ignoreLeaseId",
        "sessionAnchors": [
          "Hardware"
        ],
        "additionalAnchors": [
          "Hardware"
        ]
      },
      "leaseTimeBehavior": {
        "leaseTimeCache": 0,
        "leaseTimeCheckOut": 0,
        "refreshTimeCache": 0,
        "refreshTimeCheckOut": 0,
        "cooldownTime": 0,
        "incrementModel": "relative",
        "allowLeaseExtension": true,
        "allowLeaseRelease": true
      },
      "licenseLockingBehavior": {
        "lockMode": "noLocking"
      },
      "licensePoolBehavior": {
        "behavior": "singlePool"
      },
      "scopedLicenseConstraint": {
        "scopeType": "project",
        "allowLateBinding": true,
        "scopedCreditType": "License"
      },
      "seatCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "useCountConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
        "trackingMode": "consumptionSessions"
      },
      "useTimeConstraint": {
        "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
      },
      "versionConstraint": {
        "matcher": "exact"
      }
    },
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "seatsTaken": 0,
    "seatsReserved": 0,
    "seatsTotal": 0,
    "seatCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "seatCount": 0,
        "seatsConsumed": 0
      }
    ],
    "useCountCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useCount": 0,
        "countUsed": 0
      }
    ],
    "useTimeCredits": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "active": true,
        "allowedVersions": "string",
        "allowedVersionsDescription": "string",
        "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
        "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
        "scopeBindings": [
          {
            "type": "string",
            "externalId": "string",
            "externalName": "string"
          }
        ],
        "useTime": 0,
        "timeUsed": 0
      }
    ],
    "owner": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "lastSignOn": "1999-01-01T00:01:02.345Z",
      "nickname": "string",
      "picture": "https://id.10duke.com/api/idp/v1.exp/users/d8400c9d-6a94-4af6-b81a-57a1e52ea156/profilePicture?w=${WIDTH}&h=${HEIGHT}",
      "phoneNumber": "string",
      "professionalTitle": "CEO"
    },
    "assignments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "validFrom": "2019-08-24T14:15:22Z",
        "validUntil": "2019-08-24T14:15:22Z",
        "type": "reserved"
      }
    ]
  }
]

Properties

Name	Type	Required
anonymous - No description	[LicenseWithOwnerAndSingleUserAssignments]	false

ProductItem

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "name": "string",
  "displayName": "string",
  "description": "string",
  "type": "string",
  "aggregatedItems": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "1999-01-01T00:01:02.345Z",
      "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
      "modified": "2019-02-02T01:02:03.456Z",
      "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "aggregatedItems": []
    }
  ],
  "versionRange": "string",
  "versionDisplayString": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicensedItem	false

and

Name	Type	Required
anonymous - No description	object	false
» versionRange - No description	string	false
» versionDisplayString - No description	string	false

ProductItems

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "type": "string",
    "aggregatedItems": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created": "1999-01-01T00:01:02.345Z",
        "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
        "modified": "2019-02-02T01:02:03.456Z",
        "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
        "name": "string",
        "displayName": "string",
        "description": "string",
        "type": "string",
        "aggregatedItems": []
      }
    ],
    "versionRange": "string",
    "versionDisplayString": "string"
  }
]

Properties

Name	Type	Required
anonymous - No description	[ProductItem]	false

SeatCountCredit

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "allowedVersions": "string",
  "allowedVersionsDescription": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "seatCount": 0,
  "seatsConsumed": 0
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseCreditBase	false

and

Name	Type	Required
anonymous - No description	object	false
» seatCount - Number of seats granted	integer(int64)	false
» seatsConsumed - Number of seats consumed	integer(int64)	false

SeatCountCredits

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "allowedVersions": "string",
    "allowedVersionsDescription": "string",
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "seatCount": 0,
    "seatsConsumed": 0
  }
]

Properties

Name	Type	Required
anonymous - No description	[SeatCountCredit]	false

UseCountCredit

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "allowedVersions": "string",
  "allowedVersionsDescription": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "useCount": 0,
  "countUsed": 0
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseCreditBase	false

and

Name	Type	Required
anonymous - No description	object	false
» useCount - Granted use count	integer(int64)	false
» countUsed - Use count already used	integer(int64)	false

UseCountCredits

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "allowedVersions": "string",
    "allowedVersionsDescription": "string",
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "useCount": 0,
    "countUsed": 0
  }
]

Properties

Name	Type	Required
anonymous - No description	[UseCountCredit]	false

UseTimeCredit

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "allowedVersions": "string",
  "allowedVersionsDescription": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ],
  "useTime": 0,
  "timeUsed": 0
}

Properties

allOf

Name	Type	Required
anonymous - No description	LicenseCreditBase	false

and

Name	Type	Required
anonymous - No description	object	false
» useTime - Granted use time in milliseconds	integer(int64)	false
» timeUsed - Use time already used	integer(int64)	false

UseTimeCredits

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created": "1999-01-01T00:01:02.345Z",
    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
    "modified": "2019-02-02T01:02:03.456Z",
    "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
    "validFrom": "2019-08-24T14:15:22Z",
    "validUntil": "2019-08-24T14:15:22Z",
    "active": true,
    "allowedVersions": "string",
    "allowedVersionsDescription": "string",
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
    "scopeBindings": [
      {
        "type": "string",
        "externalId": "string",
        "externalName": "string"
      }
    ],
    "useTime": 0,
    "timeUsed": 0
  }
]

Properties

Name	Type	Required
anonymous - No description	[UseTimeCredit]	false

OrganizationGroup

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "name": "string",
  "type": "string",
  "description": "string"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» organizationId - Id of the organization owning this group	string(uuid)	false
» name - Group name	string	false
» type - Group type. The type is formal and is used by application logic. Predefined reserved type values are: employees, enterpriseEmployees and licenseConsumers.	string	false
» description - Description of the group	string	false

LicenseModel

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "name": "string",
  "description": "string",
  "assignedLicenseConstraint": {
    "requireReservation": true,
    "allowReassign": true
  },
  "concurrentSessions": {
    "maxCache": 0,
    "maxCheckOut": 0,
    "maxTotal": 0,
    "leaseTrackingMode": "ignoreLeaseId",
    "sessionAnchors": [
      "Hardware"
    ],
    "additionalAnchors": [
      "Hardware"
    ]
  },
  "leaseTimeBehavior": {
    "leaseTimeCache": 0,
    "leaseTimeCheckOut": 0,
    "refreshTimeCache": 0,
    "refreshTimeCheckOut": 0,
    "cooldownTime": 0,
    "incrementModel": "relative",
    "allowLeaseExtension": true,
    "allowLeaseRelease": true
  },
  "licenseLockingBehavior": {
    "lockMode": "noLocking"
  },
  "licensePoolBehavior": {
    "behavior": "singlePool"
  },
  "scopedLicenseConstraint": {
    "scopeType": "project",
    "allowLateBinding": true,
    "scopedCreditType": "License"
  },
  "seatCountConstraint": {
    "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
  },
  "useCountConstraint": {
    "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
    "trackingMode": "consumptionSessions"
  },
  "useTimeConstraint": {
    "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
  },
  "versionConstraint": {
    "matcher": "exact"
  }
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» name - License model name	string	false
» description - License model description	string	false
» assignedLicenseConstraint - No description	AssignedLicenseConstraint	false
» concurrentSessions - No description	ConcurrentSessions	false
» leaseTimeBehavior - No description	LeaseTimeBehavior	false
» licenseLockingBehavior - No description	LicenseLockingBehavior	false
» licensePoolBehavior - No description	LicensePoolBehavior	false
» scopedLicenseConstraint - No description	ScopedLicenseConstraint	false
» seatCountConstraint - No description	SeatCountConstraint	false
» useCountConstraint - No description	UseCountConstraint	false
» useTimeConstraint - No description	UseTimeConstraint	false
» versionConstraint - No description	VersionConstraint	false

AssignedLicenseConstraint

{
  "requireReservation": true,
  "allowReassign": true
}

Properties

Name	Type	Required
requireReservation - If set to true, requires that user has a seat reservation in order to consume a license.	boolean	false
allowReassign - Indicates if reassigning of an earlier assignment to another user is allowed. Default is true.	boolean	false

ConcurrentSessions

{
  "maxCache": 0,
  "maxCheckOut": 0,
  "maxTotal": 0,
  "leaseTrackingMode": "ignoreLeaseId",
  "sessionAnchors": [
    "Hardware"
  ],
  "additionalAnchors": [
    "Hardware"
  ]
}

Properties

Name	Type	Required
maxCache - Maximum number of concurrent license consumptions in cache mode per consumption session. Cache mode is intended for license consumption by clients that can refresh lease frequently, typically used by clients that are online.	integer(int32)	false
maxCheckOut - Maximum number of concurrent license consumptions in check-out mode per consumption session. Check-out mode is intended for license consumption by clients that can not refresh lease frequently, typically used by clients that go offline for longer periods.	integer(int32)	false
maxTotal - Maximum total number of license consumptions in either cache or check-out mode	integer(int32)	false
leaseTrackingMode - Specifies how client license consumption lease refresh request are reflected in license consumption sessions. With "ignoreLeaseId" client is not required to send earlier lease id, and each client request will extend an existing consumption session if available. With "requireLeaseId" client must always send earlier lease id in order to extend an existing consumption session. With "useLeaseIdIfPresent", client may send earlier lease and if present, it is used for ensuring that existing consumption session can be extended only if lease id matches.	string	false
sessionAnchors - Anchor or anchors that define a license consumption session	[SessionAnchorValue]	false
additionalAnchors - Additional anchors that that client must specify in license consumptions requests	[SessionAnchorValue]	false

Enumerated Values

Property	Value
leaseTrackingMode	ignoreLeaseId
leaseTrackingMode	requireLeaseId
leaseTrackingMode	useLeaseIdIfPresent

LeaseTimeBehavior

{
  "leaseTimeCache": 0,
  "leaseTimeCheckOut": 0,
  "refreshTimeCache": 0,
  "refreshTimeCheckOut": 0,
  "cooldownTime": 0,
  "incrementModel": "relative",
  "allowLeaseExtension": true,
  "allowLeaseRelease": true
}

Properties

Name	Type	Required
leaseTimeCache - Specifies how long lease and license token duration can be granted when client consumes licenses in cache mode (online, frequest lease refresh). Note that independent of this configuration, lease lifetime can never exceed license lifetime. If not specified, lease can be granted until license expiration. Value is in milliseconds.	integer(int64)	false
leaseTimeCheckOut - Specifies how long lease and license token duration can be granted when client consumes licenses in check-out mode (offline, less frequest lease refresh). Note that independent of this configuration, lease lifetime can never exceed license lifetime. If not specified, lease can be granted until license expiration. Value is in milliseconds.	integer(int64)	false
refreshTimeCache - Specifies when client with license consumption in cache mode is instructed to refresh existing license lease. Value should be less than or equal to value of "leaseTimeCache". If not specified, no refresh instruction is returned to the client. Value is in milliseconds.	integer(int64)	false
refreshTimeCheckOut - Specifies when client with license consumption in check-out mode is instructed to refresh existing license lease. Value should be less than or equal to value of "leaseTimeCheckOut". If not specified, no refresh instruction is returned to the client. Value is in milliseconds.	integer(int64)	false
cooldownTime - Cooldown time after lease release, in milliseconds. If not specified, no cooldown time is used.	integer(int64)	false
incrementModel - Specifies how lease extension request from client extends license consumption validity, and for how long the extended lease will be valid. With "relative" model, new validity is always calculated from the time of request. With "stack" model, new validity is added on top of current validity. If not specified, "relative" is used as default.	string	false
allowLeaseExtension - Specifies if subsequent license consumption requests from the same client with same session anchors are allowed to extend existing license lease. See concurrent sessions configurations for more granular control over how lease requests are reflected to license consumption sessions. If this value is not specified, by default lease extension is allowed (default is true).	boolean	false
allowLeaseRelease - Specifies if granted leases can be released. If this value is not specified, by default lease release is allowed (default is true).	boolean	false

Enumerated Values

Property	Value
incrementModel	relative
incrementModel	stack

LicenseLockingBehavior

{
  "lockMode": "noLocking"
}

Properties

Name	Type	Required
lockMode - License locking mode. "noLocking" enforces no locks, "lockLicense" enforces lock on license level.	string	false

Enumerated Values

Property	Value
lockMode	noLocking
lockMode	lockLicense

LicensePoolBehavior

{
  "behavior": "singlePool"
}

Properties

Name	Type	Required
behavior - Specifies how licenses are pooled. With "singlePool", all license credits to a licensed item are added for a single license object that works as a single pool of the licensee. With "operation", each grant creates a new license object working as an independent pool. With "singleLicense" there is no pooling and all licenses are individual.	string	false

Enumerated Values

Property	Value
behavior	singlePool
behavior	operation
behavior	singleLicense

ScopedLicenseConstraint

{
  "scopeType": "project",
  "allowLateBinding": true,
  "scopedCreditType": "License"
}

Properties

Name	Type	Required
scopeType - Type of the scope. Currently "project" is the only supported scope.	string	true
allowLateBinding - Specifies if scope can be bound to license after license initialization. Default is "false", meaning that scope must be bound when initializing license.	boolean	false
scopedCreditType - Specifies type of credits that are bound to the scope, or "License" to bind the whole license.	string	false

Enumerated Values

Property	Value
scopeType	project
scopedCreditType	License
scopedCreditType	SeatCountCredit
scopedCreditType	UseCountCredit
scopedCreditType	UseTimeCredit

SeatCountConstraint

{
  "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
}

Properties

None

UseCountConstraint

{
  "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\"",
  "trackingMode": "consumptionSessions"
}

Properties

allOf

Name	Type	Required
anonymous - No description	OveruseExpressionField	false

and

Name	Type	Required
anonymous - No description	object	false
» trackingMode - Specifies how use count is tracked. With "consumptionSessions", each established license consumption session consumes the use count quota. With "licenseUniqueResources", use count is tracked against unique consumed resources in scope of the license. With "userUniqueResources", use count is tracked against unique consumed resources in scope of the consuming user.	string	false

Enumerated Values

Property	Value
trackingMode	consumptionSessions
trackingMode	licenseUniqueResources
trackingMode	userUniqueResources

UseTimeConstraint

{
  "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
}

Properties

None

VersionConstraint

{
  "matcher": "exact"
}

Properties

Name	Type	Required
matcher - Matcher to use for checking if requested version matches with the granted version. With "exact", the requested version must match the granted version exactly. With "semantic", the requested version is matched against semantic version pattern. With "regex", the requested version is matched against regular expression. If not specified, "exact" is used as the default matcher.	string	false

Enumerated Values

Property	Value
matcher	exact
matcher	semantic
matcher	regex

ApiError

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Properties

Name	Type	Required
error - The error code	string	true
error_description - Error description for human audience	string	false
error_uri - URI for further information about the error	string	false

LicenseCreditBase

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "active": true,
  "allowedVersions": "string",
  "allowedVersionsDescription": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "licenseOrderLineId": "302b6cb6-3685-49ba-9d45-f8da35c2a590",
  "scopeBindings": [
    {
      "type": "string",
      "externalId": "string",
      "externalName": "string"
    }
  ]
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceWithValidity	false

and

Name	Type	Required
anonymous - No description	object	false
» active - Indicates if the credit can be used for consuming license. If not specified or null, credit is considered as active.	boolean	false
» allowedVersions - Specifies versions of client application that are allowed to consume the license. Exact format of this field depends on version matcher that is used.	string	false
» allowedVersionsDescription - Human readable description of allowedVersions.	string	false
» licenseId - Id of license for which credits granted	string(uuid)	false
» licenseOrderLineId - Id of license order line that granted these credits	string(uuid)	false
» scopeBindings - No description	LicenseScopes	false

ResourceWithValidity

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z"
}

Properties

allOf

Name	Type	Required
anonymous - No description	ResourceBase	false

and

Name	Type	Required
anonymous - No description	object	false
» validFrom - Validity start time. If not specified or null, object is not considered as valid.	string(date-time)	false
» validUntil - Validity end time. If not specified or null, object is considered to be valid indefinitely.	string(date-time)	false

ResourceBase

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "1999-01-01T00:01:02.345Z",
  "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
  "modified": "2019-02-02T01:02:03.456Z",
  "editorId": "799d609e-56e8-47d7-b279-52f2f936fabf"
}

Properties

Name	Type	Required
id - Unique id of the resource. In create request id is never required, server generates id if not given.	string(uuid)	false
created - Instant when the resource has been created	string	false
authorId - Id of user that created the resource	string(uuid)	false
modified - Instant when the resource has been last modified	string	false
editorId - Id of user that has made the last modification on the object	string(uuid)	false

OveruseExpressionField

{
  "overuseExpr": "\"2\", \"ceil(n / 10)\" or \"max(1, min(log2(n), 10))\""
}

Properties

Name	Type	Required
overuseExpr - Expression for maximum overuse quantity, in units used for measuring license consumption (number of seats for seat count, milliseconds for use time etc). Expression allows using variable "n" for the current quota. When license engine evaluates this expression, result is rounded to the nearest integer (using the round method).	string	false

SessionAnchorValue

"Hardware"

Properties

Name	Type	Required
anonymous - Object that can be used as a license consumption session anchor	string	false

Enumerated Values

Property	Value
anonymous	Hardware
anonymous	LicensedProcess
anonymous	LicensedResource