Create agent profiles
Create GlobalProtect agent profiles.
Query Parameters
- folder string required
Possible values: [
Mobile Users
]
- application/json
Request Body
The app settings for Global Protect you want to create
agent_ui object
agent_user_override_timeout numberDefault value:
0
max_agent_user_overrides numberDefault value:
0
passcode stringPossible values:
>= 6 characters
and<= 64 characters
uninstall_password stringPossible values:
>= 6 characters
and<= 64 characters
welcome_page object
page stringauthentication_override object
accept_cookie object
cookie_lifetime object
lifetime_in_days numberPossible values:
>= 1
and<= 365
lifetime_in_hours numberPossible values:
>= 1
and<= 72
lifetime_in_minutes numberPossible values:
>= 1
and<= 59
cookie_encrypt_decrypt_cert stringgenerate_cookie booleancertificate object
criteria object
certificate_profile stringclient_certificate object
local stringscep stringPossible values:
<= 255 characters
custom_checks object
criteria object
plist object[]
Array [key object[]
Array [name stringnegate booleanvalue stringPossible values:
<= 1024 characters
, Value must match regular expression.*
]name stringnegate boolean]registry_key object[]
Array [default_value_data stringPossible values:
<= 1024 characters
name stringPossible values:
<= 1023 characters
negate booleanregistry_value object[]
Array [name stringnegate booleanvalue_data string]]gateways object
external object
list object[]
Array [choice object
- oneOf
- fqdn
- ip
fqdn stringip object
ipv4 stringPossible values:
<= 100 characters
, Value must match regular expression^([:0-9.])+$
ipv6 stringPossible values:
<= 100 characters
manual booleanDefault value:
false
If this GlobalProtect gateway can be manually selected
name stringpriority_rule object[]
Array [name stringpriority stringPossible values: [
0
,1
,2
,3
,4
,5
]]]internal object
list object[]
Array [choice object
- oneOf
- fqdn
- ip
fqdn stringip object
ipv4 stringPossible values:
<= 100 characters
, Value must match regular expression^([:0-9.])+$
ipv6 stringPossible values:
<= 100 characters
name stringsource_ip string[]]gp_app_config object
config object[]
Currently we only support connect-method and tunnel-mtu as app-config
Array [- anyOf
- connect-method
- tunnel-mtu
name stringPossible values: [
connect-method
]Default value:
connect-method
value string[]Possible values: [
user-logon
,pre-logon
,on-demand
,pre-logon-then-on-demand
],>= 1
,<= 1
name stringPossible values: [
tunnel-mtu
]Default value:
tunnel-mtu
value number[]Possible values:
>= 1
,<= 1
GlobalProtect Connection MTU (bytes)
]hip_collection object
certificate_profile stringcollect_hip_data booleancustom_checks object
linux object
process_list string[]mac_os object
plist object[]
Array [key string[]name string requiredPossible values:
<= 1023 characters
Preference list
]process_list string[]windows object
process_list string[]registry_key object[]
Array [name string requiredPossible values:
<= 1023 characters
Registry key
registry_value string[]]exclusion object
category object[]
Array [name stringvendor object[]
Array [name stringproduct string[]]]max_wait_time numberPossible values:
>= 10
and<= 60
internal_host_detection object
hostname stringPossible values:
<= 256 characters
, Value must match regular expression^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
ip_address stringInternal IPv4 address of a host
internal_host_detection_v6 object
hostname stringPossible values:
<= 256 characters
, Value must match regular expression^[a-zA-Z0-9._-]+$
Host name of the IPv4 in DNS record
ip_address stringInternal IPv6 address of a host
machine_account_exists_with_serialno object
no objectyes object- name string required
- 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 save1
: save2
: save username only3
: only with user fingerprint
- source_user string[]
- 201
- 400
- 401
- 403
- 409
- default
Created
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- invalid_object
- invalid_query_parameter
- missing_body
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Conflict
- application/json
- Schema
- Example (from schema)
- name_not_unique
- object_not_unique
- reference_not_zero
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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
- application/json
- Schema
- Example (from schema)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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"
}