From 93a5cc24b1bc7c50acefd7589902fdc4d3d55416 Mon Sep 17 00:00:00 2001 From: sra Date: Fri, 5 Sep 2025 10:23:41 +0530 Subject: [PATCH] DOCS-8474Updated request parameter to x-panw-region. --- openapi-specs/sase/sspm/consolidated.yaml | 597 +++++----------------- 1 file changed, 116 insertions(+), 481 deletions(-) diff --git a/openapi-specs/sase/sspm/consolidated.yaml b/openapi-specs/sase/sspm/consolidated.yaml index 94db8ce9d..3eadb5223 100644 --- a/openapi-specs/sase/sspm/consolidated.yaml +++ b/openapi-specs/sase/sspm/consolidated.yaml @@ -308,18 +308,6 @@ components: - bool type: string type: object - ClassificationStatusAggregation: - properties: - sanctioned_third_party_apps: - format: int32 - type: integer - total_third_party_apps: - format: int32 - type: integer - users_using_unsanctioned_apps: - format: int32 - type: integer - type: object CommonControlProfiles: description: 'Lists compliance profiles associated with a common control. @@ -565,162 +553,6 @@ components: $ref: '#/components/schemas/JiraIssueType' type: array type: object - Metadata: - properties: - badge: - items: - type: string - type: array - compatible_products: - items: - type: string - type: array - data_used_in_models: - type: string - description: - type: string - download_count: - format: int32 - type: integer - icon: - type: string - is_bot: - type: boolean - is_copilot: - type: boolean - is_gen_ai: - type: boolean - plugin_name: - type: string - publisher_name: - type: string - review_count: - format: int32 - type: integer - risk: - format: int32 - type: integer - use_cases: - items: - type: string - type: array - type: object - Plugin: - properties: - app_id: - type: string - app_name: - type: string - app_type: - type: string - base_app_id: - type: string - classification: - type: string - has_policies: - type: boolean - high_scopes: - items: - $ref: '#/components/schemas/ThirdPartyAppScope' - type: array - id: - type: string - is_public: - type: boolean - level: - enum: - - PRODUCT - - ORGANIZATION - - WORKSPACE - - USER - type: string - low_scopes: - items: - $ref: '#/components/schemas/ThirdPartyAppScope' - type: array - marketplace: - type: string - marketplace_app_id: - type: string - medium_scopes: - items: - $ref: '#/components/schemas/ThirdPartyAppScope' - type: array - metadata: - $ref: '#/components/schemas/Metadata' - severity: - type: string - status: - type: string - tenant: - type: string - third_party_app_id: - type: string - third_party_app_name: - type: string - user_count: - format: int32 - type: integer - user_counts: - additionalProperties: - format: int32 - type: integer - type: object - type: object - PluginPage: - properties: - items: - items: - $ref: '#/components/schemas/Plugin' - type: array - limit: - format: int32 - type: integer - next_path: - type: string - prev_path: - type: string - total: - format: int64 - type: integer - type: object - PluginUser: - properties: - email: - type: string - full_names: - items: - type: string - type: array - id: - type: string - marketplaces: - items: - type: string - type: array - tenant: - type: string - user_level_plugins_count: - format: int32 - type: integer - type: object - PluginUserPage: - properties: - items: - items: - $ref: '#/components/schemas/PluginUser' - type: array - limit: - format: int32 - type: integer - next_path: - type: string - prev_path: - type: string - total: - format: int64 - type: integer - type: object RemediationConfig: description: 'Defines remediation configuration for a setting. @@ -793,19 +625,6 @@ components: description: Name of the status. type: string type: object - ThirdPartyAppScope: - properties: - id: - type: string - name: - type: string - risk: - type: string - required: - - id - - name - - risk - type: object Ticket: description: 'Represents a ticket associated with a configuration or issue. @@ -856,53 +675,6 @@ components: - full_name - user_id type: object - UserToPlugin: - properties: - app_id: - type: string - app_name: - type: string - full_name: - type: string - level: - enum: - - PRODUCT - - ORGANIZATION - - WORKSPACE - - USER - type: string - marketplace: - type: string - severity: - type: string - status: - type: string - tenant: - type: string - third_party_app_id: - type: string - third_party_app_name: - type: string - user_id: - type: string - type: object - UserToPluginPage: - properties: - items: - items: - $ref: '#/components/schemas/UserToPlugin' - type: array - limit: - format: int32 - type: integer - next_path: - type: string - prev_path: - type: string - total: - format: int64 - type: integer - type: object securitySchemes: Bearer: scheme: bearer @@ -916,10 +688,11 @@ info: \ monitoring, detection of misconfigured SaaS application settings.\nThese APIs\ \ use the common SASE authentication mechanism and base URL. \nSee the [Prisma\ \ SASE API Get Started](https://pan.dev/sase/docs/getstarted) guide for more information.\n\ - \nThis Open API spec file was created on June 13, 2025. To check for a more recent\ - \ version of this file, see\n[SaaS Security Posture Management APIs on pan.dev](https://pan.dev/sase/api/sspm/).\n\ - \n\xA9 2024 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\ - \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ + \nThis Open API spec file was created on September 05, 2025. To check for a more\ + \ recent version of this file, see\n[SaaS Security Posture Management APIs on\ + \ pan.dev](https://pan.dev/sase/api/sspm/).\n\n\xA9 2024 Palo Alto Networks, Inc.\ + \ Palo Alto Networks is a registered trademark of Palo\nAlto Networks. A list\ + \ of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ \nAll other marks mentioned herein may be trademarks of their respective companies.\n" license: name: MIT @@ -936,6 +709,12 @@ paths: ' operationId: get-sspm-api-v1-apps parameters: + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string - description: List of filters example: filter=type:office365 in: query @@ -961,7 +740,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ApplicationPage' - description: Successful operation + description: successful operation security: - Bearer: [] summary: Get registered application @@ -975,6 +754,12 @@ paths: ' operationId: get-sspm-api-v1-apps-app_id parameters: + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string - description: application id example: f1700e7b-e60f-4d5e-bfce-aba3543adf8e in: path @@ -988,9 +773,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Application' - description: Successful operation + description: successful operation '404': - description: Application not registered + description: not registered application security: - Bearer: [] summary: Application details @@ -1004,7 +789,13 @@ paths: ' operationId: get-sspm-api-v1-apps-app_id-configs parameters: - - description: Application ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: application id example: f1700e7b-e60f-4d5e-bfce-aba3543adf8e in: path name: app_id @@ -1019,9 +810,9 @@ paths: items: $ref: '#/components/schemas/Config' type: array - description: Successful operation + description: successful operation '404': - description: Application not registered + description: not registered application security: - Bearer: [] summary: Application configuration details @@ -1033,7 +824,13 @@ paths: \ app ID and tenant name. \n" operationId: get-sspm-api-v1-apps-app_id-settings parameters: - - description: Application ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: application id example: f1700e7b-e60f-4d5e-bfce-aba3543adf8e in: path name: app_id @@ -1048,9 +845,9 @@ paths: items: $ref: '#/components/schemas/Config' type: array - description: Successful operation + description: successful operation '404': - description: Application not registered + description: not registered application security: - Bearer: [] summary: Application settings details @@ -1076,9 +873,9 @@ paths: application/json: schema: $ref: '#/components/schemas/ApplicationAuthInfo' - description: Successful operation + description: successful operation '404': - description: Application not registered + description: not registered application security: - Bearer: [] summary: Authorization information @@ -1096,7 +893,7 @@ paths: items: $ref: '#/components/schemas/CatalogApplication' type: array - description: Successful operation + description: successful operation security: - Bearer: [] summary: Catalog of supported SSPM applications @@ -1108,6 +905,12 @@ paths: \ providing application type. \n" operationId: get-sspm-api-v1-catalog-apps-app parameters: + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string - description: application name example: servicenow in: path @@ -1121,7 +924,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CatalogApplication' - description: Successful operation + description: successful operation security: - Bearer: [] summary: Catalog setting details @@ -1135,6 +938,12 @@ paths: ' operationId: get-sspm-api-v1-catalog-apps-app-configs parameters: + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string - description: application name example: servicenow in: path @@ -1150,7 +959,7 @@ paths: items: $ref: '#/components/schemas/CatalogConfig' type: array - description: Successful operation + description: successful operation security: - Bearer: [] summary: Catalog configuration settings details @@ -1162,7 +971,13 @@ paths: \ type. \n" operationId: get-sspm-api-v1-catalog-apps-app-scopes parameters: - - description: Application Name + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: application name example: servicenow in: path name: app @@ -1177,7 +992,7 @@ paths: items: $ref: '#/components/schemas/ScopeConfig' type: array - description: Successful operation + description: successful operation security: - Bearer: [] summary: Plugin scope catalog @@ -1190,39 +1005,55 @@ paths: ' operationId: get-sspm-api-v1-catalog-controls-common_control_id parameters: - - description: Common Control ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: common control id example: PAN-00000001 in: path name: common_control_id required: true schema: type: string + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonControlProfiles' - description: Successful operation + description: successful operation security: - Bearer: [] summary: Compliance profile mappings tags: - Catalog Information - /sspm/api/v1/integration/integrations/:integration_id/JIRA_TICKETING/issue/{key}: + /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/issue/{key}: get: - description: Retrieve detailed information about a specific issue using the - issue key. - operationId: get-sspm-api-v1-integration-integrations-:integration_id-jira_ticketing-issue-key + operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-issue-key parameters: - - description: integration ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: integration id example: 65dcec42a2f1d37173e6294c in: path name: integration_id required: true schema: type: string - - description: Integration type + - description: integration type example: JIRA_TICKETING in: path name: integration_type @@ -1242,28 +1073,32 @@ paths: application/json: schema: $ref: '#/components/schemas/JiraIssueResponse' - description: Successful operation + description: successful operation '404': - description: Jira-ticketing integration not registered. + description: not registered jira-ticketing integration security: - Bearer: [] - summary: JIRA ticket issue details + summary: Fetch onboarded JIRA ticketing issue details by key. tags: - JIRA - /sspm/api/v1/integration/integrations/:integration_id/JIRA_TICKETING/project/{key}: + /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/project/{key}: get: - description: Retrieve detailed information about a project. The response includes - issue keys that you can use in the next step. - operationId: get-sspm-api-v1-integration-integrations-:integration_id-jira_ticketing-project-key + operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-project-key parameters: - - description: integration ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: integration id example: 65dcec42a2f1d37173e6294c in: path name: integration_id required: true schema: type: string - - description: Integration type + - description: integration type example: JIRA_TICKETING in: path name: integration_type @@ -1283,27 +1118,32 @@ paths: application/json: schema: $ref: '#/components/schemas/JiraProjectDetailResponse' - description: Successful operation + description: successful operation '404': - description: The Jira-ticketing integration is not registered. + description: not registered jira-ticketing integration security: - Bearer: [] - summary: Project information using issue key + summary: Fetch onboarded JIRA ticketing project details by key. tags: - JIRA - /sspm/api/v1/integration/integrations/:integration_id/JIRA_TICKETING/projects: + /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/projects: get: - description: Retrieve a list of JIRA tickets. - operationId: get-sspm-api-v1-integration-integrations-:integration_id-jira_ticketing-projects + operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-projects parameters: - - description: Integration ID + - description: region + in: header + name: x-panw-region + required: false + schema: + type: string + - description: integration id example: 65dcec42a2f1d37173e6294c in: path name: integration_id required: true schema: type: string - - description: Integration type + - description: integration type example: JIRA_TICKETING in: path name: integration_type @@ -1316,222 +1156,17 @@ paths: application/json: schema: type: object - description: Successful operation - '404': - description: The Jira-ticketing integration is not registered. - security: - - Bearer: [] - summary: List JIRA Projects - tags: - - JIRA - /sspm/api/v1/plugin-users: - get: - description: "Retrieve all users who connect through third-party plugins or\ - \ integrations. \nThis endpoint helps you monitor and audit external access\ - \ to your SaaS applications.\n" - operationId: get-sspm-api-v1-plugin-users - parameters: - - description: tenant - in: header - name: x-ps-tenant - required: true - schema: - type: string - - description: 'List of filters. Format: FIELD_NAME:VALUE1|VALUE2,...' - example: filter=email:xyz - in: query - name: filter - schema: - type: string - - description: 'List of sort fields.Format: FIELD_NAME:DIRECTION,... .' - example: order_by=full_name:asc - in: query - name: order_by - schema: - type: string - - description: applies page_token to get requested page of items - in: query - name: page_token - schema: - type: string - - description: Int limit of the integrations requested - in: query - name: limit - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PluginUserPage' description: successful operation '404': - description: Not Found + description: not registered jira-ticketing integration security: - Bearer: [] - summary: List third party plugin users + summary: Fetch onboarded JIRA ticketing project list. tags: - - Plugin - /sspm/api/v1/plugin-users/{id}/plugins: - get: - description: "Retrieve all third-party plugins associated with a specific user.\ - \ \nUse this endpoint to monitor which external integrations a user has access\ - \ to within your SaaS environment.\n" - operationId: get-sspm-api-v1-plugin-users-id-plugins - parameters: - - description: tenant - in: header - name: x-ps-tenant - required: true - schema: - type: string - - in: path - name: id - required: true - schema: - type: string - - description: applies page_token to get requested page of items - in: query - name: page_token - schema: - type: string - - description: Int limit of the integrations requested - in: query - name: limit - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserToPluginPage' - description: successful operation - '404': - description: Not Found - security: - - Bearer: [] - summary: Get third-party plugins connected to user - tags: - - Plugin - /sspm/api/v1/plugins: - get: - description: "Retrieve third-party plugins based on specified filters. \nThis\ - \ endpoint allows you to list and monitor external integrations connected\ - \ to your SaaS environment.\n" - operationId: get-sspm-api-v1-plugins - parameters: - - description: tenant - in: header - name: x-ps-tenant - required: true - schema: - type: string - - description: 'List of filters. Format: FIELD_NAME:VALUE1|VALUE2,...' - example: filter=marketplace_plugin_id:123,use_cases:analytics|visibility - in: query - name: filter - schema: - type: string - - description: 'List of sort fields.Format: FIELD_NAME:DIRECTION,... .' - example: order_by=publisher_name:asc|marketplace:desc - in: query - name: order_by - schema: - type: string - - description: applies page_token to get requested page of items - in: query - name: page_token - schema: - type: string - - description: Int limit of the integrations requested - in: query - name: limit - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PluginPage' - description: successful operation - '404': - description: Not Found - security: - - Bearer: [] - summary: Get third-party plugins using filters - tags: - - Plugin - /sspm/api/v1/plugins/classification-aggregates: - get: - description: "Retrieve aggregated classification data for all plugins in your\ - \ environment. \nThis endpoint provides summary statistics about plugin types,\ - \ risk levels, and integration status to help you assess your overall third-party\ - \ application landscape.\n" - operationId: get-sspm-api-v1-plugins-classification-aggregates - parameters: - - description: tenant - in: header - name: x-ps-tenant - required: true - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ClassificationStatusAggregation' - description: successful operation - '404': - description: Not Found - security: - - Bearer: [] - summary: Get aggregated classification data - tags: - - Plugin - /sspm/api/v1/plugins/{id}: - get: - description: "Retrieve detailed information about a specific third-party plugin\ - \ by its ID. \nThis endpoint provides configuration details, permissions,\ - \ and integration status for the plugin.\n" - operationId: get-sspm-api-v1-plugins-id - parameters: - - description: tenant - in: header - name: x-ps-tenant - required: true - schema: - type: string - - description: plugin id - in: path - name: id - required: true - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Plugin' - description: successful operation - '404': - description: Not Found - security: - - Bearer: [] - summary: Get details about a specific plugin - tags: - - Plugin + - JIRA servers: - url: https://api.strata.paloaltonetworks.com tags: -- description: 'plugin related API - - ' - name: Plugin - description: 'Get registered application '