added delete security endpoint to TP collection

This commit is contained in:
MirjamHTM committed 2026-09-28 12:49:57 +02:00
1 parent b6a490c979
commit 138ebe9171
1 file changed
+120
+120
View File
@@ -376,6 +376,110 @@ paths:
$ref: "#/components/schemas/ErrorResponse" $ref: "#/components/schemas/ErrorResponse"
example: example:
error: An unknown error has occurred error: An unknown error has occurred
/tokens/security:
parameters:
- name: X-HTM-JWT-AUTH-HEADER
in: header
schema:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required: false
description: The JWT of a customer in case of touchpoint were customer logs in themselves
- name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
in: header
schema:
type: integer
example: 323
required: false
description: The id of the customer Profile
- name: X-HTM-ROLE-HEADER
in: header
schema:
type: string
example: Customer
required: false
description: The role of the HTM employee in the case of the SMP
delete:
tags:
- TAT Security
summary: Request removal of the security of a token, information protected by security will now no longer be available.
description: Request removal of the security of a token, information protected by security will now no longer be available.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteSecurityTokenRequest"
examples:
With customer account:
value:
ovPayTokenId: 42
Without customer account:
value:
xTat: 62914b49-2c7f-437f-b4b0-2ad61a9f902d
responses:
"200":
description: OK
content:
application/json:
example:
value:
recipient: xxxxxx.user@gmail.com
description: OTP Sent
_links: {
"verifyotp": {
"href": "/tokens/verifyotp",
"method": "POST"
}
}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Missing Parameters:
value:
status: 400
title: Missing Mandatory Parameter
detail: Required parameter {0} is missing.
Invalid Parameters:
value:
status: 400
title: Invalid Parameter
detail: Required parameter {0} is invalid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
Unauthorized:
value:
status: 401
title: Unauthorized
detail: Invalid Access Token
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
TAT not found:
value:
status: 404
title: Not Found
detail: TAT Account Not Found
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
error: An unknown error has occurred
/tokens/verifyotp: /tokens/verifyotp:
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
@@ -423,6 +527,11 @@ paths:
xTat: 0f0defe8-828c-48e5-97e5-26d1d0179ef0 xTat: 0f0defe8-828c-48e5-97e5-26d1d0179ef0
otp: 123456 otp: 123456
action: authorize action: authorize
OTP verification for TAT security delete for anonymous token:
value:
xTat: 0f0defe8-828c-48e5-97e5-26d1d0179ef0
otp: 123456
action: delete
responses: responses:
"200": "200":
description: OK description: OK
@@ -546,6 +655,17 @@ components:
type: string type: string
format: uuid format: uuid
example: 6134db53-9ae5-41d1-a343-36656b60b510 example: 6134db53-9ae5-41d1-a343-36656b60b510
DeleteSecurityTokenRequest:
type: object
properties:
ovPayTokenId:
type: integer
example: 42
xTat:
type: string
format: uuid
example: 6134db53-9ae5-41d1-a343-36656b60b510
VerifyOtpRequest: VerifyOtpRequest:
type: object type: object
properties: properties: