Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
499 lines (499 loc) · 28.1 KB
/
Copy pathopenapi.yaml
File metadata and controls
499 lines (499 loc) · 28.1 KB
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
openapi: 3.1.0
info:
title: Gorape API
version: 0.1.0
description: Open Device Trust & Attestation Backend. Send Keycloak access tokens, never ID tokens.
servers:
- url: https://api.gorapeflutter.site
description: Official GorapeFlutter verification / production API endpoint
- url: https://api.gorapeflutter.site:8443
description: Local HTTPS development endpoint (*.gorapeflutter.site -> 127.0.0.1)
- url: http://api.gorapeflutter.site:8000
description: Local HTTP development endpoint (*.gorapeflutter.site -> 127.0.0.1)
security:
- bearerAuth: []
paths:
/health:
get:
tags: [System]
operationId: health
security: []
summary: Liveness probe
responses: {'200': {description: Healthy}}
/v1/projects:
get:
tags: [Projects]
operationId: listProjects
summary: List projects visible to the token subject
responses: {'200': {description: Projects, content: {application/json: {schema: {type: array, items: {$ref: '#/components/schemas/Project'}}}}}}
/v1/projects/{projectId}:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Projects]
operationId: getProject
summary: Get project
responses: {'200': {description: Project, content: {application/json: {schema: {$ref: '#/components/schemas/Project'}}}}}
/v1/projects/{projectId}/groups:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Groups]
operationId: listGroups
summary: List groups
responses: {'200': {description: Groups, content: {application/json: {schema: {type: array, items: {$ref: '#/components/schemas/Group'}}}}}}
post:
tags: [Groups]
operationId: createGroup
summary: Create group (project admin)
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/GroupInput'}}}}
responses: {'201': {description: Created, content: {application/json: {schema: {$ref: '#/components/schemas/Group'}}}}}
/v1/projects/{projectId}/groups/{groupId}:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/GroupId'}]
get:
tags: [Groups]
operationId: getGroup
summary: Get group
responses: {'200': {description: Group, content: {application/json: {schema: {$ref: '#/components/schemas/Group'}}}}}
patch:
tags: [Groups]
operationId: updateGroup
summary: Update group (project admin)
requestBody: {required: true, content: {application/json: {schema: {type: object, required: [name], properties: {name: {type: string}, status: {type: string}}}}}}
responses: {'200': {description: Updated, content: {application/json: {schema: {$ref: '#/components/schemas/Group'}}}}}
delete:
tags: [Groups]
operationId: deleteGroup
summary: Delete group (project admin)
responses: {'204': {description: Deleted}}
/v1/projects/{projectId}/devices:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Devices]
operationId: listDevices
summary: List devices
responses: {'200': {description: Devices, content: {application/json: {schema: {type: array, items: {$ref: '#/components/schemas/Device'}}}}}}
/v1/projects/{projectId}/devices/{deviceId}:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
get:
tags: [Devices]
operationId: getDevice
summary: Get device
responses: {'200': {description: Device, content: {application/json: {schema: {$ref: '#/components/schemas/Device'}}}}}
delete:
tags: [Devices]
operationId: revokeDevice
summary: Revoke device (admin/editor)
responses: {'204': {description: Revoked}}
/v1/projects/{projectId}/devices/registration/challenge:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
post:
tags: [Registration]
operationId: createRegistrationChallenge
summary: Issue single-use registration challenge
requestBody: {required: true, content: {application/json: {schema: {type: object, required: [platform], properties: {platform: {$ref: '#/components/schemas/Platform'}}}}}}
responses: {'201': {description: Challenge, content: {application/json: {schema: {$ref: '#/components/schemas/Challenge'}}}}, '403': {description: Requires an editor role and a Keycloak passkey-authenticated access token}}
/v1/projects/{projectId}/devices/registration/verify:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
post:
tags: [Registration]
operationId: verifyRegistration
summary: Verify attestation and register a device
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/RegistrationVerify'}}}}
responses: {'201': {description: Registered, content: {application/json: {schema: {$ref: '#/components/schemas/Device'}}}}, '403': {description: Requires an editor role and a Keycloak passkey-authenticated access token}, '422': {description: Invalid or unsupported attestation}}
/v1/projects/{projectId}/devices/passkeys/registration/options:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
post:
tags: [Passkeys]
operationId: createPasskeyRegistrationOptions
summary: Begin a Gorape RP WebAuthn registration ceremony
description: Issues single-use options bound to the authenticated principal. Requires an access token whose amr claim contains passkey. Attestation policy is evaluated server-side; empty allowlists and allow_none=false reject registration by default.
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyRegistrationOptionsRequest'}}}}
responses: {'201': {description: WebAuthn creation options, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyCeremonyOptions'}}}}, '403': {description: Insufficient permission}, '422': {description: Attestation policy denies all registration formats}, '503': {description: WebAuthn RP is not configured}}
/v1/projects/{projectId}/devices/passkeys/registration/verify:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
post:
tags: [Passkeys]
operationId: verifyPasskeyRegistration
summary: Verify WebAuthn registration and platform attestation
description: Verifies RP ID, origin, challenge, credential public key, attestation statement, allowed format, and configured trust anchors before storing the device.
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyRegistrationVerify'}}}}
responses: {'201': {description: Registered device and verified attestation, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyRegistrationResult'}}}}, '401': {description: Invalid or expired ceremony}, '403': {description: Requires Keycloak passkey authentication}, '422': {description: Invalid or denied attestation}}
/v1/projects/{projectId}/devices/{deviceId}/challenge:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
post:
tags: [Proof]
operationId: createProofChallenge
summary: Issue a device key proof challenge
responses: {'201': {description: Challenge}, '403': {description: Requires a Keycloak passkey-authenticated access token}}
/v1/projects/{projectId}/devices/{deviceId}/verify:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
post:
tags: [Proof]
operationId: verifyProof
summary: Verify device key possession
requestBody: {required: true, content: {application/json: {schema: {type: object, required: [challenge_id, signature], properties: {challenge_id: {type: string, format: uuid}, signature: {type: string, description: Base64url signature}}}}}}
responses: {'200': {description: Verified}, '403': {description: Requires a Keycloak passkey-authenticated access token}}
/v1/projects/{projectId}/devices/{deviceId}/passkeys/authentication/options:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
post:
tags: [Passkeys]
operationId: createPasskeyAuthenticationOptions
summary: Begin a device passkey assertion ceremony
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyAuthenticationOptionsRequest'}}}}
responses: {'201': {description: WebAuthn request options, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyCeremonyOptions'}}}}, '403': {description: Not authorized or passkey authentication is required}, '503': {description: WebAuthn RP is not configured}}
/v1/projects/{projectId}/devices/{deviceId}/passkeys/authentication/verify:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
post:
tags: [Passkeys]
operationId: verifyPasskeyAuthentication
summary: Verify assertion and record proof of device possession
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyAuthenticationVerify'}}}}
responses: {'200': {description: Verified}, '401': {description: Invalid assertion or expired ceremony}, '403': {description: Not authorized or passkey authentication is required}}
/v1/projects/{projectId}/proof-requests:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
post:
tags: [Passkeys]
operationId: createProofRequest
summary: Issue an operation-bound WebAuthn challenge for an external relying service (GF-API-01)
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/ProofRequestCreate'}}}}
responses: {'201': {description: Proof request options, content: {application/json: {schema: {$ref: '#/components/schemas/ProofRequestOptions'}}}}, '403': {description: Forbidden}, '422': {description: No matching credential satisfies required assurance}}
/v1/projects/{projectId}/proof-requests/{proofId}/verify:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {name: proofId, in: path, required: true, schema: {type: string, format: uuid}}]
post:
tags: [Passkeys]
operationId: verifyProofRequest
summary: Verify an operation-bound WebAuthn assertion for an external relying service (GF-API-02)
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/ProofRequestVerify'}}}}
responses: {'200': {description: Verified operation proof, content: {application/json: {schema: {$ref: '#/components/schemas/ProofRequestVerifyResult'}}}}, '401': {description: Invalid or expired proof request}, '403': {description: Forbidden}}
/v1/passkeys/browser/options:
post:
tags: [Passkeys]
operationId: getBrowserPasskeyOptions
security: []
summary: Read WebAuthn options using a short-lived browser ceremony capability
description: The challenge ID is an unguessable, expiring capability issued by an authenticated options call. Reading its WebAuthn options does not consume it; registration/assertion verification consumes it exactly once. No OIDC token is included in the browser handoff. The browser ceremony page is hosted by gf-app, not by Gorape.
requestBody: {required: true, content: {application/json: {schema: {type: object, required: [challenge_id], properties: {challenge_id: {type: string, format: uuid}}}}}}
responses: {'200': {description: Browser WebAuthn options, content: {application/json: {schema: {type: object, required: [ceremony, public_key], properties: {ceremony: {type: string, enum: [registration, authentication]}, public_key: {type: object}}}}}}, '401': {description: Invalid or expired capability}}
/v1/passkeys/browser/registration/verify:
post:
tags: [Passkeys]
operationId: verifyBrowserPasskeyRegistration
security: []
summary: Complete a browser-mediated registration using its one-time capability
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/BrowserPasskeyRegistrationVerify'}}}}
responses: {'201': {description: Registered device, content: {application/json: {schema: {$ref: '#/components/schemas/PasskeyRegistrationResult'}}}}, '401': {description: Invalid or expired capability}, '422': {description: Invalid or denied attestation}}
/v1/passkeys/browser/authentication/verify:
post:
tags: [Passkeys]
operationId: verifyBrowserPasskeyAuthentication
security: []
summary: Complete a browser-mediated assertion using its one-time capability
requestBody: {required: true, content: {application/json: {schema: {$ref: '#/components/schemas/BrowserPasskeyAuthenticationVerify'}}}}
responses: {'200': {description: Verified}, '401': {description: Invalid assertion or expired capability}}
/v1/projects/{projectId}/groups/{groupId}/devices:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/GroupId'}]
get:
tags: [Assignments]
operationId: listGroupDevices
summary: List group devices
responses: {'200': {description: Devices, content: {application/json: {schema: {type: array, items: {$ref: '#/components/schemas/Device'}}}}}}
post:
tags: [Assignments]
operationId: bindDevice
summary: Add device to group
requestBody: {required: true, content: {application/json: {schema: {type: object, required: [device_id], properties: {device_id: {type: string, format: uuid}}}}}}
responses: {'204': {description: Bound}}
/v1/projects/{projectId}/groups/{groupId}/devices/{deviceId}:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/GroupId'}, {$ref: '#/components/parameters/DeviceId'}]
delete:
tags: [Assignments]
operationId: unbindDevice
summary: Remove device from group
responses: {'204': {description: Removed}}
/v1/projects/{projectId}/permissions:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Roles]
operationId: getPermissions
summary: Resolve the caller's effective project permissions
responses: {'200': {description: Permissions, content: {application/json: {schema: {type: object, properties: {permissions: {type: array, items: {type: string}}, roles: {type: array, items: {type: string}}}}}}}}
/v1/projects/{projectId}/roles:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Roles]
operationId: listProjectRoles
summary: List project role definitions and bindings
responses: {'200': {description: Definitions and bindings}}
post:
tags: [Roles]
operationId: putProjectRole
summary: Create or replace project role binding
requestBody: {$ref: '#/components/requestBodies/Role'}
responses: {'204': {description: Bound}}
/v1/projects/{projectId}/roles/{bindingId}:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/BindingId'}]
delete:
tags: [Roles]
operationId: deleteRoleBinding
summary: Delete project role binding
responses: {'204': {description: Deleted}}
/v1/projects/{projectId}/role-definitions:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Roles]
operationId: listRoleDefinitions
summary: List role definitions
responses: {'200': {description: Definitions}}
/v1/projects/{projectId}/role-definitions/{key}:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {name: key, in: path, required: true, schema: {type: string}}]
put:
tags: [Roles]
operationId: putRoleDefinition
summary: Create or replace a role definition (role:manage)
requestBody: {$ref: '#/components/requestBodies/RoleDefinition'}
responses: {'200': {description: Definition}}
delete:
tags: [Roles]
operationId: deleteRoleDefinition
summary: Delete an unused non-builtin role definition (role:manage)
responses: {'204': {description: Deleted}}
/v1/projects/{projectId}/groups/{groupId}/roles:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/GroupId'}]
get:
tags: [Roles]
operationId: listGroupRoles
summary: List group role bindings
responses: {'200': {description: Bindings}}
post:
tags: [Roles]
operationId: putGroupRole
summary: Create or replace group role binding
requestBody: {$ref: '#/components/requestBodies/Role'}
responses: {'204': {description: Bound}}
/v1/projects/{projectId}/attestation/capabilities:
parameters: [{$ref: '#/components/parameters/ProjectId'}]
get:
tags: [Attestation]
operationId: getAttestationCapabilities
summary: List legacy native-key verifier support
description: Reports the legacy Android Keystore certificate-chain verifier. WebAuthn format policy is configured separately and enforced by the passkey registration options/verify endpoints.
responses: {'200': {description: Legacy verifier capabilities, content: {application/json: {schema: {$ref: '#/components/schemas/AttestationCapabilities'}}}}}
/v1/projects/{projectId}/devices/{deviceId}/attestation:
parameters: [{$ref: '#/components/parameters/ProjectId'}, {$ref: '#/components/parameters/DeviceId'}]
get:
tags: [Attestation]
operationId: listAttestations
summary: List device attestation records
responses: {'200': {description: Records, content: {application/json: {schema: {type: array, items: {$ref: '#/components/schemas/AttestationRecord'}}}}}}
/v1/platform/provisioning/plan:
post:
tags: [Provisioning]
operationId: planProvisioning
summary: Plan a Keycloak + Gorape provisioning manifest (platform admin)
requestBody: {$ref: '#/components/requestBodies/Provisioning'}
responses: {'200': {description: Planned actions}, '403': {description: Not a platform admin}, '503': {description: Provisioning disabled}}
/v1/platform/provisioning/apply:
post:
tags: [Provisioning]
operationId: applyProvisioning
summary: Apply a Keycloak + Gorape provisioning manifest (platform admin)
requestBody: {$ref: '#/components/requestBodies/Provisioning'}
responses: {'200': {description: Applied actions}, '403': {description: Not a platform admin}, '503': {description: Provisioning disabled}}
components:
securitySchemes:
bearerAuth: {type: http, scheme: bearer, bearerFormat: JWT}
parameters:
ProjectId: {name: projectId, in: path, required: true, schema: {type: string, format: uuid}}
GroupId: {name: groupId, in: path, required: true, schema: {type: string, format: uuid}}
DeviceId: {name: deviceId, in: path, required: true, schema: {type: string, format: uuid}}
BindingId: {name: bindingId, in: path, required: true, schema: {type: string, format: uuid}}
requestBodies:
Role:
required: true
content: {application/json: {schema: {type: object, required: [subject, role], properties: {subject: {type: string}, role: {type: string, description: Project role definition key such as admin, editor, viewer, or a provisioned custom key}}}}}
RoleDefinition:
required: true
content: {application/json: {schema: {type: object, required: [permissions], properties: {name: {type: string}, permissions: {type: array, items: {type: string}, description: 'Supports * and prefix wildcards such as device:*'}, keycloak_role: {type: string, description: 'Defaults to gorape-<key>'}}}}}
Provisioning:
required: true
content: {application/json: {schema: {$ref: '#/components/schemas/ProvisioningManifest'}}}
schemas:
ProvisioningManifest:
type: object
required: [apiVersion, kind]
properties:
apiVersion: {type: string, enum: [gorape/v1]}
kind: {type: string, enum: [Provisioning]}
keycloak: {type: object, description: 'Realm, roles, groups, clients, protocol mappers and Authorization Services resources/scopes/policies/permissions'}
gorape: {type: object, description: 'Project, role definitions, groups and role bindings'}
Platform: {type: string, enum: [android, windows, ios, macos, web, linux]}
Project:
type: object
required: [id, slug, name, issuer, realm, status]
properties:
id: {type: string, format: uuid}
slug: {type: string}
name: {type: string}
issuer: {type: string, format: uri}
realm: {type: string}
status: {type: string}
created_at: {type: string, format: date-time}
updated_at: {type: string, format: date-time}
Group:
type: object
required: [id, project_id, slug, name, status]
properties:
id: {type: string, format: uuid}
project_id: {type: string, format: uuid}
slug: {type: string}
name: {type: string}
status: {type: string}
created_at: {type: string, format: date-time}
updated_at: {type: string, format: date-time}
Device:
type: object
required: [id, project_id, owner_id, platform, display_name, status, registered_at, version]
properties:
id: {type: string, format: uuid}
project_id: {type: string, format: uuid}
owner_id: {type: string, format: uuid}
platform: {$ref: '#/components/schemas/Platform'}
display_name: {type: string}
status: {type: string, enum: [active, revoked]}
registered_at: {type: string, format: date-time}
last_verified_at: {type: string, format: date-time}
revoked_at: {type: string, format: date-time}
version: {type: integer, minimum: 1}
AttestationRecord:
type: object
required: [id, project_id, key_id, attestation_type, security_level, verification_status, verifier_version, verified_at]
properties:
id: {type: string, format: uuid}
project_id: {type: string, format: uuid}
key_id: {type: string, format: uuid}
attestation_type: {type: string}
security_level: {type: string}
verification_status: {type: string}
verifier_version: {type: string}
verified_at: {type: string, format: date-time}
evidence_reference: {type: string}
AttestationCapabilities:
type: object
required: [verifiers]
properties:
verifiers:
type: object
additionalProperties: {type: string, enum: [implemented, unsupported, unconfigured]}
GroupInput: {type: object, required: [slug, name], properties: {slug: {type: string, pattern: '^[a-z0-9-]+$'}, name: {type: string}}}
Challenge: {type: object, required: [challenge_id, challenge, expires_at], properties: {challenge_id: {type: string, format: uuid}, challenge: {type: string, description: Base64url random bytes}, expires_at: {type: string, format: date-time}}}
RegistrationVerify:
type: object
required: [challenge_id, platform, display_name, public_key_pem, key_identifier, algorithm, evidence]
properties:
challenge_id: {type: string, format: uuid}
platform: {$ref: '#/components/schemas/Platform'}
display_name: {type: string}
public_key_pem: {type: string}
key_identifier: {type: string}
algorithm: {type: string}
evidence:
type: object
description: Android uses certificate_chain, an array of PEM or base64 DER certificates (leaf first).
PasskeyRegistrationOptionsRequest:
type: object
required: [platform, display_name]
properties:
platform: {type: string, enum: [android, ios, macos, windows, web, linux]}
display_name: {type: string, minLength: 1, maxLength: 120}
PasskeyRegistrationVerify:
type: object
required: [challenge_id, platform, display_name, credential]
properties:
challenge_id: {type: string, format: uuid}
platform: {type: string, enum: [android, ios, macos, windows, web, linux]}
display_name: {type: string, minLength: 1, maxLength: 120}
credential: {type: object, description: Complete WebAuthn PublicKeyCredential creation response including response.clientDataJSON and response.attestationObject}
PasskeyAuthenticationVerify:
type: object
required: [challenge_id, credential]
properties:
challenge_id: {type: string, format: uuid}
credential: {type: object, description: Complete WebAuthn PublicKeyCredential assertion including clientDataJSON, authenticatorData, and signature}
PasskeyAuthenticationOptionsRequest:
type: object
required: [platform]
properties:
platform: {$ref: '#/components/schemas/Platform'}
BrowserPasskeyRegistrationVerify:
type: object
required: [challenge_id, credential]
properties:
challenge_id: {type: string, format: uuid, description: Short-lived single-use capability from an authenticated registration options response}
credential: {type: object, description: Complete WebAuthn PublicKeyCredential creation response}
BrowserPasskeyAuthenticationVerify:
type: object
required: [challenge_id, credential]
properties:
challenge_id: {type: string, format: uuid, description: Short-lived single-use capability from an authenticated assertion options response}
credential: {type: object, description: Complete WebAuthn PublicKeyCredential assertion}
PasskeyCeremonyOptions:
type: object
required: [challenge_id, expires_at, public_key]
properties:
challenge_id: {type: string, format: uuid}
expires_at: {type: string, format: date-time}
public_key: {type: object, description: WebAuthn creation or request options produced by the configured Gorape RP}
browser_url: {type: string, format: uri, description: gf-app Web target's browser ceremony page; present for Linux desktop}
browser_api_origin: {type: string, format: uri, description: Gorape API origin used by the browser handoff page; present for Linux desktop}
PasskeyRegistrationResult:
type: object
required: [device, attestation]
properties:
device: {$ref: '#/components/schemas/Device'}
attestation:
type: object
required: [attestation_type, security_level, verification_status, verifier_version]
properties:
attestation_type: {type: string, description: WebAuthn fmt value}
security_level: {type: string}
assurance_level: {type: string, enum: [hardware_attested, device_bound_unattested, standard_passkey, rejected]}
hardware_protected: {type: boolean}
backup_eligible: {type: boolean}
backup_state: {type: boolean}
verification_status: {type: string, enum: [verified]}
verifier_version: {type: string}
ProofRequestCreate:
type: object
required: [service_id, principal_id, operation_id, method, path, body_hash]
properties:
service_id: {type: string}
principal_id: {type: string, description: Gorape Principal UUID or OIDC subject}
operation_id: {type: string}
method: {type: string}
path: {type: string}
body_hash: {type: string}
required_assurance: {type: string, enum: [hardware_attested, device_bound_unattested, standard_passkey]}
credential_id: {type: string}
ProofRequestOptions:
type: object
required: [proof_id, expires_at, public_key_options]
properties:
proof_id: {type: string, format: uuid}
expires_at: {type: string, format: date-time}
public_key_options: {type: object}
ProofRequestVerify:
type: object
required: [service_id, operation_id, credential]
properties:
service_id: {type: string}
operation_id: {type: string}
credential: {type: object}
ProofRequestVerifyResult:
type: object
required: [verified, principal_id, device_id, credential_id, assurance_level, operation_id]
properties:
verified: {type: boolean}
principal_id: {type: string, format: uuid}
device_id: {type: string, format: uuid}
credential_id: {type: string}
assurance_level: {type: string, enum: [hardware_attested, device_bound_unattested, standard_passkey]}
operation_id: {type: string}