Activate License (Online Method)

Endpoint

Method: POST
Path: /api/v4/activate_license
Description: Activates a license for a device and returns the license payload.

Authentication

These requests are authenticated and signed. See License API Authorization.

Required headers

Date (string) — RFC7231 GMT date string (example: Thu, 17 Nov 2022 20:51:35 GMT)
Authorization (string) — signature or bearer token (depending on auth method)

Optional headers

licensespring-tpm-signature (string) — TPM licensing signature and algorithm
- licensespring-tpm-signature: algorithm="ES256",signature=""

Recommended headers

Accept: application/json
Content-Type: application/json

Request

Body parameters

Required:

hardware_id (string) — Unique hardware ID generated for the client device
product (string) — Product short code

One of (depending on product authorization method):

license_key (string) — Required for key-based products
username + password (string) — Required for user-based products
id_token (use access_token value) + customer_account_code (string) — Required for SSO Implicit grant
code + customer_account_code (string) — Required for SSO Authorization Code grant

Optional:

license_id (number) — Ensures the action affects only the license with this ID
app_ver (string)
app_name (string)
sdk_ver (string)
variables (object) — Device variables as a JSON object
redirect_uri (string)
bundle_code (string)
include_metadata_string (boolean)
tpm_enrollment (object) — Signing public key for TPM licensing
include_scheduled_changes (boolean)

Minimal example (JSON)

{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}

Schema

Request Body

Request schema (TypeScript + JSON Schema)

TypeScript

type LicenseActivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses, using username & password authentication:
  username: string
  password: string

} | {

  // for user-based licenses, using single sign-on Implicit grant authentication:
  id_token: string
  customer_account_code: string

} | {

  // for user-based licenses, using single sign-on Authorization code grant authentication:
  code: string
  customer_account_code: string

}) & {

  // required properties:
  hardware_id: string
  product: string

  // optional properties:
  bundle_code?: string | undefined
  license_id?: number | undefined
  app_ver?: string | undefined
  app_name?: string | undefined
  sdk_ver?: string | undefined
  redirect_uri?: string | undefined
  include_metadata_string?: boolean | undefined
  tpm_enrollment?: { signing_public_key: string } | undefined
  include_scheduled_changes?: boolean | undefined
  variables?: { [key: string]: string } | undefined
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "allOf": [
    {
      "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
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "hardware_id": { "type": "string" },
        "product": { "type": "string" },
        "bundle_code": { "type": "string" },
        "redirect_uri": { "type": "string" },
        "license_id": { "type": "number" },
        "app_ver": { "type": "string" },
        "app_name": { "type": "string" },
        "sdk_ver": { "type": "string" },
        "include_metadata_string": { "type": "boolean" },
        "include_scheduled_changes": { "type": "boolean" },
        "tpm_enrollment": { 
          "type": "object",
          "properties": {
            "signing_public_key": { "type": "string" },
          },
          "required": ["signing_public_key"],
        },
        "variables": {
          "type": ["object", "null"],
          "additionalProperties": { "type": "string" }
        }
      },
      "required": ["hardware_id", "product"],
      "additionalProperties": false
    }
  ]
}

Response Body

Response schema (TypeScript + JSON Schema)

TypeScript

type ConsumptionPoolState = {
  id: number,
  name: string,
  type: 'license' | 'license_product_feature',
  total_consumptions: number,
  max_consumptions: number,
  allow_overages: boolean,
  max_overages: number,
  allow_unlimited_consumptions: boolean,
  allow_negative_consumptions: boolean,
};

type LicenseScheduledChange = {
  scheduled_at: string,
  status: string,
  action: 'update' | 'reset',
  update_data: JSON,
};

type ProductFeatureScheduledChange = {
  scheduled_at: string,
  status: string,
  product_feature_id: number,
  update_data: JSON,
};

type CustomFieldScheduledChange = {
  scheduled_at: string,
  status: string,
  product_custom_field_id: number,
  update_data: JSON,
};


