Licenses for User

{ "name" "list user licenses", "method" "get", "url" "/api/v4/user licenses", "description" "returns a list of licenses assigned to a user for a product (only for user based product licenses)", "tab" "examples", "examples" { "languages" \[ { "id" "njooa8sw1kofn5ipwkm0f", "language" "javascript", "code" "const headers = new headers();\nheaders append(\\"accept\\", \\"application/json\\");\nheaders append(\\"date\\", \\"date string\\");\nheaders append(\\"authorization\\", \\"authorization string\\");\n\nconst requestoptions = {\n method 'get',\n headers headers,\n redirect 'follow'\n};\n\nconst queryparams = new urlsearchparams({\n product 'product string',\n username 'username string',\n password 'password string',\n})\n tostring();\n\nfetch(\\"/api/v4/user licenses?\\" + queryparams, requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "wsr6xyqvbnw2phl9kw0c7", "language" "curl", "code" "curl location request get '/api/v4/user licenses?product=product string\&username=username string\&password=password string' \\\\\n header 'accept application/json' \\\\\n header 'date date string' \\\\\n header 'authorization authorization string'\n\n# note since this is a get request, make sure the query parameters are url encoded", "customlabel" "" } ], "selectedlanguageid" "wsr6xyqvbnw2phl9kw0c7" }, "results" { "languages" \[ { "id" "1jlwp1hw3a0 jxhz6u2 d", "language" "200", "customlabel" "", "code" "\[\n {\n \\"license\\" {\n \\"id\\" 10003,\n \\"order store id\\" \\"store id for order 3\\",\n \\"license active\\" true,\n \\"license enabled\\" true,\n \\"license type\\" \\"perpetual\\",\n \\"is trial\\" false,\n \\"max license users\\" 1,\n \\"validity period\\" null,\n \\"enable maintenance period\\" false,\n \\"maintenance period\\" null,\n \\"allow grace period\\" false,\n \\"grace period\\" 0,\n \\"max activations\\" 1,\n \\"allow unlimited activations\\" false,\n \\"times activated\\" 1,\n \\"start date\\" null,\n \\"transfer count\\" 0,\n \\"max transfers\\" 0,\n \\"allow overages\\" false,\n \\"max overages\\" 0,\n \\"is floating cloud\\" false,\n \\"is floating\\" false,\n \\"floating timeout\\" 120,\n \\"can borrow\\" false,\n \\"max borrow time\\" 0,\n \\"prevent vm\\" false,\n \\"custom fields\\" \[],\n \\"product features\\" \[],\n \\"customer\\" {\n \\"email\\" \\"somecustomer\@somedomain com\\",\n \\"company name\\" \\"some company\\",\n \\"reference\\" \\"ref for customer 1\\",\n \\"phone\\" \\"\\",\n \\"first name\\" \\"\\",\n \\"last name\\" \\"\\",\n \\"city\\" \\"\\",\n \\"postcode\\" \\"\\",\n \\"state\\" \\"\\",\n \\"country\\" \\"\\",\n \\"address\\" \\"\\",\n \\"customer account\\" null,\n \\"metadata\\" {}\n },\n \\"product details\\" {\n \\"product id\\" 10006,\n \\"product name\\" \\"user product\\",\n \\"short code\\" \\"up\\",\n \\"authorization method\\" \\"user\\",\n \\"metadata\\" {}\n },\n \\"metadata\\" {},\n \\"is hardware key auth\\" false,\n \\"is air gapped\\" false\n },\n \\"user\\" {\n \\"id\\" 10003,\n \\"email\\" \\"someuser\@somedomain com\\",\n \\"first name\\" \\"some\\",\n \\"last name\\" \\"user\\",\n \\"phone number\\" \\"\\",\n \\"is initial password\\" true,\n \\"max activations\\" 1,\n \\"allow unlimited activations\\" false,\n \\"total activations\\" 1\n }\n },\n {\n \\"license\\" {\n \\"id\\" 1719215304208059,\n \\"order store id\\" \\"trial 1719215304208039\\",\n \\"license active\\" true,\n \\"license enabled\\" true,\n \\"license type\\" \\"perpetual\\",\n \\"is trial\\" true,\n \\"max license users\\" 1,\n \\"validity period\\" \\"2031 03 16\\",\n \\"enable maintenance period\\" false,\n \\"maintenance period\\" null,\n \\"allow grace period\\" false,\n \\"grace period\\" 0,\n \\"max activations\\" 1,\n \\"allow unlimited activations\\" false,\n \\"times activated\\" 1,\n \\"start date\\" null,\n \\"transfer count\\" 3,\n \\"max transfers\\" 2,\n \\"allow overages\\" false,\n \\"max overages\\" 0,\n \\"is floating cloud\\" false,\n \\"is floating\\" false,\n \\"floating timeout\\" 120,\n \\"can borrow\\" false,\n \\"max borrow time\\" 0,\n \\"prevent vm\\" false,\n \\"custom fields\\" \[],\n \\"product features\\" \[],\n \\"customer\\" {\n \\"email\\" \\"someuser\@somedomain com\\",\n \\"company name\\" \\"\\",\n \\"reference\\" \\"\\",\n \\"phone\\" \\"\\",\n \\"first name\\" \\"\\",\n \\"last name\\" \\"\\",\n \\"city\\" \\"\\",\n \\"postcode\\" \\"\\",\n \\"state\\" \\"\\",\n \\"country\\" \\"\\",\n \\"address\\" \\"\\",\n \\"customer account\\" null,\n \\"metadata\\" {}\n },\n \\"product details\\" {\n \\"product id\\" 10006,\n \\"product name\\" \\"user product\\",\n \\"short code\\" \\"up\\",\n \\"authorization method\\" \\"user\\",\n \\"metadata\\" {}\n },\n \\"metadata\\" {},\n \\"is hardware key auth\\" false,\n \\"is air gapped\\" false,\n \\"trial days\\" 15\n },\n \\"user\\" {\n \\"id\\" 10003,\n \\"email\\" \\"someuser\@somedomain com\\",\n \\"first name\\" \\"some\\",\n \\"last name\\" \\"user\\",\n \\"phone number\\" \\"\\",\n \\"is initial password\\" true,\n \\"max activations\\" 1,\n \\"allow unlimited activations\\" false,\n \\"total activations\\" 1\n }\n }\n]" }, { "id" "0ujeuvgav19ifssakozvk", "language" "404", "customlabel" "", "code" "" } ], "selectedlanguageid" "0ujeuvgav19ifssakozvk" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "product", "kind" "optional", "type" "string", "description" "short code of product, filters results by specified product", "children" \[] }, { "name" "username", "kind" "optional", "type" "string", "description" "user's username (if using user authentication, not sso authentication)", "children" \[] }, { "name" "password", "kind" "optional", "type" "string", "description" "user's password (if using user authentication, not sso authentication)", "children" \[] }, { "name" "customer account code", "kind" "optional", "type" "string", "description" "required if using sso (see section below) this is the customer account code to which sso provider is configured", "children" \[] }, { "name" "id token", "kind" "optional", "type" "string", "description" "required if using sso (see section below) this is the id token received from the sso if implicit grant authorization method is being used ", "children" \[] }, { "name" "code", "kind" "optional", "type" "string", "description" "required if using sso (see section below) this is the code received from the sso if authorization code grant method is being used ", "children" \[] } ], "headerparameters" \[ { "name" "date", "kind" "required", "type" "string", "description" "in rfc7231 format (see \\"license api authorization\\"), eg thu, 17 nov 2022 20 51 35 gmt", "children" \[] }, { "name" "authorization", "kind" "required", "type" "string", "description" "see \\"license api authorization\\" article", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } schema request query parameters type licensesforuserrequestparameters = { product string, } & ({ // for username and password authentication username string password string } | { // for single sign on implicit grant authentication id token string customer account code string } | { // for single sign on using authorization code grant authentication code string customer account code string }) 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 } ] } response body type licenselistresponsebody = ({ id number, allow grace period boolean, allow overages boolean, allow unlimited activations boolean, borrowed until string | null, // in iso 8601 format (always in utc timezone), e g 2024 09 27t23 30 48 016z or 2024 09 27 23 30 can borrow boolean, channel string, device id number, enable maintenance period boolean environment string, eula link string, floating timeout number, grace period number, hash md5 string, installation file string, is air gapped boolean, is borrowed boolean, is expired boolean, is floating cloud boolean, is floating boolean, is hardware key auth boolean, license active boolean, license enabled boolean, license signature string, license signature v2 string, offline signature string, license type string, 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, prevent vm boolean, release date string, release notes link string, requires version string, size string, start date string | null, times activated number, transfer count number, validity period string | null, // string is in dateiso8601utc format version string, company { id number }, product features ({ id number, code string, name string, expiry date string, metadata json, feature type 'activation' | 'consumption', is floating boolean, is floating cloud boolean, // 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 unlimited consumptions boolean, total consumptions number, allow overages number, max overages number, reset consumption boolean, consumption period 'daily' | 'weekly' | 'monthly' | 'annualy' | null, })\[], custom fields ({ name string, data type 'numer' | '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 string | null, metadata json, }, product details { product id number, product name string, short code string, authorization method 'license key' | 'user', metadata json, }, // note all licenses in this response are for user based products 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 }, metadata json, // the following property is only present if is trial=true trial days number, // the following properties is 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, reset consumption boolean, consumption period string | null, // string is in dateiso8601utc format })\[]; 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" }, "company" { "type" "object", "properties" {"id" { "type" "number" } } }, "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 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 { 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