Skip to main content

Query Users or Group (2.0)



Query users or groups of a tenant.


Path Parameters

    tenant_id stringrequired

    The tenant ID.


Details to query the users or groups.

    aggregate Aggregate

    The aggregate number of users or groups that match the query parameters.

    data AggregateData[]required

    The details of the aggregate data.

  • Array [
  • value numberrequired

    Value of the aggregate data.

    view objectrequired

    View the aggregate date.

  • ]
  • field string


    name stringrequired

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]


    statistic stringrequired

    QoS application aggregate statistics.

    unit stringrequired

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number users or groups deleted for a time frame.

    group_by string[]

    Group the users or groups for the query.

    id string

    List the users by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object

    Query using query parameters.

    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object

    Specify the order in which you want the search criteria to display.

    total_count int64

    The total number of query parameters.


Successful Operation

    count int32

    The count of the query list.

    deleted_count int64

    The deleted number of queries.

    deleted_ids string[]

    The deleted query IDs.


    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number of queries.

    items DirectoryUserGroupQueryFilter[]
  • Array [
  • description

    Filter with description of the user or group.

    id string

    Filter with the user or group ID.

    name stringrequired

    Filter with the user or group name.

    stale boolean


    tags string[]

    Filter with the tag which is an information field that can be added to identify the user or group. Maximum 10 unique tags of length 1024 each are allowed.

    tenant_id stringrequired

    Filter with the tenant ID.

  • ]