-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
169 lines (165 loc) · 6.23 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
openapi: 3.0.0
info:
title: Path calculation results using TOS
description: Path calculation results using TOS.
version: 1.0.0
servers:
- url: https://tmarelay4.azurewebsites.net/ms-copilot
paths:
/ms-copilot/securetrack/api/topology/path.json:
get:
operationId: topologyPath
summary: Get path for specified traffic.
parameters:
- $ref: '#/components/parameters/src'
- $ref: '#/components/parameters/dst'
- $ref: '#/components/parameters/srv'
responses:
200:
description: Path calculation results
400:
description: Value is missing or not valid
/ms-copilot/securechangeworkflow/api/securechange/workflows/active_workflows.json:
get:
operationId: ActiveWorkflowList
summary: Returns active workflow list defined in SecureChange.
responses:
200:
description: OK
400:
description: <TYPE> is not a valid workflow type
/ms-copilot/securechangeworkflow/api/securechange/workflows/active_workflows.json?type=ACCESS_REQUEST:
get:
operationId: AccessRequestWorkflows
summary: The Access-Request workflow can either allow or block traffic to a service from the source to the destination.
responses:
200:
description: OK
400:
description: <TYPE> is not a valid workflow type
/ms-copilot/securetrack/api/rule_search.json?lasthitgreater:30%20rule.isdisabled:false%20action:allow:
get:
operationId: UnusedRules
summary: Shows the count of unused rules per device.
responses:
200:
description: List of devices with an unused rule count per device.
content:
application/json:
schema:
type: object
properties:
device_list:
type: object
properties:
device:
type: array
400:
description: Value is missing or not valid
/ms-copilot/securetrack/api/rule_search/{deviceId}.json?lasthitgreater:30%20rule.isdisabled:false%20action:allow:
get:
operationId: UnusedRulesPerDevice
summary: Retrieve unused rules from a device based on the device id.
parameters:
- in: path
name: deviceId
required: true
description: The device id to lookup for unused rules
schema:
type: integer
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
responses:
200:
description: Return object of unused rules
content:
application/json:
schema:
type: object
properties:
rules:
type: object
properties:
count:
type: integer
total:
type: integer
rule:
type: array
404:
description: Value is missing or not valid
/ms-copilot/securetrack/api/devices/{deviceId}.json:
get:
operationId: UnusedRulesDeviceInformation
summary: Get device details based on the device id the way it is stored in SecureTrack.
parameters:
- in: path
name: deviceId
required: true
description: The device id to lookup for unused rules
schema:
type: string
responses:
200:
description: OK
/ms-copilot/securechangeworkflow/api/securechange/workflows/active_workflows.json?type=RULE_DECOMMISSION:
get:
operationId: RuleDecommissionWorkflows
summary: Rule decommission workflow list for mitigating security issues, such as disabling unused rules.
responses:
200:
description: OK
400:
description: <TYPE> is not a valid workflow type
components:
parameters:
src:
in: query
name: src
required: true
allowEmptyValue: false
schema:
type: string
default: 'any'
dst:
in: query
name: dst
required: true
allowEmptyValue: false
schema:
type: string
default: 'any'
srv:
in: query
name: service
required: true
allowEmptyValue: false
schema:
type: string
default: 'any'
searchText:
in: query
name: 'search_text'
required: true
schema:
type: string
default: 'lasthitgreater:30 rule.isdisabled:false action:allow'
allowEmptyValue: false
allowReserved: true
start:
in: query
name: start
required: true
schema:
type: integer
default: 0
minimum: 0
count:
in: query
name: count
required: true
schema:
type: integer
default: 3
minimum: 3
maximum: 10