Skip to main content

Entitlement

Properties

NameTypeDescriptionNotes
additionalFeaturesAdditionalFeature[optional]
contractModeContractModeEnumThe contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.[optional]
contractNumberStringThe contract number of this entitlement.[optional]
customerIdStringThe customer ID.[optional]
endDateOffsetDateTimeThe end date of this entitlement in UTC time.
entitlementIdStringThe entitlement ID.[optional]
flashPassMobileFlashPass[optional]
fleetManagementFleetManagement[optional]
idStringThe unique UUID of this entitlement.
idProofingList<IdProofing>The ID Proofing entitlements.[optional]
issuanceIssuance[optional]
payToPrintPayToPrint[optional]
printerPrinterEntitlement[optional]
quantityIntegerThe quantity of this entitlement.
remainingIntegerThe unused quantity of this entitlement (USERS type only).[optional]
smartLoginEnabledBooleanWhether Smart Card Smart Login is enabled or not.[optional]
smsVoiceSmsVoice[optional]
startDateOffsetDateTimeThe start date of this entitlement in UTC time.
statusStatusEnumThe status of this entitlement.
typeTypeEnumThe type of this entitlement.
userBundlesList<ServiceBundle>The entitlement bundles that defines the set of features available for authentication accounts.[optional]
usersBillingTypeUsersBillingTypeEnumThe billing type for user entitlements. Defaults to PRE_PAID if not provided.[optional]

ContractModeEnum

NameValue
PRODUCTION"PRODUCTION"
TRIAL"TRIAL"
UNKNOWN"UNKNOWN"

StatusEnum

NameValue
ACTIVE"ACTIVE"
INACTIVE"INACTIVE"
TERMINATED"TERMINATED"

TypeEnum

NameValue
USERS"USERS"
TRANSACTIONS"TRANSACTIONS"

UsersBillingTypeEnum

NameValue
PRE_PAID"PRE_PAID"
PAY_PER_USE"PAY_PER_USE"