List all licenses
Returns a list of licenses. The licenses are returned sorted by creation date in ascending order.
GET/v3/licenses
JWT
license:read
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| 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" |
| userId | string | query | Unique identifier for the user. A user is associated with a license directly, via a user group, or through the additionalUserIds property. |
| organizationId | object | query | Unique identifier for the organization. |
| activation.lastSyncedAt | object | query | The last synced at date of the activation linked to the license. |
| activation.countryCode | object | query | The country code of the activation linked to the license. |
| productId | object | query | Unique identifier for the product. |
| productVersionId | object | query | Unique identifier for the product version. |
| resellerId | object | query | Unique identifier for the reseller. |
| user.email | object | query | Email address of the user. |
| user.company | object | query | Company of the user. |
| organization.name | object | query | Organization associated with the license. |
| allowVmActivation | boolean | query | Whether activation is allowed inside a virtual machine. |
| userLocked | boolean | query | Whether activation is locked to the machine user. |
| expiringSoon | boolean | query | Whether license is about to expire based on the value of expiringSoonEventOffset. |
| maintenanceExpiringSoon | boolean | query | Whether license maintenance is about to expire based on the value of expiringSoonEventOffset. |
| expirationStrategy | string | query | Expiration strategy of the license. |
| subscriptionStartTrigger | object | query | Subscription start trigger for the license. |
| tags | object | query | Tags associated with the license. |
| maintenanceExpiresAt | object | query | Maintenance expiration date of the license. |
| activatedAt | object | query | The date when the license was first activated. |
| lastUsedAt | object | query | The date when the license was last used at (activated or synced). |
| 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
429
500