Skip to main content

Create a GlobalProtect agent profile

POST 
/agent-profiles

Create a new GlobalProtect agent profile

Request​

Query Parameters

    folder anyrequired

    The folder in which the resource is defined

Body

Created

    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 string
    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 string
    source_ip string[]
  • ]
    • gp_app_config object
    config object[]

    Currently we only support connect-method and tunnel-mtu as app-config

  • Array [
    • anyOf
    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

  • ]
    • 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]

Responses​

Created

Loading...