Skip to main content

Set an entitlement

PUT 
/api/web/v4/tenants/:tenantid/entitlements

Set the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:EDIT permission from a service provider role.

Request​

Path Parameters

    tenantid stringrequired

    The UUID of the tenant whose entitlement is to be set.

Body

required

    additionalFeatures

    object

    Additional feature

    enhancedGeoLocation boolean

    Enhanced geo location additional feature.

    contractMode string

    Possible values: [PRODUCTION, TRIAL, UNKNOWN]

    The contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.

    contractNumber string

    The contract number.

    customerId string

    The customer ID.

    endDate date-time

    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.

    entitlementId string

    The entitlement ID.

    flashPass

    object

    Parameters passed when setting the Issuance entitlements of a tenant.

    quantity int32

    Possible values: [25, 100]

    The number of FlashPass pass claims allowed during the Trial period.

    fleetManagement object

    Parameters passed when setting the fleet management entitlements of a tenant.

    idProofing

    object[]

    The ID Proofing entitlements.

  • Array [

    • billingType stringrequired

    Possible values: [PRE_PAID, PAY_PER_USE]

    The model used for billing.

    endDate date-timerequired

    The date this entitlement will end (required). The value must be after the start date.

    quantity int32

    Possible values: >= 1 and <= 50000000

    The number of entitlements assigned to the tenant (required if billingType is PRE_PAID).

    startDate date-time

    The date this entitlement will start (required).

  • ]

    • issuance

    object

    Parameters passed when setting the Issuance entitlements of a tenant.

    addOn string

    Add on column to store printer cert flag

    endDate date-time

    The date when the Trial period will end. The value must be after the start date. If specified, this value cannot be more than 30 days after start date.

    quantity int32

    Possible values: [25, 100]

    The number of print jobs allowed during the Trial period.

    serviceBundles

    object[]

    The service bundles supported. At least one bundle must be defined.

  • Array [

    • bundleType stringrequired

    Possible values: [ADVANCED, ESSENTIALS, PROFESSIONAL, API, STANDARD, PLUS, PREMIUM, CONSUMER]

    Identifies the bundle.

    rank int32

    A number that allows to sort bundles of the same category by precedence. Read-only currently.

    usageReportId string

    An identifier used to report usage for this bundle.

  • ]

    • startDate date-time

    The date when the Trial period starts. This value cannot be in the future. If not specified, it defaults to the current date.

    printer object

    Parameters passed when setting the Printer entitlements of a tenant.

    quantity int32

    Possible values: >= 1 and <= 50000000

    The number of entitlements assigned to the tenant (required during creation). The service provider must have enough available entitlements to meet this request.

    smartLoginEnabled boolean

    Whether Smart Card Smart Login is enabled or not.

    smsVoice

    object

    Parameters passed when setting the SMS/Voice entitlements of a tenant.

    endDate date-time

    The date when the entitlement period will end. The value must be after the start date.

    quantity int32

    The number of SMS/Voice credits allowed during the entitlement period.

    renewalQuantity int32

    The number of SMS/Voice credits allowed when the entitlement is renewed.

    startDate date-time

    The date when the entitlement period starts. This value cannot be in the future. If not specified, it defaults to the current date.

    startDate date-time

    The date this entitlement will start. If not specified, it defaults to the current date. This value cannot be in the future.

    status string

    Possible values: [ACTIVE, INACTIVE, TERMINATED]

    The status of this entitlement.

    type string

    Possible values: [USERS, TRANSACTIONS]

    The type of entitlement. Currently this value must be USERS. If not specified, this value defaults to USERS.

    usageType stringdeprecated

    Possible values: [USERS, TRANSACTIONS]

    [DEPRECATED] The type of entitlement (ignored if type is provided). Currently this value must be USERS. If not specified, this value defaults to USERS.

    userBundles

    object[]

    The entitlement bundles that defines the set of features available for authentication accounts.

  • Array [

    • bundleType stringrequired

    Possible values: [ADVANCED, ESSENTIALS, PROFESSIONAL, API, STANDARD, PLUS, PREMIUM, CONSUMER]

    Identifies the bundle.

    rank int32

    A number that allows to sort bundles of the same category by precedence. Read-only currently.

    usageReportId string

    An identifier used to report usage for this bundle.

  • ]

    • usersBillingType string

    Possible values: [PRE_PAID, PAY_PER_USE]

    The billing type for user entitlements. Defaults to PRE_PAID if not provided.

Responses​

Successful

Loading...