Skip to content

Commit 621415b

Browse files
authored
Merge pull request #92 from dfir-iris/api_v2_delete_customer
Api v2 delete customer
2 parents c51e47e + 6dd0e63 commit 621415b

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

docs/api_reference/reference/iris.v2.1.0.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ info:
7878
* Added POST /api/v2/manage/customers
7979
* Added GET /api/v2/manage/customers/{identifier}
8080
* Added PUT /api/v2/manage/customers/{identifier}
81+
* Added DELETE /api/v2/manage/customers/{identifier}
8182
* Added POST /api/v2/alerts-filters
8283
* Added GET /api/v2/alerts-filters/{identifier}
8384
* Added PUT /api/v2/alerts-filters/{identifier}
@@ -133,6 +134,7 @@ info:
133134
* Deprecated POST /manage/customers/add
134135
* Deprecated GET /manage/customers/{customer_id}
135136
* Deprecated POST /manage/customers/update/{customer_id}
137+
* Deprecated POST /manage/customers/delete/{customer_id}
136138
* Added documentation of missing GET /manage/severities/list
137139
* Added documentation of missing GET /manage/tlp/list
138140
* Added documentation of missing GET /manage/event-categories/list

docs/api_reference/reference/v2.1.0/resources/api_v2_manage_customers_{identifier}.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,20 @@ put:
4545
$ref: ../responses/Forbidden.yaml
4646
'404':
4747
$ref: ../responses/NotFound.yaml
48+
delete:
49+
operationId: api_v2_manage_customers_(identifier)_delete
50+
tags:
51+
- Customers
52+
- Beta
53+
summary: Delete a customer
54+
description: A customer can be deleted only if it is not referenced in a case. To delete a referenced, every referencing cases musth be deleted before.
55+
responses:
56+
'204':
57+
$ref: ../responses/Deleted.yaml
58+
'403':
59+
$ref: ../responses/Forbidden.yaml
60+
'404':
61+
$ref: ../responses/NotFound.yaml
62+
'400':
63+
$ref: ../responses/GenericError.yaml
64+

docs/api_reference/reference/v2.1.0/resources/manage_customers_delete_{customer_id}.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
post:
22
summary: Delete a customer
3+
description: This endpoint is deprecated. Use [DELETE /api/v2/manage/customers/{identifier}](#tag/Customers/operation/api_v2_manage_customers_(identifier)_delete) instead.
4+
deprecated: true
35
tags:
46
- Customers
57
responses:
@@ -36,9 +38,6 @@ post:
3638
message: Deleted successfully
3739
status: success
3840
operationId: get-customer-delete
39-
description: |-
40-
A customer can be deleted only if it is not referenced in a case.
41-
To delete a referenced, every referencing cases musth be deleted before.
4241
security:
4342
- Bearer <bearer>: []
4443
parameters:

0 commit comments

Comments
 (0)