Prisma Cloud MSSP API

{
  "openapi": "3.0.1",
  "info": {
    "title": "Prisma Cloud: Managed Security Service Provider (MSSP)",
    "description": "APIs to interact with the MSSP Backend Service\n\n# Authentication\n\n",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://mssp-api.prismacloud.io"
    }
  ],
  "tags": [
    {
      "name": "Policy Group to Tenant Group Management",
      "description": "APIs to interact with the MSSP Backend Service\n\n# Authentication\n\n"
    },
    {
      "name": "Policy Group Lifecycle Endpoints",
      "description": "APIs to interact with the MSSP Backend Service\n\n# Authentication\n\n"
    }
  ],
  "paths": {
    "/api/v1/user/{username}/credential": {
      "put": {
        "tags": [
          "User Management"
        ],
        "summary": "Palo Alto Networks Change Password",
        "description": "Change password for user",
        "operationId": "resetPassword",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "Username",
            "required": true,
            "schema": {
              "maxLength": 128,
              "minLength": 1,
              "type": "string"
            },
            "example": "jsmith"
          }
        ],
        "requestBody": {
          "content": {
            "application/json; charset=UTF-8": {
              "schema": {
                "$ref": "#/components/schemas/ChangePasswordRequest"
              },
              "examples": {
                "ResetPasswordRequestExample": {
                  "summary": "Default resetPassword request",
                  "x-microcks-default": true,
                  "value": {
                    "password": "example-password"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "Successful operation"
          },
          "400": {
            "description": "Bad password",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ResetPassword400Example": {
                    "summary": "Default resetPassword 400 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "ResetPassword401Example": {
                    "summary": "Default resetPassword 401 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many api request"
          }
        },
        "security": [
          {
            "UserJwt": []
          }
        ],
        "x-public": "true",
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/api/v1/mssp/{mssp-id}/user/{username}": {
      "get": {
        "tags": [
          "User Management"
        ],
        "summary": "Palo Alto Networks Get User by Username",
        "description": "Get User by username",
        "operationId": "getUser",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "username of the user",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "jane.doe"
          },
          {
            "name": "mssp-id",
            "in": "path",
            "description": "the id of the MSSP of interest",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "407542"
          }
        ],
        "responses": {
          "200": {
            "description": "User details for given username",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MsspUserResponse"
                },
                "examples": {
                  "GetUser200Example": {
                    "summary": "Default getUser 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "username": "jane.doe",
                      "firstName": "Production Agent 01",
                      "lastName": "Primary Agent 97",
                      "lastModifiedBy": "example-lastModifiedBy",
                      "lastModifiedAt": 578
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One of the required arguments is missing or fails a constraint",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "GetUser400Example": {
                    "summary": "Default getUser 400 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "GetUser401Example": {
                    "summary": "Default getUser 401 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "User not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "GetUser404Example": {
                    "summary": "Default getUser 404 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MsspUserResponse"
                },
                "examples": {
                  "GetUser429Example": {
                    "summary": "Default getUser 429 response",
                    "x-microcks-default": true,
                    "value": {
                      "username": "jane.doe",
                      "firstName": "Production Agent 01",
                      "lastName": "Primary Agent 97",
                      "lastModifiedBy": "example-lastModifiedBy",
                      "lastModifiedAt": 578
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "UserJwt": []
          }
        ],
        "x-public": "true",
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      },
      "put": {
        "tags": [
          "User Management"
        ],
        "summary": "Palo Alto Networks Update an Existing User",
        "description": "Update an existing user",
        "operationId": "updateUser",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "username of the user",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "soc-analyst"
          },
          {
            "name": "mssp-id",
            "in": "path",
            "description": "the id of the MSSP of interest",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "105279"
          }
        ],
        "requestBody": {
          "content": {
            "application/json; charset=UTF-8": {
              "schema": {
                "$ref": "#/components/schemas/MsspUserRequest"
              },
              "examples": {
                "UpdateUserRequestExample": {
                  "summary": "Default updateUser request",
                  "x-microcks-default": true,
                  "value": {
                    "username": "jane.doe",
                    "firstName": "Primary Gateway 46",
                    "lastName": "Corporate Gateway 06"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "User updated successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MsspUserResponse"
                },
                "examples": {
                  "UpdateUser200Example": {
                    "summary": "Default updateUser 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "username": "jane.doe",
                      "firstName": "Production Agent 01",
                      "lastName": "Primary Agent 97",
                      "lastModifiedBy": "example-lastModifiedBy",
                      "lastModifiedAt": 578
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One of the required arguments is missing or fails a constraint",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "UpdateUser400Example": {
                    "summary": "Default updateUser 400 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "UpdateUser401Example": {
                    "summary": "Default updateUser 401 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "User not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "UpdateUser404Example": {
                    "summary": "Default updateUser 404 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MsspUserResponse"
                },
                "examples": {
                  "UpdateUser429Example": {
                    "summary": "Default updateUser 429 response",
                    "x-microcks-default": true,
                    "value": {
                      "username": "jane.doe",
                      "firstName": "Production Agent 01",
                      "lastName": "Primary Agent 97",
                      "lastModifiedBy": "example-lastModifiedBy",
                      "lastModifiedAt": 578
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "UserJwt": []
          }
        ],
        "x-public": "true",
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      },
      "delete": {
        "tags": [
          "User Management"
        ],
        "summary": "Palo Alto Networks Delete an Existing User",
        "description": "Delete an existing user",
        "operationId": "deleteUser",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "Username of the user",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "jsmith"
          },
          {
            "name": "mssp-id",
            "in": "path",
            "description": "the id of the MSSP of interest",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "241012"
          }
        ],
        "responses": {
          "204": {
            "description": "User deleted successful"
          },
          "400": {
            "description": "Bad request. One of the required arguments is missing or fails a constraint",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "DeleteUser400Example": {
                    "summary": "Default deleteUser 400 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "DeleteUser401Example": {
                    "summary": "Default deleteUser 401 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "code": "example-code",
                        "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                        "target": "example-target",
                        "details": [
                          {
                            "code": "example-code",
                            "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                            "target": "example-target",
                            "details": [
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              },
                              {
                                "code": "example-code",
                                "message": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule.",
                                "target": "example-target",
                                "details": [
                                  {},
                                  {}
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "User not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "DeleteUser404Example": {
                    "summary": "Default deleteUser 404 response",
                    "x-microcks-default": true,
                    "value": {
                      "error": {
                        "cod

# --- truncated at 32 KB (380 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-prisma-cloud-mssp-api-openapi-original.json