Skip to main content

Get an entitlement

GET 
/api/web/v4/tenants/:tenantid/entitlements/:type

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

Request​

Path Parameters

    tenantid stringrequired

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

    type stringrequired

    Possible values: [USERS, TRANSACTIONS]

    The type of entitlement (only USERS is supported).

Responses​

Successful

Schema

    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 of this entitlement.

    customerId string

    The customer ID.

    endDate date-timerequired

    The end date of this entitlement in UTC time.

    entitlementId string

    The entitlement ID.

    flashPass

    object

    MobileFlashPass entitlements of a tenant.

    consumed int32

    The entitlements consumed since start date during the entitlement period.

    endDate date-time

    The date when the entitlement will end.

    quantity int32

    The number of FlashPass claims allowed during the period.

    startDate date-time

    The date when the entitlement starts.

    fleetManagement

    object

    FleetManagement entitlements of a tenant.

    addOn string

    Add on column to store fleetManagementOptIn flag

    consumed int32

    The entitlements consumed since start date during the entitlement period.

    endDate date-time

    The date when the entitlement will end.

    quantity int32

    The number of FlashPass claims allowed during the period.

    startDate date-time

    The date when the entitlement starts.

    id stringrequired

    The unique UUID of this entitlement.

    idProofing

    object[]

    The ID Proofing entitlements.

  • Array [

    • billingType stringrequired

    Possible values: [PRE_PAID, PAY_PER_USE]

    The model used for billing.

    consumed int32

    Possible values: >= 1 and <= 50000000

    The entitlements consumed since start date (percent over quantity for PRE_PAID accounts) or in the current month (PAY_PER_USE accounts).

    endDate date-timerequired

    The date this entitlement will end in UTC time. The value must be after the start date.

    faceRecognitionType string

    Possible values: [ENHANCED, STANDARD]

    The face recognitation type licensed.

    quantity int32

    Possible values: >= 1 and <= 50000000

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

    startDate date-timerequired

    The date this entitlement will start in UTC time.

  • ]

    • issuance

    object

    Issuance entitlements of a tenant.

    addOn string

    Add on column to store printer cert flag

    consumed int32

    The entitlements consumed since start date during a Trial period.

    endDate date-time

    The date when the Trial period will end. This value is not returned if the account status is PRODUCTION.

    quantity int32

    The number of print jobs allowed during the Trial period. This value is not returned if the account status is PRODUCTION.

    serviceBundles

    object[]

    required

    The service bundles supported.

  • 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 is not returned if the account status is PRODUCTION.

    payToPrint

    object

    PayToPrint entitlements of a tenant.

    addOn string

    Add on column to store PayToPrint addon

    consumed int32

    The entitlements consumed since start date during the entitlement period.

    endDate date-time

    The date when the entitlement will end.

    quantity int32

    The number of PayToPrint prints allowed during the period.

    startDate date-time

    The date when the entitlement starts.

    printer

    object

    Printer entitlements of a tenant.

    consumed int32

    The entitlements consumed since start date during the entitlement period.

    endDate date-time

    The date when the entitlement will end.

    quantity int32

    The number of FlashPass claims allowed during the period.

    startDate date-time

    The date when the entitlement starts.

    quantity int32required

    The quantity of this entitlement.

    remaining int32

    The unused quantity of this entitlement (USERS type only).

    smartLoginEnabled boolean

    Whether Smart Card Smart Login is enabled or not.

    smsVoice

    object

    Sms/Voice entitlements of a tenant.

    allotment int32

    The number of entitlements allotted to the current account. If the account is an SP then entitlements can be allocated to child accounts.

    consumed int32

    The entitlements consumed since start date during the entitlement period.

    endDate date-time

    The date when the entitlement will end.

    quantity int32

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

    renewalQuantity int32

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

    startDate date-time

    The date when the entitlement starts.

    startDate date-timerequired

    The start date of this entitlement in UTC time.

    status stringrequired

    Possible values: [ACTIVE, INACTIVE, TERMINATED]

    The status of this entitlement.

    type stringrequired

    Possible values: [USERS, TRANSACTIONS]

    The type of this entitlement.

    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.

Loading...