type ScheduledChanges = {
  license: LicenseScheduledChange[],
  product_feature: ProductFeatureScheduledChange[],
  custom_field: CustomFieldScheduledChange[],
};

type InstallationFile = {
  id: number,
  channel: string,
  environment: string,
  version: string,
  installation_file: string,
  hash_md5: string,
  eula_link: string,
  release_date: string | null,
  requires_version: string,
  size: string,
  release_notes_link: string,
};

type LicenseActivationResponseBody = {
  id: number,
  request: string,
  active: boolean,
  allow_grace_period: boolean,
  allow_overages: boolean,
  allow_unlimited_activations: boolean,
  allow_offline_activation: boolean,
  can_borrow: boolean,
  device_id: number,
  hardware_id: string,
  enable_maintenance_period: boolean,
  floating_timeout: number,
  grace_period: number,
  installation_file: InstallationFile,
  is_air_gapped: boolean,
  is_expired: boolean,
  is_floating_cloud: boolean,
  is_floating: boolean,
  is_hardware_key_auth: boolean,
  is_tpm_auth: boolean,
  is_local_license: boolean,
  is_trial: boolean,
  license_signature: string,
  license_signature_v2: string,
  offline_signature: string,
  license_type: string,
  license_template_id: number | null,
  maintenance_period: string | null,
  max_activations: number,
  max_borrow_time: number,
  max_license_users: number,
  max_overages: number,
  max_transfers: number,
  order_store_id: string | null,
  prevent_vm: boolean,
  start_date: string | null,
  times_activated: number,
  transfer_count: number,
  validity_period: string | null,
  is_bundle: boolean | null,
  bundle_license_id: number | null,
  company: { id: number },
  pool: ConsumptionPoolState | null,
  
  product_features: ({
    id: number,
    code: string,
    name?: string,
    product_feature_id: number,
    expiry_date: string | null,
    valid_duration: string | null,
    is_expired: boolean,
    is_global?: boolean,
    metadata: JSON,
    metadata_string?: string,
    can_borrow: boolean,
    max_borrow_time: number,
    feature_type: 'activation' | 'consumption',
    is_floating: boolean,
    is_floating_cloud: boolean,
    pool: ConsumptionPoolState | null,

    // the following properties are only present if is_floating=true or is_floating_cloud=true
    floating_users?: number,
    floating_timeout?: number,

    // the following properties are only present if feature_type=consumption
    max_consumption: number,
    allow_negative_consumptions: boolean,
    allow_unlimited_consumptions: boolean,
    total_consumptions: number,
    allow_overages: boolean,
    max_overages: number,
    reset_consumption: boolean,
    consumption_period: 'daily' | 'weekly' | 'monthly' | 'annually',
  })[],
  
  custom_fields: ({
    name: string,
    data_type: 'number' | 'text' | 'date/time',
    value: string,
  })[],
  
  customer: {
    email: string,
    company_name: string,
    reference: string,
    phone: string,
    first_name: string,
    last_name: string,
    city: string,
    postcode: string,
    state: string,
    country: string,
    address: string,
    customer_account: {
      id: number,
      name: string,
      code: string
    } | null,
    metadata: JSON,
    metadata_string?: string
  },
  
  product_details: {
    product_id: number,
    product_name: string,
    short_code: string,
    authorization_method: 'license-key' | 'user',
    metadata: JSON,
    metadata_string?: string
  },
  
  variables: {
    value: string,
    device_id: number,
    variable: string,
    created_at: string | null,
  }[],
  
  metadata: JSON,
  
  // the following property is only preset if include_scheduled_changes=true
  scheduled_changes: ScheduledChanges,
  
  // the following property is only present if is_trial=true
  trial_days: number,
  
  // the following property is only present when is_floating_cloud=true
  floating_in_use: boolean,
  
  // the following properties are only present if is_floating=true or is_floating_cloud=true
  floating_in_use_devices: number,
  floating_users: number,
  
  // the following properties are only present if license_type='consumption'
  max_consumptions: number,
  total_consumptions: number,
  allow_unlimited_consumptions: boolean,
  allow_negative_consumptions: boolean,
  reset_consumption: boolean,
  consumption_period: string | null,
} & ({
  license_key: string,
} | {
  user: {
    id: number,
    email: string,
    first_name: string,
    last_name: string,
    phone_number: string,
    is_initial_password: boolean,
    max_activations: number,
    allow_unlimited_activations: boolean,
    total_activations: number
  }
});

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "$defs": {
    "ConsumptionPoolState": {
      "type": "object",
      "properties": {
        "id": { "type": "number" },
        "name": { "type": "string" },
        "type": { "type": "string", "enum": ["license", "license_product_feature"] },
        "total_consumptions": { "type": "number" },
        "max_consumptions": { "type": "number" },
        "allow_overages": { "type": "boolean" },
        "max_overages": { "type": "number" },
        "allow_unlimited_consumptions": { "type": "boolean" },
        "allow_negative_consumptions": { "type": "boolean" }
      },
      "required": [
        "id",
        "name",
        "type",
        "total_consumptions",
        "max_consumptions",
        "allow_overages",
        "max_overages",
        "allow_unlimited_consumptions",
        "allow_negative_consumptions"
      ]
    },
    "LicenseScheduledChange": {
      "type": "object",
      "properties": {
        "scheduled_at": { "type": "string" },
        "status": { "type": "string" },
        "action": { "type": "string", "enum": ["update", "reset"] },
        "update_data": { "type": "object", "minProperties": 1 }
      },
      "required": ["scheduled_at", "status", "action", "update_data"]
    },
    "ProductFeatureScheduledChange": {
      "type": "object",
      "properties": {
        "scheduled_at": { "type": "string" },
        "status": { "type": "string" },
        "product_feature_id": { "type": "number" },
        "update_data": { "type": "object", "minProperties": 1 }
      },
      "required": ["scheduled_at", "status", "product_feature_id", "update_data"]
    },
    "CustomFieldScheduledChange": {
      "type": "object",
      "properties": {
        "scheduled_at": { "type": "string" },
        "status": { "type": "string" },
        "product_custom_field_id": { "type": "number" },
        "update_data": { "type": "object", "minProperties": 1 }
      },
      "required": ["scheduled_at", "status", "product_custom_field_id", "update_data"]
    },
    "ScheduledChanges": {
      "type": "object",
      "properties": {
        "license": {
          "type": "array",
          "items": { "$ref": "#/$defs/LicenseScheduledChange" }
        },
        "product_feature": {
          "type": "array",
          "items": { "$ref": "#/$defs/ProductFeatureScheduledChange" }
        },
        "custom_field": {
          "type": "array",
          "items": { "$ref": "#/$defs/CustomFieldScheduledChange" }
        }
      },
      "required": ["license", "product_feature", "custom_field"]
    }
  },
  "properties": {
    "id": { "type": "number" },
    "request": { "type": "string" },
    "active": { "type": "boolean" },
    "allow_grace_period": { "type": "boolean" },
    "allow_overages": { "type": "boolean" },
    "allow_unlimited_activations": { "type": "boolean" },
    "allow_offline_activation": { "type": "boolean" },
    "can_borrow": { "type": "boolean" },
    "device_id": { "type": "number" },
    "hardware_id": { "type": "string" },
    "enable_maintenance_period": { "type": "boolean" },
    "floating_timeout": { "type": "number" },
    "grace_period": { "type": "number" },

    "scheduled_changes": { "$ref": "#/$defs/ScheduledChanges" },

    "installation_file": {
      "type": "object",
      "properties": {
        "id": { "type": "number" },
        "channel": { "type": "string" },
        "environment": { "type": "string" },
        "version": { "type": "string" },
        "installation_file": { "type": "string" },
        "hash_md5": { "type": "string" },
        "eula_link": { "type": "string" },
        "release_date": { "type": ["string", "null"] },
        "requires_version": { "type": "string" },
        "size": { "type": "string" },
        "release_notes_link": { "type": "string" }
      }
    },

    "is_air_gapped": { "type": "boolean" },
    "is_expired": { "type": "boolean" },
    "is_floating_cloud": { "type": "boolean" },
    "is_floating": { "type": "boolean" },
    "is_hardware_key_auth": { "type": "boolean" },
    "is_tpm_auth": { "type": "boolean" },
    "is_local_license": { "type": "boolean" },
    "is_trial": { "type": "boolean" },

    "license_signature": { "type": "string" },
    "license_signature_v2": { "type": "string" },
    "offline_signature": { "type": "string" },
    "license_type": { "type": "string" },

    "license_template_id": { "type": ["number", "null"] },
    "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", "null"] },
    "prevent_vm": { "type": "boolean" },
    "start_date": { "type": ["string", "null"] },

    "times_activated": { "type": "number" },
    "transfer_count": { "type": "number" },
    "validity_period": { "type": ["string", "null"] },

    "is_bundle": { "type": ["boolean", "null"] },
    "bundle_license_id": { "type": ["number", "null"] },

    "company": {
      "type": "object",
      "properties": {
        "id": { "type": "number" }
      }
    },

    "pool": {
      "anyOf": [
        { "$ref": "#/$defs/ConsumptionPoolState" },
        { "type": "null" }
      ]
    },

    "product_features": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "number" },
          "code": { "type": "string" },
          "name": { "type": "string" },
          "product_feature_id": { "type": "number" },
          "expiry_date": { "type": ["string", "null"] },
          "valid_duration": { "type": ["string", "null"] },
          "is_expired": { "type": "boolean" },
          "is_global": { "type": "boolean" },
          "metadata": {},
          "metadata_string": { "type": "string" },
          "can_borrow": { "type": "boolean" },
          "max_borrow_time": { "type": "number" },
          "feature_type": {
            "type": "string",
            "enum": ["activation", "consumption"]
          },
          "is_floating": { "type": "boolean" },
          "is_floating_cloud": { "type": "boolean" },

          "pool": {
            "anyOf": [
              { "$ref": "#/$defs/ConsumptionPoolState" },
              { "type": "null" }
            ]
          },

          "floating_users": { "type": "number" },
          "floating_timeout": { "type": "number" },

          "max_consumption": { "type": "number" },
          "allow_negative_consumptions": { "type": "boolean" },
          "allow_unlimited_consumptions": { "type": "boolean" },
          "total_consumptions": { "type": "number" },
          "allow_overages": { "type": "boolean" },
          "max_overages": { "type": "number" },
          "reset_consumption": { "type": "boolean" },
          "consumption_period": {
            "type": "string",
            "enum": ["daily", "weekly", "monthly", "annually"]
          }
        }
      }
    },

    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "data_type": {
            "type": "string",
            "enum": ["number", "text", "date/time"]
          },
          "value": { "type": "string" }
        }
      }
    },

    "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": ["object", "null"],
          "properties": {
            "id": { "type": "number" },
            "name": { "type": "string" },
            "code": { "type": "string" }
          }
        },

        "metadata": {},
        "metadata_string": { "type": "string" }
      }
    },

    "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": {},
        "metadata_string": { "type": "string" }
      }
    },

    "variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": { "type": "string" },
          "device_id": { "type": "number" },
          "variable": { "type": "string" },
          "created_at": { "type": ["string", "null"] }
        }
      }
    },

    "metadata": {},
    "trial_days": { "type": "number" },
    "floating_in_use": { "type": "boolean" },
    "floating_in_use_devices": { "type": "number" },
    "floating_users": { "type": "number" },

    "max_consumptions": { "type": "number" },
    "total_consumptions": { "type": "number" },
    "allow_unlimited_consumptions": { "type": "boolean" },
    "allow_negative_consumptions": { "type": "boolean" },
    "reset_consumption": { "type": "boolean" },
    "consumption_period": { "type": ["string", "null"] }
  },

  "oneOf": [
    {
      "properties": {
        "license_key": { "type": "string" }
      },
      "required": ["license_key"]
    },
    {
      "properties": {
        "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": ["user"]
    }
  ]
}

