Get agent profiles

GET 
/sse/config/v1/mobile-agent/agent-profiles

Retrieve GlobalProtect agent profiles.

Request

Query Parameters

limit number

The maximum number of result objects to return per page.

offset number

The offset of the result entry.

folder stringrequired

Possible values: [Mobile Users]

Responses

200

Get App Settings for GP

application/json

Schema

Schema

data object[]
Array [
agent_ui object
agent_user_override_timeout number
Default value: 0
max_agent_user_overrides number
Default value: 0
passcode string
Possible values: >= 6 characters and <= 64 characters
uninstall_password string
Possible values: >= 6 characters and <= 64 characters
welcome_page object
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 [
key object[]
Array [
name string
negate boolean
value string
Possible values: <= 1024 characters, Value must match regular expression .*
]
name string
negate boolean
]
registry_key object[]
Array [
default_value_data string
Possible values: <= 1024 characters
name string
Possible values: <= 1023 characters
negate boolean
registry_value object[]
Array [
name string
negate boolean
value_data string
]
]
gateways object
external object
list object[]
Array [
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
name string
priority_rule object[]
Array [
name string
priority string
Possible values: [0, 1, 2, 3, 4, 5]
]
]
internal object
list object[]
Array [
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
name string
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 string
Possible values: [connect-method]
Default value: connect-method
value string[]
Possible values: [user-logon, pre-logon, on-demand, pre-logon-then-on-demand], >= 1, <= 1
tunnel-mtu
name string
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 [
key string[]
name stringrequired
Possible values: <= 1023 characters
Preference list
]
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
no object
yes object
name stringrequired
os string[]
Possible values: [Android, Chrome, IoT, Linux, Mac, Windows, WindowsUWP, iOS]
save_user_credentials string
Possible values: [0, 1, 2, 3]
Indicates whether to save user credentials.
• 0 : do not save
• 1 : save
• 2 : save username only
• 3 : only with user fingerprint
source_user string[]
third_party_vpn_clients string[]
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": [
    {
      "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": [
            {
              "key": [
                {
                  "name": "string",
                  "negate": true,
                  "value": "string"
                }
              ],
              "name": "string",
              "negate": true
            }
          ],
          "registry_key": [
            {
              "default_value_data": "string",
              "name": "string",
              "negate": true,
              "registry_value": [
                {
                  "name": "string",
                  "negate": true,
                  "value_data": "string"
                }
              ]
            }
          ]
        }
      },
      "gateways": {
        "external": {
          "list": [
            {
              "choice": {
                "fqdn": "string"
              },
              "manual": false,
              "name": "string",
              "priority_rule": [
                {
                  "name": "string",
                  "priority": "0"
                }
              ]
            }
          ]
        },
        "internal": {
          "list": [
            {
              "choice": {
                "fqdn": "string"
              },
              "name": "string",
              "source_ip": [
                "string"
              ]
            }
          ]
        }
      },
      "gp_app_config": {
        "config": [
          {
            "name": "connect-method",
            "value": [
              "user-logon"
            ]
          },
          {
            "name": "tunnel-mtu",
            "value": [
              1400
            ]
          }
        ]
      },
      "hip_collection": {
        "certificate_profile": "string",
        "collect_hip_data": true,
        "custom_checks": {
          "linux": {
            "process_list": [
              "string"
            ]
          },
          "mac_os": {
            "plist": [
              {
                "key": [
                  "string"
                ],
                "name": "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": {
        "no": {},
        "yes": {}
      },
      "name": "string",
      "os": [
        "Android"
      ],
      "save_user_credentials": "0",
      "source_user": [
        "string"
      ],
      "third_party_vpn_clients": [
        "PAN Virtual Ethernet Adapter"
      ]
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

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

Example (from schema)

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

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

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

Example (from schema)

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

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

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

Example (from schema)

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

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

404

Not Found

application/json

Schema

Schema

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

Example (from schema)

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

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

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

Example (from schema)

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

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...