@1claw/openapi-spec 0.34.4 → 0.35.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 +259 -1
- package/openapi.yaml +174 -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.22.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"
|
|
@@ -7674,6 +7674,144 @@
|
|
|
7674
7674
|
}
|
|
7675
7675
|
}
|
|
7676
7676
|
},
|
|
7677
|
+
"/v1/platform/connections/{connectionId}/grant": {
|
|
7678
|
+
"post": {
|
|
7679
|
+
"tags": [
|
|
7680
|
+
"Platform"
|
|
7681
|
+
],
|
|
7682
|
+
"summary": "Grant platform app access to vaults/agents",
|
|
7683
|
+
"description": "User-authenticated. Grant the platform app access to selected vaults and agents.\nValidates user ownership of all requested resources. Creates platform_user_grants\nentries and merges resource IDs into the connection record.\n",
|
|
7684
|
+
"security": [
|
|
7685
|
+
{
|
|
7686
|
+
"BearerAuth": []
|
|
7687
|
+
}
|
|
7688
|
+
],
|
|
7689
|
+
"parameters": [
|
|
7690
|
+
{
|
|
7691
|
+
"in": "path",
|
|
7692
|
+
"name": "connectionId",
|
|
7693
|
+
"required": true,
|
|
7694
|
+
"schema": {
|
|
7695
|
+
"type": "string",
|
|
7696
|
+
"format": "uuid"
|
|
7697
|
+
}
|
|
7698
|
+
}
|
|
7699
|
+
],
|
|
7700
|
+
"requestBody": {
|
|
7701
|
+
"required": true,
|
|
7702
|
+
"content": {
|
|
7703
|
+
"application/json": {
|
|
7704
|
+
"schema": {
|
|
7705
|
+
"$ref": "#/components/schemas/GrantResourcesRequest"
|
|
7706
|
+
}
|
|
7707
|
+
}
|
|
7708
|
+
}
|
|
7709
|
+
},
|
|
7710
|
+
"responses": {
|
|
7711
|
+
"201": {
|
|
7712
|
+
"description": "Grants created",
|
|
7713
|
+
"content": {
|
|
7714
|
+
"application/json": {
|
|
7715
|
+
"schema": {
|
|
7716
|
+
"$ref": "#/components/schemas/GrantResourcesResponse"
|
|
7717
|
+
}
|
|
7718
|
+
}
|
|
7719
|
+
}
|
|
7720
|
+
},
|
|
7721
|
+
"400": {
|
|
7722
|
+
"description": "No vault_ids or agent_ids provided"
|
|
7723
|
+
},
|
|
7724
|
+
"403": {
|
|
7725
|
+
"description": "Resource not owned by caller"
|
|
7726
|
+
},
|
|
7727
|
+
"404": {
|
|
7728
|
+
"description": "Connection not found"
|
|
7729
|
+
}
|
|
7730
|
+
}
|
|
7731
|
+
}
|
|
7732
|
+
},
|
|
7733
|
+
"/v1/platform/connections/{connectionId}/grants": {
|
|
7734
|
+
"get": {
|
|
7735
|
+
"tags": [
|
|
7736
|
+
"Platform"
|
|
7737
|
+
],
|
|
7738
|
+
"summary": "List active resource grants for a connection",
|
|
7739
|
+
"description": "User-authenticated. Returns active (non-revoked) grants for the connection.",
|
|
7740
|
+
"security": [
|
|
7741
|
+
{
|
|
7742
|
+
"BearerAuth": []
|
|
7743
|
+
}
|
|
7744
|
+
],
|
|
7745
|
+
"parameters": [
|
|
7746
|
+
{
|
|
7747
|
+
"in": "path",
|
|
7748
|
+
"name": "connectionId",
|
|
7749
|
+
"required": true,
|
|
7750
|
+
"schema": {
|
|
7751
|
+
"type": "string",
|
|
7752
|
+
"format": "uuid"
|
|
7753
|
+
}
|
|
7754
|
+
}
|
|
7755
|
+
],
|
|
7756
|
+
"responses": {
|
|
7757
|
+
"200": {
|
|
7758
|
+
"description": "Grant list",
|
|
7759
|
+
"content": {
|
|
7760
|
+
"application/json": {
|
|
7761
|
+
"schema": {
|
|
7762
|
+
"$ref": "#/components/schemas/GrantListResponse"
|
|
7763
|
+
}
|
|
7764
|
+
}
|
|
7765
|
+
}
|
|
7766
|
+
},
|
|
7767
|
+
"404": {
|
|
7768
|
+
"description": "Connection not found"
|
|
7769
|
+
}
|
|
7770
|
+
}
|
|
7771
|
+
}
|
|
7772
|
+
},
|
|
7773
|
+
"/v1/platform/connections/{connectionId}/grants/{grantId}": {
|
|
7774
|
+
"delete": {
|
|
7775
|
+
"tags": [
|
|
7776
|
+
"Platform"
|
|
7777
|
+
],
|
|
7778
|
+
"summary": "Revoke a resource grant",
|
|
7779
|
+
"description": "User-authenticated. Revoke a specific resource grant by ID.",
|
|
7780
|
+
"security": [
|
|
7781
|
+
{
|
|
7782
|
+
"BearerAuth": []
|
|
7783
|
+
}
|
|
7784
|
+
],
|
|
7785
|
+
"parameters": [
|
|
7786
|
+
{
|
|
7787
|
+
"in": "path",
|
|
7788
|
+
"name": "connectionId",
|
|
7789
|
+
"required": true,
|
|
7790
|
+
"schema": {
|
|
7791
|
+
"type": "string",
|
|
7792
|
+
"format": "uuid"
|
|
7793
|
+
}
|
|
7794
|
+
},
|
|
7795
|
+
{
|
|
7796
|
+
"in": "path",
|
|
7797
|
+
"name": "grantId",
|
|
7798
|
+
"required": true,
|
|
7799
|
+
"schema": {
|
|
7800
|
+
"type": "string",
|
|
7801
|
+
"format": "uuid"
|
|
7802
|
+
}
|
|
7803
|
+
}
|
|
7804
|
+
],
|
|
7805
|
+
"responses": {
|
|
7806
|
+
"204": {
|
|
7807
|
+
"description": "Grant revoked"
|
|
7808
|
+
},
|
|
7809
|
+
"404": {
|
|
7810
|
+
"description": "Grant not found or already revoked"
|
|
7811
|
+
}
|
|
7812
|
+
}
|
|
7813
|
+
}
|
|
7814
|
+
},
|
|
7677
7815
|
"/v1/platform/claim/{token}": {
|
|
7678
7816
|
"get": {
|
|
7679
7817
|
"tags": [
|
|
@@ -14996,6 +15134,126 @@
|
|
|
14996
15134
|
}
|
|
14997
15135
|
}
|
|
14998
15136
|
},
|
|
15137
|
+
"GrantResourcesRequest": {
|
|
15138
|
+
"type": "object",
|
|
15139
|
+
"properties": {
|
|
15140
|
+
"vault_ids": {
|
|
15141
|
+
"type": "array",
|
|
15142
|
+
"items": {
|
|
15143
|
+
"type": "string",
|
|
15144
|
+
"format": "uuid"
|
|
15145
|
+
},
|
|
15146
|
+
"description": "Vault IDs to grant access to"
|
|
15147
|
+
},
|
|
15148
|
+
"agent_ids": {
|
|
15149
|
+
"type": "array",
|
|
15150
|
+
"items": {
|
|
15151
|
+
"type": "string",
|
|
15152
|
+
"format": "uuid"
|
|
15153
|
+
},
|
|
15154
|
+
"description": "Agent IDs to grant access to"
|
|
15155
|
+
},
|
|
15156
|
+
"allowed_paths": {
|
|
15157
|
+
"type": "array",
|
|
15158
|
+
"items": {
|
|
15159
|
+
"type": "string"
|
|
15160
|
+
},
|
|
15161
|
+
"default": [
|
|
15162
|
+
"**"
|
|
15163
|
+
],
|
|
15164
|
+
"description": "Secret path patterns the app can access"
|
|
15165
|
+
},
|
|
15166
|
+
"permissions": {
|
|
15167
|
+
"type": "array",
|
|
15168
|
+
"items": {
|
|
15169
|
+
"type": "string"
|
|
15170
|
+
},
|
|
15171
|
+
"default": [
|
|
15172
|
+
"read"
|
|
15173
|
+
],
|
|
15174
|
+
"description": "Permissions granted (read, write, rotate)"
|
|
15175
|
+
},
|
|
15176
|
+
"expires_at": {
|
|
15177
|
+
"type": "string",
|
|
15178
|
+
"format": "date-time",
|
|
15179
|
+
"description": "Optional grant expiration"
|
|
15180
|
+
}
|
|
15181
|
+
}
|
|
15182
|
+
},
|
|
15183
|
+
"GrantResponse": {
|
|
15184
|
+
"type": "object",
|
|
15185
|
+
"properties": {
|
|
15186
|
+
"id": {
|
|
15187
|
+
"type": "string",
|
|
15188
|
+
"format": "uuid"
|
|
15189
|
+
},
|
|
15190
|
+
"vault_id": {
|
|
15191
|
+
"type": "string",
|
|
15192
|
+
"format": "uuid"
|
|
15193
|
+
},
|
|
15194
|
+
"allowed_paths": {
|
|
15195
|
+
"type": "array",
|
|
15196
|
+
"items": {
|
|
15197
|
+
"type": "string"
|
|
15198
|
+
}
|
|
15199
|
+
},
|
|
15200
|
+
"permissions": {
|
|
15201
|
+
"type": "array",
|
|
15202
|
+
"items": {
|
|
15203
|
+
"type": "string"
|
|
15204
|
+
}
|
|
15205
|
+
},
|
|
15206
|
+
"expires_at": {
|
|
15207
|
+
"type": "string",
|
|
15208
|
+
"format": "date-time",
|
|
15209
|
+
"nullable": true
|
|
15210
|
+
},
|
|
15211
|
+
"created_at": {
|
|
15212
|
+
"type": "string",
|
|
15213
|
+
"format": "date-time"
|
|
15214
|
+
}
|
|
15215
|
+
}
|
|
15216
|
+
},
|
|
15217
|
+
"GrantResourcesResponse": {
|
|
15218
|
+
"type": "object",
|
|
15219
|
+
"properties": {
|
|
15220
|
+
"connection_id": {
|
|
15221
|
+
"type": "string",
|
|
15222
|
+
"format": "uuid"
|
|
15223
|
+
},
|
|
15224
|
+
"grants": {
|
|
15225
|
+
"type": "array",
|
|
15226
|
+
"items": {
|
|
15227
|
+
"$ref": "#/components/schemas/GrantResponse"
|
|
15228
|
+
}
|
|
15229
|
+
},
|
|
15230
|
+
"vault_ids": {
|
|
15231
|
+
"type": "array",
|
|
15232
|
+
"items": {
|
|
15233
|
+
"type": "string",
|
|
15234
|
+
"format": "uuid"
|
|
15235
|
+
}
|
|
15236
|
+
},
|
|
15237
|
+
"agent_ids": {
|
|
15238
|
+
"type": "array",
|
|
15239
|
+
"items": {
|
|
15240
|
+
"type": "string",
|
|
15241
|
+
"format": "uuid"
|
|
15242
|
+
}
|
|
15243
|
+
}
|
|
15244
|
+
}
|
|
15245
|
+
},
|
|
15246
|
+
"GrantListResponse": {
|
|
15247
|
+
"type": "object",
|
|
15248
|
+
"properties": {
|
|
15249
|
+
"grants": {
|
|
15250
|
+
"type": "array",
|
|
15251
|
+
"items": {
|
|
15252
|
+
"$ref": "#/components/schemas/GrantResponse"
|
|
15253
|
+
}
|
|
15254
|
+
}
|
|
15255
|
+
}
|
|
15256
|
+
},
|
|
14999
15257
|
"ClaimPreviewResponse": {
|
|
15000
15258
|
"type": "object",
|
|
15001
15259
|
"properties": {
|
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.22.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,
|
|
@@ -4957,6 +4957,93 @@ paths:
|
|
|
4957
4957
|
"404":
|
|
4958
4958
|
description: Connection not found
|
|
4959
4959
|
|
|
4960
|
+
/v1/platform/connections/{connectionId}/grant:
|
|
4961
|
+
post:
|
|
4962
|
+
tags: [Platform]
|
|
4963
|
+
summary: Grant platform app access to vaults/agents
|
|
4964
|
+
description: |
|
|
4965
|
+
User-authenticated. Grant the platform app access to selected vaults and agents.
|
|
4966
|
+
Validates user ownership of all requested resources. Creates platform_user_grants
|
|
4967
|
+
entries and merges resource IDs into the connection record.
|
|
4968
|
+
security:
|
|
4969
|
+
- BearerAuth: []
|
|
4970
|
+
parameters:
|
|
4971
|
+
- in: path
|
|
4972
|
+
name: connectionId
|
|
4973
|
+
required: true
|
|
4974
|
+
schema:
|
|
4975
|
+
type: string
|
|
4976
|
+
format: uuid
|
|
4977
|
+
requestBody:
|
|
4978
|
+
required: true
|
|
4979
|
+
content:
|
|
4980
|
+
application/json:
|
|
4981
|
+
schema:
|
|
4982
|
+
$ref: "#/components/schemas/GrantResourcesRequest"
|
|
4983
|
+
responses:
|
|
4984
|
+
"201":
|
|
4985
|
+
description: Grants created
|
|
4986
|
+
content:
|
|
4987
|
+
application/json:
|
|
4988
|
+
schema:
|
|
4989
|
+
$ref: "#/components/schemas/GrantResourcesResponse"
|
|
4990
|
+
"400":
|
|
4991
|
+
description: No vault_ids or agent_ids provided
|
|
4992
|
+
"403":
|
|
4993
|
+
description: Resource not owned by caller
|
|
4994
|
+
"404":
|
|
4995
|
+
description: Connection not found
|
|
4996
|
+
|
|
4997
|
+
/v1/platform/connections/{connectionId}/grants:
|
|
4998
|
+
get:
|
|
4999
|
+
tags: [Platform]
|
|
5000
|
+
summary: List active resource grants for a connection
|
|
5001
|
+
description: User-authenticated. Returns active (non-revoked) grants for the connection.
|
|
5002
|
+
security:
|
|
5003
|
+
- BearerAuth: []
|
|
5004
|
+
parameters:
|
|
5005
|
+
- in: path
|
|
5006
|
+
name: connectionId
|
|
5007
|
+
required: true
|
|
5008
|
+
schema:
|
|
5009
|
+
type: string
|
|
5010
|
+
format: uuid
|
|
5011
|
+
responses:
|
|
5012
|
+
"200":
|
|
5013
|
+
description: Grant list
|
|
5014
|
+
content:
|
|
5015
|
+
application/json:
|
|
5016
|
+
schema:
|
|
5017
|
+
$ref: "#/components/schemas/GrantListResponse"
|
|
5018
|
+
"404":
|
|
5019
|
+
description: Connection not found
|
|
5020
|
+
|
|
5021
|
+
/v1/platform/connections/{connectionId}/grants/{grantId}:
|
|
5022
|
+
delete:
|
|
5023
|
+
tags: [Platform]
|
|
5024
|
+
summary: Revoke a resource grant
|
|
5025
|
+
description: User-authenticated. Revoke a specific resource grant by ID.
|
|
5026
|
+
security:
|
|
5027
|
+
- BearerAuth: []
|
|
5028
|
+
parameters:
|
|
5029
|
+
- in: path
|
|
5030
|
+
name: connectionId
|
|
5031
|
+
required: true
|
|
5032
|
+
schema:
|
|
5033
|
+
type: string
|
|
5034
|
+
format: uuid
|
|
5035
|
+
- in: path
|
|
5036
|
+
name: grantId
|
|
5037
|
+
required: true
|
|
5038
|
+
schema:
|
|
5039
|
+
type: string
|
|
5040
|
+
format: uuid
|
|
5041
|
+
responses:
|
|
5042
|
+
"204":
|
|
5043
|
+
description: Grant revoked
|
|
5044
|
+
"404":
|
|
5045
|
+
description: Grant not found or already revoked
|
|
5046
|
+
|
|
4960
5047
|
/v1/platform/claim/{token}:
|
|
4961
5048
|
get:
|
|
4962
5049
|
tags: [Platform]
|
|
@@ -9906,6 +9993,92 @@ components:
|
|
|
9906
9993
|
type: string
|
|
9907
9994
|
format: date-time
|
|
9908
9995
|
|
|
9996
|
+
GrantResourcesRequest:
|
|
9997
|
+
type: object
|
|
9998
|
+
properties:
|
|
9999
|
+
vault_ids:
|
|
10000
|
+
type: array
|
|
10001
|
+
items:
|
|
10002
|
+
type: string
|
|
10003
|
+
format: uuid
|
|
10004
|
+
description: Vault IDs to grant access to
|
|
10005
|
+
agent_ids:
|
|
10006
|
+
type: array
|
|
10007
|
+
items:
|
|
10008
|
+
type: string
|
|
10009
|
+
format: uuid
|
|
10010
|
+
description: Agent IDs to grant access to
|
|
10011
|
+
allowed_paths:
|
|
10012
|
+
type: array
|
|
10013
|
+
items:
|
|
10014
|
+
type: string
|
|
10015
|
+
default: ["**"]
|
|
10016
|
+
description: Secret path patterns the app can access
|
|
10017
|
+
permissions:
|
|
10018
|
+
type: array
|
|
10019
|
+
items:
|
|
10020
|
+
type: string
|
|
10021
|
+
default: ["read"]
|
|
10022
|
+
description: Permissions granted (read, write, rotate)
|
|
10023
|
+
expires_at:
|
|
10024
|
+
type: string
|
|
10025
|
+
format: date-time
|
|
10026
|
+
description: Optional grant expiration
|
|
10027
|
+
|
|
10028
|
+
GrantResponse:
|
|
10029
|
+
type: object
|
|
10030
|
+
properties:
|
|
10031
|
+
id:
|
|
10032
|
+
type: string
|
|
10033
|
+
format: uuid
|
|
10034
|
+
vault_id:
|
|
10035
|
+
type: string
|
|
10036
|
+
format: uuid
|
|
10037
|
+
allowed_paths:
|
|
10038
|
+
type: array
|
|
10039
|
+
items:
|
|
10040
|
+
type: string
|
|
10041
|
+
permissions:
|
|
10042
|
+
type: array
|
|
10043
|
+
items:
|
|
10044
|
+
type: string
|
|
10045
|
+
expires_at:
|
|
10046
|
+
type: string
|
|
10047
|
+
format: date-time
|
|
10048
|
+
nullable: true
|
|
10049
|
+
created_at:
|
|
10050
|
+
type: string
|
|
10051
|
+
format: date-time
|
|
10052
|
+
|
|
10053
|
+
GrantResourcesResponse:
|
|
10054
|
+
type: object
|
|
10055
|
+
properties:
|
|
10056
|
+
connection_id:
|
|
10057
|
+
type: string
|
|
10058
|
+
format: uuid
|
|
10059
|
+
grants:
|
|
10060
|
+
type: array
|
|
10061
|
+
items:
|
|
10062
|
+
$ref: "#/components/schemas/GrantResponse"
|
|
10063
|
+
vault_ids:
|
|
10064
|
+
type: array
|
|
10065
|
+
items:
|
|
10066
|
+
type: string
|
|
10067
|
+
format: uuid
|
|
10068
|
+
agent_ids:
|
|
10069
|
+
type: array
|
|
10070
|
+
items:
|
|
10071
|
+
type: string
|
|
10072
|
+
format: uuid
|
|
10073
|
+
|
|
10074
|
+
GrantListResponse:
|
|
10075
|
+
type: object
|
|
10076
|
+
properties:
|
|
10077
|
+
grants:
|
|
10078
|
+
type: array
|
|
10079
|
+
items:
|
|
10080
|
+
$ref: "#/components/schemas/GrantResponse"
|
|
10081
|
+
|
|
9909
10082
|
ClaimPreviewResponse:
|
|
9910
10083
|
type: object
|
|
9911
10084
|
properties:
|