Sign in

v1

latestOpenAPI 3.0.42026-08-062942352.0 MB
OrganizationLicenses

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

Path parameters

organizationIdstring required

Query parameters

pageinteger

The page number.

limitinteger

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

sortstring

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

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Unique identifier of the user group to which the user belongs.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

The key associated with the license.

revokedboolean

Whether a license is revoked.

suspendedboolean

Whether a license is suspended.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Type of the license.

eqinteger

Matches values that are equal to the specified value.

neinteger

Matches values that are not equal to the specified value.

gtinteger

Matches values that are greater than the specified value.

gteinteger

Matches values that are greater than or equal to the specified value.

ltinteger

Matches values that are less than the specified value.

lteinteger

Matches values that are less than or equal to the specified value.

The duration after which the license will expire.

eqstring period

Matches values that are equal to the specified value.

nestring period

Matches values that are not equal to the specified value.

Subscription interval for the license.

eqinteger

Matches values that are equal to the specified value.

neinteger

Matches values that are not equal to the specified value.

gtinteger

Matches values that are greater than the specified value.

gteinteger

Matches values that are greater than or equal to the specified value.

ltinteger

Matches values that are less than the specified value.

lteinteger

Matches values that are less than or equal to the specified value.

Allowed number of activations for the license.

eqinteger

Matches values that are equal to the specified value.

neinteger

Matches values that are not equal to the specified value.

gtinteger

Matches values that are greater than the specified value.

gteinteger

Matches values that are greater than or equal to the specified value.

ltinteger

Matches values that are less than the specified value.

lteinteger

Matches values that are less than or equal to the specified value.

Allowed number of deactivations for the license.

eqinteger

Matches values that are equal to the specified value.

neinteger

Matches values that are not equal to the specified value.

gtinteger

Matches values that are greater than the specified value.

gteinteger

Matches values that are greater than or equal to the specified value.

ltinteger

Matches values that are less than the specified value.

lteinteger

Matches values that are less than or equal to the specified value.

Total number of activations for the license.

eqinteger

Matches values that are equal to the specified value.

neinteger

Matches values that are not equal to the specified value.

gtinteger

Matches values that are greater than the specified value.

gteinteger

Matches values that are greater than or equal to the specified value.

ltinteger

Matches values that are less than the specified value.

lteinteger

Matches values that are less than or equal to the specified value.

Total number of deactivations for the license.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

The license notes.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata key associated with the license.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata value associated with the license.

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Licenses expiring at.

expiredboolean

Whether license is expired.

perpetualboolean

Whether license is perpetual.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

ID of the linked entitlement set.

searchstring

Search string.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

ID of the resource.

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of creation

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of last update

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
keystring required
revokedboolean required
suspendedboolean required
perpetualboolean required
type'node-locked' | 'hosted-floating' | 'on-premise-floating' required
validityinteger nullable
subscriptionIntervalstring nullable
totalActivationsinteger required
totalDeactivationsinteger required
allowedActivationsinteger required
allowedDeactivationsinteger required
allowedFloatingClientsinteger required
leaseDurationinteger required
expiresAtstring date-time nullable
effectiveDatestring date-time nullable
notesstring nullable