Palo Alto Networks · Schema

agent-profiles

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
agent_ui object
authentication_override object
certificate object
client_certificate object
custom_checks object
gateways object
gp_app_config object
hip_collection object
internal_host_detection object
internal_host_detection_v6 object
machine_account_exists_with_serialno object
name string
os array
save_user_credentials string Indicates whether to save user credentials. * `0` : do not save * `1` : save * `2` : save username only * `3` : only with user fingerprint
source_user array
third_party_vpn_clients array
View JSON Schema on GitHub

JSON Schema

palo-alto-networks-agent-profiles-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-agent-profiles-schema.json",
  "title": "agent-profiles",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-mobileagent-api-openapi.yml#/components/schemas/agent-profiles",
  "properties": {
    "agent_ui": {
      "properties": {
        "agent_user_override_timeout": {
          "default": 0,
          "minimum": 0,
          "type": "number"
        },
        "max_agent_user_overrides": {
          "default": 0,
          "minimum": 0,
          "type": "number"
        },
        "passcode": {
          "maxLength": 64,
          "minLength": 6,
          "type": "string"
        },
        "uninstall_password": {
          "maxLength": 64,
          "minLength": 6,
          "type": "string"
        },
        "welcome_page": {
          "properties": {
            "page": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "authentication_override": {
      "properties": {
        "accept_cookie": {
          "properties": {
            "cookie_lifetime": {
              "properties": {
                "lifetime_in_days": {
                  "maximum": 365,
                  "minimum": 1,
                  "type": "number"
                },
                "lifetime_in_hours": {
                  "maximum": 72,
                  "minimum": 1,
                  "type": "number"
                },
                "lifetime_in_minutes": {
                  "maximum": 59,
                  "minimum": 1,
                  "type": "number"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        },
        "cookie_encrypt_decrypt_cert": {
          "type": "string"
        },
        "generate_cookie": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "certificate": {
      "properties": {
        "criteria": {
          "properties": {
            "certificate_profile": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "client_certificate": {
      "properties": {
        "local": {
          "type": "string"
        },
        "scep": {
          "maxLength": 255,
          "type": "string"
        }
      },
      "type": "object"
    },
    "custom_checks": {
      "properties": {
        "criteria": {
          "properties": {
            "plist": {
              "items": {
                "properties": {
                  "key": {
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "negate": {
                          "type": "boolean"
                        },
                        "value": {
                          "maxLength": 1024,
                          "pattern": ".*",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "name": {
                    "type": "string"
                  },
                  "negate": {
                    "type": "boolean"
                  }
                },
                "type": "object"
              },
              "type": "array"
            },
            "registry_key": {
              "items": {
                "properties": {
                  "default_value_data": {
                    "maxLength": 1024,
                    "type": "string"
                  },
                  "name": {
                    "maxLength": 1023,
                    "type": "string"
                  },
                  "negate": {
                    "type": "boolean"
                  },
                  "registry_value": {
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "negate": {
                          "type": "boolean"
                        },
                        "value_data": {
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "gateways": {
      "properties": {
        "external": {
          "properties": {
            "list": {
              "items": {
                "properties": {
                  "choice": {
                    "oneOf": [
                      {
                        "properties": {
                          "fqdn": {
                            "type": "string"
                          }
                        },
                        "title": "fqdn",
                        "type": "object"
                      },
                      {
                        "properties": {
                          "ip": {
                            "properties": {
                              "ipv4": {
                                "maxLength": 100,
                                "minLength": 0,
                                "pattern": "^([:0-9.])+$",
                                "type": "string"
                              },
                              "ipv6": {
                                "maxLength": 100,
                                "minLength": 0,
                                "type": "string"
                              }
                            },
                            "type": "object"
                          }
                        },
                        "title": "ip",
                        "type": "object"
                      }
                    ],
                    "type": "object"
                  },
                  "manual": {
                    "default": false,
                    "description": "If this GlobalProtect gateway can be manually selected",
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "priority_rule": {
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "priority": {
                          "enum": [
                            "0",
                            "1",
                            "2",
                            "3",
                            "4",
                            "5"
                          ],
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "type": "object"
        },
        "internal": {
          "properties": {
            "list": {
              "items": {
                "properties": {
                  "choice": {
                    "oneOf": [
                      {
                        "properties": {
                          "fqdn": {
                            "type": "string"
                          }
                        },
                        "title": "fqdn",
                        "type": "object"
                      },
                      {
                        "properties": {
                          "ip": {
                            "properties": {
                              "ipv4": {
                                "maxLength": 100,
                                "minLength": 0,
                                "pattern": "^([:0-9.])+$",
                                "type": "string"
                              },
                              "ipv6": {
                                "maxLength": 100,
                                "minLength": 0,
                                "type": "string"
                              }
                            },
                            "type": "object"
                          }
                        },
                        "title": "ip",
                        "type": "object"
                      }
                    ],
                    "type": "object"
                  },
                  "name": {
                    "type": "string"
                  },
                  "source_ip": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "gp_app_config": {
      "properties": {
        "config": {
          "description": "Currently we only support connect-method and tunnel-mtu as app-config",
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/connect-method"
              },
              {
                "$ref": "#/$defs/tunnel-mtu"
              }
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "hip_collection": {
      "properties": {
        "certificate_profile": {
          "type": "string"
        },
        "collect_hip_data": {
          "type": "boolean"
        },
        "custom_checks": {
          "properties": {
            "linux": {
              "properties": {
                "process_list": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            },
            "mac_os": {
              "properties": {
                "plist": {
                  "items": {
                    "properties": {
                      "key": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "name": {
                        "description": "Preference list",
                        "maxLength": 1023,
                        "type": "string"
                      }
                    },
                    "required": [
                      "name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "process_list": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            },
            "windows": {
              "properties": {
                "process_list": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "registry_key": {
                  "items": {
                    "properties": {
                      "name": {
                        "description": "Registry key",
                        "maxLength": 1023,
                        "type": "string"
                      },
                      "registry_value": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": [
                      "name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        },
        "exclusion": {
          "properties": {
            "category": {
              "items": {
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "vendor": {
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "product": {
                          "items": {
                            "type": "string"
                          },
                          "type": "array"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "type": "array"
            }
          },
          "type": "object"
        },
        "max_wait_time": {
          "maximum": 60,
          "minimum": 10,
          "type": "number"
        }
      },
      "type": "object"
    },
    "internal_host_detection": {
      "properties": {
        "hostname": {
          "description": "Host name of the IPv4 in DNS record",
          "maxLength": 256,
          "pattern": "^[a-zA-Z0-9._-]+$",
          "type": "string"
        },
        "ip_address": {
          "description": "Internal IPv4 address of a host",
          "type": "string"
        }
      },
      "type": "object"
    },
    "internal_host_detection_v6": {
      "properties": {
        "hostname": {
          "description": "Host name of the IPv4 in DNS record",
          "maxLength": 256,
          "pattern": "^[a-zA-Z0-9._-]+$",
          "type": "string"
        },
        "ip_address": {
          "description": "Internal IPv6 address of a host",
          "type": "string"
        }
      },
      "type": "object"
    },
    "machine_account_exists_with_serialno": {
      "properties": {
        "no": {
          "type": "object"
        },
        "yes": {
          "type": "object"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "os": {
      "items": {
        "enum": [
          "Android",
          "Chrome",
          "IoT",
          "Linux",
          "Mac",
          "Windows",
          "WindowsUWP",
          "iOS"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "save_user_credentials": {
      "description": "Indicates whether to save user credentials.\n\n* `0` : do not save\n* `1` : save\n* `2` : save username only\n* `3` : only with user fingerprint\n",
      "enum": [
        "0",
        "1",
        "2",
        "3"
      ],
      "type": "string"
    },
    "source_user": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "third_party_vpn_clients": {
      "items": {
        "enum": [
          "PAN Virtual Ethernet Adapter",
          "Juniper Network Virtual Adapter",
          "Cisco Systems VPN Adapter"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "name"
  ],
  "type": "object",
  "$defs": {
    "connect-method": {
      "properties": {
        "name": {
          "default": "connect-method",
          "enum": [
            "connect-method"
          ],
          "type": "string"
        },
        "value": {
          "items": {
            "enum": [
              "user-logon",
              "pre-logon",
              "on-demand",
              "pre-logon-then-on-demand"
            ],
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        }
      },
      "type": "object"
    },
    "tunnel-mtu": {
      "properties": {
        "name": {
          "default": "tunnel-mtu",
          "enum": [
            "tunnel-mtu"
          ],
          "type": "string"
        },
        "value": {
          "description": "GlobalProtect Connection MTU (bytes)",
          "items": {
            "default": 1400,
            "maximum": 1420,
            "minimum": 1000,
            "type": "number"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        }
      },
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/palo-alto-networks-agent-profiles"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.