Response objects contain a license_signature value which the client app can use to verify authenticity (see Response Signature).

License Authorization Method

There are two types of product licenses based on how the client application authorizes itself to interact with a license:

Key-based product licenses

Each license assigned to the product requires the client to provide a license key (license_key) in order to activate, check or deactivate the license. The response will contain license_key and product_details.authorization_method will be "license-key".

User-based product licenses

Each license has a corresponding "license user" instead of a license key. Ways to access:

username & password
id_token (use access_token value) & customer_account_code (SSO Implicit grant)
code & customer_account_code (SSO Authorization code grant)

In the response, product_details.authorization_method will be "user" and the response will contain a user object.

License Types

license_type property values:

Perpetual: perpetual
Time-limited: time-limited
Subscription: subscription
Consumption: consumption

See: License Types

Errors

If an error occurs, HTTP status will be 400 or higher and the response body will have:

{
  status: number,
  code: string,
  message: string
}

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
}

List of exceptions:

unknown_product (400): Provided product was not found

license_not_found (400): License with the provided license user not found

license_not_enabled (400): The license is not enabled

vm_not_allowed (400): Virtual machine not allowed

offline_floating_cloud_not_supported (400): Floating cloud licenses cannot be activated offline

license_start_date_error (400): This license cannot be activated before start date: {date}

