Get All User ID Agents (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/useridagents

Get All User ID Agents

Request

Path Parameters

tenant_id stringrequired

Tenant ID

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The number of responses.

id string

The ID of the response.

tenant_id string

The ID of the tenant.

items UserIDAgent[]
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: JsonIgnore(value = true)
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.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "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"
      ],
      "tenant_id": "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": "INVALID_JSON_EXTRA_ATTRIBUTE"
      }
    ]
  }
}

Loading...