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

Reads whether activating the entitlement requires a hardware key.

GET
/api/v1/provision/admin/entitlements/{entitlementId}/policies/hardware-key
curl --request GET \
--url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/policies/hardware-key
entitlementId
required
string format: uuid

Target entitlement or offer.

The hardware-key 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
requiredKey

The hardware key an activation must come with; None when none is required.

Allowed values: None YubiKey
requireTouch

The key must ask for a touch before it signs, so a person is present at every check.

boolean

No such entitlement.

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