Create agent profiles
Create GlobalProtect agent profiles.
Query Parameters
Possible values: [Mobile Users
]
Request Body
The app settings for Global Protect you want to create
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
0
: do not save1
: save2
: save username only3
: only with user fingerprint
agent_ui object
Default value: 0
Default value: 0
Possible values: >= 6 characters
and <= 64 characters
Possible values: >= 6 characters
and <= 64 characters
welcome_page object
authentication_override object
accept_cookie object
cookie_lifetime object
Possible values: >= 1
and <= 365
Possible values: >= 1
and <= 72
Possible values: >= 1
and <= 59
certificate object
criteria object
client_certificate object
Possible values: <= 255 characters
custom_checks object
criteria object
plist object[]
key object[]
Possible values: <= 1024 characters
, Value must match regular expression .*
registry_key object[]
Possible values: <= 1024 characters
Possible values: <= 1023 characters
registry_value object[]
gateways object
external object
list object[]
choice object
ip object
Possible values: <= 100 characters
, Value must match regular expression ^([:0-9.])+$
Possible values: <= 100 characters
Default value: false
If this GlobalProtect gateway can be manually selected
priority_rule object[]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
internal object
list object[]
choice object
ip object
Possible values: <= 100 characters
, Value must match regular expression ^([:0-9.])+$
Possible values: <= 100 characters
gp_app_config object
config object[]
Currently we only support connect-method and tunnel-mtu as app-config
Possible values: [connect-method
]
Default value: connect-method
Possible values: [user-logon
, pre-logon
, on-demand
, pre-logon-then-on-demand
], >= 1
, <= 1
Possible values: [tunnel-mtu
]
Default value: tunnel-mtu
Possible values: >= 1
, <= 1
GlobalProtect Connection MTU (bytes)
hip_collection object
custom_checks object
linux object
mac_os object
plist object[]
Possible values: <= 1023 characters
Preference list
windows object
registry_key object[]
Possible values: <= 1023 characters
Registry key
exclusion object
category object[]
vendor object[]
Possible values: >= 10
and <= 60
internal_host_detection object
Possible values: <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
Internal IPv4 address of a host
internal_host_detection_v6 object
Possible values: <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
Internal IPv6 address of a host
machine_account_exists_with_serialno object
Possible values: [Android
, Chrome
, IoT
, Linux
, Mac
, Windows
, WindowsUWP
, iOS
]
Possible values: [0
, 1
, 2
, 3
]
Indicates whether to save user credentials.
Possible values: [PAN Virtual Ethernet Adapter
, Juniper Network Virtual Adapter
, Cisco Systems VPN Adapter
]
- 201
- 400
- 401
- 403
- 409
- default
Created
Bad Request
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Input Format Mismatch: input-format=json"
}
],
"_request_id": "abcd-1234"
}
Invalid Object
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Object"
}
],
"_request_id": "abcd-1234"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_request_id": "abcd-1234"
}
Missing Body
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Body"
}
],
"_request_id": "abcd-1234"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Query Parameter: name"
}
],
"_request_id": "abcd-1234"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Output Format Mismatch: output-format=json Accept=xml"
}
],
"_request_id": "abcd-1234"
}
Unauthorized
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Not Authenticated"
}
],
"_request_id": "abcd-1234"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Invalid Credential"
}
],
"_request_id": "abcd-1234"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Expired"
}
],
"_request_id": "abcd-1234"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Too Long"
}
],
"_request_id": "abcd-1234"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "The password needs to be changed."
}
],
"_request_id": "abcd-1234"
}
Forbidden
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Conflict
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Name Not Unique
{
"_errors": [
{
"code": "E006",
"details": {},
"message": "Name Not Unique"
}
],
"_request_id": "abcd-1234"
}
Object Not Unique
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Object Not Unique"
}
],
"_request_id": "abcd-1234"
}
Reference Not Zero
{
"_errors": [
{
"code": "E009",
"details": {},
"message": "Reference Not Zero"
}
],
"_request_id": "abcd-1234"
}
General Errors
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Action Not Supported: move"
}
],
"_request_id": "abcd-1234"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"details": {},
"message": "Bad XPath"
}
],
"_request_id": "abcd-1234"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Command"
}
],
"_request_id": "abcd-1234"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Malformed Command"
}
],
"_request_id": "abcd-1234"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Method Not Supported"
}
],
"_request_id": "abcd-1234"
}
Session Timeout
{
"_errors": [
{
"code": 4,
"details": {},
"message": "Session Timeout"
}
],
"_request_id": "abcd-1234"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Version Not Supported"
}
],
"_request_id": "abcd-1234"
}