Deactivate Bundle (Online Method)

Endpoint

• Method: POST

• Path: /api/v4/deactivate_bundle

• Description: Deactivates a bundle license for a device and returns license_deactivated on success.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string

• Authorization (string) — signature or bearer token

Recommended headers

• Accept: application/json

• Content-Type: application/json

Request

Body parameters

Required:

• hardware_id (string)

• product (string) — Bundle product short code

One of:

• license_key (string)

• username + password (string)

• id_token + customer_account_code (string)

• code + customer_account_code (string)

Optional:

• license_id (number)

• sdk_ver (string)

• device metadata fields (is_vm, vm_info, os_ver, hostname, ip, mac_address, ...)

Minimal example (JSON)

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

Schema

Request schema (TypeScript + JSON Schema)

TypeScript

type BundleDeactivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string
  password: string

} | {

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

} | {

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

}) & {
  hardware_id: string
  product: string

  license_id?: number | undefined
  sdk_ver?: 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" },
        "license_id": { "type": "number" },
        "sdk_ver": { "type": "string" }
      },
      "required": ["hardware_id", "product"],
      "additionalProperties": false
    }
  ]
}

Examples

curl

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

nodejs

javascript (fetch)

python

ruby

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 in order to activate, check or deactivate the license (property license_key in the request body).

The license response object will contain the license_key property, and product_details.authorization_method will be the string license_key.

User-based product licenses

Each license assigned to the product has a corresponding "license user" instead of a license key. There are multiple ways a user-based product license can be accessed when making a request:

• 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

In the license response object, product_details.authorization_method will have the string value user and the response object will contain the user object with information on the license user.

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:

{
  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

• product_not_bundle (400): Specified product "code" is not a bundle

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

• license_not_active (400): The license is not active

• device_not_found (400): An active device matching the hardware_id not found

• missing_headers (400): Some headers are missing