Tokens

Managing and Tracking Licenses in Babel Licensing Service

In the Babel Licensing Service API, License Tokens play a crucial role in the management and tracking of licenses. License tokens are specialized digital keys that are central to the effective enforcement and monitoring of licensing terms. There are two main types of license tokens, each serving a distinct purpose in the licensing ecosystem.

Get

Roles: Administrator, LicenseManager

This method is used to obtain details about license tokens associated with a specific license. It enables users to query and view information related to both floating license tokens and license activation tokens under a particular license. This is crucial for monitoring how each license's tokens are distributed and used, ensuring alignment with compliance and licensing strategies.

Retrieves a list of tokens for a specific license.

GET/v1/licenses/{licenseId}/tokens

Path parameters

licenseId*integer (int32)

license_id is the ID of the license.

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licenseTokensarray of LicenseToken (object)

license_tokens is the list of license tokens.

totalLicenseTokensCountinteger (int32)

total_license_tokens_count is the total number of license tokens.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses/{licenseId}/tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenseTokens": [
    {
      "token": "text",
      "address": "text",
      "clientId": "text",
      "clientName": "text",
      "machineId": "text",
      "issueDate": "text",
      "expireDate": "text",
      "lastHeartbeat": "text",
      "hash": "text",
      "license": {
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": false,
        "licenseKey": "text",
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text"
          }
        ]
      },
      "nodeLockedLicense": {
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": false,
        "licenseKey": "text",
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text"
          }
        ]
      }
    }
  ]
}

Post

Roles: Administrator, LicenseManager

The POST method is instrumental in generating new license tokens for a given license. Whether it’s for issuing new floating license tokens or activation tokens, this method plays a key role in expanding or renewing the licensing capabilities associated with a particular license. It is essential for granting additional access under an existing license or for activating new user or device rights.

POST/v1/licenses/{licenseId}/tokens

Path parameters

licenseId*integer (int32)

license_id is the ID of the license.

Body

application/json

licenseIdinteger (int32)

license_id is the ID of the license.

licenseTokenLicenseToken (object)

LicenseToken represents a license allocated on the client.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licenseIdinteger (int32)

license_id is the ID of the license.

licenseTokenIdinteger (int32)

license_token_id is the ID of the inserted license token.

tokenstring

token is the token string of the inserted license token.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses/{licenseId}/tokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "token": "text"
}

Delete

Roles: Administrator, LicenseManager

Utilizing the DELETE method revokes and removes a license token from a specific license. This is a necessary action when a token is no longer needed, such as in cases of license expiration or termination of user access. It is an important aspect of license management, helping to keep the licensing system streamlined and free from redundant or invalid tokens.

Deletes a specific token from a given license.

DELETE/v1/licenses/{licenseId}/tokens/{tokenId}

Path parameters

licenseId*integer (int32)

license_id is the ID of the license.

tokenId*integer (int32)

token_id is the ID of the license token to delete.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses/{licenseId}/tokens/{tokenId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}