Skip to main content

EntitlementParms

Parameters passed when setting the entitlements of a tenant. Entitlements are required.

Properties

NameTypeDescriptionNotes
AdditionalFeaturesAdditionalFeature[optional]
ContractModestringThe contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.[optional]
ContractNumberstringThe contract number.[optional]
CustomerIdstringThe customer ID.[optional]
EndDateDateTime?The date this entitlement will end. The value must be after the start date. If not specified, this value defaults to the end date of the service provider's entitlement.[optional]
EntitlementIdstringThe entitlement ID.[optional]
FlashPassFlashPassParms[optional]
FleetManagementObjectParameters passed when setting the fleet management entitlements of a tenant.[optional]
IdProofingList<IdProofingParms>The ID Proofing entitlements.[optional]
IssuanceIssuanceParms[optional]
PrinterObjectParameters passed when setting the Printer entitlements of a tenant.[optional]
Quantityint?The number of entitlements assigned to the tenant (required during creation). The service provider must have enough available entitlements to meet this request.[optional]
SmartLoginEnabledbool?Whether Smart Card Smart Login is enabled or not.[optional]
SmsVoiceSmsVoiceParms[optional]
StartDateDateTime?The date this entitlement will start. If not specified, it defaults to the current date. This value cannot be in the future.[optional]
StatusstringThe status of this entitlement.[optional]
TypestringThe type of entitlement. Currently this value must be USERS. If not specified, this value defaults to USERS.[optional]
UsageTypestring[DEPRECATED] The type of entitlement (ignored if type is provided). Currently this value must be USERS. If not specified, this value defaults to USERS.[optional]
UserBundlesList<ServiceBundle>The entitlement bundles that defines the set of features available for authentication accounts.[optional]
UsersBillingTypestringThe billing type for user entitlements. Defaults to PRE_PAID if not provided.[optional]