@inklok/api-spec 7.8.0 → 7.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/openapi.yaml +21 -82
  2. package/package.json +1 -1
package/openapi.yaml CHANGED
@@ -8,7 +8,7 @@ info:
8
8
  Authenticate using an API key or bearer token, then use the resources below to manage
9
9
  templates, agreements, documents, and signing. For your first integration, start with
10
10
  the Quick Start guide.
11
- version: "7.8.0"
11
+ version: "7.8.1"
12
12
  contact:
13
13
  name: Inklok API Support
14
14
  email: support@inklok.com
@@ -1816,6 +1816,12 @@ paths:
1816
1816
  description: Document identifier
1817
1817
  schema:
1818
1818
  type: string
1819
+ - name: executionId
1820
+ in: query
1821
+ required: false
1822
+ description: Required for signer-token access; binds document access to the verified signing execution.
1823
+ schema:
1824
+ type: string
1819
1825
  responses:
1820
1826
  '200':
1821
1827
  description: Base64-encoded document encryption key for client-side decryption
@@ -2624,63 +2630,6 @@ paths:
2624
2630
  '500':
2625
2631
  $ref: '#/components/responses/InternalServerError'
2626
2632
 
2627
- /v1/signing/managed-regrant:
2628
- post:
2629
- operationId: managedScopeRegrant
2630
- summary: Regrant authorized managed scope envelopes
2631
- x-visibility: internal
2632
- x-required-roles: []
2633
- description: |
2634
- Derives the caller's authorized managed scopes from the verified Cognito
2635
- membership or signer token, recovers those scope DEKs inside the managed
2636
- recovery boundary, and returns only RSA-OAEP envelopes for the caller's
2637
- validated registered transient public key. The request cannot select scope
2638
- IDs and the response never contains plaintext values or raw DEKs.
2639
- tags:
2640
- - Signing
2641
- security:
2642
- - bearerAuth: []
2643
- requestBody:
2644
- required: true
2645
- content:
2646
- application/json:
2647
- schema:
2648
- type: object
2649
- required: [executionId, destinationPublicKeyId]
2650
- properties:
2651
- executionId:
2652
- type: string
2653
- destinationPublicKeyId:
2654
- type: string
2655
- responses:
2656
- '200':
2657
- description: Scoped managed envelopes for the authenticated principal
2658
- content:
2659
- application/json:
2660
- schema:
2661
- type: object
2662
- required: [keyScopes, envelopes]
2663
- properties:
2664
- keyScopes:
2665
- type: array
2666
- items:
2667
- $ref: '#/components/schemas/KeyScope'
2668
- envelopes:
2669
- type: array
2670
- items:
2671
- $ref: '#/components/schemas/KeyEnvelope'
2672
- '400':
2673
- $ref: '#/components/responses/BadRequest'
2674
- '401':
2675
- $ref: '#/components/responses/Unauthorized'
2676
- '403':
2677
- $ref: '#/components/responses/Forbidden'
2678
- '404':
2679
- $ref: '#/components/responses/NotFound'
2680
- '500':
2681
- $ref: '#/components/responses/InternalServerError'
2682
- x-inklok-lambda: managed-scope-regrant
2683
-
2684
2633
  /v1/agreements/{executionId}/resend-completion-emails:
2685
2634
  post:
2686
2635
  operationId: agreementResendCompletionEmails
@@ -3175,16 +3124,15 @@ paths:
3175
3124
 
3176
3125
  /v1/signing/scope-envelopes:
3177
3126
  post:
3178
- operationId: resolveSigningScopeEnvelopes
3179
- summary: Resolve signer-authorized scope envelopes
3127
+ operationId: managedScopeRegrant
3128
+ summary: Regrant authorized managed scope envelopes
3180
3129
  x-visibility: internal
3181
3130
  description: |
3182
- Returns wrapped key material scoped to the authenticated signer.
3183
-
3184
- - Requires a signing access token
3185
- - Returns document key material for current PDF compatibility
3186
- - Returns only scope envelopes authorized for the signer
3187
- - Audited for signer access
3131
+ Derives the caller's authorized managed scopes from the verified Cognito
3132
+ membership or signer token, recovers those scope DEKs inside the managed
3133
+ recovery boundary, and returns only RSA-OAEP envelopes for the caller's
3134
+ validated registered transient public key. The request cannot select scope
3135
+ IDs and the response never contains plaintext values or raw DEKs.
3188
3136
  tags:
3189
3137
  - Signing
3190
3138
  security:
@@ -3195,30 +3143,24 @@ paths:
3195
3143
  application/json:
3196
3144
  schema:
3197
3145
  type: object
3198
- required: [executionId]
3146
+ required: [executionId, destinationPublicKeyId]
3199
3147
  properties:
3200
3148
  executionId:
3201
3149
  type: string
3150
+ destinationPublicKeyId:
3151
+ type: string
3202
3152
  example:
3203
3153
  executionId: "exec_123"
3154
+ destinationPublicKeyId: "session_key_123"
3204
3155
  responses:
3205
3156
  '200':
3206
- description: Wrapped document material and signer-visible scoped field envelopes
3157
+ description: Scoped managed envelopes for the authenticated principal
3207
3158
  content:
3208
3159
  application/json:
3209
3160
  schema:
3210
3161
  type: object
3211
- required: [documentDek, placeholders]
3162
+ required: [keyScopes, envelopes]
3212
3163
  properties:
3213
- documentDek:
3214
- type: object
3215
- required: [encrypted, alg]
3216
- properties:
3217
- encrypted:
3218
- type: string
3219
- alg:
3220
- type: string
3221
- enum: [KMS-WRAPPED-BASE64, RSA-OAEP]
3222
3164
  keyScopes:
3223
3165
  type: array
3224
3166
  items:
@@ -3228,9 +3170,6 @@ paths:
3228
3170
  items:
3229
3171
  $ref: '#/components/schemas/KeyEnvelope'
3230
3172
  example:
3231
- documentDek:
3232
- encrypted: "base64..."
3233
- alg: "KMS-WRAPPED-BASE64"
3234
3173
  keyScopes: []
3235
3174
  envelopes: []
3236
3175
  '400':
@@ -3243,7 +3182,7 @@ paths:
3243
3182
  $ref: '#/components/responses/NotFound'
3244
3183
  '500':
3245
3184
  $ref: '#/components/responses/InternalServerError'
3246
- x-inklok-lambda: signing-scope-envelopes
3185
+ x-inklok-lambda: managed-scope-regrant
3247
3186
 
3248
3187
  components:
3249
3188
  securitySchemes:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inklok/api-spec",
3
- "version": "7.8.0",
3
+ "version": "7.8.1",
4
4
  "description": "Canonical OpenAPI specification for the Inklok public API.",
5
5
  "main": "openapi.yaml",
6
6
  "license": "MIT",