forked from pagopa/io-backend
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_io_wallet.yaml
267 lines (249 loc) · 8.38 KB
/
api_io_wallet.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
openapi: 3.0.3
info:
title: IO Wallet
version: 1.0.0
servers:
- url: https://api-app.io.pagopa.it/api/v1/wallet
security:
- Bearer: []
paths:
/nonce:
get:
operationId: getNonce
summary: Returns a randomly generated nonce
responses:
"200":
description: Nonce successfully generated
content:
application/json:
schema:
$ref: "#/components/schemas/NonceDetailView"
"500":
$ref: "#/components/responses/Unexpected"
"503":
$ref: "#/components/responses/ServiceUnavailable"
/wallet-instances:
post:
operationId: createWalletInstance
summary: Create a wallet instance
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletInstanceBody"
responses:
"204":
description: Wallet instance successfully created
"400":
$ref: "#/components/responses/BadRequest"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/UnprocessableContent"
"500":
$ref: "#/components/responses/Unexpected"
"503":
$ref: "#/components/responses/ServiceUnavailable"
/token:
description: This is a token endpoint (as defined in RFC 7523 section 4)
post:
operationId: createWalletAttestation
summary: Create and return a Wallet Attestation
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletAttestationBody"
responses:
"200":
description: Wallet Attestation generated
content:
application/json:
schema:
$ref: "#/components/schemas/WalletAttestationView"
"400":
$ref: "#/components/responses/BadRequest"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/UnprocessableContent"
"500":
$ref: "#/components/responses/Unexpected"
"503":
$ref: "#/components/responses/ServiceUnavailable"
/wallet-instances/current/status:
put:
summary: Revoke current Wallet Instance
operationId: setCurrentWalletInstanceStatus
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SetCurrentWalletInstanceStatusBody"
responses:
"204":
description: Wallet Instance status successfully set
"400":
$ref: "#/components/responses/BadRequest"
"403":
$ref: "#/components/responses/Forbidden"
"422":
$ref: "#/components/responses/UnprocessableContent"
"500":
$ref: "#/components/responses/Unexpected"
"503":
$ref: "#/components/responses/ServiceUnavailable"
components:
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
responses:
Forbidden:
description: The server understands the request but refuses to authorize it
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
UnprocessableContent:
description: Unprocessable Content
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
BadRequest:
description: Validation error
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
Conflict:
description: There has been a conflict
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
Unexpected:
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
ServiceUnavailable:
description: Service Unavailable
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetail"
schemas:
NonceDetailView:
type: object
properties:
nonce:
type: string
required:
- nonce
WalletAttestationView:
type: object
properties:
wallet_attestation:
type: string
minLength: 1
format: binary
required:
- wallet_attestation
CreateWalletInstanceBody:
type: object
properties:
challenge:
type: string
minLength: 1
format: binary
key_attestation:
type: string
minLength: 1
format: binary
hardware_key_tag:
type: string
minLength: 1
required:
- challenge
- key_attestation
- hardware_key_tag
CreateWalletAttestationBody:
type: object
properties:
grant_type:
type: string
enum: ["urn:ietf:params:oauth:grant-type:jwt-bearer"]
assertion:
type: string
minLength: 1
format: binary
example: eyJhbGciOiJFUzI1NiIsImtpZCI6InZiZVhKa3NNNDV4cGh0QU5uQ2lHNm1DeXVVNGpmR056b3BHdUt2b2dnOWMiLCJ0eXAiOiJ3YXIrand0In0.eyJpc3MiOiJodHRwczovL3dhbGxldC1wcm92aWRlci5leGFtcGxlLm9yZy9pbnN0YW5jZS92YmVYSmtzTTQ1eHBodEFObkNpRzZtQ3l1VTRqZkdOem9wR3VLdm9nZzljIiwic3ViIjoiaHR0cHM6Ly93YWxsZXQtcHJvdmlkZXIuZXhhbXBsZS5vcmcvIiwiY2hhbGxlbmdlIjoiNmVjNjkzMjQtNjBhOC00ZTViLWE2OTctYTc2NmQ4NTc5MGVhIiwiaGFyZHdhcmVfc2lnbmF0dXJlIjoiS29aSWh2Y05BUWNDb0lBd2dBSUIuLi5yZWRhY3RlZCIsImludGVncml0eV9hc3NlcnRpb24iOiJvMk5tYlhSdllYQndiR1V0WVhCd1lYLi4ucmVkYWN0ZWQiLCJoYXJkd2FyZV9rZXlfdGFnIjoiV1FoeUR5bUZLc1A5NWlGcXB6ZEVEV1c0bDdhVm5hMkZuNEpDZVdIWXRiVT0iLCJjbmYiOnsiandrIjp7ImNydiI6IlAtMjU2Iiwia3R5IjoiRUMiLCJ4IjoiNEhOcHRJLXhyMnBqeVJKS0dNbno0V21kblFEX3VKU3E0Ujk1Tmo5OGI0NCIsInkiOiJMSVpuU0IzOXZGSmhZZ1MzazdqWEU0cjMtQ29HRlF3WnRQQklScXBObHJnIiwia2lkIjoidmJlWEprc000NXhwaHRBTm5DaUc2bUN5dVU0amZHTnpvcEd1S3ZvZ2c5YyJ9fSwidnBfZm9ybWF0c19zdXBwb3J0ZWQiOnsiand0X3ZjX2pzb24iOnsiYWxnX3ZhbHVlc19zdXBwb3J0ZWQiOlsiRVMyNTZLIiwiRVMzODQiXX0sImp3dF92cF9qc29uIjp7ImFsZ192YWx1ZXNfc3VwcG9ydGVkIjpbIkVTMjU2SyIsIkVkRFNBIl19fSwiaWF0IjoxNjg2NjQ1MTE1LCJleHAiOjE2ODY2NTIzMTV9.F32bisVth4eDdGxDjB9ByENT-oZLtSY_89uwTSePo2GMEKaeEedpXZE_9mrX7t0_Fmc5m6LNVvIIBqotqsYJYQ
required:
- grant_type
- assertion
SetCurrentWalletInstanceStatusBody:
type: object
properties:
status:
type: string
enum: ["REVOKED"]
required:
- status
ProblemDetail:
type: object
properties:
type:
type: string
format: uri
description: |-
An absolute URI that identifies the problem type. When dereferenced,
it SHOULD provide human-readable documentation for the problem type
(e.g., using HTML).
default: about:blank
example: https://example.com/problem/constraint-violation
title:
type: string
description: >-
A short, summary of the problem type. Written in english and
readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable
status:
type: integer
format: int32
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem.
minimum: 100
maximum: 600
exclusiveMaximum: true
example: 200
detail:
type: string
description: |-
A human readable explanation specific to this occurrence of the
problem.
example: There was an error processing the request
instance:
type: string
format: uri
description: >-
An absolute URI that identifies the specific occurrence of the
problem. It may or may not yield further information if
dereferenced.