Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AIRS APIs for auth scheme #801

Merged
merged 1 commit into from
Dec 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 14 additions & 30 deletions openapi-specs/ai-runtime-security/scan/ScanService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,11 @@ paths:
post:
summary: Send a Synchronous Scan Request
description: Post a scan request containing prompt/model-response that returns a synchronous scan response
security: []
security:
- x-pan-token: []
operationId: ScanSyncRequest
tags:
- Scans
parameters:
- description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
required: true
in: header
name: x-pan-token
schema:
type: string
requestBody:
description: Scan request object
required: true
Expand Down Expand Up @@ -86,17 +80,11 @@ paths:
post:
summary: Send an Asynchronous Scan Request
description: Post a scan request that returns asynchronous scan response
security: []
security:
- x-pan-token: []
operationId: ScanAsyncRequest
tags:
- Scans
parameters:
- description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
required: true
in: header
name: x-pan-token
schema:
type: string
requestBody:
description: A list of scan request objects
required: true
Expand Down Expand Up @@ -139,17 +127,12 @@ paths:
get:
summary: Retrieve Scan Results by ScanIDs
description: Get the Scan results for upto a maximum of 5 Scan IDs
security: []
security:
- x-pan-token: []
operationId: GetScanResultsByScanIDs
tags:
- Scan Results
parameters:
- description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
required: true
in: header
name: x-pan-token
schema:
type: string
- name: scan_ids
in: query
description: Scan Ids for Results
Expand Down Expand Up @@ -199,17 +182,12 @@ paths:
get:
summary: Retrieve Threat Scan Reports by Report IDs
description: Get the Threat Scan Reports for a given list of report_ids
security: []
security:
- x-pan-token: []
tags:
- Scan Reports
operationId: GetThreatScanReports
parameters:
- description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
required: true
in: header
name: x-pan-token
schema:
type: string
- name: report_ids
in: query
description: Report Ids for Results
Expand Down Expand Up @@ -254,6 +232,12 @@ paths:
$ref: '#/components/schemas/Error'

components:
securitySchemes:
x-pan-token:
description: API key token generated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager.
in: header
name: x-pan-token
type: apiKey
schemas:
ScanRequest:
type: object
Expand Down
Loading