blacklisted (400): This device is blacklisted

license_activated_max_times (400): This license key has already been activated the maximum number of times

license_user_activated_max_times (400): License user has activated this license max times

license_expired (400): License validity period has expired

license_transferred_max_times (400): This license has already been transferred the maximum number of times

license_device_exists (409): A device matching this hardware_id is already created on the license.

product_version_not_supported (400): License product version does not support the app_ver sent in the request

tpm_not_enabled (400): This license doesn't have TPM licensing enabled, and tpm_enrollment is being sent in the request

tpm_enrollment_required (400): This license has TPM licensing enabled, but tpm_enrollment is not being sent in the request

tpm_invalid_public_key (400): The TPM public key sent is not valid

tpm_signature_required (400): The TPM signature is missing from the header and TPM usage is enforced

tpm_signature_missmatch (400): The TPM signature/algorithm is not ES256 and the signature can't be verified against the TPM public key

Examples

curl --location --request POST '/api/v4/activate_license' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}'

var request = require('request');

var options = {
  method: 'POST',
  url: '/api/v4/activate_license',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  },
  body: JSON.stringify({
    hardware_id: 'some-unique-id',
    product: 'XY',
    license_key: 'AAAA-BBBB-CCCC-DDDD'
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = JSON.stringify({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("/api/v4/activate_license", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests

url = "/api/v4/activate_license"

payload = {
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}

headers = {
  "Accept": "application/json",
  "Content-Type": "application/json",
  "Date": "string",
  "Authorization": "string"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

require "uri"
require "net/http"
require "json"

url = URI("/api/v4/activate_license")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = JSON.dump({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD"
})

response = http.request(request)
puts response.read_body

Single-Sign-On License Activation

SSO setup and how to get the SSO URL: Single Sign On URL.

curl --location --request POST 'https://api.licensespring.com/api/v4/activate_license/' \
--header 'Date: Mon, 10 May 2021 13:14:18 GMT' \
--header 'Authorization: algorithm="hmac-sha256",headers="date",signature="{generated_signature}",apikey="{your_api_key}"' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_token": "{access_token_here}",
  	"code": "{code_here}",
    "customer_account_code": "acme_inc",
    "hardware_id": "some-unique-id",
    "product": "XY"
}'

Use either id_token or code, not both at the same time.

Device Variables

The optional variables property lets you set device variables during activation. See Device Variables.

PreviousLicense Activation & Deactivation

NextActivate License (Offline Method)

Last updated 3 days ago

Was this helpful?