List all licenses

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

GET/v3/licenses
JWTlicense:read

Query parameters

pageinteger

The page number.

Range: [1, 2147483647]Format: int32

limitinteger

The number of records per page. Must be a number between 1 and 100.

Range: [1, 100]Format: int32

sortstring

The sort string to sort the returned records e.g. "-createdAt"

Pattern: ([+-]\w*\.*\w*){1}(\|[+-]\w*){0,5}

customAttributeobject

Custom attribute values associated with the license, filtered as customAttribute.<name>[<op>]=value, e.g. customAttribute.region[eq]=EU. Admin-only — portal audiences can only see values their access level allows, so exposing the filter there would let them infer hidden values.

userIdstring

Unique identifier for the user. A user is associated with a license directly, via a user group, or through the additionalUserIds property.

Length: [0,256]

organizationIdobject

Unique identifier for the organization.

activation.lastSyncedAtobject

The last synced at date of the activation linked to the license.

activation.countryCodeobject

The country code of the activation linked to the license.

productIdobject

Unique identifier for the product.

productVersionIdobject

Unique identifier for the product version.

resellerIdobject

Unique identifier for the reseller.

user.emailobject

Email address of the user.

user.companyobject

Company of the user.

organization.nameobject

Organization associated with the license.

allowVmActivationboolean

Whether activation is allowed inside a virtual machine.

userLockedboolean

Whether activation is locked to the machine user.

expiringSoonboolean

Whether license is about to expire based on the value of expiringSoonEventOffset.

maintenanceExpiringSoonboolean

Whether license maintenance is about to expire based on the value of expiringSoonEventOffset.

expirationStrategystring

Expiration strategy of the license.

subscriptionStartTriggerobject

Subscription start trigger for the license.

tagsobject

Tags associated with the license.

maintenanceExpiresAtobject

Maintenance expiration date of the license.

activatedAtobject

The date when the license was first activated.

lastUsedAtobject

The date when the license was last used at (activated or synced).

includearray of string

Whether to include related entities in the response.

keyobject

The key associated with the license.

revokedboolean

Whether a license is revoked.

suspendedboolean

Whether a license is suspended.

typeobject

Type of the license.

validityobject

The duration after which the license will expire.

subscriptionIntervalobject

Subscription interval for the license.

allowedActivationsobject

Allowed number of activations for the license.

allowedDeactivationsobject

Allowed number of deactivations for the license.

totalActivationsobject

Total number of activations for the license.

totalDeactivationsobject

Total number of deactivations for the license.

notesobject

The license notes.

metadata.keyobject

Metadata key associated with the license.

metadata.valueobject

Metadata value associated with the license.

expiresAtobject

Licenses expiring at.

expiredboolean

Whether license is expired.

perpetualboolean

Whether license is perpetual.

entitlementSetIdobject

ID of the linked entitlement set.

searchstring

Search string.

Length: [0,256]

idobject

ID of the resource.

createdAtobject

Date of creation

updatedAtobject

Date of last update

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

keystringrequired
revokedbooleanrequired
suspendedbooleanrequired
perpetualbooleanrequired
totalActivationsintegerrequired

Format: int32

totalDeactivationsintegerrequired

Format: int32

fingerprintMatchingStrategystringrequired

Allowed values: fuzzy, exact, loose

allowedActivationsintegerrequired

Format: int32

allowedDeactivationsintegerrequired

Format: int32

typestringrequired

Allowed values: node-locked, hosted-floating, on-premise-floating

allowedFloatingClientsintegerrequired

Format: int32

serverSyncGracePeriodintegerrequired

Format: int32

serverSyncIntervalintegerrequired

Format: int32

allowedClockOffsetintegerrequired

Format: int32

cryptoBindingEnabledbooleanrequired
expiringSoonEventOffsetintegerrequired

Format: int32

leaseDurationintegerrequired

Format: int32

leasingStrategystringrequired

Allowed values: per-machine, per-instance

allowVmActivationbooleanrequired
allowContainerActivationbooleanrequired
allowClientLeaseDurationbooleanrequired
userLockedbooleanrequired
requireAuthenticationbooleanrequired
disableGeoLocationbooleanrequired
productIdstringrequired
additionalUserIdsarray of stringrequired
allowedIpRangesarray of stringrequired
allowedIpAddressesarray of stringrequired
disallowedIpAddressesarray of stringrequired
allowedCountriesarray of stringrequired
disallowedCountriesarray of stringrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
meterAttributesarray of objectrequired
tagsarray of stringrequired
subscriptionIntervalstring
subscriptionStartTriggerstring

Allowed values: creation, activation

effectiveDatestring

Format: date-time

expiresAtstring

Format: date-time

activatedAtstring

Format: date-time

lastUsedAtstring

Format: date-time

notesstring
entitlementSetIdstring
productVersionIdstring
maintenancePolicyIdstring
maintenanceExpiresAtstring

Format: date-time

currentReleaseVersionstring
maxAllowedReleaseVersionstring
organizationIdstring
organizationobject
userIdstring
userobject
resellerIdstring
resellerobject
allowedIpRangestring