License API
License Activation/Deactivatio...

Deactivate Bundle (Online Method)

10min
schema request body type licenseactivationrequestbody = ({ // 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 }) & { // required properties hardware id string product string // optional properties 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", "code", "customer account code"], "additionalproperties" false }, { "type" "object", "properties" { "code" { "type" "string" }, "customer account code" { "type" "string" } }, "required" \["id token", "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 } ] } response body if the request succeeds, the endpoint responds with the http code 200 and the string license deactivated 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 the property 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