Query Users (2.0)

POST 
/v2.0/api/tenants/:tenant_id/directoryusers/query

Query users of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details to query the users.

aggregate Aggregate

The aggregate number of users 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

Field

name stringrequired

The name of the query response.

operator string

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

Operator

statistic stringrequired

QoS application aggregate statistics.

unit stringrequired

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number users deleted for a time frame.

group_by string[]

Group the users 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.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The count of the query list.

deleted_count int64

The deleted number of queries.

deleted_ids string[]

The deleted query IDs.

description

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 DirectoryUserQueryFilter[]
Array [
description
The description of the user. Max size = 256.
id string
The user ID.
name stringrequired
The user's name.
stale boolean
Stale
tags string[]
A information field that can be added to identify the user. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
The tenant ID.
user_group_ids string[]
The user group IDs to which the user belongs.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "id": "string",
      "name": "string",
      "stale": true,
      "tags": [
        "string"
      ],
      "tenant_id": "string",
      "user_group_ids": [
        "string"
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...