Files
api-specs/idn/v3/paths/sod-report-run.yaml
GitHub Action Bot 9269e86172 Automated commit 'added new oauth2 flow and description (#1386)
* added new oauth2 flow and description

* renamed authentication to make more sense' by github action: 5967546682
2023-08-24 18:29:03 +00:00

44 lines
1.2 KiB
YAML

post:
security:
- UserContextAuth: [idn:sod-violation:write]
operationId: startSodPolicy
tags:
- SOD Policy
summary: Runs SOD policy violation report
description: >-
This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with
violation limit exceeded message.
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The SOD policy ID to run.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
responses:
'200':
description: Reference to the violation report run task.
content:
application/json:
schema:
$ref: '../schemas/ReportResultReference.yaml'
example: {
"status": "PENDING",
"type": "REPORT_RESULT",
"id": "2e8d8180-24bc-4d21-91c6-7affdb473b0d",
"name": "policy-xyz"
}
'400':
$ref: '../responses/400.yaml'
'401':
$ref: '../responses/401.yaml'
'403':
$ref: '../responses/403.yaml'
'404':
$ref: '../responses/404.yaml'
'429':
$ref: '../responses/429.yaml'
'500':
$ref: '../responses/500.yaml'