List all organization licenses

Returns a list of organization licenses. The organization licenses are returned sorted by creation date in ascending order.

GET/v3/organizations/{organizationId}/licenses

JWT

organization:license:read

Parameters

Name	Type	In	Description
organizationId*	string	path
page	integer	query	The page number.
limit	integer	query	The number of records per page. Must be a number between 1 and 100.
sort	string	query	The sort string to sort the returned records e.g. "-createdAt"
userGroupId	object	query	Unique identifier of the user group to which the user belongs.
key	object	query	The key associated with the license.
revoked	boolean	query	Whether a license is revoked.
suspended	boolean	query	Whether a license is suspended.
type	object	query	Type of the license.
validity	object	query	The duration after which the license will expire.
subscriptionInterval	object	query	Subscription interval for the license.
allowedActivations	object	query	Allowed number of activations for the license.
allowedDeactivations	object	query	Allowed number of deactivations for the license.
totalActivations	object	query	Total number of activations for the license.
totalDeactivations	object	query	Total number of deactivations for the license.
notes	object	query	The license notes.
metadata.key	object	query	Metadata key associated with the license.
metadata.value	object	query	Metadata value associated with the license.
expiresAt	object	query	Licenses expiring at.
expired	boolean	query	Whether license is expired.
perpetual	boolean	query	Whether license is perpetual.
entitlementSetId	object	query	ID of the linked entitlement set.
search	string	query	Search string.
id	object	query	ID of the resource.
createdAt	object	query	Date of creation
updatedAt	object	query	Date of last update

Responses

200

401

403

404

429

500

200 OK

[
  {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "key": "string",
    "revoked": true,
    "suspended": true,
    "perpetual": true,
    "type": "node-locked",
    "validity": 0,
    "subscriptionInterval": "string",
    "totalActivations": 0,
    "totalDeactivations": 0,
    "allowedActivations": 0,
    "allowedDeactivations": 0,
    "allowedFloatingClients": 0,
    "leaseDuration": 0,
    "expiresAt": "2019-08-24T14:15:22Z",
    "effectiveDate": "2019-08-24T14:15:22Z",
    "notes": "string",
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string"
      }
    ],
    "meterAttributes": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "allowedUses": 0,
        "totalUses": 0,
        "grossUses": 0,
        "floating": true
      }
    ],
    "product": {
      "id": "string",
      "displayName": "string",
      "iconUrl": "string",
      "description": "string"
    },
    "productVersion": {
      "displayName": "string"
    },
    "entitlementSet": {
      "name": "string"
    },
    "userGroups": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "description": "string"
      }
    ]
  }
]