Licenses for User

6min
Returns a list of licenses assigned to a user for a product (only for user-based product licenses)
GET
Request
Query Parameters
product
optional
String
Short code of product, filters results by specified product
username
optional
String
User's username (if using user authentication, not SSO authentication)
password
optional
String
User's password (if using user authentication, not SSO authentication)
customer_account_code
optional
String
Required if using SSO (see section below). This is the customer_account_code to which SSO provider is configured
id_token
optional
String
Required if using SSO (see section below). This is the id_token received from the SSO if Implicit grant authorization method is being used.
code
optional
String
Required if using SSO (see section below). This is the code received from the SSO if Authorization code grant method is being used.
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
JS
Curl
const headers = new Headers();
headers.append("Accept", "application/json");
headers.append("Date", "DATE_STRING");
headers.append("Authorization", "AUTHORIZATION_STRING");

const requestOptions = {
  method: 'GET',
  headers: headers,
  redirect: 'follow'
};

const queryParams = new URLSearchParams({
  product: 'PRODUCT_STRING',
  username: 'USERNAME_STRING',
  password: 'PASSWORD_STRING',
})
.toString();

fetch("/api/v4/user_licenses?" + queryParams, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
const headers = new Headers();
headers.append("Accept", "application/json");
headers.append("Date", "DATE_STRING");
headers.append("Authorization", "AUTHORIZATION_STRING");

const requestOptions = {
  method: 'GET',
  headers: headers,
  redirect: 'follow'
};

const queryParams = new URLSearchParams({
  product: 'PRODUCT_STRING',
  username: 'USERNAME_STRING',
  password: 'PASSWORD_STRING',
})
.toString();

fetch("/api/v4/user_licenses?" + queryParams, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
Responses
200
404

﻿
Schema
Request Query Parameters
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "license_key": { "type": "string" }
      },
      "required": ["license_key"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "username": { "type": "string" },
        "password": { "type": "string" }
      },
      "required": ["username", "password"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id_token": { "type": "string" },
        "customer_account_code": { "type": "string" }
      },
      "required": ["id_token", "customer_account_code"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "code": { "type": "string" },
        "customer_account_code": { "type": "string" }
      },
      "required": ["code", "customer_account_code"],
      "additionalProperties": false
    }
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "license_key": { "type": "string" }
      },
      "required": ["license_key"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "username": { "type": "string" },
        "password": { "type": "string" }
      },
      "required": ["username", "password"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id_token": { "type": "string" },
        "customer_account_code": { "type": "string" }
      },
      "required": ["id_token", "customer_account_code"],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "code": { "type": "string" },
        "customer_account_code": { "type": "string" }
      },
      "required": ["code", "customer_account_code"],
      "additionalProperties": false
    }
  ]
}
﻿
Response Body
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": { "type": "number" },
      "allow_grace_period": { "type": "boolean" },
      "allow_overages": { "type": "boolean" },
      "allow_unlimited_activations": { "type": "boolean" },
      "borrowed_until": { "type": ["string", "null"] },
      "can_borrow": { "type": "boolean" },
      "channel": { "type": "string" },
      "device_id": { "type": "number" },
      "enable_maintenance_period": { "type": "boolean" },
      "environment": { "type": "string" },
      "eula_link": { "type": "string" },
      "floating_timeout": { "type": "number" },
      "grace_period": { "type": "number" },
      "hash_md5": { "type": "string" },
      "installation_file": { "type": "string" },
      "is_air_gapped": { "type": "boolean" },
      "is_borrowed": { "type": "boolean" },
      "is_expired": { "type": "boolean" },
      "is_floating_cloud": { "type": "boolean" },
      "is_floating": { "type": "boolean" },
      "is_hardware_key_auth": { "type": "boolean" },
      "license_active": { "type": "boolean" },
      "license_enabled": { "type": "boolean" },
      "license_signature": { "type": "string" },
      "license_signature_v2": { "type": "string" },
      "offline_signature": { "type": "string" },
      "license_type": { "type": "string" },
      "maintenance_period": { "type": ["string", "null"] },
      "max_activations": { "type": "number" },
      "max_borrow_time": { "type": "number" },
      "max_license_users": { "type": "number" },
      "max_overages": { "type": "number" },
      "max_transfers": { "type": "number" },
      "order_store_id": { "type": "string" },
      "prevent_vm": { "type": "boolean" },
      "release_date": { "type": "string" },
      "release_notes_link": { "type": "string" },
      "requires_version": { "type": "string" },
      "size": { "type": "string" },
      "start_date": { "type": ["string", "null"] },
      "times_activated": { "type": "number" },
      "transfer_count": { "type": "number" },
      "validity_period": { "type": ["string", "null"] },
      "version": { "type": "string" },
      "product_features": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": { "type": "number" },
            "code": { "type": "string" },
            "name": { "type": "string" },
            "expiry_date": { "type": "string" },
            "metadata": { "type": "object" },
            "feature_type": { "type": "string", "enum": ["activation", "consumption"] },
            "is_floating": { "type": "boolean" },
            "is_floating_cloud": { "type": "boolean" },
            "floating_users": { "type": "number" },
            "floating_timeout": { "type": "number" },
            "max_consumption": { "type": "number" },
            "allow_unlimited_consumptions": { "type": "boolean" },
            "total_consumptions": { "type": "number" },
            "allow_overages": { "type": "number" },
            "max_overages": { "type": "number" },
            "reset_consumption": { "type": "boolean" },
            "consumption_period": {
              "type": ["string", "null"],
              "enum": ["daily", "weekly", "monthly", "annualy", null]
            }
          },
          "required": ["id", "code", "name", "expiry_date", "metadata", "feature_type", "is_floating", "is_floating_cloud"]
        }
      },
      "custom_fields": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": { "type": "string" },
            "data_type": { "type": "string", "enum": ["numer", "text", "date/time"] },
            "value": { "type": "string" }
          },
          "required": ["name", "data_type", "value"]
        }
      },
      "customer": {
        "type": "object",
        "properties": {
          "email": { "type": "string" },
          "company_name": { "type": "string" },
          "reference": { "type": "string" },
          "phone": { "type": "string" },
          "first_name": { "type": "string" },
          "last_name": { "type": "string" },
          "city": { "type": "string" },
          "postcode": { "type": "string" },
          "state": { "type": "string" },
          "country": { "type": "string" },
          "address": { "type": "string" },
          "customer_account": { "type": ["string", "null"] },
          "metadata": { "type": "object" }
        },
        "required": ["email", "company_name", "reference", "phone", "first_name", "last_name", "city", "postcode", "state", "country", "address", "metadata"]
      },
      "product_details": {
        "type": "object",
        "properties": {
          "product_id": { "type": "number" },
          "product_name": { "type": "string" },
          "short_code": { "type": "string" },
          "authorization_method": { "type": "string", "enum": ["license-key", "user"] },
          "metadata": { "type": "object" }
        },
        "required": ["product_id", "product_name", "short_code", "authorization_method", "metadata"]
      },
      "user": {
        "type": "object",
        "properties": {
          "id": { "type": "number" },
          "email": { "type": "string" },
          "first_name": { "type": "string" },
          "last_name": { "type": "string" },
          "phone_number": { "type": "string" },
          "is_initial_password": { "type": "boolean" },
          "max_activations": { "type": "number" },
          "allow_unlimited_activations": { "type": "boolean" },
          "total_activations": { "type": "number" }
        },
        "required": ["id", "email", "first_name", "last_name", "phone_number", "is_initial_password", "max_activations", "allow_unlimited_activations", "total_activations"]
      },
      "metadata": { "type": "object" },
      "trial_days": { "type": "number" },
      "floating_in_use_devices": { "type": "number" },
      "floating_users": { "type": "number" },
      "max_consumptions": { "type": "number" },
      "total_consumptions": { "type": "number" },
      "allow_unlimited_consumptions": { "type": "boolean" },
      "reset_consumption": { "type": "boolean" },
      "consumption_period": { "type": ["string", "null"] }
    },
    "required": [
      "id",
      "allow_grace_period",
      "allow_overages",
      "allow_unlimited_activations",
      "can_borrow",
      "channel",
      "device_id",
      "enable_maintenance_period",
      "environment",
      "eula_link",
      "floating_timeout",
      "grace_period",
      "hash_md5",
      "installation_file",
      "is_air_gapped",
      "is_borrowed",
      "is_expired",
      "is_floating_cloud",
      "is_floating",
      "is_hardware_key_auth",
      "license_active",
      "license_enabled",
      "license_signature",
      "license_signature_v2",
      "offline_signature",
      "license_type",
      "max_activations",
      "max_borrow_time",
      "max_license_users",
      "max_overages",
      "max_transfers",
      "order_store_id",
      "prevent_vm",
      "release_date",
      "release_notes_link",
      "requires_version",
      "size",
      "times_activated",
      "transfer_count",
      "user",
      "version",
      "product_features",
      "custom_fields",
      "product_details",
      "metadata"
    ],
    "additionalProperties": false
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": { "type": "number" },
      "allow_grace_period": { "type": "boolean" },
      "allow_overages": { "type": "boolean" },
      "allow_unlimited_activations": { "type": "boolean" },
      "borrowed_until": { "type": ["string", "null"] },
      "can_borrow": { "type": "boolean" },
      "channel": { "type": "string" },
      "device_id": { "type": "number" },
      "enable_maintenance_period": { "type": "boolean" },
      "environment": { "type": "string" },
      "eula_link": { "type": "string" },
      "floating_timeout": { "type": "number" },
      "grace_period": { "type": "number" },
      "hash_md5": { "type": "string" },
      "installation_file": { "type": "string" },
      "is_air_gapped": { "type": "boolean" },
      "is_borrowed": { "type": "boolean" },
      "is_expired": { "type": "boolean" },
      "is_floating_cloud": { "type": "boolean" },
      "is_floating": { "type": "boolean" },
      "is_hardware_key_auth": { "type": "boolean" },
      "license_active": { "type": "boolean" },
      "license_enabled": { "type": "boolean" },
      "license_signature": { "type": "string" },
      "license_signature_v2": { "type": "string" },
      "offline_signature": { "type": "string" },
      "license_type": { "type": "string" },
      "maintenance_period": { "type": ["string", "null"] },
      "max_activations": { "type": "number" },
      "max_borrow_time": { "type": "number" },
      "max_license_users": { "type": "number" },
      "max_overages": { "type": "number" },
      "max_transfers": { "type": "number" },
      "order_store_id": { "type": "string" },
      "prevent_vm": { "type": "boolean" },
      "release_date": { "type": "string" },
      "release_notes_link": { "type": "string" },
      "requires_version": { "type": "string" },
      "size": { "type": "string" },
      "start_date": { "type": ["string", "null"] },
      "times_activated": { "type": "number" },
      "transfer_count": { "type": "number" },
      "validity_period": { "type": ["string", "null"] },
      "version": { "type": "string" },
      "product_features": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": { "type": "number" },
            "code": { "type": "string" },
            "name": { "type": "string" },
            "expiry_date": { "type": "string" },
            "metadata": { "type": "object" },
            "feature_type": { "type": "string", "enum": ["activation", "consumption"] },
            "is_floating": { "type": "boolean" },
            "is_floating_cloud": { "type": "boolean" },
            "floating_users": { "type": "number" },
            "floating_timeout": { "type": "number" },
            "max_consumption": { "type": "number" },
            "allow_unlimited_consumptions": { "type": "boolean" },
            "total_consumptions": { "type": "number" },
            "allow_overages": { "type": "number" },
            "max_overages": { "type": "number" },
            "reset_consumption": { "type": "boolean" },
            "consumption_period": {
              "type": ["string", "null"],
              "enum": ["daily", "weekly", "monthly", "annualy", null]
            }
          },
          "required": ["id", "code", "name", "expiry_date", "metadata", "feature_type", "is_floating", "is_floating_cloud"]
        }
      },
      "custom_fields": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": { "type": "string" },
            "data_type": { "type": "string", "enum": ["numer", "text", "date/time"] },
            "value": { "type": "string" }
          },
          "required": ["name", "data_type", "value"]
        }
      },
      "customer": {
        "type": "object",
        "properties": {
          "email": { "type": "string" },
          "company_name": { "type": "string" },
          "reference": { "type": "string" },
          "phone": { "type": "string" },
          "first_name": { "type": "string" },
          "last_name": { "type": "string" },
          "city": { "type": "string" },
          "postcode": { "type": "string" },
          "state": { "type": "string" },
          "country": { "type": "string" },
          "address": { "type": "string" },
          "customer_account": { "type": ["string", "null"] },
          "metadata": { "type": "object" }
        },
        "required": ["email", "company_name", "reference", "phone", "first_name", "last_name", "city", "postcode", "state", "country", "address", "metadata"]
      },
      "product_details": {
        "type": "object",
        "properties": {
          "product_id": { "type": "number" },
          "product_name": { "type": "string" },
          "short_code": { "type": "string" },
          "authorization_method": { "type": "string", "enum": ["license-key", "user"] },
          "metadata": { "type": "object" }
        },
        "required": ["product_id", "product_name", "short_code", "authorization_method", "metadata"]
      },
      "user": {
        "type": "object",
        "properties": {
          "id": { "type": "number" },
          "email": { "type": "string" },
          "first_name": { "type": "string" },
          "last_name": { "type": "string" },
          "phone_number": { "type": "string" },
          "is_initial_password": { "type": "boolean" },
          "max_activations": { "type": "number" },
          "allow_unlimited_activations": { "type": "boolean" },
          "total_activations": { "type": "number" }
        },
        "required": ["id", "email", "first_name", "last_name", "phone_number", "is_initial_password", "max_activations", "allow_unlimited_activations", "total_activations"]
      },
      "metadata": { "type": "object" },
      "trial_days": { "type": "number" },
      "floating_in_use_devices": { "type": "number" },
      "floating_users": { "type": "number" },
      "max_consumptions": { "type": "number" },
      "total_consumptions": { "type": "number" },
      "allow_unlimited_consumptions": { "type": "boolean" },
      "reset_consumption": { "type": "boolean" },
      "consumption_period": { "type": ["string", "null"] }
    },
    "required": [
      "id",
      "allow_grace_period",
      "allow_overages",
      "allow_unlimited_activations",
      "can_borrow",
      "channel",
      "device_id",
      "enable_maintenance_period",
      "environment",
      "eula_link",
      "floating_timeout",
      "grace_period",
      "hash_md5",
      "installation_file",
      "is_air_gapped",
      "is_borrowed",
      "is_expired",
      "is_floating_cloud",
      "is_floating",
      "is_hardware_key_auth",
      "license_active",
      "license_enabled",
      "license_signature",
      "license_signature_v2",
      "offline_signature",
      "license_type",
      "max_activations",
      "max_borrow_time",
      "max_license_users",
      "max_overages",
      "max_transfers",
      "order_store_id",
      "prevent_vm",
      "release_date",
      "release_notes_link",
      "requires_version",
      "size",
      "times_activated",
      "transfer_count",
      "user",
      "version",
      "product_features",
      "custom_fields",
      "product_details",
      "metadata"
    ],
    "additionalProperties": false
  }
}
﻿
License Authorization Method
The licenses returned by this endpoint are allways user-based product licenses. This means they don't have a license key, and instead each license has a "license user".
Accessing this endpoint requires license user authentication, which can be done in three ways:
By providing the values for username and password for the license user
By providing the values for id_token and customer_account_code if using single sign-on authentication using Implicit grant
By providing the values for code and customer_account_code if using single sign-on authentication using Authorization code grant
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
﻿
List of exceptions
﻿
Updated 24 Jan 2025
Did this page help you?
List Licenses
Licenses for Device