Query User ID Agents (v2.0)

POST 
/sdwan/v2.0/api/useridagents/query

Query all the user ID agents.

Request

application/json

Body

Details to query the users.

aggregate Aggregate

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

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

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 UserIDAgentQueryFilter[]
Array [
authentication UserIDAgentAuthentication
The user ID agent authentication details.
collector_name string
Collector Name
collector_secret string
Collector Secret
collector_secret_encrypted string
Collector Secret Encrypted
local_certificate string
Local Certificate
local_private_key string
Local Private Key
passphrase string
Passphrase
remote_ca_certificate string
Remote Ca Certificate
description
The user ID agent description.
enabled boolean
The user ID agent enabled.
id string
The ID.
name stringrequired
The user ID agent name.
port int32required
The user agent port range. Must be between 1 - 65535.
server_fqdn string
The server fqdn.
server_ip string
The user agent server IP.
site_id stringrequired
The site ID.
source_interface string
The user agent server source interface.
tags string[]
An information field that can be added to identify the user agent. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "authentication": {
        "collector_name": "string",
        "collector_secret": "string",
        "collector_secret_encrypted": "string",
        "local_certificate": "string",
        "local_private_key": "string",
        "passphrase": "string",
        "remote_ca_certificate": "string"
      },
      "enabled": true,
      "id": "string",
      "name": "string",
      "port": 0,
      "server_fqdn": "string",
      "server_ip": "string",
      "site_id": "string",
      "source_interface": "string",
      "tags": [
        "string"
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

Loading...