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}'};
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 }'Returns extended metadata: provider info, legal notices, public key for token verification, licensed product IDs. Prefer this when the client needs to display legal / product information or cache verification key. Error codes same as /jwt endpoint.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Optional Idempotency-Key header, reserved for future use. Re-activating the same device returns the existing session (see remarks); this header is not yet independently enforced.
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. Use instead of former RequestedLeasePeriod (which incorrectly used DateTime).
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.
Example generated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": 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. Use instead of former RequestedLeasePeriod (which incorrectly used DateTime).
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.
Example generated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": 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. Use instead of former RequestedLeasePeriod (which incorrectly used DateTime).
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.
Example generated
{ "activationCode": "example", "fingerprint": "example", "components": "example", "deviceName": "example", "applicationScope": "example", "applicationInstanceId": "example", "email": "example", "requestedLeaseDurationSeconds": 1, "targetSoftwareVersion": "example", "useInteractiveUser": true}Responses
Section titled “ Responses ”License activated successfully – returns complete license information.
End user license token with meta data.
object
object
Example generated
{ "licenseToken": "example", "version": 1, "legalNotice": "example", "copyright": "example", "providerUrl": "example", "providerEmail": "example", "description": "example", "licensedProducts": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "activatedFeatures": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "featureCode": "example", "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "moduleName": "example", "featurePath": "example", "name": "example", "description": "example", "value": "example", "version": "example", "isEnabled": true, "isAvailableDuringTrialPeriod": true, "isAvailableDuringGracePeriod": true, "featureExpiration": "2026-04-15T12:00:00Z" } ]}Invalid request data or activation code.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Activation forbidden by policy (e.g., authentication required, user not verified).
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Activation code not found or expired.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Device already activated or seat limit exceeded.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Too many requests – rate limit exceeded.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}