Sets whether activating the entitlement requires a hardware key.
const url = 'https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/policies/hardware-key';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"requiredKey":"None","requireTouch":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/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/policies/hardware-key \ --header 'Content-Type: application/json' \ --data '{ "requiredKey": "None", "requireTouch": true }'A license that requires a hardware key activates only through the hardware-key add-on, which verifies the key’s attestation first. The requirement applies to activations from then on: devices already activated keep their licenses until their sessions are released or revoked. Turning the requirement on needs a plan that includes hardware keys; turning it off, or changing the touch setting of a requirement already on, does not.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Target entitlement or offer.
Request Bodyrequired
Section titled “Request Bodyrequired”The key required, and whether it must ask for a touch.
Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Responses
Section titled “Responses”The stored requirement.
Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Example
{ "requiredKey": "None"}Whether activating the entitlement requires a hardware key. A license that requires one activates only through the hardware-key service, which verifies the key’s attestation first.
object
The hardware key an activation must come with; None when none is required.
The key must ask for a touch before it signs, so a person is present at every check.
Example
{ "requiredKey": "None"}The hardware key named is not one the platform knows (license.validation_error).
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Hardware keys are not included in the plan (license.hardware_keys_not_licensed).
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}No such entitlement.
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}