Skip to main content

Lists a page of entitlement usage information

POST 
/api/web/v4/tenants/entitlements/usage

Returns tenant usage information for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported:

  • startTime: a mandatory String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • endTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • tenantId: The UUID of the tenant. Allowed operators are: EQUALS.
  • isTrial: true or false. Allowed operator: EQUALS.
  • usageType: the type of entitlement: USERS, ISSUANCE. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: startTime.

Request​

Responses​

Successful