Activates a license and returns complete license information with metadata.
const url = 'https://example.com/api/v1/provision/activations/license';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"activationCode":"example","fingerprint":"example","components":"example","deviceName":"example","applicationScope":"example","applicationInstanceId":"example","email":"example","requestedLeaseDurationSeconds":1,"targetSoftwareVersion":"example","useInteractiveUser":true,"tryMode":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/activations/license \ --header 'Content-Type: application/json' \ --data '{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": true, "tryMode": true }'Returns the license token with the unsigned metadata around it: the entitlement’s description and license terms link, the activated features’ names and descriptions, and the licensed products with the custom properties marked Public. Prefer this when the client displays license or product information. Error codes same as /jwt endpoint.
Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”License activation request containing activation code, fingerprint, and optional email.
Represents a request to obtain (or check availability for) a license activation. All nullable fields are optional depending on the activation policy.
object
Activation (or license) code required to identify entitlement or activation workflow.
The fingerprint is used to bind the license to a specific device or environment and therefore should be unique (as possible). This acts as identifier for binding a license to a seat.
Optional per-component one-way hashes of the device identity (well-known keys: MachineName, MacAddress, OsVersion, UserName). Enables the entitlement’s ComponentMatchingStrategy (MatchAny/Two/Most) during session-reuse lookup. Additive: when omitted the server falls back to exact-equality on string? LicenseRequestDto.Fingerprint (MatchAll). Values are hashed on-device; raw component values never leave the client.
The device name is optional (but highly recommended) additional information about the device (e.g. for display in management UIs).
The license is bound to restricted to the provided application scope. This is to ensure that the activation code is used only for its intended application.
Identifies the specific application or process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.
End-user email (used for identity verification or association). Optional depending on policy.
Desired lease duration, in seconds. Advisory: the server currently ignores this value and derives the lease duration from the entitlement’s license-allocation policy.
Software version requesting activation (policy may restrict allowed software versions).
When true, the server will resolve the authenticated user’s identity and find entitlements assigned to that user (via EntitlementPrincipal). Requires an authenticated request with a valid user token. The activation code may be omitted when this is true and the user has exactly one assigned entitlement.
When true, string LicenseRequestDto.ActivationCode is read as an offer’s public try code and the server answers with the calling device’s own short-lived license, issuing one if the device has none. string? LicenseRequestDto.Fingerprint is required: the try code is public, so it identifies the offer and never the caller, and a request that names no device is refused.
Examplegenerated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": true, "tryMode": true}Represents a request to obtain (or check availability for) a license activation. All nullable fields are optional depending on the activation policy.
object
Activation (or license) code required to identify entitlement or activation workflow.
The fingerprint is used to bind the license to a specific device or environment and therefore should be unique (as possible). This acts as identifier for binding a license to a seat.
Optional per-component one-way hashes of the device identity (well-known keys: MachineName, MacAddress, OsVersion, UserName). Enables the entitlement’s ComponentMatchingStrategy (MatchAny/Two/Most) during session-reuse lookup. Additive: when omitted the server falls back to exact-equality on string? LicenseRequestDto.Fingerprint (MatchAll). Values are hashed on-device; raw component values never leave the client.
The device name is optional (but highly recommended) additional information about the device (e.g. for display in management UIs).
The license is bound to restricted to the provided application scope. This is to ensure that the activation code is used only for its intended application.
Identifies the specific application or process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.
End-user email (used for identity verification or association). Optional depending on policy.
Desired lease duration, in seconds. Advisory: the server currently ignores this value and derives the lease duration from the entitlement’s license-allocation policy.
Software version requesting activation (policy may restrict allowed software versions).
When true, the server will resolve the authenticated user’s identity and find entitlements assigned to that user (via EntitlementPrincipal). Requires an authenticated request with a valid user token. The activation code may be omitted when this is true and the user has exactly one assigned entitlement.
When true, string LicenseRequestDto.ActivationCode is read as an offer’s public try code and the server answers with the calling device’s own short-lived license, issuing one if the device has none. string? LicenseRequestDto.Fingerprint is required: the try code is public, so it identifies the offer and never the caller, and a request that names no device is refused.
Examplegenerated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": true, "tryMode": true}Represents a request to obtain (or check availability for) a license activation. All nullable fields are optional depending on the activation policy.
object
Activation (or license) code required to identify entitlement or activation workflow.
The fingerprint is used to bind the license to a specific device or environment and therefore should be unique (as possible). This acts as identifier for binding a license to a seat.
Optional per-component one-way hashes of the device identity (well-known keys: MachineName, MacAddress, OsVersion, UserName). Enables the entitlement’s ComponentMatchingStrategy (MatchAny/Two/Most) during session-reuse lookup. Additive: when omitted the server falls back to exact-equality on string? LicenseRequestDto.Fingerprint (MatchAll). Values are hashed on-device; raw component values never leave the client.
The device name is optional (but highly recommended) additional information about the device (e.g. for display in management UIs).
The license is bound to restricted to the provided application scope. This is to ensure that the activation code is used only for its intended application.
Identifies the specific application or process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.
End-user email (used for identity verification or association). Optional depending on policy.
Desired lease duration, in seconds. Advisory: the server currently ignores this value and derives the lease duration from the entitlement’s license-allocation policy.
Software version requesting activation (policy may restrict allowed software versions).
When true, the server will resolve the authenticated user’s identity and find entitlements assigned to that user (via EntitlementPrincipal). Requires an authenticated request with a valid user token. The activation code may be omitted when this is true and the user has exactly one assigned entitlement.
When true, string LicenseRequestDto.ActivationCode is read as an offer’s public try code and the server answers with the calling device’s own short-lived license, issuing one if the device has none. string? LicenseRequestDto.Fingerprint is required: the try code is public, so it identifies the offer and never the caller, and a request that names no device is refused.
Examplegenerated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": true, "tryMode": true}Responses
Section titled “Responses”License activated successfully – returns complete license information.
End user license token with meta data.
object
The signed license JWT the SDK validates offline against the provider’s public key.
Link to the license terms (EULA) the license was issued under: an absolute https URL, or null when the entitlement has none. Unsigned display metadata, read from the entitlement at every issue and refresh.
A feature as activated on an end-user license: the granted value, enablement, trial/grace availability, and optional per-feature expiration.
object
The metric a metered feature’s usage is recorded under, resolved by the issuer. A feature code
and its metric name are deliberately different strings (MIRAGE.IMAGE.RENDERS against
mirage.image.renders) and the server matches a meter by exact metric name, so this is the
only name usage may be reported under. Null for a feature that has no meter, or when the issuer
did not resolve one.
What the feature’s value is counted in (GB, seats, calls), read from the vendor’s catalog at every issue, for showing beside the value. Null for a Boolean feature, or when the catalog names none. Unsigned display metadata, like string? ActivatedFeatureDto.Name.
When true, the feature is withheld for the duration of a trial even if enabled.
The issuer’s verdict that this license explicitly does not grant the feature. Validation treats it as final, while the feature stays present for display — a locked capability can still be shown, and reaching for it is counted as a denied check.
A product covered by the license, with the custom properties the vendor marked Public. Display/catalog metadata carried on the unsigned EndUserLicenseDto envelope, like feature names and descriptions, so it must never gate functionality. The product code and version are also in the signed token (SignedProductDto); gate on that copy.
object
The version of the product the license was issued for, for display; empty when the product has none.
object
A custom key/value property (e.g. on a product) with optional metadata entries.
object
A key/value metadata entry attached to a PropertyValueDto.
object
Whether a custom property is sent to the application with its license.
The license’s meters, one per metric name, with the unit each counts in.
A meter of the license: the metric name its usage is recorded and limited under (the key in the
signed usage_limits claim) and the unit it counts in. Display metadata carried on the unsigned
EndUserLicenseDto envelope, read from the same record as the customer API’s meter
(string MyMonitoredAssetDto.Unit), so both report the same unit. A meter of a feature the
license withholds is left out, as the feature is.
object
What the meter counts, e.g. renders or minutes; null when the meter names none.
Example
{ "products": [ { "propertyValues": { "additionalProperty": { "visibility": "Private" } } } ]}Invalid request data or activation code.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Activation forbidden by policy (e.g., authentication required, user not verified), or every product this application may use is past its End of life and the device has never activated it (license.product_end_of_life).
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Activation code not found or expired.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Device already activated, seat limit exceeded, or the Idempotency-Key was reused for a different request.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Too many requests – rate limit exceeded.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}The caller is signed in and the user directory could not be reached to look the user up (service.unavailable). Nothing was activated; retry with backoff.