Get entitlements for tenant
GET/api/web/v4/tenants/:tenantid/entitlements
Get all entitlements for the specified tenant of the current service provider. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.
Request
Path Parameters
The UUID of the tenant whose entitlements are to be fetched.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
]
additionalFeatures
object
Additional feature
Enhanced geo location additional feature.
Possible values: [PRODUCTION
, TRIAL
, UNKNOWN
]
The contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.
The contract number of this entitlement.
The customer ID.
The end date of this entitlement in UTC time.
The entitlement ID.
flashPass
object
MobileFlashPass entitlements of a tenant.
The entitlements consumed since start date during the entitlement period.
The date when the entitlement will end.
The number of FlashPass claims allowed during the period.
The date when the entitlement starts.
fleetManagement
object
FleetManagement entitlements of a tenant.
Add on column to store fleetManagementOptIn flag
The entitlements consumed since start date during the entitlement period.
The date when the entitlement will end.
The number of FlashPass claims allowed during the period.
The date when the entitlement starts.
The unique UUID of this entitlement.
idProofing
object[]
The ID Proofing entitlements.
Possible values: [PRE_PAID
, PAY_PER_USE
]
The model used for billing.
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).
The date this entitlement will end in UTC time. The value must be after the start date.
Possible values: [ENHANCED
, STANDARD
]
The face recognitation type licensed.
Possible values: >= 1
and <= 50000000
The number of entitlements assigned to the tenant (required during creation if billingType is PRE_PAID).
The date this entitlement will start in UTC time.
issuance
object
Issuance entitlements of a tenant.
Add on column to store printer cert flag
The entitlements consumed since start date during a Trial period.
The date when the Trial period will end. This value is not returned if the account status is PRODUCTION.
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.
Possible values: [ADVANCED
, ESSENTIALS
, PROFESSIONAL
, API
, STANDARD
, PLUS
, PREMIUM
, CONSUMER
]
Identifies the bundle.
A number that allows to sort bundles of the same category by precedence. Read-only currently.
An identifier used to report usage for this bundle.
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.
Add on column to store PayToPrint addon
The entitlements consumed since start date during the entitlement period.
The date when the entitlement will end.
The number of PayToPrint prints allowed during the period.
The date when the entitlement starts.
printer
object
Printer entitlements of a tenant.
The entitlements consumed since start date during the entitlement period.
The date when the entitlement will end.
The number of FlashPass claims allowed during the period.
The date when the entitlement starts.
The quantity of this entitlement.
The unused quantity of this entitlement (USERS type only).
Whether Smart Card Smart Login is enabled or not.
smsVoice
object
Sms/Voice entitlements of a tenant.
The number of entitlements allotted to the current account. If the account is an SP then entitlements can be allocated to child accounts.
The entitlements consumed since start date during the entitlement period.
The date when the entitlement will end.
The number of SMS/Voice credits allowed during the period.
The number of SMS/Voice credits allowed when the entitlement is renewed.
The date when the entitlement starts.
The start date of this entitlement in UTC time.
Possible values: [ACTIVE
, INACTIVE
, TERMINATED
]
The status of this entitlement.
Possible values: [USERS
, TRANSACTIONS
]
The type of this entitlement.
userBundles
object[]
The entitlement bundles that defines the set of features available for authentication accounts.
Possible values: [ADVANCED
, ESSENTIALS
, PROFESSIONAL
, API
, STANDARD
, PLUS
, PREMIUM
, CONSUMER
]
Identifies the bundle.
A number that allows to sort bundles of the same category by precedence. Read-only currently.
An identifier used to report usage for this bundle.
Possible values: [PRE_PAID
, PAY_PER_USE
]
The billing type for user entitlements. Defaults to PRE_PAID if not provided.
[
{
"additionalFeatures": {
"enhancedGeoLocation": true
},
"contractMode": "PRODUCTION",
"contractNumber": "string",
"customerId": "string",
"endDate": "2020-02-18T23:59:59Z",
"entitlementId": "string",
"flashPass": {
"consumed": 0,
"endDate": "2020-02-19T00:00:00Z",
"quantity": 1000,
"startDate": "2019-02-19T00:00:00Z"
},
"fleetManagement": {
"addOn": "string",
"consumed": 0,
"endDate": "2020-02-19T00:00:00Z",
"quantity": 1000,
"startDate": "2019-02-19T00:00:00Z"
},
"id": "string",
"idProofing": [
{
"billingType": "PRE_PAID",
"consumed": 0,
"endDate": "2020-02-18T23:59:59Z",
"faceRecognitionType": "ENHANCED",
"quantity": 0,
"startDate": "2019-02-19T00:00:00Z"
}
],
"issuance": {
"addOn": "string",
"consumed": 0,
"endDate": "2019-02-19T00:00:00Z",
"quantity": 25,
"serviceBundles": [
{
"bundleType": "ADVANCED",
"rank": 1000,
"usageReportId": "SIG_CTR-474988"
}
],
"startDate": "2019-02-19T00:00:00Z"
},
"payToPrint": {
"addOn": "string",
"consumed": 0,
"endDate": "2020-02-19T00:00:00Z",
"quantity": 1000,
"startDate": "2019-02-19T00:00:00Z"
},
"printer": {
"consumed": 0,
"endDate": "2020-02-19T00:00:00Z",
"quantity": 1000,
"startDate": "2019-02-19T00:00:00Z"
},
"quantity": 200,
"remaining": 37,
"smartLoginEnabled": true,
"smsVoice": {
"allotment": 400,
"consumed": 0,
"endDate": "2020-02-19T00:00:00Z",
"quantity": 1000,
"renewalQuantity": 1000,
"startDate": "2019-02-19T00:00:00Z"
},
"startDate": "2019-02-19T00:00:00Z",
"status": "ACTIVE",
"type": "USERS",
"userBundles": [
{
"bundleType": "ADVANCED",
"rank": 1000,
"usageReportId": "SIG_CTR-474988"
}
],
"usersBillingType": "PRE_PAID"
}
]
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}