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, AUTHENTICATIONS, IDPROOFING, ISSUANCE. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: startTime.

Request​

Body

required

    attributes string[]

    Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.

    cursor string

    Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.

    limit int32

    Possible values: >= 1 and <= 100

    Identifies the maximum number of items to include in a page (1-100).

    orderByAttribute

    object

    An attribute used to sort the result from a search.

    ascending booleanrequired

    Identifies whether to order results in ascending order.

    name stringrequired

    Identifies the attribute.

    searchByAttributes

    object[]

    Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.

  • Array [

    • name stringrequired

    Identifies the attribute we are searching for.

    operator stringrequired

    Possible values: [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, EXISTS, NOT_EXISTS]

    Identifies the operator.

    value string

    Identifies the value of the attribute we are searching for.

  • ]

Responses​

Successful

Schema

    paging

    object

    Contains navigation information.

    limit int32required

    Possible values: >= 1 and <= 100

    The page limit used (1-100)

    nextCursor string

    The cursor pointing to the next page.

    prevCursor string

    The cursor pointing to the previous page.

    results

    object[]

    required

    A single page with the list of usage info found.

  • Array [

    • aggregationPeriod stringrequired

    Possible values: [DAILY, WEEKLY, MONTHLY]

    The aggregation period used.

    bundleType string

    The service bundle.

    count int64required

    The entitlements used in the aggregation period.

    endTime stringrequired

    The end time of the aggregation period.

    id stringrequired

    The unique UUID for this usage info.

    startTime stringrequired

    The start time of the aggregation period.

    tenantId stringrequired

    The unique UUID of the tenant.

    trial booleanrequired

    Whether the usage is associated to a trial tenant.

    usageType stringrequired

    Possible values: [USERS, IDPROOFING, ISSUANCE]

    The type of this entitlement.

  • ]

Loading...