{ "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": { "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" } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/policy-group/{pg-id}": { "get": { "tags": [ "Policy Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Details of an Existing Policy Group", "description": "Returns the details of an existing policy group. Will use msspId from the auth token if available.", "operationId": "get-policy-group-by-id", "parameters": [ { "name": "pg-id", "in": "path", "description": "the id of the policy group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "34e2e197-f172-4a04-93a4-39b1532648ab" }, { "name": "mssp-id", "in": "path", "description": "the mssp the policy group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PolicyGroupResponse" }, "examples": { "Get-Policy-Group-By-Id200Example": { "summary": "Default get-policy-group-by-id 200 response", "x-microcks-default": true, "value": { "id": "289a717e-8053-4e21-b5be-23f1918a1628", "name": "Production Agent 76", "policies": [ "example-policies_item" ], "tenantGroups": [ { "id": "ad7141fc-7249-4085-ba81-89c7dce06beb", "tenantGroupId": "016e80c2-a77b-43b9-8892-71848159488e", "tenantGroupName": "Branch Policy 91", "tenantCount": 729 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-Policy-Group-By-Id400Example": { "summary": "Default get-policy-group-by-id 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-Policy-Group-By-Id401Example": { "summary": "Default get-policy-group-by-id 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-Policy-Group-By-Id403Example": { "summary": "Default get-policy-group-by-id 403 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/ErrorResponse" }, "examples": { "Get-Policy-Group-By-Id429Example": { "summary": "Default get-policy-group-by-id 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Policy Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Update a Policy Group", "description": "Updates a policy group if it doesn't exist. Will use msspId from the auth token if available.", "operationId": "update-policy-group", "parameters": [ { "name": "pg-id", "in": "path", "description": "the id of the policy group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "34e2e197-f172-4a04-93a4-39b1532648ab" }, { "name": "mssp-id", "in": "path", "description": "the mssp the tenant group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PolicyGroupRequest" }, "examples": { "Update-Policy-GroupRequestExample": { "summary": "Default update-policy-group request", "x-microcks-default": true, "value": { "name": "Production Agent 45", "policies": [ "example-policies_item" ] } } } } }, "required": true }, "responses": { "204": { "description": "Update Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Update-Policy-Group400Example": { "summary": "Default update-policy-group 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Update-Policy-Group401Example": { "summary": "Default update-policy-group 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Update-Policy-Group403Example": { "summary": "Default update-policy-group 403 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/ErrorResponse" }, "examples": { "Update-Policy-Group429Example": { "summary": "Default update-policy-group 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Policy Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Delete an Existing Policy Group", "description": "Deletes a policy group if it is empty. Will use msspId from the auth token if available.", "operationId": "delete-policy-group", "parameters": [ { "name": "pg-id", "in": "path", "description": "the id of the policy group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "34e2e197-f172-4a04-93a4-39b1532648ab" }, { "name": "mssp-id", "in": "path", "description": "the mssp the policy group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "responses": { "204": { "description": "Delete Accepted", "headers": { "Location": { "description": "The relative path to the deleted policy group", "style": "simple", "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Policy-Group400Example": { "summary": "Default delete-policy-group 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Policy-Group401Example": { "summary": "Default delete-policy-group 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Policy-Group403Example": { "summary": "Default delete-policy-group 403 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/ErrorResponse" }, "examples": { "Delete-Policy-Group429Example": { "summary": "Default delete-policy-group 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/user/{username}/credential/reset-token/validate": { "post": { "tags": [ "User Management" ], "summary": "Palo Alto Networks Validate Forgot Password Token", "description": "Triggers the validation of a forgot password token and generating a special JWT upon successful validation of the forgot password token", "operationId": "validateToken", "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/ValidateTokenRequest" }, "examples": { "ValidateTokenRequestExample": { "summary": "Default validateToken request", "x-microcks-default": true, "value": { "resetToken": "example-resetToken" } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateTokenResponse" }, "examples": { "ValidateToken200Example": { "summary": "Default validateToken 200 response", "x-microcks-default": true, "value": { "token": "4c53e5f5a41d0f448065561d370f7834" } } } } } }, "400": { "description": "Bad request token / Request token expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "ValidateToken400Example": { "summary": "Default validateToken 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": [ {}, {} ] } ] } ] } } } } } } }, "429": { "description": "Too many api request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateTokenResponse" }, "examples": { "ValidateToken429Example": { "summary": "Default validateToken 429 response", "x-microcks-default": true, "value": { "token": "4c53e5f5a41d0f448065561d370f7834" } } } } } } }, "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/user": { "get": { "tags": [ "User Management" ], "summary": "Palo Alto Networks List Users", "description": "List users for given mssp console", "operationId": "listUsers", "parameters": [ { "name": "next_page_token", "in": "query", "description": "Token to fetch next page. Max pagesize is 60.", "required": false, "schema": { "type": "string" }, "example": "example-next_page_token" }, { "name": "mssp-id", "in": "path", "description": "The id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "309330" } ], "responses": { "200": { "description": "List of users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsspListUserResponse" }, "examples": { "ListUsers200Example": { "summary": "Default listUsers 200 response", "x-microcks-default": true, "value": { "value": [ { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 }, { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 } ], "nextPageToken": "example-nextPageToken" } } } } } }, "400": { "description": "Bad request. One of the required arguments is missing or fails a constraint", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "ListUsers400Example": { "summary": "Default listUsers 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": { "ListUsers401Example": { "summary": "Default listUsers 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 requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsspListUserResponse" }, "examples": { "ListUsers429Example": { "summary": "Default listUsers 429 response", "x-microcks-default": true, "value": { "value": [ { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 }, { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 } ], "nextPageToken": "example-nextPageToken" } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "User Management" ], "summary": "Palo Alto Networks Create a New User", "description": "Create a new user under a specific MSSP account", "operationId": "createUser", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "604843" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/MsspUserRequest" }, "examples": { "CreateUserRequestExample": { "summary": "Default createUser request", "x-microcks-default": true, "value": { "username": "jane.doe", "firstName": "Primary Gateway 46", "lastName": "Corporate Gateway 06" } } } } }, "required": true }, "responses": { "201": { "description": "User created successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsspUserResponse" }, "examples": { "CreateUser201Example": { "summary": "Default createUser 201 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": { "CreateUser400Example": { "summary": "Default createUser 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": { "CreateUser401Example": { "summary": "Default createUser 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": [ {}, {} ] } ] } ] } } } } } } }, "409": { "description": "Conflicting username found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateUser409Example": { "summary": "Default createUser 409 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": { "CreateUser429Example": { "summary": "Default createUser 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" } } }, "/api/v1/mssp/{mssp-id}/tos": { "post": { "tags": [ "MSSP Account Management" ], "summary": "Palo Alto Networks Terms of Service", "description": "Endpoint used to accept terms of service.", "operationId": "tosAcceptance", "parameters": [ { "name": "mssp-id", "in": "path", "description": "The id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "457996" } ], "responses": { "204": { "description": "Successful operation" }, "400": { "description": "Bad request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "TosAcceptance400Example": { "summary": "Default tosAcceptance 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": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "TosAcceptance401Example": { "summary": "Default tosAcceptance 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": "Rate limiting error" } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/tenant-group": { "get": { "tags": [ "Tenant Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Tenant Group List for an MSSP", "description": "Gets the list of tenant groups for an MSSP. Will use msspId from the auth token if available.", "operationId": "getTenantGroupsByMsspId", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "424374" }, { "name": "next_page_token", "in": "query", "description": "pagination token to continue a previous queryif set", "required": false, "schema": { "type": "string" }, "example": "example-next_page_token" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupsResponse" }, "examples": { "GetTenantGroupsByMsspId200Example": { "summary": "Default getTenantGroupsByMsspId 200 response", "x-microcks-default": true, "value": { "value": [ { "id": "7f4e6576-9ea5-4354-a200-3c1205d09a9e", "groupName": "Branch Gateway 90", "tenants": [ { "externalTenantId": "849955", "prismaId": "788442" } ], "createdAt": 183, "createdBy": "example-createdBy" } ], "nextPageToken": "example-nextPageToken" } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetTenantGroupsByMsspId404Example": { "summary": "Default getTenantGroupsByMsspId 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetTenantGroupsByMsspId429Example": { "summary": "Default getTenantGroupsByMsspId 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Tenant Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Create a Tenant Group", "description": "Creates a tenant group if it doesn't exist. Will use msspId from the auth token if available.", "operationId": "createTenantGroup", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id mssp the tenant group belongs to", "required": true, "schema": { "type": "string" }, "example": "539797" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CreateTenantGroupRequest" }, "examples": { "CreateTenantGroupRequestExample": { "summary": "Default createTenantGroup request", "x-microcks-default": true, "value": { "groupName": "Staging Gateway 82", "tenantIds": [ "example-tenantIds_item", "example-tenantIds_item" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupResponse" }, "examples": { "CreateTenantGroup200Example": { "summary": "Default createTenantGroup 200 response", "x-microcks-default": true, "value": { "id": "7f4e6576-9ea5-4354-a200-3c1205d09a9e", "groupName": "Branch Gateway 90", "tenants": [ { "externalTenantId": "849955", "prismaId": "788442" } ], "createdAt": 183, "createdBy": "example-createdBy" } } } } } }, "400": { "description": "Client error. One of the required arguments in the request body is not correctly supplied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateTenantGroup400Example": { "summary": "Default createTenantGroup 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateTenantGroup404Example": { "summary": "Default createTenantGroup 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateTenantGroup429Example": { "summary": "Default createTenantGroup 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/tenant-group-policy-group-mapping": { "post": { "tags": [ "Policy Group to Tenant Group Management" ], "summary": "Palo Alto Networks Associate Policy Groups to Selected Tenant Group", "description": "Assign the selected policy groups to selected tenant group. Will use msspId from the auth token if available.", "operationId": "add-tenant-group-policy-group-mapping", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the tenant group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupPolicyGroupMapRequest" }, "examples": { "Add-Tenant-Group-Policy-Group-MappingRequestExample": { "summary": "Default add-tenant-group-policy-group-mapping request", "x-microcks-default": true, "value": { "mappings": [ { "tenantGroupId": "04e7c14c-0d44-48ff-91c4-4d4b10156455", "policyGroupIds": [ "9bec2de0-bb1d-4dcc-89d7-d8f0b938132b" ] } ] } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupPolicyGroupMappingsResponse" }, "examples": { "Add-Tenant-Group-Policy-Group-Mapping201Example": { "summary": "Default add-tenant-group-policy-group-mapping 201 response", "x-microcks-default": true, "value": { "value": [ { "id": "201aba9b-8ef8-43e0-aea9-27718b2ddbfc", "tenantGroupId": "a0b223c0-cda7-4dbd-8d4c-2e8b4b38c0e8", "policyGroupId": "c662e0b7-2ea3-4da4-9b4c-4ed3d083f851" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Add-Tenant-Group-Policy-Group-Mapping400Example": { "summary": "Default add-tenant-group-policy-group-mapping 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Add-Tenant-Group-Policy-Group-Mapping401Example": { "summary": "Default add-tenant-group-policy-group-mapping 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Add-Tenant-Group-Policy-Group-Mapping403Example": { "summary": "Default add-tenant-group-policy-group-mapping 403 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/ErrorResponse" }, "examples": { "Add-Tenant-Group-Policy-Group-Mapping429Example": { "summary": "Default add-tenant-group-policy-group-mapping 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/policy-group": { "get": { "tags": [ "Policy Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Details of All Existing Policy Groups", "description": "Returns the details of all existing policy groups. Will use msspId from the auth token if available.", "operationId": "get-all-policy-groups", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the policy group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" }, { "name": "next_page_token", "in": "query", "description": "pagination token to continue a previous query", "required": false, "schema": { "type": "string" }, "example": "example-next_page_token" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PolicyGroupsListResponse" }, "examples": { "Get-All-Policy-Groups200Example": { "summary": "Default get-all-policy-groups 200 response", "x-microcks-default": true, "value": { "value": [ { "id": "87eb394e-a31f-4802-9c0c-90060f936459", "name": "Staging Sensor 65", "policyCount": 601, "tenantGroupCount": 617 }, { "id": "87eb394e-a31f-4802-9c0c-90060f936459", "name": "Staging Sensor 65", "policyCount": 601, "tenantGroupCount": 617 } ], "nextPageToken": "example-nextPageToken" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-All-Policy-Groups400Example": { "summary": "Default get-all-policy-groups 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-All-Policy-Groups401Example": { "summary": "Default get-all-policy-groups 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Get-All-Policy-Groups403Example": { "summary": "Default get-all-policy-groups 403 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/ErrorResponse" }, "examples": { "Get-All-Policy-Groups429Example": { "summary": "Default get-all-policy-groups 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Policy Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Create a Policy Group", "description": "Creates a policy group if it doesn't exist. Will use msspId from the auth token if available.", "operationId": "create-policy-group", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the tenant group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PolicyGroupRequest" }, "examples": { "Create-Policy-GroupRequestExample": { "summary": "Default create-policy-group request", "x-microcks-default": true, "value": { "name": "Production Agent 45", "policies": [ "example-policies_item" ] } } } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "description": "The relative path to the created policy group", "style": "simple", "schema": { "type": "string" } } }, "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CreatePolicyGroupResponse" }, "examples": { "Create-Policy-Group201Example": { "summary": "Default create-policy-group 201 response", "x-microcks-default": true, "value": { "id": "7b13785c-32f1-4969-8a6e-d8fc9f6c6acd", "name": "Staging Agent 12", "policies": [ "example-policies_item" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Create-Policy-Group400Example": { "summary": "Default create-policy-group 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Create-Policy-Group401Example": { "summary": "Default create-policy-group 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Create-Policy-Group403Example": { "summary": "Default create-policy-group 403 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": [ {}, {} ] } ] } ] } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Create-Policy-Group409Example": { "summary": "Default create-policy-group 409 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/ErrorResponse" }, "examples": { "Create-Policy-Group429Example": { "summary": "Default create-policy-group 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/operation/{request-id}/retry": { "post": { "tags": [ "MSSP Operations Retry" ], "summary": "Palo Alto Networks API to Retry Failed Operation", "description": "MSSP user API to retry failed operation", "operationId": "retryOperation", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "504934" }, { "name": "request-id", "in": "path", "description": "the request id being retried", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3018454b-1fec-4eb6-901a-c76b62535f96" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/OperationAckRequest" }, "examples": { "RetryOperationRequestExample": { "summary": "Default retryOperation request", "x-microcks-default": true, "value": { "status": "SUCCESS", "errorMessage": "example-errorMessage", "tenantUpdate": { "prismaId": 797, "externalTenantId": "225012", "stackName": "Branch Gateway 63", "stackBaseUrl": "example-stackBaseUrl" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/OperationResponse" }, "examples": { "RetryOperation200Example": { "summary": "Default retryOperation 200 response", "x-microcks-default": true, "value": { "requestId": "4b0348d5-573c-4efd-a630-8b03814c6b3c", "msspId": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b", "operationType": "MESSAGE_FAN_OUT", "operationName": "POLICY_MAP", "operationDescription": "Incident incident configured investigation malware violation incident applied applied on network.", "status": "FAILURE", "tenantChanges": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ], "startedBy": "example-startedBy", "startedAt": 93, "updatedAt": 375, "isRetryable": true, "retryOf": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153", "retriedBy": "3ea1e71a-2068-4b42-91ea-859717617763" } } } } } }, "400": { "description": "Client error. One of the required arguments in the request body is not correctly supplied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "RetryOperation400Example": { "summary": "Default retryOperation 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "RetryOperation404Example": { "summary": "Default retryOperation 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": "Rate limiting error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "RetryOperation429Example": { "summary": "Default retryOperation 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/managed-tenant": { "get": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Managed Tenants for an MSSP", "description": "Gets the list of managed tenants for an MSSP, optionally filterable by tenant group.", "operationId": "getManagedTenants", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "740743" }, { "name": "tenant_group", "in": "query", "description": "the tenant groups the managed tenants belong to, accepts multiple. Maximum limit of 10", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "57190034-a785-412f-a733-633d8602b597" ] }, { "name": "show_synthetic_tenant", "in": "query", "description": "show synthetic tenant, defaults to false", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "show_deleted_tenants", "in": "query", "description": "show deleted tenants, defaults to false", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "next_page_token", "in": "query", "description": "pagination token to continue a previous query", "required": false, "schema": { "type": "string" }, "example": "example-next_page_token" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ManagedTenantsResponse" }, "examples": { "GetManagedTenants200Example": { "summary": "Default getManagedTenants 200 response", "x-microcks-default": true, "value": { "value": [ { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" }, { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" } ], "nextPageToken": "example-nextPageToken" } } } } } }, "400": { "description": "Client error. One of the required arguments in the request body is not correctly supplied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenants400Example": { "summary": "Default getManagedTenants 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenants404Example": { "summary": "Default getManagedTenants 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenants429Example": { "summary": "Default getManagedTenants 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Create a New Managed Tenant", "description": "Creates a new managed tenant belonging to the MSSP.", "operationId": "createManagedTenant", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "256045" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CreateManagedTenantRequest" }, "examples": { "CreateManagedTenantRequestExample": { "summary": "Default createManagedTenant request", "x-microcks-default": true, "value": { "name": "Branch Agent 28", "companyName": "Production Policy 50", "region": "eu-west-1", "tenantGroupId": "fedb2e94-6200-4f20-b7a9-78b393f82cb6", "planType": "RS_ADVANCED", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "licenseInfo": { "licensePoolId": "891733", "allocatedCredits": 729 }, "modules": [ { "featureName": "Corporate Agent 22", "enabled": true, "additionalData": {} } ] } } } } }, "required": true }, "responses": { "202": { "description": "Accepted. Tenant Creation has async components", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ManagedTenantResponse" }, "examples": { "CreateManagedTenant202Example": { "summary": "Default createManagedTenant 202 response", "x-microcks-default": true, "value": { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" } } } } } }, "400": { "description": "Client error. One of the required arguments is missing or fails a constraint", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateManagedTenant400Example": { "summary": "Default createManagedTenant 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateManagedTenant404Example": { "summary": "Default createManagedTenant 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": "Rate limiting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CreateManagedTenant429Example": { "summary": "Default createManagedTenant 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/login": { "post": { "tags": [ "User Authentication" ], "summary": "Palo Alto Networks Login with Username and Password", "description": "Login with username and password", "operationId": "processLogin", "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/FormLoginRequest" }, "examples": { "ProcessLoginRequestExample": { "summary": "Default processLogin request", "x-microcks-default": true, "value": { "username": "soc-analyst", "password": "example-password" } } } } }, "required": true }, "responses": { "200": { "description": "Login Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormLoginResponse" }, "examples": { "ProcessLogin200Example": { "summary": "Default processLogin 200 response", "x-microcks-default": true, "value": { "token": "fa9da05f5324df66e7df52a8ba08be8d", "msspId": "437386", "message": "On rule incident configured threat applied threat suspicious." } } } } } }, "400": { "description": "Bad request. One of the required arguments is missing or fails a constraint", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "ProcessLogin400Example": { "summary": "Default processLogin 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": { "ProcessLogin401Example": { "summary": "Default processLogin 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 requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormLoginResponse" }, "examples": { "ProcessLogin429Example": { "summary": "Default processLogin 429 response", "x-microcks-default": true, "value": { "token": "fa9da05f5324df66e7df52a8ba08be8d", "msspId": "437386", "message": "On rule incident configured threat applied threat suspicious." } } } } } } }, "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/license/usage": { "post": { "tags": [ "Mssp License Endpoints" ], "summary": "Palo Alto Networks Get the License Usage for MSSP", "description": "Get the license Usage for a MSSP", "operationId": "getMsspLicenseUsageV1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsspLicenseUsageRequestObject" }, "examples": { "GetMsspLicenseUsageV1RequestExample": { "summary": "Default getMsspLicenseUsageV1 request", "x-microcks-default": true, "value": { "tenantGroupId": "609286", "licensePoolId": "720133", "timeRange": "example-timeRange", "nextPageToken": "example-nextPageToken" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/MsspLicenseUsageResponse" }, "examples": { "GetMsspLicenseUsageV1200Example": { "summary": "Default getMsspLicenseUsageV1 200 response", "x-microcks-default": true, "value": { "value": [ { "tenantName": "Production Agent 53", "prismaId": "999338", "createdOn": 201, "expiringOn": 627, "status": "DELETING", "creditsAllocated": 752, "avgConsumption": 781, "lastUpdated": 896, "externalTenantId": "986311" }, { "tenantName": "Staging Sensor 16", "prismaId": "842673", "createdOn": 662, "expiringOn": 182, "status": "ACTIVE", "creditsAllocated": 585, "avgConsumption": 766, "lastUpdated": 138, "externalTenantId": "479192" } ], "nextPageToken": "example-nextPageToken" } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicenseUsageV1401Example": { "summary": "Default getMsspLicenseUsageV1 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Authorization failed, user doesn't have access to the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicenseUsageV1403Example": { "summary": "Default getMsspLicenseUsageV1 403 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}": { "get": { "tags": [ "MSSP Account Management" ], "summary": "Palo Alto Networks Get the Details of an Existing MSSP", "description": "Returns the details of an existing MSSP account", "operationId": "getMssp", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "818522" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/MsspResponse" }, "examples": { "GetMssp200Example": { "summary": "Default getMssp 200 response", "x-microcks-default": true, "value": { "msspId": "963068", "name": "Corporate Gateway 26", "createdBy": "example-createdBy", "createdAt": 414, "customerSupportId": "670106", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" } } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMssp404Example": { "summary": "Default getMssp 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMssp429Example": { "summary": "Default getMssp 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/tenant-group/{id}": { "get": { "tags": [ "Tenant Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Tenant Group by Id", "description": "Gets a tenant group by id.", "operationId": "getTenantGroupById", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "235310" }, { "name": "id", "in": "path", "description": "the id of the tenant group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "656f5cca-0222-41f1-bc29-41216d37fc09" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupResponse" }, "examples": { "GetTenantGroupById200Example": { "summary": "Default getTenantGroupById 200 response", "x-microcks-default": true, "value": { "id": "7f4e6576-9ea5-4354-a200-3c1205d09a9e", "groupName": "Branch Gateway 90", "tenants": [ { "externalTenantId": "849955", "prismaId": "788442" } ], "createdAt": 183, "createdBy": "example-createdBy" } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetTenantGroupById404Example": { "summary": "Default getTenantGroupById 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetTenantGroupById429Example": { "summary": "Default getTenantGroupById 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Tenant Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Delete an Existing Tenant Group", "description": "Deletes a tenant group if it is empty. Will use msspId from the auth token if available.", "operationId": "deleteTenantGroupById", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the tenant group belongs to", "required": true, "schema": { "type": "string" }, "example": "588758" }, { "name": "id", "in": "path", "description": "the id of the tenant group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "38a189bf-e1eb-42fa-9d13-192414a234da" } ], "responses": { "204": { "description": "Deletion accepted" }, "404": { "description": "The MSSP or tenant group does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeleteTenantGroupById404Example": { "summary": "Default deleteTenantGroupById 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeleteTenantGroupById429Example": { "summary": "Default deleteTenantGroupById 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "patch": { "tags": [ "Tenant Group Lifecycle Endpoints" ], "summary": "Palo Alto Networks Modify the Tenant Group by Id", "description": "Modifies a tenant group by id.", "operationId": "patchTenantGroupById", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "367388" }, { "name": "id", "in": "path", "description": "the id of the tenant group", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "6f83abb7-6eaa-4f6b-940d-ab6a40022d61" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantGroupRequest" }, "examples": { "PatchTenantGroupByIdRequestExample": { "summary": "Default patchTenantGroupById request", "x-microcks-default": true, "value": { "groupName": "Staging Firewall 76", "tenantIds": [ "example-tenantIds_item" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/TenantGroupResponse" }, "examples": { "PatchTenantGroupById200Example": { "summary": "Default patchTenantGroupById 200 response", "x-microcks-default": true, "value": { "id": "7f4e6576-9ea5-4354-a200-3c1205d09a9e", "groupName": "Branch Gateway 90", "tenants": [ { "externalTenantId": "849955", "prismaId": "788442" } ], "createdAt": 183, "createdBy": "example-createdBy" } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "PatchTenantGroupById404Example": { "summary": "Default patchTenantGroupById 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "PatchTenantGroupById429Example": { "summary": "Default patchTenantGroupById 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/managed-tenant/{tenant-id}": { "get": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Get the Details of an Existing Managed Tenant", "description": "Returns the details of an existing MSSP.", "operationId": "getManagedTenantById", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "425248" }, { "name": "tenant-id", "in": "path", "description": "the prisma id or external tenant id of the managed tenant of interest", "required": true, "schema": { "type": "string" }, "example": "548814" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ManagedTenantDetailedResponse" }, "examples": { "GetManagedTenantById200Example": { "summary": "Default getManagedTenantById 200 response", "x-microcks-default": true, "value": { "prismaId": "222478", "externalTenantId": "895934", "customerName": "Staging Policy 84", "companyName": "Branch Firewall 61", "status": "ERRORED", "isSynthetic": true, "wasMigrated": true, "msspId": "442187", "tenantGroupId": "aa8a8ae2-ba70-450a-b7df-423ed6589a61", "planType": "RS_STANDARD", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "eu-west-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 372, "modules": [ { "feature_name": "Branch Policy 59", "enabled": true, "billing_type": "BUY", "state": "PROVISION_FAILED", "additional_data": {} }, { "feature_name": "Branch Policy 59", "enabled": true, "billing_type": "BUY", "state": "PROVISION_FAILED", "additional_data": {} } ], "erroredBy": "62275c4f-4c58-4c7a-a21d-e31bd07cf940", "policyGroups": [ { "id": "318094fe-783b-4bdc-aeae-b9f2831c2d35", "name": "Staging Policy 69", "policyCount": 26 } ] } } } } } }, "400": { "description": "Client error. One of the required arguments in the request body is not correctly supplied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenantById400Example": { "summary": "Default getManagedTenantById 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The managed tenant does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenantById404Example": { "summary": "Default getManagedTenantById 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetManagedTenantById429Example": { "summary": "Default getManagedTenantById 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Delete a Managed Tenant", "description": "Marks the requested MSSP as deleted.", "operationId": "softDeleteManagedTenant", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "960246" }, { "name": "tenant-id", "in": "path", "description": "the prisma id or external tenant if of the managed tenant of interest", "required": true, "schema": { "type": "string" }, "example": "623801" } ], "responses": { "202": { "description": "Deletion accepted" }, "404": { "description": "The managed tenant does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "SoftDeleteManagedTenant404Example": { "summary": "Default softDeleteManagedTenant 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "SoftDeleteManagedTenant429Example": { "summary": "Default softDeleteManagedTenant 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "patch": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Modify an Existing Managed Tenant", "description": "Modify select attributes of an existing managed tenant, such as updating its MSSP ID", "operationId": "updateManagedTenant", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "628280" }, { "name": "tenant-id", "in": "path", "description": "the prisma id or external tenant id of the managed tenant of interest", "required": true, "schema": { "type": "string" }, "example": "784070" } ], "requestBody": { "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/UpdateManagedTenantRequest" }, "examples": { "UpdateManagedTenantRequestExample": { "summary": "Default updateManagedTenant request", "x-microcks-default": true, "value": { "tenantGroupId": "4bf4541a-4d22-4119-b6ae-0617c59ea86c", "companyName": "Staging Policy 81", "licenseInfo": { "licensePoolId": "891733", "allocatedCredits": 729 }, "modules": [ { "featureName": "Corporate Firewall 42", "enabled": true, "additionalData": {} } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ManagedTenantResponse" }, "examples": { "UpdateManagedTenant200Example": { "summary": "Default updateManagedTenant 200 response", "x-microcks-default": true, "value": { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" } } } } } }, "400": { "description": "Client error. One of the required arguments in the request body is not correctly supplied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UpdateManagedTenant400Example": { "summary": "Default updateManagedTenant 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": [ {}, {} ] } ] } ] } } } } } } }, "404": { "description": "The managed tenant does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UpdateManagedTenant404Example": { "summary": "Default updateManagedTenant 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UpdateManagedTenant429Example": { "summary": "Default updateManagedTenant 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/user/{username}/credential/reset-token": { "get": { "tags": [ "User Management" ], "summary": "Palo Alto Networks Generate Password Reset Token", "description": "Triggers the forgot password flow where a password reset token is emailed to a validated user", "operationId": "resetToken", "parameters": [ { "name": "username", "in": "path", "description": "Username", "required": true, "schema": { "maxLength": 128, "minLength": 1, "type": "string" }, "example": "jsmith" } ], "responses": { "204": { "description": "Successful operation" }, "429": { "description": "Too many api request" } }, "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/stack-mapping": { "get": { "tags": [ "Stack Details Endpoint" ], "summary": "Palo Alto Networks Get List of Stacks and Api Hosts", "description": "Returns the list of stacks with display name and apiHosts, and plan types", "operationId": "requestStackMapping", "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/StackMappingPlanTypesListResponse" }, "examples": { "RequestStackMapping200Example": { "summary": "Default requestStackMapping 200 response", "x-microcks-default": true, "value": { "stackMappings": [ { "name": "Production Policy 31", "displayName": "Corporate Agent 42", "apiHost": "example-apiHost" }, { "name": "Production Sensor 26", "displayName": "Staging Agent 35", "apiHost": "example-apiHost" } ], "planTypes": [ "standard", "advanced" ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "RequestStackMapping401Example": { "summary": "Default requestStackMapping 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/token-refresh": { "get": { "tags": [ "User Authentication" ], "summary": "Palo Alto Networks Refresh User JWT", "description": "Refresh User JWT", "operationId": "refreshToken", "parameters": [ { "name": "mssp-id", "in": "path", "description": "MSSP Id", "required": true, "schema": { "type": "string" }, "example": "217742" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRefreshResponse" }, "examples": { "RefreshToken200Example": { "summary": "Default refreshToken 200 response", "x-microcks-default": true, "value": { "token": "89e1d118cd653806d56ad0072e459ad6" } } } } } }, "400": { "description": "Bad request. One of the required arguments is missing or fails a constraint", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "RefreshToken400Example": { "summary": "Default refreshToken 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": { "RefreshToken401Example": { "summary": "Default refreshToken 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 requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRefreshResponse" }, "examples": { "RefreshToken429Example": { "summary": "Default refreshToken 429 response", "x-microcks-default": true, "value": { "token": "89e1d118cd653806d56ad0072e459ad6" } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/operation": { "get": { "tags": [ "MSSP Account Management" ], "summary": "Palo Alto Networks Get the Operation List for an MSSP", "description": "Gets the list of operations for an MSSP.", "operationId": "getMsspOperations", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "249425" }, { "name": "status", "in": "query", "description": "optional filter by status, accepts \"success\", \"failure\", \"in_progress\"", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "IN_PROGRESS", "SUCCESS", "FAILURE" ] } }, "example": [ "IN_PROGRESS", "FAILURE" ] }, { "name": "show_retried", "in": "query", "description": "optional boolean filter to show retried operations, defaults to false", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "nextPageToken", "in": "query", "description": "pagination token to continue a previous query", "required": false, "schema": { "type": "string" }, "example": "example-nextPageToken" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/OperationsResponse" }, "examples": { "GetMsspOperations200Example": { "summary": "Default getMsspOperations 200 response", "x-microcks-default": true, "value": { "value": [ { "requestId": "4b0348d5-573c-4efd-a630-8b03814c6b3c", "msspId": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b", "operationType": "MESSAGE_FAN_OUT", "operationName": "POLICY_MAP", "operationDescription": "Incident incident configured investigation malware violation incident applied applied on network.", "status": "FAILURE", "tenantChanges": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ], "startedBy": "example-startedBy", "startedAt": 93, "updatedAt": 375, "isRetryable": true, "retryOf": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153", "retriedBy": "3ea1e71a-2068-4b42-91ea-859717617763" }, { "requestId": "4b0348d5-573c-4efd-a630-8b03814c6b3c", "msspId": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b", "operationType": "MESSAGE_FAN_OUT", "operationName": "POLICY_MAP", "operationDescription": "Incident incident configured investigation malware violation incident applied applied on network.", "status": "FAILURE", "tenantChanges": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ], "startedBy": "example-startedBy", "startedAt": 93, "updatedAt": 375, "isRetryable": true, "retryOf": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153", "retriedBy": "3ea1e71a-2068-4b42-91ea-859717617763" } ], "nextPageToken": "example-nextPageToken" } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspOperations404Example": { "summary": "Default getMsspOperations 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspOperations429Example": { "summary": "Default getMsspOperations 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/managed-tenant/{tenant-id}/login": { "get": { "tags": [ "MSSP Managed Tenant Lifecycle Endpoints" ], "summary": "Palo Alto Networks Seamless Login", "description": "Seamless login to managed tenant", "operationId": "seamlessLogin", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the mssp the managed tenants belong to", "required": true, "schema": { "type": "string" }, "example": "418507" }, { "name": "tenant-id", "in": "path", "description": "the prisma id or external tenant if of the managed tenant of interest", "required": true, "schema": { "type": "string" }, "example": "823937" }, { "name": "landing_page", "in": "query", "description": "The landing page for redirection on prisma tenant", "required": false, "schema": { "type": "string" }, "example": "example-landing_page" } ], "responses": { "200": { "description": "Login Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeamlessLoginResponse" }, "examples": { "SeamlessLogin200Example": { "summary": "Default seamlessLogin 200 response", "x-microcks-default": true, "value": { "token": "5e67f1fc069f5a0d9a48bcf34c02304d", "location": "example-location" } } } } } }, "400": { "description": "MsspId doesnt match with token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "SeamlessLogin400Example": { "summary": "Default seamlessLogin 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": { "SeamlessLogin401Example": { "summary": "Default seamlessLogin 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": "Tenant Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "SeamlessLogin404Example": { "summary": "Default seamlessLogin 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeamlessLoginResponse" }, "examples": { "SeamlessLogin429Example": { "summary": "Default seamlessLogin 429 response", "x-microcks-default": true, "value": { "token": "5e67f1fc069f5a0d9a48bcf34c02304d", "location": "example-location" } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/license-pool": { "get": { "tags": [ "MSSP Account Management" ], "summary": "Palo Alto Networks Get the License Pool Details of an Existing MSSP", "description": "Returns the details of an existing MSSP.", "operationId": "getMsspLicensePools", "parameters": [ { "name": "mssp-id", "in": "path", "description": "the id of the MSSP of interest", "required": true, "schema": { "type": "string" }, "example": "827871" } ], "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/MsspLicensePoolsResponse" }, "examples": { "GetMsspLicensePools200Example": { "summary": "Default getMsspLicensePools 200 response", "x-microcks-default": true, "value": { "value": [ { "licensePoolId": "791432", "poolName": "Branch Firewall 14", "serialNumber": "example-serialNumber", "msspId": "652019", "totalCredits": 749, "unallocatedCredits": 827, "startDate": 649, "endDate": 939, "tenantLicenses": [ { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 } ] }, { "licensePoolId": "791432", "poolName": "Branch Firewall 14", "serialNumber": "example-serialNumber", "msspId": "652019", "totalCredits": 749, "unallocatedCredits": 827, "startDate": 649, "endDate": 939, "tenantLicenses": [ { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 } ] } ], "nextPageToken": "example-nextPageToken" } } } } } }, "404": { "description": "The MSSP does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicensePools404Example": { "summary": "Default getMsspLicensePools 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": "Rate limiting error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicensePools429Example": { "summary": "Default getMsspLicensePools 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/license/info": { "get": { "tags": [ "Mssp License Endpoints" ], "summary": "Palo Alto Networks Get the License Info for MSSP", "description": "Get the license info for a MSSP", "operationId": "getMsspLicenseInfoV1", "responses": { "200": { "description": "OK", "content": { "application/json; charset=UTF-8": { "schema": { "$ref": "#/components/schemas/MsspLicenseInfoResponse" }, "examples": { "GetMsspLicenseInfoV1200Example": { "summary": "Default getMsspLicenseInfoV1 200 response", "x-microcks-default": true, "value": { "creditsPurchased": 658, "creditsAllocated": 596, "balanceCredit": 157, "numOfTenant": 306, "startTime": 1729330017973, "endTime": 1721793895841, "msspLicensePoolInfos": [ { "licensePoolName": "Branch Sensor 15", "licensePoolId": "776589", "serialNumber": "example-serialNumber", "startTime": 1701182573535, "endTime": 1712115339005, "numOfTenant": 265, "creditsAllocated": 145, "creditsPurchased": 707, "tenantGroupLicenseInfos": [ { "tenantGroupName": "Branch Agent 68", "tenantGroupId": "843820", "numOfTenant": 622, "creditsAllocated": 925 }, { "tenantGroupName": "Production Gateway 45", "tenantGroupId": "718815", "numOfTenant": 2, "creditsAllocated": 426 } ] } ] } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicenseInfoV1401Example": { "summary": "Default getMsspLicenseInfoV1 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Authorization failed, user doesn't have access to the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "GetMsspLicenseInfoV1403Example": { "summary": "Default getMsspLicenseInfoV1 403 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/mssp/{mssp-id}/tenant-group-policy-group-mapping/{mapping-id}": { "delete": { "tags": [ "Policy Group to Tenant Group Management" ], "summary": "Palo Alto Networks Delete an Association of Policy Group from Tenant Group", "description": "Deletes a policy group association from a tenant group. Will use msspId from the auth token if available.", "operationId": "delete-tenant-group-policy-group-mapping", "parameters": [ { "name": "mapping-id", "in": "path", "description": "the id of the policy group to tenant group mapping. You can get this from tenantGroups[x].id of the policy group response.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "52017d1a-d665-4187-8675-33ee1ac5b365" }, { "name": "mssp-id", "in": "path", "description": "the mssp the policy group belongs to", "required": true, "schema": { "type": "string" }, "example": "e91b486a-e139-4d3b-a9dd-959fd5cffb10" } ], "responses": { "204": { "description": "Delete Accepted", "headers": { "Location": { "description": "The relative path to the deleted tenant group to policy group mapping", "style": "simple", "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Tenant-Group-Policy-Group-Mapping400Example": { "summary": "Default delete-tenant-group-policy-group-mapping 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": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Tenant-Group-Policy-Group-Mapping401Example": { "summary": "Default delete-tenant-group-policy-group-mapping 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": [ {}, {} ] } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Delete-Tenant-Group-Policy-Group-Mapping403Example": { "summary": "Default delete-tenant-group-policy-group-mapping 403 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/ErrorResponse" }, "examples": { "Delete-Tenant-Group-Policy-Group-Mapping429Example": { "summary": "Default delete-tenant-group-policy-group-mapping 429 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": [ {}, {} ] } ] } ] } } } } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1/proxy/tenant/{prisma-id}/**": { "get": { "tags": [ "Proxy Endpoint Provider" ], "summary": "Palo Alto Networks Summary Needed", "description": "description needed", "operationId": "proxyRequest", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 657 }, { "name": "body", "in": "query", "required": true, "schema": { "type": "string" }, "example": "example-body" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_3", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 598 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_2", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 142 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_5", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 348 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "options": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_6", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true" }, "head": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_1", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true" }, "patch": { "tags": [ "Proxy Endpoint Provider" ], "operationId": "proxyRequest_4", "parameters": [ { "name": "prisma-id", "in": "path", "description": "prisma-id of the tenant to be proxied to", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 76 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "UserJwt": [] } ], "x-public": "true", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "ChangePasswordRequest": { "required": [ "password" ], "type": "object", "properties": { "password": { "type": "string", "description": "New Password", "example": "example-password" } } }, "Error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "example": "example-code" }, "message": { "type": "string", "example": "Incident malware violation firewall endpoint investigation firewall network rule blocked activity rule." }, "target": { "type": "string", "example": "example-target" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "example": [ { "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": [ {}, {} ] } ] } ] } } }, "ErrorResponse": { "required": [ "error" ], "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } } }, "MsspUserRequest": { "required": [ "firstName", "lastName", "username" ], "type": "object", "properties": { "username": { "maxLength": 128, "minLength": 1, "type": "string", "description": "User name of the user.", "example": "jane.doe" }, "firstName": { "maxLength": 63, "minLength": 1, "type": "string", "description": "First name of the user.", "example": "Primary Gateway 46" }, "lastName": { "maxLength": 63, "minLength": 1, "type": "string", "description": "Last name of the user.", "example": "Corporate Gateway 06" } } }, "MsspUserResponse": { "type": "object", "properties": { "username": { "type": "string", "example": "jane.doe" }, "firstName": { "type": "string", "example": "Production Agent 01" }, "lastName": { "type": "string", "example": "Primary Agent 97" }, "lastModifiedBy": { "type": "string", "example": "example-lastModifiedBy" }, "lastModifiedAt": { "type": "integer", "format": "int64", "example": 578 } } }, "PolicyGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 63, "minLength": 3, "type": "string", "description": "Name of the policy group.", "example": "Production Agent 45" }, "policies": { "type": "array", "description": "Policies assigned to this policy group.", "items": { "type": "string", "description": "Policies assigned to this policy group." }, "example": [ "example-policies_item" ] } } }, "ValidateTokenRequest": { "required": [ "resetToken" ], "type": "object", "properties": { "resetToken": { "type": "string", "description": "Reset password token", "example": "example-resetToken" } } }, "ValidateTokenResponse": { "type": "object", "properties": { "token": { "type": "string", "description": "Reset Password Restricted JWT", "example": "4c53e5f5a41d0f448065561d370f7834" } } }, "ContactInfo": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 63, "minLength": 1, "type": "string", "example": "Branch Sensor 70" }, "lastName": { "maxLength": 63, "minLength": 1, "type": "string", "example": "Staging Policy 31" }, "email": { "maxLength": 128, "minLength": 1, "type": "string", "example": "analyst1@example.com" } } }, "CreateMsspRequest": { "required": [ "contactInfo", "customerSupportId", "licensePool", "name" ], "type": "object", "properties": { "name": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Production Policy 69" }, "customerSupportId": { "type": "string", "example": "757905" }, "contactInfo": { "$ref": "#/components/schemas/ContactInfo" }, "licensePool": { "$ref": "#/components/schemas/MsspLicensePoolRequest" } } }, "MsspLicensePoolRequest": { "required": [ "credits", "endDate", "poolName", "serialNumber", "startDate" ], "type": "object", "properties": { "serialNumber": { "type": "string", "example": "example-serialNumber" }, "poolName": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Primary Sensor 71" }, "startDate": { "type": "integer", "format": "int64", "example": 915 }, "endDate": { "type": "integer", "format": "int64", "example": 918 }, "credits": { "minimum": 1, "type": "integer", "format": "int32", "example": 735 } } }, "CreateTenantGroupRequest": { "required": [ "groupName" ], "type": "object", "properties": { "groupName": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Staging Gateway 82" }, "tenantIds": { "type": "array", "items": { "type": "string" }, "example": [ "example-tenantIds_item", "example-tenantIds_item" ] } } }, "TenantGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "7f4e6576-9ea5-4354-a200-3c1205d09a9e" }, "groupName": { "type": "string", "example": "Branch Gateway 90" }, "tenants": { "type": "array", "items": { "$ref": "#/components/schemas/TenantIds" }, "example": [ { "externalTenantId": "849955", "prismaId": "788442" } ] }, "createdAt": { "type": "integer", "format": "int64", "example": 183 }, "createdBy": { "type": "string", "example": "example-createdBy" } } }, "TenantIds": { "type": "object", "properties": { "externalTenantId": { "type": "string", "example": "755704" }, "prismaId": { "type": "string", "example": "454413" } } }, "TenantGroupPolicyGroupMapRequest": { "required": [ "mappings" ], "type": "object", "properties": { "mappings": { "type": "array", "description": "Tenant group to Policy groups mappings.", "items": { "$ref": "#/components/schemas/TenantGroupPolicyGroupMapping" }, "example": [ { "tenantGroupId": "04e7c14c-0d44-48ff-91c4-4d4b10156455", "policyGroupIds": [ "9bec2de0-bb1d-4dcc-89d7-d8f0b938132b" ] } ] } } }, "TenantGroupPolicyGroupMapping": { "required": [ "policyGroupIds", "tenantGroupId" ], "type": "object", "properties": { "tenantGroupId": { "type": "string", "description": "Tenant group to which the policy groups are mapped.", "format": "uuid", "example": "bd1ccaf1-194d-43b2-9c04-b6ea957c0fd2" }, "policyGroupIds": { "type": "array", "description": "Policy groups to be mapped.", "items": { "type": "string", "description": "Policy groups to be mapped.", "format": "uuid" }, "example": [ "971f26b3-5745-441e-b0ac-c0f3a6968595", "8dff844a-68d5-442d-8b2f-fec17c060014" ] } }, "description": "Tenant group to Policy groups mappings." }, "TenantGroupPolicyGroupMappingResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "201aba9b-8ef8-43e0-aea9-27718b2ddbfc" }, "tenantGroupId": { "type": "string", "format": "uuid", "example": "a0b223c0-cda7-4dbd-8d4c-2e8b4b38c0e8" }, "policyGroupId": { "type": "string", "format": "uuid", "example": "c662e0b7-2ea3-4da4-9b4c-4ed3d083f851" } } }, "TenantGroupPolicyGroupMappingsResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/TenantGroupPolicyGroupMappingResponse" }, "example": [ { "id": "201aba9b-8ef8-43e0-aea9-27718b2ddbfc", "tenantGroupId": "a0b223c0-cda7-4dbd-8d4c-2e8b4b38c0e8", "policyGroupId": "c662e0b7-2ea3-4da4-9b4c-4ed3d083f851" } ] } } }, "CreatePolicyGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "7b13785c-32f1-4969-8a6e-d8fc9f6c6acd" }, "name": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Staging Agent 12" }, "policies": { "type": "array", "items": { "type": "string" }, "example": [ "example-policies_item" ] } } }, "OperationAckRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "enum": [ "SUCCESS", "FAILURE" ], "example": "SUCCESS" }, "errorMessage": { "type": "string", "example": "example-errorMessage" }, "tenantUpdate": { "$ref": "#/components/schemas/TenantUpdate" } } }, "TenantUpdate": { "type": "object", "properties": { "prismaId": { "type": "integer", "format": "int64", "example": 797 }, "externalTenantId": { "type": "string", "example": "225012" }, "stackName": { "type": "string", "example": "Branch Gateway 63" }, "stackBaseUrl": { "type": "string", "example": "example-stackBaseUrl" } } }, "OperationResponse": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "example": "4b0348d5-573c-4efd-a630-8b03814c6b3c" }, "msspId": { "type": "string", "format": "uuid", "example": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b" }, "operationType": { "type": "string", "enum": [ "MESSAGE_FAN_OUT", "ORCHESTRATOR_REQUEST" ], "example": "MESSAGE_FAN_OUT" }, "operationName": { "type": "string", "enum": [ "PROVISION_TENANT", "UPDATE_TENANT", "DELETE_TENANT", "OFFBOARD_TENANT", "REPLICATE_ACTION", "CREATE_USER", "UPDATE_USER", "DELETE_USER", "POLICY_MAP", "POLICY_UNMAP", "SYNC_POLICIES" ], "example": "POLICY_MAP" }, "operationDescription": { "type": "string", "example": "Incident incident configured investigation malware violation incident applied applied on network." }, "status": { "type": "string", "enum": [ "IN_PROGRESS", "SUCCESS", "FAILURE" ], "example": "FAILURE" }, "tenantChanges": { "type": "array", "items": { "$ref": "#/components/schemas/TenantChangeResponse" }, "example": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ] }, "startedBy": { "type": "string", "example": "example-startedBy" }, "startedAt": { "type": "integer", "format": "int64", "example": 93 }, "updatedAt": { "type": "integer", "format": "int64", "example": 375 }, "isRetryable": { "type": "boolean", "example": true }, "retryOf": { "type": "string", "format": "uuid", "example": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153" }, "retriedBy": { "type": "string", "format": "uuid", "example": "3ea1e71a-2068-4b42-91ea-859717617763" } } }, "TenantChangeResponse": { "type": "object", "properties": { "tenantChangeId": { "type": "string", "format": "uuid", "example": "21506922-dae2-4e8a-879f-b738126b7a2d" }, "externalTenantId": { "type": "string", "example": "833084" }, "tenantPrismaId": { "type": "string", "example": "169016" }, "status": { "type": "string", "enum": [ "IN_PROGRESS", "SUCCESS", "FAILURE" ], "example": "SUCCESS" }, "updatedAt": { "type": "integer", "format": "int64", "example": 131 } } }, "CreateManagedTenantRequest": { "required": [ "companyName", "contactInfo", "licenseInfo", "name", "planType", "region" ], "type": "object", "properties": { "name": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Branch Agent 28" }, "companyName": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Production Policy 50" }, "region": { "type": "string", "example": "eu-west-1" }, "tenantGroupId": { "type": "string", "format": "uuid", "example": "fedb2e94-6200-4f20-b7a9-78b393f82cb6" }, "planType": { "type": "string", "enum": [ "RS_STANDARD", "RS_FOUNDATION", "RS_ADVANCED" ], "example": "RS_ADVANCED" }, "contactInfo": { "$ref": "#/components/schemas/ContactInfo" }, "licenseInfo": { "$ref": "#/components/schemas/LicenseInfo" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleInfoRequest" }, "example": [ { "featureName": "Corporate Agent 22", "enabled": true, "additionalData": {} } ] } } }, "LicenseInfo": { "required": [ "allocatedCredits", "licensePoolId" ], "type": "object", "properties": { "licensePoolId": { "type": "string", "example": "891733" }, "allocatedCredits": { "minimum": 1, "type": "integer", "format": "int32", "example": 729 } } }, "ModuleInfoRequest": { "required": [ "enabled", "featureName" ], "type": "object", "properties": { "featureName": { "pattern": "iam-security", "type": "string", "example": "Corporate Firewall 42" }, "enabled": { "type": "boolean", "example": true }, "additionalData": { "type": "object", "additionalProperties": { "type": "object" }, "example": {} } } }, "ManagedTenantLicenseResponse": { "type": "object", "properties": { "tenantLicenseId": { "type": "string", "example": "109663" }, "serialNumber": { "type": "string", "example": "example-serialNumber" }, "licensePoolId": { "type": "string", "example": "997200" }, "allocatedCredits": { "type": "integer", "format": "int32", "example": 456 }, "startDate": { "type": "integer", "format": "int64", "example": 589 }, "endDate": { "type": "integer", "format": "int64", "example": 255 } } }, "ManagedTenantResponse": { "type": "object", "properties": { "prismaId": { "type": "string", "example": "181916" }, "externalTenantId": { "type": "string", "example": "666088" }, "customerName": { "type": "string", "example": "Branch Sensor 23" }, "companyName": { "type": "string", "example": "Production Sensor 74" }, "status": { "type": "string", "enum": [ "ACTIVE", "PROVISIONING", "UPDATING", "DELETING", "DELETED", "OFFBOARDING", "ERRORED" ], "example": "DELETING" }, "isSynthetic": { "type": "boolean", "example": false }, "wasMigrated": { "type": "boolean", "example": true }, "msspId": { "type": "string", "example": "581159" }, "tenantGroupId": { "type": "string", "format": "uuid", "example": "d97478e0-2164-432c-a1dc-ee53918a7fb3" }, "planType": { "type": "string", "enum": [ "RS_STANDARD", "RS_FOUNDATION", "RS_ADVANCED" ], "example": "RS_FOUNDATION" }, "contactInfo": { "$ref": "#/components/schemas/ContactInfo" }, "stack": { "type": "string", "example": "example-stack" }, "region": { "type": "string", "example": "us-east-1" }, "baseApiUrl": { "type": "string", "example": "example-baseApiUrl" }, "tenantLicense": { "$ref": "#/components/schemas/ManagedTenantLicenseResponse" }, "createdBy": { "type": "string", "example": "example-createdBy" }, "createdAt": { "type": "integer", "format": "int64", "example": 530 }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleInfo" }, "example": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ] }, "erroredBy": { "type": "string", "format": "uuid", "example": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" } } }, "ModuleInfo": { "required": [ "feature_name" ], "type": "object", "properties": { "feature_name": { "type": "string", "example": "Branch Policy 59" }, "enabled": { "type": "boolean", "example": true }, "billing_type": { "type": "string", "enum": [ "TRIAL", "BUY" ], "example": "BUY" }, "state": { "type": "string", "enum": [ "PROVISION_STARTED", "PROVISION_SUCCESSFUL", "PROVISION_FAILED" ], "example": "PROVISION_FAILED" }, "additional_data": { "type": "object", "additionalProperties": { "type": "object" }, "example": {} } } }, "FormLoginRequest": { "required": [ "password", "username" ], "type": "object", "properties": { "username": { "type": "string", "description": "username of the user", "example": "soc-analyst" }, "password": { "type": "string", "description": "password of the user", "example": "example-password" } } }, "FormLoginResponse": { "type": "object", "properties": { "token": { "type": "string", "example": "fa9da05f5324df66e7df52a8ba08be8d" }, "msspId": { "type": "string", "example": "437386" }, "message": { "type": "string", "example": "On rule incident configured threat applied threat suspicious." } } }, "MsspLicenseUsageResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/TenantLicenseUsage" }, "example": [ { "tenantName": "Production Agent 53", "prismaId": "999338", "createdOn": 201, "expiringOn": 627, "status": "DELETING", "creditsAllocated": 752, "avgConsumption": 781, "lastUpdated": 896, "externalTenantId": "986311" }, { "tenantName": "Staging Sensor 16", "prismaId": "842673", "createdOn": 662, "expiringOn": 182, "status": "ACTIVE", "creditsAllocated": 585, "avgConsumption": 766, "lastUpdated": 138, "externalTenantId": "479192" } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "TenantLicenseUsage": { "type": "object", "properties": { "tenantName": { "type": "string", "example": "Branch Gateway 36" }, "prismaId": { "type": "string", "example": "571390" }, "createdOn": { "type": "integer", "format": "int64", "example": 998 }, "expiringOn": { "type": "integer", "format": "int64", "example": 492 }, "status": { "type": "string", "enum": [ "ACTIVE", "PROVISIONING", "UPDATING", "DELETING", "DELETED", "OFFBOARDING", "ERRORED" ], "example": "OFFBOARDING" }, "creditsAllocated": { "type": "integer", "format": "int32", "example": 409 }, "avgConsumption": { "type": "integer", "format": "int32", "example": 137 }, "lastUpdated": { "type": "integer", "format": "int64", "example": 82 }, "externalTenantId": { "type": "string", "example": "501635" } } }, "MsspLicenseUsageRequestObject": { "required": [ "licensePoolId" ], "type": "object", "properties": { "tenantGroupId": { "type": "string", "example": "609286" }, "licensePoolId": { "type": "string", "example": "720133" }, "timeRange": { "oneOf": [ { "$ref": "#/components/schemas/RelativeTimeRangeConfig" }, { "$ref": "#/components/schemas/ToNowTimeRangeConfig" } ], "example": "example-timeRange" }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "RelativeTimeDuration": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "week", "month", "year" ], "example": "year" }, "amount": { "type": "integer", "description": "Number of time units", "format": "int32", "example": 241 } } }, "RelativeTimeRangeConfig": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TimeRangeConfigObject" }, { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/RelativeTimeDuration" } } } ] }, "TimeRangeConfigObject": { "type": "object", "properties": { "type": { "type": "string", "example": "standard" }, "timeUnit": { "type": "string", "example": "example-timeUnit" }, "timeValue": { "type": "integer", "format": "int32", "example": 586 } }, "discriminator": { "propertyName": "type" } }, "ToNowTimeRangeConfig": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/TimeRangeConfigObject" }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "week", "month", "year" ] } } } ] }, "ScheduleTaskRequest": { "type": "object", "properties": { "scheduledTime": { "type": "integer", "format": "int64", "example": 145 }, "prismaIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "example": [ 922 ] } } }, "V1Response": { "type": "object" }, "UpdateMsspRequest": { "type": "object", "properties": { "name": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Primary Gateway 08" }, "addLicensePool": { "$ref": "#/components/schemas/MsspLicensePoolRequest" } } }, "MsspResponse": { "type": "object", "properties": { "msspId": { "type": "string", "example": "963068" }, "name": { "type": "string", "example": "Corporate Gateway 26" }, "createdBy": { "type": "string", "example": "example-createdBy" }, "createdAt": { "type": "integer", "format": "int64", "example": 414 }, "customerSupportId": { "type": "string", "example": "670106" }, "contactInfo": { "$ref": "#/components/schemas/ContactInfo" } } }, "UpdateTenantGroupRequest": { "required": [ "groupName" ], "type": "object", "properties": { "groupName": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Staging Firewall 76" }, "tenantIds": { "type": "array", "items": { "type": "string" }, "example": [ "example-tenantIds_item" ] } } }, "UpdateManagedTenantRequest": { "type": "object", "properties": { "tenantGroupId": { "type": "string", "format": "uuid", "example": "4bf4541a-4d22-4119-b6ae-0617c59ea86c" }, "companyName": { "maxLength": 63, "minLength": 3, "type": "string", "example": "Staging Policy 81" }, "licenseInfo": { "$ref": "#/components/schemas/LicenseInfo" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleInfoRequest" }, "example": [ { "featureName": "Corporate Firewall 42", "enabled": true, "additionalData": {} } ] } } }, "RecurString": { "type": "object", "properties": { "type": { "type": "string", "example": "standard" }, "recurString": { "type": "string", "example": "example-recurString" } } }, "Task": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "2b91f0d8-ec70-45fa-a650-79bfe1250921" }, "webhookUrl": { "type": "string", "example": "example-webhookUrl" }, "description": { "type": "string", "example": "On blocked endpoint network traffic violation monitoring applied threat firewall malware alert." }, "scheduledTime": { "type": "integer", "format": "int64", "example": 933 }, "submitTime": { "type": "integer", "format": "int64", "example": 425 }, "recur": { "$ref": "#/components/schemas/RecurString" }, "matureTime": { "type": "integer", "format": "int64", "example": 142 }, "cancel": { "type": "boolean", "example": false }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "example": {} } } }, "StackMappingPlanTypesListResponse": { "type": "object", "properties": { "stackMappings": { "type": "array", "items": { "$ref": "#/components/schemas/StackMappingResponse" }, "example": [ { "name": "Production Policy 31", "displayName": "Corporate Agent 42", "apiHost": "example-apiHost" }, { "name": "Production Sensor 26", "displayName": "Staging Agent 35", "apiHost": "example-apiHost" } ] }, "planTypes": { "type": "array", "items": { "type": "string" }, "example": [ "standard", "advanced" ] } } }, "StackMappingResponse": { "type": "object", "properties": { "name": { "type": "string", "example": "Primary Policy 95" }, "displayName": { "type": "string", "example": "Branch Firewall 99" }, "apiHost": { "type": "string", "example": "example-apiHost" } } }, "MsspListUserResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/MsspUserResponse" }, "example": [ { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 }, { "username": "jane.doe", "firstName": "Production Agent 01", "lastName": "Primary Agent 97", "lastModifiedBy": "example-lastModifiedBy", "lastModifiedAt": 578 } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "TokenRefreshResponse": { "type": "object", "properties": { "token": { "type": "string", "example": "89e1d118cd653806d56ad0072e459ad6" } } }, "TenantGroupsResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/TenantGroupResponse" }, "example": [ { "id": "7f4e6576-9ea5-4354-a200-3c1205d09a9e", "groupName": "Branch Gateway 90", "tenants": [ { "externalTenantId": "849955", "prismaId": "788442" } ], "createdAt": 183, "createdBy": "example-createdBy" } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "PolicyGroupListResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "87eb394e-a31f-4802-9c0c-90060f936459" }, "name": { "type": "string", "example": "Staging Sensor 65" }, "policyCount": { "type": "integer", "format": "int32", "example": 601 }, "tenantGroupCount": { "type": "integer", "format": "int32", "example": 617 } } }, "PolicyGroupsListResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyGroupListResponse" }, "example": [ { "id": "87eb394e-a31f-4802-9c0c-90060f936459", "name": "Staging Sensor 65", "policyCount": 601, "tenantGroupCount": 617 }, { "id": "87eb394e-a31f-4802-9c0c-90060f936459", "name": "Staging Sensor 65", "policyCount": 601, "tenantGroupCount": 617 } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "PolicyGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "289a717e-8053-4e21-b5be-23f1918a1628" }, "name": { "type": "string", "example": "Production Agent 76" }, "policies": { "type": "array", "items": { "type": "string" }, "example": [ "example-policies_item" ] }, "tenantGroups": { "type": "array", "items": { "$ref": "#/components/schemas/TenantGroupMappingDetails" }, "example": [ { "id": "ad7141fc-7249-4085-ba81-89c7dce06beb", "tenantGroupId": "016e80c2-a77b-43b9-8892-71848159488e", "tenantGroupName": "Branch Policy 91", "tenantCount": 729 } ] } } }, "TenantGroupMappingDetails": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "76ac47ff-a974-4764-8b56-a6fbf64aecb9" }, "tenantGroupId": { "type": "string", "format": "uuid", "example": "27542068-18f9-4a68-9f7f-ebe5bf91a1dd" }, "tenantGroupName": { "type": "string", "example": "Branch Agent 07" }, "tenantCount": { "type": "integer", "format": "int32", "example": 171 } } }, "OperationsResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/OperationResponse" }, "example": [ { "requestId": "4b0348d5-573c-4efd-a630-8b03814c6b3c", "msspId": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b", "operationType": "MESSAGE_FAN_OUT", "operationName": "POLICY_MAP", "operationDescription": "Incident incident configured investigation malware violation incident applied applied on network.", "status": "FAILURE", "tenantChanges": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ], "startedBy": "example-startedBy", "startedAt": 93, "updatedAt": 375, "isRetryable": true, "retryOf": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153", "retriedBy": "3ea1e71a-2068-4b42-91ea-859717617763" }, { "requestId": "4b0348d5-573c-4efd-a630-8b03814c6b3c", "msspId": "e63fa3c6-95a4-4aeb-98f7-e9aa00a7558b", "operationType": "MESSAGE_FAN_OUT", "operationName": "POLICY_MAP", "operationDescription": "Incident incident configured investigation malware violation incident applied applied on network.", "status": "FAILURE", "tenantChanges": [ { "tenantChangeId": "018cb8f2-d5f2-43b8-9571-f38716ffe3d2", "externalTenantId": "426227", "tenantPrismaId": "519160", "status": "IN_PROGRESS", "updatedAt": 73 } ], "startedBy": "example-startedBy", "startedAt": 93, "updatedAt": 375, "isRetryable": true, "retryOf": "5716ecaa-0bb9-4bf6-ae8d-f2afdc9dc153", "retriedBy": "3ea1e71a-2068-4b42-91ea-859717617763" } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "ManagedTenantsResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedTenantResponse" }, "example": [ { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" }, { "prismaId": "181916", "externalTenantId": "666088", "customerName": "Branch Sensor 23", "companyName": "Production Sensor 74", "status": "DELETING", "isSynthetic": false, "wasMigrated": true, "msspId": "581159", "tenantGroupId": "d97478e0-2164-432c-a1dc-ee53918a7fb3", "planType": "RS_FOUNDATION", "contactInfo": { "firstName": "Branch Sensor 70", "lastName": "Staging Policy 31", "email": "analyst1@example.com" }, "stack": "example-stack", "region": "us-east-1", "baseApiUrl": "example-baseApiUrl", "tenantLicense": { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 }, "createdBy": "example-createdBy", "createdAt": 530, "modules": [ { "feature_name": "Branch Agent 34", "enabled": true, "billing_type": "TRIAL", "state": "PROVISION_STARTED", "additional_data": {} } ], "erroredBy": "b1bef040-d3dc-4eac-ba7f-ee158ca14f1c" } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "ManagedTenantDetailedResponse": { "type": "object", "properties": { "prismaId": { "type": "string", "example": "222478" }, "externalTenantId": { "type": "string", "example": "895934" }, "customerName": { "type": "string", "example": "Staging Policy 84" }, "companyName": { "type": "string", "example": "Branch Firewall 61" }, "status": { "type": "string", "enum": [ "ACTIVE", "PROVISIONING", "UPDATING", "DELETING", "DELETED", "OFFBOARDING", "ERRORED" ], "example": "ERRORED" }, "isSynthetic": { "type": "boolean", "example": true }, "wasMigrated": { "type": "boolean", "example": true }, "msspId": { "type": "string", "example": "442187" }, "tenantGroupId": { "type": "string", "format": "uuid", "example": "aa8a8ae2-ba70-450a-b7df-423ed6589a61" }, "planType": { "type": "string", "enum": [ "RS_STANDARD", "RS_FOUNDATION", "RS_ADVANCED" ], "example": "RS_STANDARD" }, "contactInfo": { "$ref": "#/components/schemas/ContactInfo" }, "stack": { "type": "string", "example": "example-stack" }, "region": { "type": "string", "example": "eu-west-1" }, "baseApiUrl": { "type": "string", "example": "example-baseApiUrl" }, "tenantLicense": { "$ref": "#/components/schemas/ManagedTenantLicenseResponse" }, "createdBy": { "type": "string", "example": "example-createdBy" }, "createdAt": { "type": "integer", "format": "int64", "example": 372 }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleInfo" }, "example": [ { "feature_name": "Branch Policy 59", "enabled": true, "billing_type": "BUY", "state": "PROVISION_FAILED", "additional_data": {} }, { "feature_name": "Branch Policy 59", "enabled": true, "billing_type": "BUY", "state": "PROVISION_FAILED", "additional_data": {} } ] }, "erroredBy": { "type": "string", "format": "uuid", "example": "62275c4f-4c58-4c7a-a21d-e31bd07cf940" }, "policyGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyGroupInfo" }, "example": [ { "id": "318094fe-783b-4bdc-aeae-b9f2831c2d35", "name": "Staging Policy 69", "policyCount": 26 } ] } } }, "PolicyGroupInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "55be82da-9c54-4a91-a816-db48bb33f550" }, "name": { "type": "string", "example": "Corporate Firewall 35" }, "policyCount": { "type": "integer", "format": "int32", "example": 452 } } }, "SeamlessLoginResponse": { "type": "object", "properties": { "token": { "type": "string", "example": "5e67f1fc069f5a0d9a48bcf34c02304d" }, "location": { "type": "string", "example": "example-location" } } }, "MsspLicensePoolResponse": { "type": "object", "properties": { "licensePoolId": { "type": "string", "example": "791432" }, "poolName": { "type": "string", "example": "Branch Firewall 14" }, "serialNumber": { "type": "string", "example": "example-serialNumber" }, "msspId": { "type": "string", "example": "652019" }, "totalCredits": { "type": "integer", "format": "int32", "example": 749 }, "unallocatedCredits": { "type": "integer", "format": "int32", "example": 827 }, "startDate": { "type": "integer", "format": "int64", "example": 649 }, "endDate": { "type": "integer", "format": "int64", "example": 939 }, "tenantLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedTenantLicenseResponse" }, "example": [ { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 } ] } } }, "MsspLicensePoolsResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/MsspLicensePoolResponse" }, "example": [ { "licensePoolId": "791432", "poolName": "Branch Firewall 14", "serialNumber": "example-serialNumber", "msspId": "652019", "totalCredits": 749, "unallocatedCredits": 827, "startDate": 649, "endDate": 939, "tenantLicenses": [ { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 } ] }, { "licensePoolId": "791432", "poolName": "Branch Firewall 14", "serialNumber": "example-serialNumber", "msspId": "652019", "totalCredits": 749, "unallocatedCredits": 827, "startDate": 649, "endDate": 939, "tenantLicenses": [ { "tenantLicenseId": "109663", "serialNumber": "example-serialNumber", "licensePoolId": "997200", "allocatedCredits": 456, "startDate": 589, "endDate": 255 } ] } ] }, "nextPageToken": { "type": "string", "example": "example-nextPageToken" } } }, "LicensePoolInfo": { "type": "object", "properties": { "licensePoolName": { "type": "string", "example": "Branch Sensor 15" }, "licensePoolId": { "type": "string", "example": "776589" }, "serialNumber": { "type": "string", "example": "example-serialNumber" }, "startTime": { "type": "integer", "format": "int64", "example": 1701182573535 }, "endTime": { "type": "integer", "format": "int64", "example": 1712115339005 }, "numOfTenant": { "type": "integer", "format": "int32", "example": 265 }, "creditsAllocated": { "type": "integer", "format": "int32", "example": 145 }, "creditsPurchased": { "type": "integer", "format": "int32", "example": 707 }, "tenantGroupLicenseInfos": { "type": "array", "items": { "$ref": "#/components/schemas/TenantGroupLicenseInfo" }, "example": [ { "tenantGroupName": "Branch Agent 68", "tenantGroupId": "843820", "numOfTenant": 622, "creditsAllocated": 925 }, { "tenantGroupName": "Production Gateway 45", "tenantGroupId": "718815", "numOfTenant": 2, "creditsAllocated": 426 } ] } } }, "MsspLicenseInfoResponse": { "type": "object", "properties": { "creditsPurchased": { "type": "integer", "format": "int32", "example": 658 }, "creditsAllocated": { "type": "integer", "format": "int32", "example": 596 }, "balanceCredit": { "type": "integer", "format": "int32", "example": 157 }, "numOfTenant": { "type": "integer", "format": "int32", "example": 306 }, "startTime": { "type": "integer", "format": "int64", "example": 1729330017973 }, "endTime": { "type": "integer", "format": "int64", "example": 1721793895841 }, "msspLicensePoolInfos": { "type": "array", "items": { "$ref": "#/components/schemas/LicensePoolInfo" }, "example": [ { "licensePoolName": "Branch Sensor 15", "licensePoolId": "776589", "serialNumber": "example-serialNumber", "startTime": 1701182573535, "endTime": 1712115339005, "numOfTenant": 265, "creditsAllocated": 145, "creditsPurchased": 707, "tenantGroupLicenseInfos": [ { "tenantGroupName": "Branch Agent 68", "tenantGroupId": "843820", "numOfTenant": 622, "creditsAllocated": 925 }, { "tenantGroupName": "Production Gateway 45", "tenantGroupId": "718815", "numOfTenant": 2, "creditsAllocated": 426 } ] } ] } } }, "TenantGroupLicenseInfo": { "type": "object", "properties": { "tenantGroupName": { "type": "string", "example": "Primary Sensor 61" }, "tenantGroupId": { "type": "string", "example": "715892" }, "numOfTenant": { "type": "integer", "format": "int32", "example": 842 }, "creditsAllocated": { "type": "integer", "format": "int32", "example": 391 } } }, "JwkResponse": { "required": [ "alg", "key_ops", "kid", "kty" ], "type": "object", "properties": { "kid": { "type": "string", "example": "692165" }, "kty": { "type": "string", "example": "example-kty" }, "alg": { "type": "string", "example": "example-alg" }, "key_ops": { "type": "array", "items": { "type": "string" }, "example": [ "example-key_ops_item" ] }, "e": { "type": "string", "example": "example-e" }, "n": { "type": "string", "example": "example-n" } } }, "JwksResponse": { "required": [ "keys" ], "type": "object", "properties": { "keys": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/JwkResponse" }, "example": [ { "kid": "692165", "kty": "example-kty", "alg": "example-alg", "key_ops": [ "example-key_ops_item" ], "e": "example-e", "n": "example-n" } ] } } } }, "headers": { "prismaId": { "description": "x-prisma-tenant-id", "style": "simple", "schema": { "type": "string" } } }, "securitySchemes": { "ServiceJwt": { "type": "http", "description": "Service to Service communication JWT. Such tokens are available to other microservices", "scheme": "bearer", "bearerFormat": "JWT" }, "UserJwt": { "type": "http", "description": "JWT for User to Service communication. Such tokens are available to MSSP account users", "scheme": "bearer", "bearerFormat": "JWT" } } }, "x-tagGroups": [ { "tags": [ "User Authentication", "MSSP Account Management", "User Management", "MSSP Managed Tenant Lifecycle Endpoints", "Tenant Group Lifecycle Endpoints", "Policy Group Lifecycle Endpoints", "Policy Group to Tenant Group Management", "MSSP Operations Retry", "Mssp License Endpoints", "Stack Details Endpoint", "Proxy Endpoint Provider" ], "name": "public" }, { "tags": [ "Managed Tenant Management Service", "MSSP Async Change Management", "Licensing Job Schedule Management", "OIDC Discovery Endpoint", "MSSP Account Management Service Endpoint" ], "name": "service" }, { "tags": [ "Hard Delete Managed Tenant" ], "name": "support" } ] }