List GlobalProtect agent profiles

GET 
/agent-profiles

Retrieve a list of GlobalProtect agent profiles

Request

Query Parameters

name string

The name of the configuration resource

limit number

Default value: 200

The maximum number of results per page

offset number

Default value: 0

The offset into the list of results returned

folder anyrequired

The folder in which the resource is defined

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
name stringrequired
folder string
Default value: Mobile Users
agent_ui object
Agent UI configuration settings
agent_user_override_timeout integer
Possible values: <= 65535
Default value: 0
Agent disabled duration (minutes). A value of 0 means the agent will remain disabled until manually enabled.
max_agent_user_overrides integer
Possible values: <= 25
Default value: 0
The maximum number of times the agent can be disabled. A value of 0 means there are no limits to the number of times the agent can be disabled.
passcode password
Possible values: >= 6 characters and <= 64 characters
The passcode used to disable the agent
uninstall_password password
Possible values: >= 6 characters and <= 32 characters
The password used to uninstall the agent
welcome_page object
The welcome page displayed upon login
page string
authentication_override object
accept_cookie object
cookie_lifetime object
lifetime_in_days number
Possible values: >= 1 and <= 365
lifetime_in_hours number
Possible values: >= 1 and <= 72
lifetime_in_minutes number
Possible values: >= 1 and <= 59
cookie_encrypt_decrypt_cert string
generate_cookie boolean
certificate object
criteria object
certificate_profile string
client_certificate object
local string
scep string
Possible values: <= 255 characters
custom_checks object
criteria object
plist object[]
Array [
name string
key object[]
Array [
name string
negate boolean
value string
Possible values: <= 1024 characters, Value must match regular expression .*
]
negate boolean
]
registry_key object[]
Array [
name string
Possible values: <= 1023 characters
default_value_data string
Possible values: <= 1024 characters
negate boolean
registry_value object[]
Array [
name string
negate boolean
value_data string
]
]
gateways object
external object
list object[]
Array [
name string
choice object
oneOf
fqdn
fqdn string
ip
ip object
ipv4 string
Possible values: <= 100 characters, Value must match regular expression ^([:0-9.])+$
ipv6 string
Possible values: <= 100 characters
manual boolean
If this GlobalProtect gateway can be manually selected
priority_rule object[]
Array [
name string
priority
Possible values: [0, 1, 2, 3, 4, 5]
]
]
internal object
list object[]
Array [
name string
choice object
oneOf
fqdn
fqdn string
ip
ip object
ipv4 string
Possible values: <= 100 characters, Value must match regular expression ^([:0-9.])+$
ipv6 string
Possible values: <= 100 characters
source_ip string[]
]
gp_app_config object
config object[]
Currently we only support connect-method and tunnel-mtu as app-config
Array [
anyOf
connect-method
name
Possible values: [connect-method]
Default value: connect-method
value undefined[]
Possible values: [user-logon, pre-logon, on-demand, pre-logon-then-on-demand], >= 1, <= 1
tunnel-mtu
name
Possible values: [tunnel-mtu]
Default value: tunnel-mtu
value number[]
Possible values: >= 1, <= 1
GlobalProtect Connection MTU (bytes)
]
hip_collection object
certificate_profile string
collect_hip_data boolean
custom_checks object
linux object
process_list string[]
mac_os object
plist object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Preference list
key string[]
]
process_list string[]
windows object
process_list string[]
registry_key object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Registry key
registry_value string[]
]
exclusion object
category object[]
Array [
name string
vendor object[]
Array [
name string
product string[]
]
]
max_wait_time number
Possible values: >= 10 and <= 60
internal_host_detection object
hostname string
Possible values: <= 256 characters, Value must match regular expression ^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
ip_address string
Internal IPv4 address of a host
internal_host_detection_v6 object
hostname string
Possible values: <= 256 characters, Value must match regular expression ^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
ip_address string
Internal IPv6 address of a host
machine_account_exists_with_serialno object
yes object
no object
os undefined[]
Possible values: [Android, Chrome, IoT, Linux, Mac, Windows, WindowsUWP, iOS]
save_user_credentials
Possible values: [0, 1, 2, 3]
source_user string[]
third_party_vpn_clients undefined[]
Possible values: [PAN Virtual Ethernet Adapter, Juniper Network Virtual Adapter, Cisco Systems VPN Adapter]
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "name": "string",
      "folder": "Mobile Users",
      "agent_ui": {
        "agent_user_override_timeout": 0,
        "max_agent_user_overrides": 0,
        "passcode": "string",
        "uninstall_password": "string",
        "welcome_page": {
          "page": "string"
        }
      },
      "authentication_override": {
        "accept_cookie": {
          "cookie_lifetime": {
            "lifetime_in_days": 0,
            "lifetime_in_hours": 0,
            "lifetime_in_minutes": 0
          }
        },
        "cookie_encrypt_decrypt_cert": "string",
        "generate_cookie": true
      },
      "certificate": {
        "criteria": {
          "certificate_profile": "string"
        }
      },
      "client_certificate": {
        "local": "string",
        "scep": "string"
      },
      "custom_checks": {
        "criteria": {
          "plist": [
            {
              "name": "string",
              "key": [
                {
                  "name": "string",
                  "negate": true,
                  "value": "string"
                }
              ],
              "negate": true
            }
          ],
          "registry_key": [
            {
              "name": "string",
              "default_value_data": "string",
              "negate": true,
              "registry_value": [
                {
                  "name": "string",
                  "negate": true,
                  "value_data": "string"
                }
              ]
            }
          ]
        }
      },
      "gateways": {
        "external": {
          "list": [
            {
              "name": "string",
              "choice": {
                "fqdn": "string"
              },
              "manual": false,
              "priority_rule": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        "internal": {
          "list": [
            {
              "name": "string",
              "choice": {
                "fqdn": "string"
              },
              "source_ip": [
                "string"
              ]
            }
          ]
        }
      },
      "gp_app_config": {
        "config": [
          {
            "value": [
              null
            ]
          },
          {
            "value": [
              1400
            ]
          }
        ]
      },
      "hip_collection": {
        "certificate_profile": "string",
        "collect_hip_data": true,
        "custom_checks": {
          "linux": {
            "process_list": [
              "string"
            ]
          },
          "mac_os": {
            "plist": [
              {
                "name": "string",
                "key": [
                  "string"
                ]
              }
            ],
            "process_list": [
              "string"
            ]
          },
          "windows": {
            "process_list": [
              "string"
            ],
            "registry_key": [
              {
                "name": "string",
                "registry_value": [
                  "string"
                ]
              }
            ]
          }
        },
        "exclusion": {
          "category": [
            {
              "name": "string",
              "vendor": [
                {
                  "name": "string",
                  "product": [
                    "string"
                  ]
                }
              ]
            }
          ]
        },
        "max_wait_time": 0
      },
      "internal_host_detection": {
        "hostname": "string",
        "ip_address": "string"
      },
      "internal_host_detection_v6": {
        "hostname": "string",
        "ip_address": "string"
      },
      "machine_account_exists_with_serialno": {
        "yes": {},
        "no": {}
      },
      "os": [
        null
      ],
      "source_user": [
        "string"
      ],
      "third_party_vpn_clients": [
        null
      ]
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...