@1claw/openapi-spec 0.40.0 → 0.41.0
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.
- package/openapi.json +136 -3
- package/openapi.yaml +86 -1
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "1Claw API",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.27.0",
|
|
6
6
|
"description": "Secure secret management for AI agents. Provides vaults, secrets,\npolicy-based access control, agent identity, Intents API,\nsharing, billing, and audit logging.\n\nAll endpoints require JWT Bearer authentication unless marked with\n`security: []`.\n",
|
|
7
7
|
"contact": {
|
|
8
8
|
"email": "ops@1claw.xyz"
|
|
@@ -4116,6 +4116,66 @@
|
|
|
4116
4116
|
}
|
|
4117
4117
|
}
|
|
4118
4118
|
},
|
|
4119
|
+
"/v1/agents/{agent_id}/bindings/{binding_id}/rotate-credential": {
|
|
4120
|
+
"post": {
|
|
4121
|
+
"tags": [
|
|
4122
|
+
"Execution Intents"
|
|
4123
|
+
],
|
|
4124
|
+
"summary": "Rotate a binding credential",
|
|
4125
|
+
"description": "Overwrite the stored credential for a binding without touching its config or guardrails. Human-only. The credential value is never returned.",
|
|
4126
|
+
"operationId": "rotateBindingCredential",
|
|
4127
|
+
"parameters": [
|
|
4128
|
+
{
|
|
4129
|
+
"$ref": "#/components/parameters/AgentId"
|
|
4130
|
+
},
|
|
4131
|
+
{
|
|
4132
|
+
"name": "binding_id",
|
|
4133
|
+
"in": "path",
|
|
4134
|
+
"required": true,
|
|
4135
|
+
"schema": {
|
|
4136
|
+
"type": "string",
|
|
4137
|
+
"format": "uuid"
|
|
4138
|
+
}
|
|
4139
|
+
}
|
|
4140
|
+
],
|
|
4141
|
+
"requestBody": {
|
|
4142
|
+
"required": true,
|
|
4143
|
+
"content": {
|
|
4144
|
+
"application/json": {
|
|
4145
|
+
"schema": {
|
|
4146
|
+
"type": "object",
|
|
4147
|
+
"required": [
|
|
4148
|
+
"credential"
|
|
4149
|
+
],
|
|
4150
|
+
"properties": {
|
|
4151
|
+
"credential": {
|
|
4152
|
+
"description": "New credential material (object or string). Stored server-side."
|
|
4153
|
+
}
|
|
4154
|
+
}
|
|
4155
|
+
}
|
|
4156
|
+
}
|
|
4157
|
+
}
|
|
4158
|
+
},
|
|
4159
|
+
"responses": {
|
|
4160
|
+
"200": {
|
|
4161
|
+
"description": "Updated binding",
|
|
4162
|
+
"content": {
|
|
4163
|
+
"application/json": {
|
|
4164
|
+
"schema": {
|
|
4165
|
+
"$ref": "#/components/schemas/BindingResponse"
|
|
4166
|
+
}
|
|
4167
|
+
}
|
|
4168
|
+
}
|
|
4169
|
+
},
|
|
4170
|
+
"403": {
|
|
4171
|
+
"$ref": "#/components/responses/Forbidden"
|
|
4172
|
+
},
|
|
4173
|
+
"404": {
|
|
4174
|
+
"$ref": "#/components/responses/NotFound"
|
|
4175
|
+
}
|
|
4176
|
+
}
|
|
4177
|
+
}
|
|
4178
|
+
},
|
|
4119
4179
|
"/v1/agents/{agent_id}/execute": {
|
|
4120
4180
|
"post": {
|
|
4121
4181
|
"tags": [
|
|
@@ -17038,6 +17098,39 @@
|
|
|
17038
17098
|
}
|
|
17039
17099
|
}
|
|
17040
17100
|
},
|
|
17101
|
+
"CredentialSource": {
|
|
17102
|
+
"type": "object",
|
|
17103
|
+
"required": [
|
|
17104
|
+
"type"
|
|
17105
|
+
],
|
|
17106
|
+
"description": "Credential source — inline value (stored in __agent-keys) or live pointer to a vault secret (resolved at execution time).",
|
|
17107
|
+
"discriminator": {
|
|
17108
|
+
"propertyName": "type"
|
|
17109
|
+
},
|
|
17110
|
+
"properties": {
|
|
17111
|
+
"type": {
|
|
17112
|
+
"type": "string",
|
|
17113
|
+
"enum": [
|
|
17114
|
+
"inline",
|
|
17115
|
+
"vault_ref"
|
|
17116
|
+
]
|
|
17117
|
+
},
|
|
17118
|
+
"value": {
|
|
17119
|
+
"type": "object",
|
|
17120
|
+
"additionalProperties": true,
|
|
17121
|
+
"description": "For inline — the credential value object."
|
|
17122
|
+
},
|
|
17123
|
+
"vault_id": {
|
|
17124
|
+
"type": "string",
|
|
17125
|
+
"format": "uuid",
|
|
17126
|
+
"description": "For vault_ref — the vault containing the referenced secret."
|
|
17127
|
+
},
|
|
17128
|
+
"path": {
|
|
17129
|
+
"type": "string",
|
|
17130
|
+
"description": "For vault_ref — the secret path in the vault."
|
|
17131
|
+
}
|
|
17132
|
+
}
|
|
17133
|
+
},
|
|
17041
17134
|
"CreateBindingRequest": {
|
|
17042
17135
|
"type": "object",
|
|
17043
17136
|
"required": [
|
|
@@ -17073,7 +17166,11 @@
|
|
|
17073
17166
|
},
|
|
17074
17167
|
"credential": {
|
|
17075
17168
|
"type": "object",
|
|
17076
|
-
"additionalProperties": true
|
|
17169
|
+
"additionalProperties": true,
|
|
17170
|
+
"description": "Legacy: inline credential value. Use credential_source for new integrations."
|
|
17171
|
+
},
|
|
17172
|
+
"credential_source": {
|
|
17173
|
+
"$ref": "#/components/schemas/CredentialSource"
|
|
17077
17174
|
}
|
|
17078
17175
|
}
|
|
17079
17176
|
},
|
|
@@ -17093,7 +17190,11 @@
|
|
|
17093
17190
|
},
|
|
17094
17191
|
"credential": {
|
|
17095
17192
|
"type": "object",
|
|
17096
|
-
"additionalProperties": true
|
|
17193
|
+
"additionalProperties": true,
|
|
17194
|
+
"description": "Legacy: inline credential value."
|
|
17195
|
+
},
|
|
17196
|
+
"credential_source": {
|
|
17197
|
+
"$ref": "#/components/schemas/CredentialSource"
|
|
17097
17198
|
}
|
|
17098
17199
|
}
|
|
17099
17200
|
},
|
|
@@ -17146,6 +17247,30 @@
|
|
|
17146
17247
|
"is_active": {
|
|
17147
17248
|
"type": "boolean"
|
|
17148
17249
|
},
|
|
17250
|
+
"credential_set": {
|
|
17251
|
+
"type": "boolean",
|
|
17252
|
+
"description": "Whether a credential is stored for this binding. The value itself is never returned."
|
|
17253
|
+
},
|
|
17254
|
+
"credential_source_type": {
|
|
17255
|
+
"type": "string",
|
|
17256
|
+
"enum": [
|
|
17257
|
+
"inline",
|
|
17258
|
+
"vault_ref"
|
|
17259
|
+
],
|
|
17260
|
+
"nullable": true,
|
|
17261
|
+
"description": "How the credential is sourced — inline (HSM-encrypted copy) or vault_ref (live pointer)."
|
|
17262
|
+
},
|
|
17263
|
+
"credential_vault_id": {
|
|
17264
|
+
"type": "string",
|
|
17265
|
+
"format": "uuid",
|
|
17266
|
+
"nullable": true,
|
|
17267
|
+
"description": "For vault_ref credentials — the vault containing the referenced secret."
|
|
17268
|
+
},
|
|
17269
|
+
"credential_path": {
|
|
17270
|
+
"type": "string",
|
|
17271
|
+
"nullable": true,
|
|
17272
|
+
"description": "For vault_ref credentials — the secret path in the referenced vault."
|
|
17273
|
+
},
|
|
17149
17274
|
"created_at": {
|
|
17150
17275
|
"type": "string",
|
|
17151
17276
|
"format": "date-time"
|
|
@@ -17237,6 +17362,14 @@
|
|
|
17237
17362
|
},
|
|
17238
17363
|
"redactions_applied": {
|
|
17239
17364
|
"type": "integer"
|
|
17365
|
+
},
|
|
17366
|
+
"execution_surface": {
|
|
17367
|
+
"type": "string",
|
|
17368
|
+
"enum": [
|
|
17369
|
+
"vault",
|
|
17370
|
+
"tee"
|
|
17371
|
+
],
|
|
17372
|
+
"description": "Where the intent actually ran. Reported truthfully — never claims TEE when it ran in the Vault."
|
|
17240
17373
|
}
|
|
17241
17374
|
}
|
|
17242
17375
|
},
|
package/openapi.yaml
CHANGED
|
@@ -2,7 +2,7 @@ openapi: 3.1.0
|
|
|
2
2
|
|
|
3
3
|
info:
|
|
4
4
|
title: 1Claw API
|
|
5
|
-
version: 2.
|
|
5
|
+
version: 2.27.0
|
|
6
6
|
description: |
|
|
7
7
|
Secure secret management for AI agents. Provides vaults, secrets,
|
|
8
8
|
policy-based access control, agent identity, Intents API,
|
|
@@ -2689,6 +2689,42 @@ paths:
|
|
|
2689
2689
|
"404":
|
|
2690
2690
|
$ref: "#/components/responses/NotFound"
|
|
2691
2691
|
|
|
2692
|
+
/v1/agents/{agent_id}/bindings/{binding_id}/rotate-credential:
|
|
2693
|
+
post:
|
|
2694
|
+
tags: [Execution Intents]
|
|
2695
|
+
summary: Rotate a binding credential
|
|
2696
|
+
description: Overwrite the stored credential for a binding without touching its config or guardrails. Human-only. The credential value is never returned.
|
|
2697
|
+
operationId: rotateBindingCredential
|
|
2698
|
+
parameters:
|
|
2699
|
+
- $ref: "#/components/parameters/AgentId"
|
|
2700
|
+
- name: binding_id
|
|
2701
|
+
in: path
|
|
2702
|
+
required: true
|
|
2703
|
+
schema:
|
|
2704
|
+
type: string
|
|
2705
|
+
format: uuid
|
|
2706
|
+
requestBody:
|
|
2707
|
+
required: true
|
|
2708
|
+
content:
|
|
2709
|
+
application/json:
|
|
2710
|
+
schema:
|
|
2711
|
+
type: object
|
|
2712
|
+
required: [credential]
|
|
2713
|
+
properties:
|
|
2714
|
+
credential:
|
|
2715
|
+
description: New credential material (object or string). Stored server-side.
|
|
2716
|
+
responses:
|
|
2717
|
+
"200":
|
|
2718
|
+
description: Updated binding
|
|
2719
|
+
content:
|
|
2720
|
+
application/json:
|
|
2721
|
+
schema:
|
|
2722
|
+
$ref: "#/components/schemas/BindingResponse"
|
|
2723
|
+
"403":
|
|
2724
|
+
$ref: "#/components/responses/Forbidden"
|
|
2725
|
+
"404":
|
|
2726
|
+
$ref: "#/components/responses/NotFound"
|
|
2727
|
+
|
|
2692
2728
|
/v1/agents/{agent_id}/execute:
|
|
2693
2729
|
post:
|
|
2694
2730
|
tags: [Execution Intents]
|
|
@@ -11264,6 +11300,28 @@ components:
|
|
|
11264
11300
|
|
|
11265
11301
|
# --- Execution Intents ---
|
|
11266
11302
|
|
|
11303
|
+
CredentialSource:
|
|
11304
|
+
type: object
|
|
11305
|
+
required: [type]
|
|
11306
|
+
description: Credential source — inline value (stored in __agent-keys) or live pointer to a vault secret (resolved at execution time).
|
|
11307
|
+
discriminator:
|
|
11308
|
+
propertyName: type
|
|
11309
|
+
properties:
|
|
11310
|
+
type:
|
|
11311
|
+
type: string
|
|
11312
|
+
enum: [inline, vault_ref]
|
|
11313
|
+
value:
|
|
11314
|
+
type: object
|
|
11315
|
+
additionalProperties: true
|
|
11316
|
+
description: For inline — the credential value object.
|
|
11317
|
+
vault_id:
|
|
11318
|
+
type: string
|
|
11319
|
+
format: uuid
|
|
11320
|
+
description: For vault_ref — the vault containing the referenced secret.
|
|
11321
|
+
path:
|
|
11322
|
+
type: string
|
|
11323
|
+
description: For vault_ref — the secret path in the vault.
|
|
11324
|
+
|
|
11267
11325
|
CreateBindingRequest:
|
|
11268
11326
|
type: object
|
|
11269
11327
|
required: [name, binding_type]
|
|
@@ -11282,6 +11340,9 @@ components:
|
|
|
11282
11340
|
credential:
|
|
11283
11341
|
type: object
|
|
11284
11342
|
additionalProperties: true
|
|
11343
|
+
description: "Legacy: inline credential value. Use credential_source for new integrations."
|
|
11344
|
+
credential_source:
|
|
11345
|
+
$ref: "#/components/schemas/CredentialSource"
|
|
11285
11346
|
|
|
11286
11347
|
UpdateBindingRequest:
|
|
11287
11348
|
type: object
|
|
@@ -11297,6 +11358,9 @@ components:
|
|
|
11297
11358
|
credential:
|
|
11298
11359
|
type: object
|
|
11299
11360
|
additionalProperties: true
|
|
11361
|
+
description: "Legacy: inline credential value."
|
|
11362
|
+
credential_source:
|
|
11363
|
+
$ref: "#/components/schemas/CredentialSource"
|
|
11300
11364
|
|
|
11301
11365
|
BindingResponse:
|
|
11302
11366
|
type: object
|
|
@@ -11321,6 +11385,23 @@ components:
|
|
|
11321
11385
|
additionalProperties: true
|
|
11322
11386
|
is_active:
|
|
11323
11387
|
type: boolean
|
|
11388
|
+
credential_set:
|
|
11389
|
+
type: boolean
|
|
11390
|
+
description: Whether a credential is stored for this binding. The value itself is never returned.
|
|
11391
|
+
credential_source_type:
|
|
11392
|
+
type: string
|
|
11393
|
+
enum: [inline, vault_ref]
|
|
11394
|
+
nullable: true
|
|
11395
|
+
description: How the credential is sourced — inline (HSM-encrypted copy) or vault_ref (live pointer).
|
|
11396
|
+
credential_vault_id:
|
|
11397
|
+
type: string
|
|
11398
|
+
format: uuid
|
|
11399
|
+
nullable: true
|
|
11400
|
+
description: For vault_ref credentials — the vault containing the referenced secret.
|
|
11401
|
+
credential_path:
|
|
11402
|
+
type: string
|
|
11403
|
+
nullable: true
|
|
11404
|
+
description: For vault_ref credentials — the secret path in the referenced vault.
|
|
11324
11405
|
created_at:
|
|
11325
11406
|
type: string
|
|
11326
11407
|
format: date-time
|
|
@@ -11380,6 +11461,10 @@ components:
|
|
|
11380
11461
|
type: integer
|
|
11381
11462
|
redactions_applied:
|
|
11382
11463
|
type: integer
|
|
11464
|
+
execution_surface:
|
|
11465
|
+
type: string
|
|
11466
|
+
enum: [vault, tee]
|
|
11467
|
+
description: Where the intent actually ran. Reported truthfully — never claims TEE when it ran in the Vault.
|
|
11383
11468
|
|
|
11384
11469
|
ExecutionEventResponse:
|
|
11385
11470
|
type: object
|