Palo Alto Networks · JSON Structure

Sspm Api Onboard App Request Structure

OnboardAppRequest schema from Palo Alto Networks SaaS Security Posture Management API

Type: object Properties: 3 Required: 1
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

OnboardAppRequest is a JSON Structure definition published by Palo Alto Networks, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

app_type display_name credentials

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sspm-api-onboard-app-request-structure.json",
  "name": "OnboardAppRequest",
  "description": "OnboardAppRequest schema from Palo Alto Networks SaaS Security Posture Management API",
  "type": "object",
  "properties": {
    "app_type": {
      "type": "string",
      "description": "Application type to onboard (e.g., google_workspace, microsoft_365, salesforce)."
    },
    "display_name": {
      "type": "string",
      "description": "Optional display name for this application instance."
    },
    "credentials": {
      "type": "object",
      "description": "Authentication credentials required to connect to the application.",
      "additionalProperties": true
    }
  },
  "required": [
    "app_type"
  ]
}