Skip to content
Oclavex is in private preview, available to selected users. Public signup is blocked. Request access at [email protected].

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, "fingerprintingMethod": "example", "componentMatchingStrategy": "MatchAll" }'
entitlementId
required
string format: uuid

Target entitlement.

Policy payload.

Defines allocation and usage policy for a license: seat limits, lease/grace periods, pooling (floating), offline activation 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

Allows offline activation: when false, the server refuses to issue an offline activation response for this license. Online activation is not affected.

boolean
fingerprintingMethod

Identifier for the device fingerprinting method used.

string
componentMatchingStrategy

Strictness of fingerprint-component matching during activation lookup. Defaults to ComponentMatchingStrategy.MatchAll (exact-equality). All four strategies are accepted. The tolerant ones (MatchAny, MatchTwo, MatchMost) take effect when the client supplies per-component fingerprint hashes (an SDK node-id provider implementing IComponentNodeIdProvider); activations without components fall back to exact-fingerprint matching.

Allowed values: MatchAll MatchAny MatchTwo MatchMost

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