Skip to content

Sets the license-allocation (claim-based) policy on the entitlement.

POST
/api/v1/provision/admin/entitlements/{entitlementId}/policies/license-allocation
curl --request POST \
--url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/policies/license-allocation \
--header 'Content-Type: application/json' \
--data '{ "leaseTime": "example", "gracePeriod": "example", "numberOfSeats": 1, "isFloatingLicense": true, "allowOffLineUse": true, "isTransferableLicense": true, "fingerprintingMethod": "example", "componentMatchingStrategy": 1 }'
entitlementId
required
string format: uuid

Target entitlement.

Policy payload.

Defines allocation and usage policy for a license: seat limits, lease/grace periods, pooling (floating), transfer capability, offline allowance and fingerprinting method.

object
leaseTime

Duration a seat remains leased before renewal is required.

string
/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/
gracePeriod

Extra allowed time after lease expiration before the license is considered invalid.

string
/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/
numberOfSeats

Maximum number of device activations (seats) allowed.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isFloatingLicense

Indicates if seats are drawn from a shared pool (floating license).

boolean
allowOffLineUse

Indicates if a device may continue operating without online validation for a period.

boolean
isTransferableLicense

Indicates if the license can be explicitly transferred to another principal.

boolean
fingerprintingMethod

Identifier for the device fingerprinting method used.

string
componentMatchingStrategy

Strictness of fingerprint-component matching during activation lookup. Defaults to ComponentMatchingStrategy.MatchAll (legacy exact-equality). Only MatchAll and MatchAny are accepted by the server today; the multi-component strategies (MatchTwo, MatchMost) require an SDK that surfaces fingerprint components individually and are reserved for a future release.

integer
Example generated
{
"leaseTime": "example",
"gracePeriod": "example",
"numberOfSeats": 1,
"isFloatingLicense": true,
"allowOffLineUse": true,
"isTransferableLicense": true,
"fingerprintingMethod": "example",
"componentMatchingStrategy": 1
}

OK

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string