Skip to main content

Get User ID Agent (v2.0)



Get User ID Agent


Path Parameters

    tenant_id stringrequired

    Tenant ID

    id stringrequired

    User Agent ID


Successful Operation

    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


    remote_ca_certificate string

    Remote Ca Certificate


    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)