Skip to main content

EntitlementParms

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

Properties

NameTypeDescriptionNotes
additionalFeaturesAdditionalFeature[optional]
contractModeContractModeEnumThe contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.[optional]
contractNumberStringThe contract number.[optional]
customerIdStringThe customer ID.[optional]
endDateOffsetDateTimeThe 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]
quantityIntegerThe number of entitlements assigned to the tenant (required during creation). The service provider must have enough available entitlements to meet this request.[optional]
smartLoginEnabledBooleanWhether Smart Card Smart Login is enabled or not.[optional]
smsVoiceSmsVoiceParms[optional]
startDateOffsetDateTimeThe date this entitlement will start. If not specified, it defaults to the current date. This value cannot be in the future.[optional]
statusStatusEnumThe status of this entitlement.[optional]
typeTypeEnumThe type of entitlement. Currently this value must be USERS. If not specified, this value defaults to USERS.[optional]
usageTypeUsageTypeEnum[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]
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"

UsageTypeEnum

NameValue
USERS"USERS"
TRANSACTIONS"TRANSACTIONS"

UsersBillingTypeEnum

NameValue
PRE_PAID"PRE_PAID"
PAY_PER_USE"PAY_PER_USE"