Skip to main content

Query Active User Mappings (v2.0)



Query all the active user mappings of a tenant.



Query details Active user mappings

    aggregate Aggregate

    The aggregate number of active user mappings that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    The field value.

    name string

    The name of the query response.

    operator string

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

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number active user mappings deleted for a time frame.

    group_by string[]

    Group the active user mappings for the query.

    id string

    List the active user mappings 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 actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    total_count int64

    Total number.

    items ActiveUserIPQueryFilter[]
  • Array [
  • add boolean

    Active user added.

    disabled boolean

    Active user disabled.

    disabled_reason string

    Reason to disable the active user.

    id string

    The active user ID.

    inactive boolean

    Active user inactive.

    inactive_reason string

    Reason for active user to be inactive.

    ip stringrequired

    Active user IP.

    last_login_time int64

    Active user last log in time.

    region string

    Region of the active user.

    site_id stringrequired

    The active user site ID.

    user_id string

    The user ID of the user.

    username stringrequired

    The username of the active user.

    valid_until int64

    The active user valid value.

  • ]