@turnkey/http 0.13.0 → 0.13.2
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/CHANGELOG.md +12 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.swagger.json +3750 -0
- package/dist/base.d.ts.map +1 -1
- package/dist/base.js +7 -5
- package/dist/base.js.map +1 -1
- package/dist/config.d.ts +9 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/shared.d.ts +10 -0
- package/dist/shared.d.ts.map +1 -1
- package/dist/shared.js +14 -1
- package/dist/shared.js.map +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,3750 @@
|
|
|
1
|
+
{
|
|
2
|
+
"swagger": "2.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Turnkey Public API",
|
|
5
|
+
"version": "1.0",
|
|
6
|
+
"contact": {
|
|
7
|
+
"name": "Turnkey Engineering",
|
|
8
|
+
"url": "https://turnkey.io/contact",
|
|
9
|
+
"email": "eng@turnkey.io"
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"tags": [
|
|
13
|
+
{
|
|
14
|
+
"name": "PublicApiService"
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"host": "coordinator-beta.turnkey.io",
|
|
18
|
+
"schemes": ["https"],
|
|
19
|
+
"consumes": ["application/json"],
|
|
20
|
+
"produces": ["application/json"],
|
|
21
|
+
"paths": {
|
|
22
|
+
"/public/v1/query/get_activity": {
|
|
23
|
+
"post": {
|
|
24
|
+
"summary": "Get Activity",
|
|
25
|
+
"description": "Get details about an Activity",
|
|
26
|
+
"operationId": "PublicApiService_GetActivity",
|
|
27
|
+
"responses": {
|
|
28
|
+
"200": {
|
|
29
|
+
"description": "A successful response.",
|
|
30
|
+
"schema": {
|
|
31
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"403": {
|
|
35
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
36
|
+
"schema": {}
|
|
37
|
+
},
|
|
38
|
+
"404": {
|
|
39
|
+
"description": "Returned when the resource does not exist.",
|
|
40
|
+
"schema": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"format": "string"
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"default": {
|
|
46
|
+
"description": "An unexpected error response.",
|
|
47
|
+
"schema": {
|
|
48
|
+
"$ref": "#/definitions/rpcStatus"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
"parameters": [
|
|
53
|
+
{
|
|
54
|
+
"name": "body",
|
|
55
|
+
"in": "body",
|
|
56
|
+
"required": true,
|
|
57
|
+
"schema": {
|
|
58
|
+
"$ref": "#/definitions/v1GetActivityRequest"
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
],
|
|
62
|
+
"tags": ["Activities"],
|
|
63
|
+
"x-readme": {
|
|
64
|
+
"code-samples": [
|
|
65
|
+
{
|
|
66
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_activity --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"activityId\": \"\"\n}'",
|
|
67
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
68
|
+
"language": "curl",
|
|
69
|
+
"name": "Turnkey CLI"
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"/public/v1/query/get_organization": {
|
|
76
|
+
"post": {
|
|
77
|
+
"summary": "Get Organization",
|
|
78
|
+
"description": "Get details about an Organization",
|
|
79
|
+
"operationId": "PublicApiService_GetOrganization",
|
|
80
|
+
"responses": {
|
|
81
|
+
"200": {
|
|
82
|
+
"description": "A successful response.",
|
|
83
|
+
"schema": {
|
|
84
|
+
"$ref": "#/definitions/v1GetOrganizationResponse"
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"403": {
|
|
88
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
89
|
+
"schema": {}
|
|
90
|
+
},
|
|
91
|
+
"404": {
|
|
92
|
+
"description": "Returned when the resource does not exist.",
|
|
93
|
+
"schema": {
|
|
94
|
+
"type": "string",
|
|
95
|
+
"format": "string"
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"default": {
|
|
99
|
+
"description": "An unexpected error response.",
|
|
100
|
+
"schema": {
|
|
101
|
+
"$ref": "#/definitions/rpcStatus"
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"parameters": [
|
|
106
|
+
{
|
|
107
|
+
"name": "body",
|
|
108
|
+
"in": "body",
|
|
109
|
+
"required": true,
|
|
110
|
+
"schema": {
|
|
111
|
+
"$ref": "#/definitions/v1GetOrganizationRequest"
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"tags": ["Organizations"],
|
|
116
|
+
"x-readme": {
|
|
117
|
+
"code-samples": [
|
|
118
|
+
{
|
|
119
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_organization --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
120
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
121
|
+
"language": "curl",
|
|
122
|
+
"name": "Turnkey CLI"
|
|
123
|
+
}
|
|
124
|
+
]
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"/public/v1/query/get_policy": {
|
|
129
|
+
"post": {
|
|
130
|
+
"summary": "Get Policy",
|
|
131
|
+
"description": "Get details about a Policy",
|
|
132
|
+
"operationId": "PublicApiService_GetPolicy",
|
|
133
|
+
"responses": {
|
|
134
|
+
"200": {
|
|
135
|
+
"description": "A successful response.",
|
|
136
|
+
"schema": {
|
|
137
|
+
"$ref": "#/definitions/v1GetPolicyResponse"
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"403": {
|
|
141
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
142
|
+
"schema": {}
|
|
143
|
+
},
|
|
144
|
+
"404": {
|
|
145
|
+
"description": "Returned when the resource does not exist.",
|
|
146
|
+
"schema": {
|
|
147
|
+
"type": "string",
|
|
148
|
+
"format": "string"
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
"default": {
|
|
152
|
+
"description": "An unexpected error response.",
|
|
153
|
+
"schema": {
|
|
154
|
+
"$ref": "#/definitions/rpcStatus"
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"parameters": [
|
|
159
|
+
{
|
|
160
|
+
"name": "body",
|
|
161
|
+
"in": "body",
|
|
162
|
+
"required": true,
|
|
163
|
+
"schema": {
|
|
164
|
+
"$ref": "#/definitions/v1GetPolicyRequest"
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
],
|
|
168
|
+
"tags": ["Policies"],
|
|
169
|
+
"x-readme": {
|
|
170
|
+
"code-samples": [
|
|
171
|
+
{
|
|
172
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_policy --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"policyId\": \"\"\n}'",
|
|
173
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
174
|
+
"language": "curl",
|
|
175
|
+
"name": "Turnkey CLI"
|
|
176
|
+
}
|
|
177
|
+
]
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
"/public/v1/query/get_user": {
|
|
182
|
+
"post": {
|
|
183
|
+
"summary": "Get User",
|
|
184
|
+
"description": "Get details about a User",
|
|
185
|
+
"operationId": "PublicApiService_GetUser",
|
|
186
|
+
"responses": {
|
|
187
|
+
"200": {
|
|
188
|
+
"description": "A successful response.",
|
|
189
|
+
"schema": {
|
|
190
|
+
"$ref": "#/definitions/v1GetUserResponse"
|
|
191
|
+
}
|
|
192
|
+
},
|
|
193
|
+
"403": {
|
|
194
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
195
|
+
"schema": {}
|
|
196
|
+
},
|
|
197
|
+
"404": {
|
|
198
|
+
"description": "Returned when the resource does not exist.",
|
|
199
|
+
"schema": {
|
|
200
|
+
"type": "string",
|
|
201
|
+
"format": "string"
|
|
202
|
+
}
|
|
203
|
+
},
|
|
204
|
+
"default": {
|
|
205
|
+
"description": "An unexpected error response.",
|
|
206
|
+
"schema": {
|
|
207
|
+
"$ref": "#/definitions/rpcStatus"
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"parameters": [
|
|
212
|
+
{
|
|
213
|
+
"name": "body",
|
|
214
|
+
"in": "body",
|
|
215
|
+
"required": true,
|
|
216
|
+
"schema": {
|
|
217
|
+
"$ref": "#/definitions/v1GetUserRequest"
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
],
|
|
221
|
+
"tags": ["Users"],
|
|
222
|
+
"x-readme": {
|
|
223
|
+
"code-samples": [
|
|
224
|
+
{
|
|
225
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_user --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"userId\": \"\"\n}'",
|
|
226
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
227
|
+
"language": "curl",
|
|
228
|
+
"name": "Turnkey CLI"
|
|
229
|
+
}
|
|
230
|
+
]
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"/public/v1/query/list_activities": {
|
|
235
|
+
"post": {
|
|
236
|
+
"summary": "List Activities",
|
|
237
|
+
"description": "List all Activities within an Organization",
|
|
238
|
+
"operationId": "PublicApiService_GetActivities",
|
|
239
|
+
"responses": {
|
|
240
|
+
"200": {
|
|
241
|
+
"description": "A successful response.",
|
|
242
|
+
"schema": {
|
|
243
|
+
"$ref": "#/definitions/v1GetActivitiesResponse"
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
"403": {
|
|
247
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
248
|
+
"schema": {}
|
|
249
|
+
},
|
|
250
|
+
"404": {
|
|
251
|
+
"description": "Returned when the resource does not exist.",
|
|
252
|
+
"schema": {
|
|
253
|
+
"type": "string",
|
|
254
|
+
"format": "string"
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"default": {
|
|
258
|
+
"description": "An unexpected error response.",
|
|
259
|
+
"schema": {
|
|
260
|
+
"$ref": "#/definitions/rpcStatus"
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
"parameters": [
|
|
265
|
+
{
|
|
266
|
+
"name": "body",
|
|
267
|
+
"in": "body",
|
|
268
|
+
"required": true,
|
|
269
|
+
"schema": {
|
|
270
|
+
"$ref": "#/definitions/v1GetActivitiesRequest"
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
],
|
|
274
|
+
"tags": ["Activities"],
|
|
275
|
+
"x-readme": {
|
|
276
|
+
"code-samples": [
|
|
277
|
+
{
|
|
278
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_activities --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
279
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
280
|
+
"language": "curl",
|
|
281
|
+
"name": "Turnkey CLI"
|
|
282
|
+
}
|
|
283
|
+
]
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
},
|
|
287
|
+
"/public/v1/query/list_policies": {
|
|
288
|
+
"post": {
|
|
289
|
+
"summary": "List Policies",
|
|
290
|
+
"description": "List all Policies within an Organization",
|
|
291
|
+
"operationId": "PublicApiService_GetPolicies",
|
|
292
|
+
"responses": {
|
|
293
|
+
"200": {
|
|
294
|
+
"description": "A successful response.",
|
|
295
|
+
"schema": {
|
|
296
|
+
"$ref": "#/definitions/v1GetPoliciesResponse"
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
"403": {
|
|
300
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
301
|
+
"schema": {}
|
|
302
|
+
},
|
|
303
|
+
"404": {
|
|
304
|
+
"description": "Returned when the resource does not exist.",
|
|
305
|
+
"schema": {
|
|
306
|
+
"type": "string",
|
|
307
|
+
"format": "string"
|
|
308
|
+
}
|
|
309
|
+
},
|
|
310
|
+
"default": {
|
|
311
|
+
"description": "An unexpected error response.",
|
|
312
|
+
"schema": {
|
|
313
|
+
"$ref": "#/definitions/rpcStatus"
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
},
|
|
317
|
+
"parameters": [
|
|
318
|
+
{
|
|
319
|
+
"name": "body",
|
|
320
|
+
"in": "body",
|
|
321
|
+
"required": true,
|
|
322
|
+
"schema": {
|
|
323
|
+
"$ref": "#/definitions/v1GetPoliciesRequest"
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
],
|
|
327
|
+
"tags": ["Policies"],
|
|
328
|
+
"x-readme": {
|
|
329
|
+
"code-samples": [
|
|
330
|
+
{
|
|
331
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_policies --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
332
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
333
|
+
"language": "curl",
|
|
334
|
+
"name": "Turnkey CLI"
|
|
335
|
+
}
|
|
336
|
+
]
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"/public/v1/query/list_private_keys": {
|
|
341
|
+
"post": {
|
|
342
|
+
"summary": "List Private Keys",
|
|
343
|
+
"description": "List all Private Keys within an Organization",
|
|
344
|
+
"operationId": "PublicApiService_GetPrivateKeys",
|
|
345
|
+
"responses": {
|
|
346
|
+
"200": {
|
|
347
|
+
"description": "A successful response.",
|
|
348
|
+
"schema": {
|
|
349
|
+
"$ref": "#/definitions/v1GetPrivateKeysResponse"
|
|
350
|
+
}
|
|
351
|
+
},
|
|
352
|
+
"403": {
|
|
353
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
354
|
+
"schema": {}
|
|
355
|
+
},
|
|
356
|
+
"404": {
|
|
357
|
+
"description": "Returned when the resource does not exist.",
|
|
358
|
+
"schema": {
|
|
359
|
+
"type": "string",
|
|
360
|
+
"format": "string"
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"default": {
|
|
364
|
+
"description": "An unexpected error response.",
|
|
365
|
+
"schema": {
|
|
366
|
+
"$ref": "#/definitions/rpcStatus"
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
},
|
|
370
|
+
"parameters": [
|
|
371
|
+
{
|
|
372
|
+
"name": "body",
|
|
373
|
+
"in": "body",
|
|
374
|
+
"required": true,
|
|
375
|
+
"schema": {
|
|
376
|
+
"$ref": "#/definitions/v1GetPrivateKeysRequest"
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
],
|
|
380
|
+
"tags": ["Private Keys"],
|
|
381
|
+
"x-readme": {
|
|
382
|
+
"code-samples": [
|
|
383
|
+
{
|
|
384
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_private_keys --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
385
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
386
|
+
"language": "curl",
|
|
387
|
+
"name": "Turnkey CLI"
|
|
388
|
+
}
|
|
389
|
+
]
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
"/public/v1/query/list_users": {
|
|
394
|
+
"post": {
|
|
395
|
+
"summary": "List Users",
|
|
396
|
+
"description": "List all Users within an Organization",
|
|
397
|
+
"operationId": "PublicApiService_GetUsers",
|
|
398
|
+
"responses": {
|
|
399
|
+
"200": {
|
|
400
|
+
"description": "A successful response.",
|
|
401
|
+
"schema": {
|
|
402
|
+
"$ref": "#/definitions/v1GetUsersResponse"
|
|
403
|
+
}
|
|
404
|
+
},
|
|
405
|
+
"403": {
|
|
406
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
407
|
+
"schema": {}
|
|
408
|
+
},
|
|
409
|
+
"404": {
|
|
410
|
+
"description": "Returned when the resource does not exist.",
|
|
411
|
+
"schema": {
|
|
412
|
+
"type": "string",
|
|
413
|
+
"format": "string"
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
"default": {
|
|
417
|
+
"description": "An unexpected error response.",
|
|
418
|
+
"schema": {
|
|
419
|
+
"$ref": "#/definitions/rpcStatus"
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
},
|
|
423
|
+
"parameters": [
|
|
424
|
+
{
|
|
425
|
+
"name": "body",
|
|
426
|
+
"in": "body",
|
|
427
|
+
"required": true,
|
|
428
|
+
"schema": {
|
|
429
|
+
"$ref": "#/definitions/v1GetUsersRequest"
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
],
|
|
433
|
+
"tags": ["Users"],
|
|
434
|
+
"x-readme": {
|
|
435
|
+
"code-samples": [
|
|
436
|
+
{
|
|
437
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_users --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
438
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
439
|
+
"language": "curl",
|
|
440
|
+
"name": "Turnkey CLI"
|
|
441
|
+
}
|
|
442
|
+
]
|
|
443
|
+
}
|
|
444
|
+
}
|
|
445
|
+
},
|
|
446
|
+
"/public/v1/query/whoami": {
|
|
447
|
+
"post": {
|
|
448
|
+
"summary": "Who am I?",
|
|
449
|
+
"description": "Get basic information about your current API user and your organization",
|
|
450
|
+
"operationId": "PublicApiService_GetWhoami",
|
|
451
|
+
"responses": {
|
|
452
|
+
"200": {
|
|
453
|
+
"description": "A successful response.",
|
|
454
|
+
"schema": {
|
|
455
|
+
"$ref": "#/definitions/v1GetWhoamiResponse"
|
|
456
|
+
}
|
|
457
|
+
},
|
|
458
|
+
"403": {
|
|
459
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
460
|
+
"schema": {}
|
|
461
|
+
},
|
|
462
|
+
"404": {
|
|
463
|
+
"description": "Returned when the resource does not exist.",
|
|
464
|
+
"schema": {
|
|
465
|
+
"type": "string",
|
|
466
|
+
"format": "string"
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"default": {
|
|
470
|
+
"description": "An unexpected error response.",
|
|
471
|
+
"schema": {
|
|
472
|
+
"$ref": "#/definitions/rpcStatus"
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"parameters": [
|
|
477
|
+
{
|
|
478
|
+
"name": "body",
|
|
479
|
+
"in": "body",
|
|
480
|
+
"required": true,
|
|
481
|
+
"schema": {
|
|
482
|
+
"$ref": "#/definitions/v1GetWhoamiRequest"
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
],
|
|
486
|
+
"tags": ["Users"],
|
|
487
|
+
"x-readme": {
|
|
488
|
+
"code-samples": [
|
|
489
|
+
{
|
|
490
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/whoami --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'",
|
|
491
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
492
|
+
"language": "curl",
|
|
493
|
+
"name": "Turnkey CLI"
|
|
494
|
+
}
|
|
495
|
+
]
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"/public/v1/submit/create_api_keys": {
|
|
500
|
+
"post": {
|
|
501
|
+
"summary": "Create API Keys",
|
|
502
|
+
"description": "Add api keys to an existing User",
|
|
503
|
+
"operationId": "PublicApiService_CreateApiKeys",
|
|
504
|
+
"responses": {
|
|
505
|
+
"200": {
|
|
506
|
+
"description": "A successful response.",
|
|
507
|
+
"schema": {
|
|
508
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
509
|
+
}
|
|
510
|
+
},
|
|
511
|
+
"403": {
|
|
512
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
513
|
+
"schema": {}
|
|
514
|
+
},
|
|
515
|
+
"404": {
|
|
516
|
+
"description": "Returned when the resource does not exist.",
|
|
517
|
+
"schema": {
|
|
518
|
+
"type": "string",
|
|
519
|
+
"format": "string"
|
|
520
|
+
}
|
|
521
|
+
},
|
|
522
|
+
"default": {
|
|
523
|
+
"description": "An unexpected error response.",
|
|
524
|
+
"schema": {
|
|
525
|
+
"$ref": "#/definitions/rpcStatus"
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
},
|
|
529
|
+
"parameters": [
|
|
530
|
+
{
|
|
531
|
+
"name": "body",
|
|
532
|
+
"in": "body",
|
|
533
|
+
"required": true,
|
|
534
|
+
"schema": {
|
|
535
|
+
"$ref": "#/definitions/v1CreateApiKeysRequest"
|
|
536
|
+
}
|
|
537
|
+
}
|
|
538
|
+
],
|
|
539
|
+
"tags": ["Users"],
|
|
540
|
+
"x-readme": {
|
|
541
|
+
"code-samples": [
|
|
542
|
+
{
|
|
543
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_api_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_API_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"apiKeys\": [{\n\t\t\t\"apiKeyName\": \"\",\n\t\t\t\"publicKey\": \"\"\n\t\t}],\n\t\t\"userId\": \"\"\n\t}\n}'",
|
|
544
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
545
|
+
"language": "curl",
|
|
546
|
+
"name": "Turnkey CLI"
|
|
547
|
+
}
|
|
548
|
+
]
|
|
549
|
+
}
|
|
550
|
+
}
|
|
551
|
+
},
|
|
552
|
+
"/public/v1/submit/create_api_only_users": {
|
|
553
|
+
"post": {
|
|
554
|
+
"summary": "Create Invitations",
|
|
555
|
+
"description": "Create API-only Users in an existing Organization",
|
|
556
|
+
"operationId": "PublicApiService_CreateApiOnlyUsers",
|
|
557
|
+
"responses": {
|
|
558
|
+
"200": {
|
|
559
|
+
"description": "A successful response.",
|
|
560
|
+
"schema": {
|
|
561
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
"403": {
|
|
565
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
566
|
+
"schema": {}
|
|
567
|
+
},
|
|
568
|
+
"404": {
|
|
569
|
+
"description": "Returned when the resource does not exist.",
|
|
570
|
+
"schema": {
|
|
571
|
+
"type": "string",
|
|
572
|
+
"format": "string"
|
|
573
|
+
}
|
|
574
|
+
},
|
|
575
|
+
"default": {
|
|
576
|
+
"description": "An unexpected error response.",
|
|
577
|
+
"schema": {
|
|
578
|
+
"$ref": "#/definitions/rpcStatus"
|
|
579
|
+
}
|
|
580
|
+
}
|
|
581
|
+
},
|
|
582
|
+
"parameters": [
|
|
583
|
+
{
|
|
584
|
+
"name": "body",
|
|
585
|
+
"in": "body",
|
|
586
|
+
"required": true,
|
|
587
|
+
"schema": {
|
|
588
|
+
"$ref": "#/definitions/v1CreateApiOnlyUsersRequest"
|
|
589
|
+
}
|
|
590
|
+
}
|
|
591
|
+
],
|
|
592
|
+
"tags": ["Organizations"],
|
|
593
|
+
"x-readme": {
|
|
594
|
+
"code-samples": [
|
|
595
|
+
{
|
|
596
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_api_only_users --body '{\n\t\"timestampMs\": \"$TIMESTAMP_IN_MILLISECONDS\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_API_ONLY_USERS\",\n\t\"organizationId\": \"$ORGANIZATION_ID\",\n\t\"parameters\": {\n\t\t\"api_only_users\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"userTags\": \"[]\", \n\t\t\t\"apiKeys\": [\n\t\t\t\t{\"publicKey\": \"public-key\",\"apiKeyName\": \"test\"}\n\t\t\t]}'",
|
|
597
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
598
|
+
"language": "curl",
|
|
599
|
+
"name": "Turnkey CLI"
|
|
600
|
+
}
|
|
601
|
+
]
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
},
|
|
605
|
+
"/public/v1/submit/create_invitations": {
|
|
606
|
+
"post": {
|
|
607
|
+
"summary": "Create Invitations",
|
|
608
|
+
"description": "Create Invitations to join an existing Organization",
|
|
609
|
+
"operationId": "PublicApiService_CreateInvitations",
|
|
610
|
+
"responses": {
|
|
611
|
+
"200": {
|
|
612
|
+
"description": "A successful response.",
|
|
613
|
+
"schema": {
|
|
614
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
"403": {
|
|
618
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
619
|
+
"schema": {}
|
|
620
|
+
},
|
|
621
|
+
"404": {
|
|
622
|
+
"description": "Returned when the resource does not exist.",
|
|
623
|
+
"schema": {
|
|
624
|
+
"type": "string",
|
|
625
|
+
"format": "string"
|
|
626
|
+
}
|
|
627
|
+
},
|
|
628
|
+
"default": {
|
|
629
|
+
"description": "An unexpected error response.",
|
|
630
|
+
"schema": {
|
|
631
|
+
"$ref": "#/definitions/rpcStatus"
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
},
|
|
635
|
+
"parameters": [
|
|
636
|
+
{
|
|
637
|
+
"name": "body",
|
|
638
|
+
"in": "body",
|
|
639
|
+
"required": true,
|
|
640
|
+
"schema": {
|
|
641
|
+
"$ref": "#/definitions/v1CreateInvitationsRequest"
|
|
642
|
+
}
|
|
643
|
+
}
|
|
644
|
+
],
|
|
645
|
+
"tags": ["Organizations"],
|
|
646
|
+
"x-readme": {
|
|
647
|
+
"code-samples": [
|
|
648
|
+
{
|
|
649
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_invitations --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_INVITATIONS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"invitations\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"receiverUserTags\": \"\",\n\t\t\t\"accessType\": \"\",\n\t\t\t\"senderUserId\": \"\"\n\t\t}]\n\t}\n}'",
|
|
650
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
651
|
+
"language": "curl",
|
|
652
|
+
"name": "Turnkey CLI"
|
|
653
|
+
}
|
|
654
|
+
]
|
|
655
|
+
}
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
"/public/v1/submit/create_policy": {
|
|
659
|
+
"post": {
|
|
660
|
+
"summary": "Create Policy",
|
|
661
|
+
"description": "Create a new Policy",
|
|
662
|
+
"operationId": "PublicApiService_CreatePolicy",
|
|
663
|
+
"responses": {
|
|
664
|
+
"200": {
|
|
665
|
+
"description": "A successful response.",
|
|
666
|
+
"schema": {
|
|
667
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
"403": {
|
|
671
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
672
|
+
"schema": {}
|
|
673
|
+
},
|
|
674
|
+
"404": {
|
|
675
|
+
"description": "Returned when the resource does not exist.",
|
|
676
|
+
"schema": {
|
|
677
|
+
"type": "string",
|
|
678
|
+
"format": "string"
|
|
679
|
+
}
|
|
680
|
+
},
|
|
681
|
+
"default": {
|
|
682
|
+
"description": "An unexpected error response.",
|
|
683
|
+
"schema": {
|
|
684
|
+
"$ref": "#/definitions/rpcStatus"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
"parameters": [
|
|
689
|
+
{
|
|
690
|
+
"name": "body",
|
|
691
|
+
"in": "body",
|
|
692
|
+
"required": true,
|
|
693
|
+
"schema": {
|
|
694
|
+
"$ref": "#/definitions/v1CreatePolicyRequest"
|
|
695
|
+
}
|
|
696
|
+
}
|
|
697
|
+
],
|
|
698
|
+
"tags": ["Policies"],
|
|
699
|
+
"x-readme": {
|
|
700
|
+
"code-samples": [
|
|
701
|
+
{
|
|
702
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_policy --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_POLICY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"policyName\": \"\",\n\t\t\"selectors\": [],\n\t\t\"effect\": \"\",\n\t\t\"notes\": \"\"\n\t}\n}'",
|
|
703
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
704
|
+
"language": "curl",
|
|
705
|
+
"name": "Turnkey CLI"
|
|
706
|
+
}
|
|
707
|
+
]
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"/public/v1/submit/create_private_keys": {
|
|
712
|
+
"post": {
|
|
713
|
+
"summary": "Create Private Keys",
|
|
714
|
+
"description": "Create new Private Keys",
|
|
715
|
+
"operationId": "PublicApiService_CreatePrivateKeys",
|
|
716
|
+
"responses": {
|
|
717
|
+
"200": {
|
|
718
|
+
"description": "A successful response.",
|
|
719
|
+
"schema": {
|
|
720
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
721
|
+
}
|
|
722
|
+
},
|
|
723
|
+
"403": {
|
|
724
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
725
|
+
"schema": {}
|
|
726
|
+
},
|
|
727
|
+
"404": {
|
|
728
|
+
"description": "Returned when the resource does not exist.",
|
|
729
|
+
"schema": {
|
|
730
|
+
"type": "string",
|
|
731
|
+
"format": "string"
|
|
732
|
+
}
|
|
733
|
+
},
|
|
734
|
+
"default": {
|
|
735
|
+
"description": "An unexpected error response.",
|
|
736
|
+
"schema": {
|
|
737
|
+
"$ref": "#/definitions/rpcStatus"
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
},
|
|
741
|
+
"parameters": [
|
|
742
|
+
{
|
|
743
|
+
"name": "body",
|
|
744
|
+
"in": "body",
|
|
745
|
+
"required": true,
|
|
746
|
+
"schema": {
|
|
747
|
+
"$ref": "#/definitions/v1CreatePrivateKeysRequest"
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
],
|
|
751
|
+
"tags": ["Private Keys"],
|
|
752
|
+
"x-readme": {
|
|
753
|
+
"code-samples": [
|
|
754
|
+
{
|
|
755
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_private_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeys\": [{\n\t\t\t\"privateKeyName\": \"\",\n\t\t\t\"curve\": \"\",\n\t\t\t\"privateKeyTags\": \"\",\n\t\t\t\"addressFormats\": \"\"\n\t\t}]\n\t}\n}'",
|
|
756
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
757
|
+
"language": "curl",
|
|
758
|
+
"name": "Turnkey CLI"
|
|
759
|
+
}
|
|
760
|
+
]
|
|
761
|
+
}
|
|
762
|
+
}
|
|
763
|
+
},
|
|
764
|
+
"/public/v1/submit/create_users": {
|
|
765
|
+
"post": {
|
|
766
|
+
"summary": "Create Users",
|
|
767
|
+
"description": "Create Users in an existing Organization",
|
|
768
|
+
"operationId": "PublicApiService_CreateUsers",
|
|
769
|
+
"responses": {
|
|
770
|
+
"200": {
|
|
771
|
+
"description": "A successful response.",
|
|
772
|
+
"schema": {
|
|
773
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
774
|
+
}
|
|
775
|
+
},
|
|
776
|
+
"403": {
|
|
777
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
778
|
+
"schema": {}
|
|
779
|
+
},
|
|
780
|
+
"404": {
|
|
781
|
+
"description": "Returned when the resource does not exist.",
|
|
782
|
+
"schema": {
|
|
783
|
+
"type": "string",
|
|
784
|
+
"format": "string"
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
"default": {
|
|
788
|
+
"description": "An unexpected error response.",
|
|
789
|
+
"schema": {
|
|
790
|
+
"$ref": "#/definitions/rpcStatus"
|
|
791
|
+
}
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
"parameters": [
|
|
795
|
+
{
|
|
796
|
+
"name": "body",
|
|
797
|
+
"in": "body",
|
|
798
|
+
"required": true,
|
|
799
|
+
"schema": {
|
|
800
|
+
"$ref": "#/definitions/v1CreateUsersRequest"
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
],
|
|
804
|
+
"tags": ["Organizations"],
|
|
805
|
+
"deprecated": true,
|
|
806
|
+
"x-readme": {
|
|
807
|
+
"code-samples": [
|
|
808
|
+
{
|
|
809
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_users --body '{\n\t\"timestampMs\": \"$TIMESTAMP_IN_MILLISECONDS\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_USERS\",\n\t\"organizationId\": \"$ORGANIZATION_ID\",\n\t\"parameters\": {\n\t\t\"users\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"accessType\": \"ACCESS_TYPE_API\",\n\t\t\t\"userTags\": \"[]\", \n\t\t\t\"apiKeys\": [\n\t\t\t\t{\"publicKey\": \"public-key\",\"apiKeyName\": \"test\"}\n\t\t\t]}]}'",
|
|
810
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
811
|
+
"language": "curl",
|
|
812
|
+
"name": "Turnkey CLI"
|
|
813
|
+
}
|
|
814
|
+
]
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
},
|
|
818
|
+
"/public/v1/submit/delete_api_keys": {
|
|
819
|
+
"post": {
|
|
820
|
+
"summary": "Delete API Keys",
|
|
821
|
+
"description": "Remove api keys from a User",
|
|
822
|
+
"operationId": "PublicApiService_DeleteApiKeys",
|
|
823
|
+
"responses": {
|
|
824
|
+
"200": {
|
|
825
|
+
"description": "A successful response.",
|
|
826
|
+
"schema": {
|
|
827
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
828
|
+
}
|
|
829
|
+
},
|
|
830
|
+
"403": {
|
|
831
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
832
|
+
"schema": {}
|
|
833
|
+
},
|
|
834
|
+
"404": {
|
|
835
|
+
"description": "Returned when the resource does not exist.",
|
|
836
|
+
"schema": {
|
|
837
|
+
"type": "string",
|
|
838
|
+
"format": "string"
|
|
839
|
+
}
|
|
840
|
+
},
|
|
841
|
+
"default": {
|
|
842
|
+
"description": "An unexpected error response.",
|
|
843
|
+
"schema": {
|
|
844
|
+
"$ref": "#/definitions/rpcStatus"
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
},
|
|
848
|
+
"parameters": [
|
|
849
|
+
{
|
|
850
|
+
"name": "body",
|
|
851
|
+
"in": "body",
|
|
852
|
+
"required": true,
|
|
853
|
+
"schema": {
|
|
854
|
+
"$ref": "#/definitions/v1DeleteApiKeysRequest"
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
],
|
|
858
|
+
"tags": ["Users"],
|
|
859
|
+
"x-readme": {
|
|
860
|
+
"code-samples": [
|
|
861
|
+
{
|
|
862
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_api_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_API_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"apiKeyIds\": [],\n\t\t\"userId\": \"\"\n\t}\n}'",
|
|
863
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
864
|
+
"language": "curl",
|
|
865
|
+
"name": "Turnkey CLI"
|
|
866
|
+
}
|
|
867
|
+
]
|
|
868
|
+
}
|
|
869
|
+
}
|
|
870
|
+
},
|
|
871
|
+
"/public/v1/submit/delete_invitations": {
|
|
872
|
+
"post": {
|
|
873
|
+
"summary": "Delete Invitation",
|
|
874
|
+
"description": "Delete an existing Invitation",
|
|
875
|
+
"operationId": "PublicApiService_DeleteInvitation",
|
|
876
|
+
"responses": {
|
|
877
|
+
"200": {
|
|
878
|
+
"description": "A successful response.",
|
|
879
|
+
"schema": {
|
|
880
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"403": {
|
|
884
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
885
|
+
"schema": {}
|
|
886
|
+
},
|
|
887
|
+
"404": {
|
|
888
|
+
"description": "Returned when the resource does not exist.",
|
|
889
|
+
"schema": {
|
|
890
|
+
"type": "string",
|
|
891
|
+
"format": "string"
|
|
892
|
+
}
|
|
893
|
+
},
|
|
894
|
+
"default": {
|
|
895
|
+
"description": "An unexpected error response.",
|
|
896
|
+
"schema": {
|
|
897
|
+
"$ref": "#/definitions/rpcStatus"
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
"parameters": [
|
|
902
|
+
{
|
|
903
|
+
"name": "body",
|
|
904
|
+
"in": "body",
|
|
905
|
+
"required": true,
|
|
906
|
+
"schema": {
|
|
907
|
+
"$ref": "#/definitions/v1DeleteInvitationRequest"
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
],
|
|
911
|
+
"tags": ["Organizations"],
|
|
912
|
+
"x-readme": {
|
|
913
|
+
"code-samples": [
|
|
914
|
+
{
|
|
915
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_invitation --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_INVITATION\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"invitationId\": \"\"\n\t}\n}'",
|
|
916
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
917
|
+
"language": "curl",
|
|
918
|
+
"name": "Turnkey CLI"
|
|
919
|
+
}
|
|
920
|
+
]
|
|
921
|
+
}
|
|
922
|
+
}
|
|
923
|
+
},
|
|
924
|
+
"/public/v1/submit/delete_policy": {
|
|
925
|
+
"post": {
|
|
926
|
+
"summary": "Delete Policy",
|
|
927
|
+
"description": "Delete an existing Policy",
|
|
928
|
+
"operationId": "PublicApiService_DeletePolicy",
|
|
929
|
+
"responses": {
|
|
930
|
+
"200": {
|
|
931
|
+
"description": "A successful response.",
|
|
932
|
+
"schema": {
|
|
933
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
"403": {
|
|
937
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
938
|
+
"schema": {}
|
|
939
|
+
},
|
|
940
|
+
"404": {
|
|
941
|
+
"description": "Returned when the resource does not exist.",
|
|
942
|
+
"schema": {
|
|
943
|
+
"type": "string",
|
|
944
|
+
"format": "string"
|
|
945
|
+
}
|
|
946
|
+
},
|
|
947
|
+
"default": {
|
|
948
|
+
"description": "An unexpected error response.",
|
|
949
|
+
"schema": {
|
|
950
|
+
"$ref": "#/definitions/rpcStatus"
|
|
951
|
+
}
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
"parameters": [
|
|
955
|
+
{
|
|
956
|
+
"name": "body",
|
|
957
|
+
"in": "body",
|
|
958
|
+
"required": true,
|
|
959
|
+
"schema": {
|
|
960
|
+
"$ref": "#/definitions/v1DeletePolicyRequest"
|
|
961
|
+
}
|
|
962
|
+
}
|
|
963
|
+
],
|
|
964
|
+
"tags": ["Policies"],
|
|
965
|
+
"x-readme": {
|
|
966
|
+
"code-samples": [
|
|
967
|
+
{
|
|
968
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_policy --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_POLICY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"policyId\": \"\"\n\t}\n}'",
|
|
969
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
970
|
+
"language": "curl",
|
|
971
|
+
"name": "Turnkey CLI"
|
|
972
|
+
}
|
|
973
|
+
]
|
|
974
|
+
}
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"/public/v1/submit/sign_raw_payload": {
|
|
978
|
+
"post": {
|
|
979
|
+
"summary": "Sign Raw Payload",
|
|
980
|
+
"description": "Sign a raw payload with a Private Key",
|
|
981
|
+
"operationId": "PublicApiService_SignRawPayload",
|
|
982
|
+
"responses": {
|
|
983
|
+
"200": {
|
|
984
|
+
"description": "A successful response.",
|
|
985
|
+
"schema": {
|
|
986
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
987
|
+
}
|
|
988
|
+
},
|
|
989
|
+
"403": {
|
|
990
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
991
|
+
"schema": {}
|
|
992
|
+
},
|
|
993
|
+
"404": {
|
|
994
|
+
"description": "Returned when the resource does not exist.",
|
|
995
|
+
"schema": {
|
|
996
|
+
"type": "string",
|
|
997
|
+
"format": "string"
|
|
998
|
+
}
|
|
999
|
+
},
|
|
1000
|
+
"default": {
|
|
1001
|
+
"description": "An unexpected error response.",
|
|
1002
|
+
"schema": {
|
|
1003
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
"parameters": [
|
|
1008
|
+
{
|
|
1009
|
+
"name": "body",
|
|
1010
|
+
"in": "body",
|
|
1011
|
+
"required": true,
|
|
1012
|
+
"schema": {
|
|
1013
|
+
"$ref": "#/definitions/v1SignRawPayloadRequest"
|
|
1014
|
+
}
|
|
1015
|
+
}
|
|
1016
|
+
],
|
|
1017
|
+
"tags": ["Private Keys"],
|
|
1018
|
+
"x-readme": {
|
|
1019
|
+
"code-samples": [
|
|
1020
|
+
{
|
|
1021
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/sign_raw_payload --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\",\n\t\t\"encoding\": \"PAYLOAD_ENCODING_TEXT_UTF8\",\n\t\t\"payload\": \"\",\n\t\t\"hashFunction\": \"HASH_FUNCTION_KECCAK256\"\n\t}\n}'",
|
|
1022
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
1023
|
+
"language": "curl",
|
|
1024
|
+
"name": "Turnkey CLI"
|
|
1025
|
+
}
|
|
1026
|
+
]
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
1029
|
+
},
|
|
1030
|
+
"/public/v1/submit/sign_transaction": {
|
|
1031
|
+
"post": {
|
|
1032
|
+
"summary": "Sign Transaction",
|
|
1033
|
+
"description": "Sign a transaction with a Private Key",
|
|
1034
|
+
"operationId": "PublicApiService_SignTransaction",
|
|
1035
|
+
"responses": {
|
|
1036
|
+
"200": {
|
|
1037
|
+
"description": "A successful response.",
|
|
1038
|
+
"schema": {
|
|
1039
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
"403": {
|
|
1043
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
1044
|
+
"schema": {}
|
|
1045
|
+
},
|
|
1046
|
+
"404": {
|
|
1047
|
+
"description": "Returned when the resource does not exist.",
|
|
1048
|
+
"schema": {
|
|
1049
|
+
"type": "string",
|
|
1050
|
+
"format": "string"
|
|
1051
|
+
}
|
|
1052
|
+
},
|
|
1053
|
+
"default": {
|
|
1054
|
+
"description": "An unexpected error response.",
|
|
1055
|
+
"schema": {
|
|
1056
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1057
|
+
}
|
|
1058
|
+
}
|
|
1059
|
+
},
|
|
1060
|
+
"parameters": [
|
|
1061
|
+
{
|
|
1062
|
+
"name": "body",
|
|
1063
|
+
"in": "body",
|
|
1064
|
+
"required": true,
|
|
1065
|
+
"schema": {
|
|
1066
|
+
"$ref": "#/definitions/v1SignTransactionRequest"
|
|
1067
|
+
}
|
|
1068
|
+
}
|
|
1069
|
+
],
|
|
1070
|
+
"tags": ["Private Keys"],
|
|
1071
|
+
"x-readme": {
|
|
1072
|
+
"code-samples": [
|
|
1073
|
+
{
|
|
1074
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/sign_transaction --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_SIGN_TRANSACTION\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\",\n\t\t\"unsignedTransaction\": \"\",\n\t\t\"type\": \"\"\n\t}\n}'",
|
|
1075
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
1076
|
+
"language": "curl",
|
|
1077
|
+
"name": "Turnkey CLI"
|
|
1078
|
+
}
|
|
1079
|
+
]
|
|
1080
|
+
}
|
|
1081
|
+
}
|
|
1082
|
+
},
|
|
1083
|
+
"/tkhq/public/v1/query/get_private_key": {
|
|
1084
|
+
"post": {
|
|
1085
|
+
"summary": "Get Private Key",
|
|
1086
|
+
"description": "Get details about a Private Key",
|
|
1087
|
+
"operationId": "PublicApiService_GetPrivateKey",
|
|
1088
|
+
"responses": {
|
|
1089
|
+
"200": {
|
|
1090
|
+
"description": "A successful response.",
|
|
1091
|
+
"schema": {
|
|
1092
|
+
"$ref": "#/definitions/v1GetPrivateKeyResponse"
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"403": {
|
|
1096
|
+
"description": "Returned when the user does not have permission to access the resource.",
|
|
1097
|
+
"schema": {}
|
|
1098
|
+
},
|
|
1099
|
+
"404": {
|
|
1100
|
+
"description": "Returned when the resource does not exist.",
|
|
1101
|
+
"schema": {
|
|
1102
|
+
"type": "string",
|
|
1103
|
+
"format": "string"
|
|
1104
|
+
}
|
|
1105
|
+
},
|
|
1106
|
+
"default": {
|
|
1107
|
+
"description": "An unexpected error response.",
|
|
1108
|
+
"schema": {
|
|
1109
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1110
|
+
}
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
"parameters": [
|
|
1114
|
+
{
|
|
1115
|
+
"name": "body",
|
|
1116
|
+
"in": "body",
|
|
1117
|
+
"required": true,
|
|
1118
|
+
"schema": {
|
|
1119
|
+
"$ref": "#/definitions/v1GetPrivateKeyRequest"
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
],
|
|
1123
|
+
"tags": ["Private Keys"],
|
|
1124
|
+
"x-readme": {
|
|
1125
|
+
"code-samples": [
|
|
1126
|
+
{
|
|
1127
|
+
"code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_private_key --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\"\n}'",
|
|
1128
|
+
"install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey",
|
|
1129
|
+
"language": "curl",
|
|
1130
|
+
"name": "Turnkey CLI"
|
|
1131
|
+
}
|
|
1132
|
+
]
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
},
|
|
1137
|
+
"definitions": {
|
|
1138
|
+
"datav1Tag": {
|
|
1139
|
+
"type": "object",
|
|
1140
|
+
"properties": {
|
|
1141
|
+
"tagId": {
|
|
1142
|
+
"type": "string",
|
|
1143
|
+
"description": "Unique identifier for a given Tag."
|
|
1144
|
+
},
|
|
1145
|
+
"tagName": {
|
|
1146
|
+
"type": "string",
|
|
1147
|
+
"description": "Human-readable name for a Tag."
|
|
1148
|
+
},
|
|
1149
|
+
"tagType": {
|
|
1150
|
+
"$ref": "#/definitions/v1TagType"
|
|
1151
|
+
},
|
|
1152
|
+
"createdAt": {
|
|
1153
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1154
|
+
},
|
|
1155
|
+
"updatedAt": {
|
|
1156
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1157
|
+
}
|
|
1158
|
+
},
|
|
1159
|
+
"required": ["tagId", "tagName", "tagType", "createdAt", "updatedAt"]
|
|
1160
|
+
},
|
|
1161
|
+
"externaldatav1AccessType": {
|
|
1162
|
+
"type": "string",
|
|
1163
|
+
"enum": ["ACCESS_TYPE_WEB", "ACCESS_TYPE_API", "ACCESS_TYPE_ALL"]
|
|
1164
|
+
},
|
|
1165
|
+
"externaldatav1Address": {
|
|
1166
|
+
"type": "object",
|
|
1167
|
+
"properties": {
|
|
1168
|
+
"format": {
|
|
1169
|
+
"$ref": "#/definitions/externaldatav1AddressFormat"
|
|
1170
|
+
},
|
|
1171
|
+
"address": {
|
|
1172
|
+
"type": "string"
|
|
1173
|
+
}
|
|
1174
|
+
}
|
|
1175
|
+
},
|
|
1176
|
+
"externaldatav1AddressFormat": {
|
|
1177
|
+
"type": "string",
|
|
1178
|
+
"enum": [
|
|
1179
|
+
"ADDRESS_FORMAT_UNCOMPRESSED",
|
|
1180
|
+
"ADDRESS_FORMAT_COMPRESSED",
|
|
1181
|
+
"ADDRESS_FORMAT_ETHEREUM",
|
|
1182
|
+
"ADDRESS_FORMAT_BITCOIN_P2PKH",
|
|
1183
|
+
"ADDRESS_FORMAT_BITCOIN_P2PKH_TESTNET"
|
|
1184
|
+
],
|
|
1185
|
+
"title": "- ADDRESS_FORMAT_UNCOMPRESSED: 04\u003cX_COORDINATE\u003e\u003cY_COORDINATE\u003e\n - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate\n - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.\n - ADDRESS_FORMAT_BITCOIN_P2PKH: Bitcoin formats. See https://en.bitcoin.it/wiki/List_of_address_prefixes"
|
|
1186
|
+
},
|
|
1187
|
+
"externaldatav1AuthenticatorTransport": {
|
|
1188
|
+
"type": "string",
|
|
1189
|
+
"enum": [
|
|
1190
|
+
"AUTHENTICATOR_TRANSPORT_BLE",
|
|
1191
|
+
"AUTHENTICATOR_TRANSPORT_INTERNAL",
|
|
1192
|
+
"AUTHENTICATOR_TRANSPORT_NFC",
|
|
1193
|
+
"AUTHENTICATOR_TRANSPORT_USB",
|
|
1194
|
+
"AUTHENTICATOR_TRANSPORT_HYBRID"
|
|
1195
|
+
]
|
|
1196
|
+
},
|
|
1197
|
+
"externaldatav1Curve": {
|
|
1198
|
+
"type": "string",
|
|
1199
|
+
"enum": ["CURVE_SECP256K1"],
|
|
1200
|
+
"description": "Cryptographic Curve used to generate a given Private Key."
|
|
1201
|
+
},
|
|
1202
|
+
"externaldatav1Effect": {
|
|
1203
|
+
"type": "string",
|
|
1204
|
+
"enum": ["EFFECT_ALLOW", "EFFECT_DENY"]
|
|
1205
|
+
},
|
|
1206
|
+
"externaldatav1Operator": {
|
|
1207
|
+
"type": "string",
|
|
1208
|
+
"enum": [
|
|
1209
|
+
"OPERATOR_EQUAL",
|
|
1210
|
+
"OPERATOR_MORE_THAN",
|
|
1211
|
+
"OPERATOR_MORE_THAN_OR_EQUAL",
|
|
1212
|
+
"OPERATOR_LESS_THAN",
|
|
1213
|
+
"OPERATOR_LESS_THAN_OR_EQUAL",
|
|
1214
|
+
"OPERATOR_CONTAINS",
|
|
1215
|
+
"OPERATOR_NOT_EQUAL",
|
|
1216
|
+
"OPERATOR_IN",
|
|
1217
|
+
"OPERATOR_NOT_IN",
|
|
1218
|
+
"OPERATOR_CONTAINS_ONE",
|
|
1219
|
+
"OPERATOR_CONTAINS_ALL"
|
|
1220
|
+
],
|
|
1221
|
+
"description": "Logical operators."
|
|
1222
|
+
},
|
|
1223
|
+
"externaldatav1Selector": {
|
|
1224
|
+
"type": "object",
|
|
1225
|
+
"properties": {
|
|
1226
|
+
"subject": {
|
|
1227
|
+
"type": "string",
|
|
1228
|
+
"description": "The resource being referenced within a policy (e.g., user.tags or activities.type)."
|
|
1229
|
+
},
|
|
1230
|
+
"operator": {
|
|
1231
|
+
"$ref": "#/definitions/externaldatav1Operator"
|
|
1232
|
+
},
|
|
1233
|
+
"targets": {
|
|
1234
|
+
"type": "array",
|
|
1235
|
+
"items": {
|
|
1236
|
+
"type": "string"
|
|
1237
|
+
},
|
|
1238
|
+
"description": "The specific parameter from the subject being referenced, like a specific user ID."
|
|
1239
|
+
}
|
|
1240
|
+
},
|
|
1241
|
+
"required": ["subject", "operator", "targets"]
|
|
1242
|
+
},
|
|
1243
|
+
"immutableactivityv1AccessType": {
|
|
1244
|
+
"type": "string",
|
|
1245
|
+
"enum": ["ACCESS_TYPE_WEB", "ACCESS_TYPE_API", "ACCESS_TYPE_ALL"]
|
|
1246
|
+
},
|
|
1247
|
+
"immutableactivityv1AddressFormat": {
|
|
1248
|
+
"type": "string",
|
|
1249
|
+
"enum": [
|
|
1250
|
+
"ADDRESS_FORMAT_UNCOMPRESSED",
|
|
1251
|
+
"ADDRESS_FORMAT_COMPRESSED",
|
|
1252
|
+
"ADDRESS_FORMAT_ETHEREUM",
|
|
1253
|
+
"ADDRESS_FORMAT_BITCOIN_P2PKH",
|
|
1254
|
+
"ADDRESS_FORMAT_BITCOIN_P2PKH_TESTNET"
|
|
1255
|
+
],
|
|
1256
|
+
"title": "- ADDRESS_FORMAT_UNCOMPRESSED: 04\u003cX_COORDINATE\u003e\u003cY_COORDINATE\u003e\n - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate\n - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.\n - ADDRESS_FORMAT_BITCOIN_P2PKH: Bitcoin formats. See https://en.bitcoin.it/wiki/List_of_address_prefixes"
|
|
1257
|
+
},
|
|
1258
|
+
"immutableactivityv1Curve": {
|
|
1259
|
+
"type": "string",
|
|
1260
|
+
"enum": ["CURVE_SECP256K1"],
|
|
1261
|
+
"description": "Cryptographic Curve used to generate a given Private Key."
|
|
1262
|
+
},
|
|
1263
|
+
"immutableactivityv1Effect": {
|
|
1264
|
+
"type": "string",
|
|
1265
|
+
"enum": ["EFFECT_ALLOW", "EFFECT_DENY"]
|
|
1266
|
+
},
|
|
1267
|
+
"immutableactivityv1Operator": {
|
|
1268
|
+
"type": "string",
|
|
1269
|
+
"enum": [
|
|
1270
|
+
"OPERATOR_EQUAL",
|
|
1271
|
+
"OPERATOR_MORE_THAN",
|
|
1272
|
+
"OPERATOR_MORE_THAN_OR_EQUAL",
|
|
1273
|
+
"OPERATOR_LESS_THAN",
|
|
1274
|
+
"OPERATOR_LESS_THAN_OR_EQUAL",
|
|
1275
|
+
"OPERATOR_CONTAINS",
|
|
1276
|
+
"OPERATOR_NOT_EQUAL",
|
|
1277
|
+
"OPERATOR_IN",
|
|
1278
|
+
"OPERATOR_NOT_IN",
|
|
1279
|
+
"OPERATOR_CONTAINS_ONE",
|
|
1280
|
+
"OPERATOR_CONTAINS_ALL"
|
|
1281
|
+
]
|
|
1282
|
+
},
|
|
1283
|
+
"immutableactivityv1Selector": {
|
|
1284
|
+
"type": "object",
|
|
1285
|
+
"properties": {
|
|
1286
|
+
"subject": {
|
|
1287
|
+
"type": "string"
|
|
1288
|
+
},
|
|
1289
|
+
"operator": {
|
|
1290
|
+
"$ref": "#/definitions/immutableactivityv1Operator"
|
|
1291
|
+
},
|
|
1292
|
+
"target": {
|
|
1293
|
+
"type": "string"
|
|
1294
|
+
}
|
|
1295
|
+
}
|
|
1296
|
+
},
|
|
1297
|
+
"immutableactivityv1TransactionType": {
|
|
1298
|
+
"type": "string",
|
|
1299
|
+
"enum": ["TRANSACTION_TYPE_ETHEREUM"],
|
|
1300
|
+
"title": "- TRANSACTION_TYPE_ETHEREUM: Unsigned Ethereum transaction, RLP-encoded and hex-encoded"
|
|
1301
|
+
},
|
|
1302
|
+
"immutablewebauthnv1AuthenticatorTransport": {
|
|
1303
|
+
"type": "string",
|
|
1304
|
+
"enum": [
|
|
1305
|
+
"AUTHENTICATOR_TRANSPORT_BLE",
|
|
1306
|
+
"AUTHENTICATOR_TRANSPORT_INTERNAL",
|
|
1307
|
+
"AUTHENTICATOR_TRANSPORT_NFC",
|
|
1308
|
+
"AUTHENTICATOR_TRANSPORT_USB",
|
|
1309
|
+
"AUTHENTICATOR_TRANSPORT_HYBRID"
|
|
1310
|
+
]
|
|
1311
|
+
},
|
|
1312
|
+
"protobufAny": {
|
|
1313
|
+
"type": "object",
|
|
1314
|
+
"properties": {
|
|
1315
|
+
"@type": {
|
|
1316
|
+
"type": "string"
|
|
1317
|
+
}
|
|
1318
|
+
},
|
|
1319
|
+
"additionalProperties": {}
|
|
1320
|
+
},
|
|
1321
|
+
"rpcStatus": {
|
|
1322
|
+
"type": "object",
|
|
1323
|
+
"properties": {
|
|
1324
|
+
"code": {
|
|
1325
|
+
"type": "integer",
|
|
1326
|
+
"format": "int32"
|
|
1327
|
+
},
|
|
1328
|
+
"message": {
|
|
1329
|
+
"type": "string"
|
|
1330
|
+
},
|
|
1331
|
+
"details": {
|
|
1332
|
+
"type": "array",
|
|
1333
|
+
"items": {
|
|
1334
|
+
"$ref": "#/definitions/protobufAny"
|
|
1335
|
+
}
|
|
1336
|
+
}
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
"v1AcceptInvitationIntent": {
|
|
1340
|
+
"type": "object",
|
|
1341
|
+
"properties": {
|
|
1342
|
+
"invitationId": {
|
|
1343
|
+
"type": "string",
|
|
1344
|
+
"description": "Unique identifier for a given Invitation object.",
|
|
1345
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
1346
|
+
},
|
|
1347
|
+
"userId": {
|
|
1348
|
+
"type": "string",
|
|
1349
|
+
"description": "Unique identifier for a given User.",
|
|
1350
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
1351
|
+
},
|
|
1352
|
+
"authenticator": {
|
|
1353
|
+
"$ref": "#/definitions/v1AuthenticatorParams"
|
|
1354
|
+
}
|
|
1355
|
+
},
|
|
1356
|
+
"required": ["invitationId", "userId", "authenticator"]
|
|
1357
|
+
},
|
|
1358
|
+
"v1AcceptInvitationResult": {
|
|
1359
|
+
"type": "object",
|
|
1360
|
+
"properties": {
|
|
1361
|
+
"invitationId": {
|
|
1362
|
+
"type": "string",
|
|
1363
|
+
"description": "Unique identifier for a given Invitation."
|
|
1364
|
+
},
|
|
1365
|
+
"userId": {
|
|
1366
|
+
"type": "string",
|
|
1367
|
+
"description": "Unique identifier for a given User."
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"required": ["invitationId", "userId"]
|
|
1371
|
+
},
|
|
1372
|
+
"v1ActivateBillingTierIntent": {
|
|
1373
|
+
"type": "object",
|
|
1374
|
+
"properties": {
|
|
1375
|
+
"productId": {
|
|
1376
|
+
"type": "string",
|
|
1377
|
+
"description": "The product that the customer wants to subscribe to.",
|
|
1378
|
+
"title": "@inject_tag: validate:\"required\""
|
|
1379
|
+
}
|
|
1380
|
+
},
|
|
1381
|
+
"required": ["productId"]
|
|
1382
|
+
},
|
|
1383
|
+
"v1ActivateBillingTierResult": {
|
|
1384
|
+
"type": "object",
|
|
1385
|
+
"properties": {
|
|
1386
|
+
"productId": {
|
|
1387
|
+
"type": "string",
|
|
1388
|
+
"description": "The id of the product being subscribed to."
|
|
1389
|
+
}
|
|
1390
|
+
},
|
|
1391
|
+
"required": ["productId"]
|
|
1392
|
+
},
|
|
1393
|
+
"v1Activity": {
|
|
1394
|
+
"type": "object",
|
|
1395
|
+
"properties": {
|
|
1396
|
+
"id": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"description": "Unique identifier for a given Activity object."
|
|
1399
|
+
},
|
|
1400
|
+
"organizationId": {
|
|
1401
|
+
"type": "string",
|
|
1402
|
+
"description": "Unique identifier for a given Organization."
|
|
1403
|
+
},
|
|
1404
|
+
"status": {
|
|
1405
|
+
"$ref": "#/definitions/v1ActivityStatus"
|
|
1406
|
+
},
|
|
1407
|
+
"type": {
|
|
1408
|
+
"$ref": "#/definitions/v1ActivityType"
|
|
1409
|
+
},
|
|
1410
|
+
"intent": {
|
|
1411
|
+
"$ref": "#/definitions/v1Intent"
|
|
1412
|
+
},
|
|
1413
|
+
"result": {
|
|
1414
|
+
"$ref": "#/definitions/v1Result"
|
|
1415
|
+
},
|
|
1416
|
+
"votes": {
|
|
1417
|
+
"type": "array",
|
|
1418
|
+
"items": {
|
|
1419
|
+
"$ref": "#/definitions/v1Vote"
|
|
1420
|
+
},
|
|
1421
|
+
"description": "A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata."
|
|
1422
|
+
},
|
|
1423
|
+
"fingerprint": {
|
|
1424
|
+
"type": "string",
|
|
1425
|
+
"description": "An artifact verifying a User's action."
|
|
1426
|
+
},
|
|
1427
|
+
"canApprove": {
|
|
1428
|
+
"type": "boolean"
|
|
1429
|
+
},
|
|
1430
|
+
"canReject": {
|
|
1431
|
+
"type": "boolean"
|
|
1432
|
+
},
|
|
1433
|
+
"createdAt": {
|
|
1434
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1435
|
+
},
|
|
1436
|
+
"updatedAt": {
|
|
1437
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1438
|
+
}
|
|
1439
|
+
},
|
|
1440
|
+
"description": "An action that can that can be taken within the Turnkey infrastructure.",
|
|
1441
|
+
"required": [
|
|
1442
|
+
"id",
|
|
1443
|
+
"organizationId",
|
|
1444
|
+
"status",
|
|
1445
|
+
"type",
|
|
1446
|
+
"intent",
|
|
1447
|
+
"result",
|
|
1448
|
+
"votes",
|
|
1449
|
+
"fingerprint",
|
|
1450
|
+
"canApprove",
|
|
1451
|
+
"canReject",
|
|
1452
|
+
"createdAt",
|
|
1453
|
+
"updatedAt"
|
|
1454
|
+
]
|
|
1455
|
+
},
|
|
1456
|
+
"v1ActivityResponse": {
|
|
1457
|
+
"type": "object",
|
|
1458
|
+
"properties": {
|
|
1459
|
+
"activity": {
|
|
1460
|
+
"$ref": "#/definitions/v1Activity"
|
|
1461
|
+
}
|
|
1462
|
+
},
|
|
1463
|
+
"required": ["activity"]
|
|
1464
|
+
},
|
|
1465
|
+
"v1ActivityStatus": {
|
|
1466
|
+
"type": "string",
|
|
1467
|
+
"enum": [
|
|
1468
|
+
"ACTIVITY_STATUS_CREATED",
|
|
1469
|
+
"ACTIVITY_STATUS_PENDING",
|
|
1470
|
+
"ACTIVITY_STATUS_COMPLETED",
|
|
1471
|
+
"ACTIVITY_STATUS_FAILED",
|
|
1472
|
+
"ACTIVITY_STATUS_CONSENSUS_NEEDED",
|
|
1473
|
+
"ACTIVITY_STATUS_REJECTED"
|
|
1474
|
+
],
|
|
1475
|
+
"description": "The current processing status of an Activity."
|
|
1476
|
+
},
|
|
1477
|
+
"v1ActivityType": {
|
|
1478
|
+
"type": "string",
|
|
1479
|
+
"enum": [
|
|
1480
|
+
"ACTIVITY_TYPE_CREATE_API_KEYS",
|
|
1481
|
+
"ACTIVITY_TYPE_CREATE_USERS",
|
|
1482
|
+
"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS",
|
|
1483
|
+
"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD",
|
|
1484
|
+
"ACTIVITY_TYPE_CREATE_INVITATIONS",
|
|
1485
|
+
"ACTIVITY_TYPE_ACCEPT_INVITATION",
|
|
1486
|
+
"ACTIVITY_TYPE_CREATE_POLICY",
|
|
1487
|
+
"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY",
|
|
1488
|
+
"ACTIVITY_TYPE_DELETE_USERS",
|
|
1489
|
+
"ACTIVITY_TYPE_DELETE_API_KEYS",
|
|
1490
|
+
"ACTIVITY_TYPE_DELETE_INVITATION",
|
|
1491
|
+
"ACTIVITY_TYPE_DELETE_ORGANIZATION",
|
|
1492
|
+
"ACTIVITY_TYPE_DELETE_POLICY",
|
|
1493
|
+
"ACTIVITY_TYPE_CREATE_USER_TAG",
|
|
1494
|
+
"ACTIVITY_TYPE_DELETE_USER_TAGS",
|
|
1495
|
+
"ACTIVITY_TYPE_CREATE_ORGANIZATION",
|
|
1496
|
+
"ACTIVITY_TYPE_SIGN_TRANSACTION",
|
|
1497
|
+
"ACTIVITY_TYPE_APPROVE_ACTIVITY",
|
|
1498
|
+
"ACTIVITY_TYPE_REJECT_ACTIVITY",
|
|
1499
|
+
"ACTIVITY_TYPE_DELETE_AUTHENTICATORS",
|
|
1500
|
+
"ACTIVITY_TYPE_CREATE_AUTHENTICATORS",
|
|
1501
|
+
"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG",
|
|
1502
|
+
"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS",
|
|
1503
|
+
"ACTIVITY_TYPE_SET_PAYMENT_METHOD",
|
|
1504
|
+
"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER",
|
|
1505
|
+
"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD",
|
|
1506
|
+
"ACTIVITY_TYPE_CREATE_POLICY_V2",
|
|
1507
|
+
"ACTIVITY_TYPE_CREATE_POLICY_V3",
|
|
1508
|
+
"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"
|
|
1509
|
+
],
|
|
1510
|
+
"description": "Type of Activity, such as Add User, or Sign Transaction."
|
|
1511
|
+
},
|
|
1512
|
+
"v1ApiKey": {
|
|
1513
|
+
"type": "object",
|
|
1514
|
+
"properties": {
|
|
1515
|
+
"credential": {
|
|
1516
|
+
"$ref": "#/definitions/v1Credential"
|
|
1517
|
+
},
|
|
1518
|
+
"apiKeyId": {
|
|
1519
|
+
"type": "string",
|
|
1520
|
+
"description": "Unique identifier for a given API Key."
|
|
1521
|
+
},
|
|
1522
|
+
"apiKeyName": {
|
|
1523
|
+
"type": "string",
|
|
1524
|
+
"description": "Human-readable name for an API Key."
|
|
1525
|
+
},
|
|
1526
|
+
"createdAt": {
|
|
1527
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1528
|
+
},
|
|
1529
|
+
"updatedAt": {
|
|
1530
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1531
|
+
}
|
|
1532
|
+
},
|
|
1533
|
+
"required": [
|
|
1534
|
+
"credential",
|
|
1535
|
+
"apiKeyId",
|
|
1536
|
+
"apiKeyName",
|
|
1537
|
+
"createdAt",
|
|
1538
|
+
"updatedAt"
|
|
1539
|
+
]
|
|
1540
|
+
},
|
|
1541
|
+
"v1ApiKeyParams": {
|
|
1542
|
+
"type": "object",
|
|
1543
|
+
"properties": {
|
|
1544
|
+
"apiKeyName": {
|
|
1545
|
+
"type": "string",
|
|
1546
|
+
"description": "Human-readable name for an API Key.",
|
|
1547
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
1548
|
+
},
|
|
1549
|
+
"publicKey": {
|
|
1550
|
+
"type": "string",
|
|
1551
|
+
"description": "The public component of a cryptographic key pair used to sign messages and transactions.",
|
|
1552
|
+
"title": "@inject_tag: validate:\"hexadecimal,len=66\""
|
|
1553
|
+
}
|
|
1554
|
+
},
|
|
1555
|
+
"required": ["apiKeyName", "publicKey"]
|
|
1556
|
+
},
|
|
1557
|
+
"v1ApiOnlyUserParams": {
|
|
1558
|
+
"type": "object",
|
|
1559
|
+
"properties": {
|
|
1560
|
+
"userName": {
|
|
1561
|
+
"type": "string",
|
|
1562
|
+
"description": "The name of the new API-only User.",
|
|
1563
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
1564
|
+
},
|
|
1565
|
+
"userEmail": {
|
|
1566
|
+
"type": "string",
|
|
1567
|
+
"description": "The email address for this API-only User (optional).",
|
|
1568
|
+
"title": "@inject_tag: validate:\"omitempty,email,tk_email\""
|
|
1569
|
+
},
|
|
1570
|
+
"userTags": {
|
|
1571
|
+
"type": "array",
|
|
1572
|
+
"items": {
|
|
1573
|
+
"type": "string"
|
|
1574
|
+
},
|
|
1575
|
+
"description": "A list of tags assigned to the new API-only User.",
|
|
1576
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
1577
|
+
},
|
|
1578
|
+
"apiKeys": {
|
|
1579
|
+
"type": "array",
|
|
1580
|
+
"items": {
|
|
1581
|
+
"$ref": "#/definitions/v1ApiKeyParams"
|
|
1582
|
+
},
|
|
1583
|
+
"description": "A list of API Key parameters.",
|
|
1584
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
1585
|
+
}
|
|
1586
|
+
},
|
|
1587
|
+
"required": ["userName", "userTags", "apiKeys"]
|
|
1588
|
+
},
|
|
1589
|
+
"v1ApproveActivityIntent": {
|
|
1590
|
+
"type": "object",
|
|
1591
|
+
"properties": {
|
|
1592
|
+
"fingerprint": {
|
|
1593
|
+
"type": "string",
|
|
1594
|
+
"description": "An artifact verifying a User's action.",
|
|
1595
|
+
"title": "@inject_tag: validate:\"required\""
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
"required": ["fingerprint"]
|
|
1599
|
+
},
|
|
1600
|
+
"v1Authenticator": {
|
|
1601
|
+
"type": "object",
|
|
1602
|
+
"properties": {
|
|
1603
|
+
"transports": {
|
|
1604
|
+
"type": "array",
|
|
1605
|
+
"items": {
|
|
1606
|
+
"$ref": "#/definitions/externaldatav1AuthenticatorTransport"
|
|
1607
|
+
},
|
|
1608
|
+
"description": "Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE)."
|
|
1609
|
+
},
|
|
1610
|
+
"attestationType": {
|
|
1611
|
+
"type": "string"
|
|
1612
|
+
},
|
|
1613
|
+
"aaguid": {
|
|
1614
|
+
"type": "string",
|
|
1615
|
+
"description": "Identifier indicating the type of the Security Key."
|
|
1616
|
+
},
|
|
1617
|
+
"userId": {
|
|
1618
|
+
"type": "string",
|
|
1619
|
+
"description": "Unique identifier for a given User."
|
|
1620
|
+
},
|
|
1621
|
+
"credentialId": {
|
|
1622
|
+
"type": "string",
|
|
1623
|
+
"description": "Unique identifier for a WebAuthn credential."
|
|
1624
|
+
},
|
|
1625
|
+
"model": {
|
|
1626
|
+
"type": "string",
|
|
1627
|
+
"description": "The type of Authenticator device."
|
|
1628
|
+
},
|
|
1629
|
+
"credential": {
|
|
1630
|
+
"$ref": "#/definitions/v1Credential"
|
|
1631
|
+
},
|
|
1632
|
+
"authenticatorId": {
|
|
1633
|
+
"type": "string",
|
|
1634
|
+
"description": "Unique identifier for a given Authenticator."
|
|
1635
|
+
},
|
|
1636
|
+
"authenticatorName": {
|
|
1637
|
+
"type": "string",
|
|
1638
|
+
"description": "Human-readable name for an Authenticator."
|
|
1639
|
+
},
|
|
1640
|
+
"createdAt": {
|
|
1641
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1642
|
+
},
|
|
1643
|
+
"updatedAt": {
|
|
1644
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
1645
|
+
}
|
|
1646
|
+
},
|
|
1647
|
+
"required": [
|
|
1648
|
+
"transports",
|
|
1649
|
+
"attestationType",
|
|
1650
|
+
"aaguid",
|
|
1651
|
+
"userId",
|
|
1652
|
+
"credentialId",
|
|
1653
|
+
"model",
|
|
1654
|
+
"credential",
|
|
1655
|
+
"authenticatorId",
|
|
1656
|
+
"authenticatorName",
|
|
1657
|
+
"createdAt",
|
|
1658
|
+
"updatedAt"
|
|
1659
|
+
]
|
|
1660
|
+
},
|
|
1661
|
+
"v1AuthenticatorAttestationResponse": {
|
|
1662
|
+
"type": "object",
|
|
1663
|
+
"properties": {
|
|
1664
|
+
"clientDataJson": {
|
|
1665
|
+
"type": "string",
|
|
1666
|
+
"title": "ENCODING: base64url"
|
|
1667
|
+
},
|
|
1668
|
+
"attestationObject": {
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"title": "ENCODING: base64url"
|
|
1671
|
+
},
|
|
1672
|
+
"transports": {
|
|
1673
|
+
"type": "array",
|
|
1674
|
+
"items": {
|
|
1675
|
+
"$ref": "#/definitions/immutablewebauthnv1AuthenticatorTransport"
|
|
1676
|
+
}
|
|
1677
|
+
},
|
|
1678
|
+
"authenticatorAttachment": {
|
|
1679
|
+
"type": "string",
|
|
1680
|
+
"enum": ["cross-platform", "platform"],
|
|
1681
|
+
"x-nullable": true
|
|
1682
|
+
}
|
|
1683
|
+
},
|
|
1684
|
+
"required": ["clientDataJson", "attestationObject"]
|
|
1685
|
+
},
|
|
1686
|
+
"v1AuthenticatorParams": {
|
|
1687
|
+
"type": "object",
|
|
1688
|
+
"properties": {
|
|
1689
|
+
"authenticatorName": {
|
|
1690
|
+
"type": "string",
|
|
1691
|
+
"description": "Human-readable name for an Authenticator.",
|
|
1692
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
1693
|
+
},
|
|
1694
|
+
"userId": {
|
|
1695
|
+
"type": "string",
|
|
1696
|
+
"description": "Unique identifier for a given User.",
|
|
1697
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
1698
|
+
},
|
|
1699
|
+
"attestation": {
|
|
1700
|
+
"$ref": "#/definitions/v1PublicKeyCredentialWithAttestation"
|
|
1701
|
+
},
|
|
1702
|
+
"challenge": {
|
|
1703
|
+
"type": "string",
|
|
1704
|
+
"description": "Challenge presented for authentication purposes.",
|
|
1705
|
+
"title": "@inject_tag: validate:\"required,max=256\""
|
|
1706
|
+
}
|
|
1707
|
+
},
|
|
1708
|
+
"required": ["authenticatorName", "userId", "attestation", "challenge"]
|
|
1709
|
+
},
|
|
1710
|
+
"v1CreateApiKeysIntent": {
|
|
1711
|
+
"type": "object",
|
|
1712
|
+
"properties": {
|
|
1713
|
+
"apiKeys": {
|
|
1714
|
+
"type": "array",
|
|
1715
|
+
"items": {
|
|
1716
|
+
"$ref": "#/definitions/v1ApiKeyParams"
|
|
1717
|
+
},
|
|
1718
|
+
"description": "A list of API Keys.",
|
|
1719
|
+
"title": "@inject_tag: validate:\"dive,required\""
|
|
1720
|
+
},
|
|
1721
|
+
"userId": {
|
|
1722
|
+
"type": "string",
|
|
1723
|
+
"description": "Unique identifier for a given User.",
|
|
1724
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
1725
|
+
}
|
|
1726
|
+
},
|
|
1727
|
+
"required": ["apiKeys", "userId"]
|
|
1728
|
+
},
|
|
1729
|
+
"v1CreateApiKeysRequest": {
|
|
1730
|
+
"type": "object",
|
|
1731
|
+
"properties": {
|
|
1732
|
+
"type": {
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"enum": ["ACTIVITY_TYPE_CREATE_API_KEYS"]
|
|
1735
|
+
},
|
|
1736
|
+
"timestampMs": {
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
1739
|
+
},
|
|
1740
|
+
"organizationId": {
|
|
1741
|
+
"type": "string",
|
|
1742
|
+
"description": "Unique identifier for a given Organization."
|
|
1743
|
+
},
|
|
1744
|
+
"parameters": {
|
|
1745
|
+
"$ref": "#/definitions/v1CreateApiKeysIntent"
|
|
1746
|
+
}
|
|
1747
|
+
},
|
|
1748
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
1749
|
+
},
|
|
1750
|
+
"v1CreateApiKeysResult": {
|
|
1751
|
+
"type": "object",
|
|
1752
|
+
"properties": {
|
|
1753
|
+
"apiKeyIds": {
|
|
1754
|
+
"type": "array",
|
|
1755
|
+
"items": {
|
|
1756
|
+
"type": "string"
|
|
1757
|
+
},
|
|
1758
|
+
"description": "A list of API Key IDs."
|
|
1759
|
+
}
|
|
1760
|
+
},
|
|
1761
|
+
"required": ["apiKeyIds"]
|
|
1762
|
+
},
|
|
1763
|
+
"v1CreateApiOnlyUsersIntent": {
|
|
1764
|
+
"type": "object",
|
|
1765
|
+
"properties": {
|
|
1766
|
+
"apiOnlyUsers": {
|
|
1767
|
+
"type": "array",
|
|
1768
|
+
"items": {
|
|
1769
|
+
"$ref": "#/definitions/v1ApiOnlyUserParams"
|
|
1770
|
+
},
|
|
1771
|
+
"description": "A list of API-only Users to create.",
|
|
1772
|
+
"title": "@inject_tag: validate:\"required,dive,required\""
|
|
1773
|
+
}
|
|
1774
|
+
},
|
|
1775
|
+
"required": ["apiOnlyUsers"]
|
|
1776
|
+
},
|
|
1777
|
+
"v1CreateApiOnlyUsersRequest": {
|
|
1778
|
+
"type": "object",
|
|
1779
|
+
"properties": {
|
|
1780
|
+
"type": {
|
|
1781
|
+
"type": "string",
|
|
1782
|
+
"enum": ["ACTIVITY_TYPE_CREATE_API_ONLY_USERS"]
|
|
1783
|
+
},
|
|
1784
|
+
"timestampMs": {
|
|
1785
|
+
"type": "string",
|
|
1786
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
1787
|
+
},
|
|
1788
|
+
"organizationId": {
|
|
1789
|
+
"type": "string",
|
|
1790
|
+
"description": "Unique identifier for a given Organization."
|
|
1791
|
+
},
|
|
1792
|
+
"parameters": {
|
|
1793
|
+
"$ref": "#/definitions/v1CreateApiOnlyUsersIntent"
|
|
1794
|
+
}
|
|
1795
|
+
},
|
|
1796
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
1797
|
+
},
|
|
1798
|
+
"v1CreateApiOnlyUsersResult": {
|
|
1799
|
+
"type": "object",
|
|
1800
|
+
"properties": {
|
|
1801
|
+
"userIds": {
|
|
1802
|
+
"type": "array",
|
|
1803
|
+
"items": {
|
|
1804
|
+
"type": "string"
|
|
1805
|
+
},
|
|
1806
|
+
"description": "A list of API-only User IDs."
|
|
1807
|
+
}
|
|
1808
|
+
},
|
|
1809
|
+
"required": ["userIds"]
|
|
1810
|
+
},
|
|
1811
|
+
"v1CreateAuthenticatorsIntent": {
|
|
1812
|
+
"type": "object",
|
|
1813
|
+
"properties": {
|
|
1814
|
+
"authenticators": {
|
|
1815
|
+
"type": "array",
|
|
1816
|
+
"items": {
|
|
1817
|
+
"$ref": "#/definitions/v1AuthenticatorParams"
|
|
1818
|
+
},
|
|
1819
|
+
"description": "A list of Authenticators.",
|
|
1820
|
+
"title": "@inject_tag: validate:\"dive,required\""
|
|
1821
|
+
},
|
|
1822
|
+
"userId": {
|
|
1823
|
+
"type": "string",
|
|
1824
|
+
"description": "Unique identifier for a given User.",
|
|
1825
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
1826
|
+
}
|
|
1827
|
+
},
|
|
1828
|
+
"required": ["authenticators", "userId"]
|
|
1829
|
+
},
|
|
1830
|
+
"v1CreateAuthenticatorsResult": {
|
|
1831
|
+
"type": "object",
|
|
1832
|
+
"properties": {
|
|
1833
|
+
"authenticatorIds": {
|
|
1834
|
+
"type": "array",
|
|
1835
|
+
"items": {
|
|
1836
|
+
"type": "string"
|
|
1837
|
+
},
|
|
1838
|
+
"description": "A list of Authenticator IDs."
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
"required": ["authenticatorIds"]
|
|
1842
|
+
},
|
|
1843
|
+
"v1CreateInvitationsIntent": {
|
|
1844
|
+
"type": "object",
|
|
1845
|
+
"properties": {
|
|
1846
|
+
"invitations": {
|
|
1847
|
+
"type": "array",
|
|
1848
|
+
"items": {
|
|
1849
|
+
"$ref": "#/definitions/v1InvitationParams"
|
|
1850
|
+
},
|
|
1851
|
+
"description": "A list of Invitations.",
|
|
1852
|
+
"title": "@inject_tag: validate:\"required,dive,required\""
|
|
1853
|
+
}
|
|
1854
|
+
},
|
|
1855
|
+
"required": ["invitations"]
|
|
1856
|
+
},
|
|
1857
|
+
"v1CreateInvitationsRequest": {
|
|
1858
|
+
"type": "object",
|
|
1859
|
+
"properties": {
|
|
1860
|
+
"type": {
|
|
1861
|
+
"type": "string",
|
|
1862
|
+
"enum": ["ACTIVITY_TYPE_CREATE_INVITATIONS"]
|
|
1863
|
+
},
|
|
1864
|
+
"timestampMs": {
|
|
1865
|
+
"type": "string",
|
|
1866
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
1867
|
+
},
|
|
1868
|
+
"organizationId": {
|
|
1869
|
+
"type": "string",
|
|
1870
|
+
"description": "Unique identifier for a given Organization."
|
|
1871
|
+
},
|
|
1872
|
+
"parameters": {
|
|
1873
|
+
"$ref": "#/definitions/v1CreateInvitationsIntent"
|
|
1874
|
+
}
|
|
1875
|
+
},
|
|
1876
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
1877
|
+
},
|
|
1878
|
+
"v1CreateInvitationsResult": {
|
|
1879
|
+
"type": "object",
|
|
1880
|
+
"properties": {
|
|
1881
|
+
"invitationIds": {
|
|
1882
|
+
"type": "array",
|
|
1883
|
+
"items": {
|
|
1884
|
+
"type": "string"
|
|
1885
|
+
},
|
|
1886
|
+
"description": "A list of Invitation IDs"
|
|
1887
|
+
}
|
|
1888
|
+
},
|
|
1889
|
+
"required": ["invitationIds"]
|
|
1890
|
+
},
|
|
1891
|
+
"v1CreateOrganizationIntent": {
|
|
1892
|
+
"type": "object",
|
|
1893
|
+
"properties": {
|
|
1894
|
+
"organizationName": {
|
|
1895
|
+
"type": "string",
|
|
1896
|
+
"description": "Human-readable name for an Organization.",
|
|
1897
|
+
"title": "@inject_tag: validate:\"required,tk_label_length\""
|
|
1898
|
+
},
|
|
1899
|
+
"rootEmail": {
|
|
1900
|
+
"type": "string",
|
|
1901
|
+
"description": "The root user's email address.",
|
|
1902
|
+
"title": "@inject_tag: validate:\"required,email,tk_email\""
|
|
1903
|
+
},
|
|
1904
|
+
"rootAuthenticator": {
|
|
1905
|
+
"$ref": "#/definitions/v1AuthenticatorParams"
|
|
1906
|
+
},
|
|
1907
|
+
"rootUserId": {
|
|
1908
|
+
"type": "string",
|
|
1909
|
+
"description": "Unique identifier for the root user object.",
|
|
1910
|
+
"title": "@inject_tag: validate:\"uuid\""
|
|
1911
|
+
}
|
|
1912
|
+
},
|
|
1913
|
+
"required": ["organizationName", "rootEmail", "rootAuthenticator"]
|
|
1914
|
+
},
|
|
1915
|
+
"v1CreateOrganizationResult": {
|
|
1916
|
+
"type": "object",
|
|
1917
|
+
"properties": {
|
|
1918
|
+
"organizationId": {
|
|
1919
|
+
"type": "string",
|
|
1920
|
+
"description": "Unique identifier for a given Organization."
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
1923
|
+
"required": ["organizationId"]
|
|
1924
|
+
},
|
|
1925
|
+
"v1CreatePolicyIntent": {
|
|
1926
|
+
"type": "object",
|
|
1927
|
+
"properties": {
|
|
1928
|
+
"policyName": {
|
|
1929
|
+
"type": "string",
|
|
1930
|
+
"description": "Human-readable name for a Policy.",
|
|
1931
|
+
"title": "@inject_tag: validate:\"required,tk_label_length\""
|
|
1932
|
+
},
|
|
1933
|
+
"selectors": {
|
|
1934
|
+
"type": "array",
|
|
1935
|
+
"items": {
|
|
1936
|
+
"$ref": "#/definitions/immutableactivityv1Selector"
|
|
1937
|
+
},
|
|
1938
|
+
"description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.",
|
|
1939
|
+
"title": "@inject_tag: validate:\"required,dive,required\""
|
|
1940
|
+
},
|
|
1941
|
+
"effect": {
|
|
1942
|
+
"$ref": "#/definitions/immutableactivityv1Effect"
|
|
1943
|
+
},
|
|
1944
|
+
"notes": {
|
|
1945
|
+
"type": "string"
|
|
1946
|
+
}
|
|
1947
|
+
},
|
|
1948
|
+
"required": ["policyName", "selectors", "effect"]
|
|
1949
|
+
},
|
|
1950
|
+
"v1CreatePolicyIntentV2": {
|
|
1951
|
+
"type": "object",
|
|
1952
|
+
"properties": {
|
|
1953
|
+
"policyName": {
|
|
1954
|
+
"type": "string",
|
|
1955
|
+
"description": "Human-readable name for a Policy.",
|
|
1956
|
+
"title": "@inject_tag: validate:\"required,tk_label_length\""
|
|
1957
|
+
},
|
|
1958
|
+
"selectors": {
|
|
1959
|
+
"type": "array",
|
|
1960
|
+
"items": {
|
|
1961
|
+
"$ref": "#/definitions/v1SelectorV2"
|
|
1962
|
+
},
|
|
1963
|
+
"description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.",
|
|
1964
|
+
"title": "@inject_tag: validate:\"required,dive,required\""
|
|
1965
|
+
},
|
|
1966
|
+
"effect": {
|
|
1967
|
+
"$ref": "#/definitions/immutableactivityv1Effect"
|
|
1968
|
+
},
|
|
1969
|
+
"notes": {
|
|
1970
|
+
"type": "string"
|
|
1971
|
+
}
|
|
1972
|
+
},
|
|
1973
|
+
"required": ["policyName", "selectors", "effect"]
|
|
1974
|
+
},
|
|
1975
|
+
"v1CreatePolicyIntentV3": {
|
|
1976
|
+
"type": "object",
|
|
1977
|
+
"properties": {
|
|
1978
|
+
"policyName": {
|
|
1979
|
+
"type": "string",
|
|
1980
|
+
"description": "Human-readable name for a Policy.",
|
|
1981
|
+
"title": "@inject_tag: validate:\"required,tk_label,tk_label_length\""
|
|
1982
|
+
},
|
|
1983
|
+
"effect": {
|
|
1984
|
+
"$ref": "#/definitions/immutableactivityv1Effect"
|
|
1985
|
+
},
|
|
1986
|
+
"condition": {
|
|
1987
|
+
"type": "string",
|
|
1988
|
+
"description": "The condition expression that triggers the Effect"
|
|
1989
|
+
},
|
|
1990
|
+
"consensus": {
|
|
1991
|
+
"type": "string",
|
|
1992
|
+
"description": "The consensus expression that triggers the Effect"
|
|
1993
|
+
},
|
|
1994
|
+
"notes": {
|
|
1995
|
+
"type": "string"
|
|
1996
|
+
}
|
|
1997
|
+
},
|
|
1998
|
+
"required": ["policyName", "effect"]
|
|
1999
|
+
},
|
|
2000
|
+
"v1CreatePolicyRequest": {
|
|
2001
|
+
"type": "object",
|
|
2002
|
+
"properties": {
|
|
2003
|
+
"type": {
|
|
2004
|
+
"type": "string",
|
|
2005
|
+
"enum": ["ACTIVITY_TYPE_CREATE_POLICY_V3"]
|
|
2006
|
+
},
|
|
2007
|
+
"timestampMs": {
|
|
2008
|
+
"type": "string",
|
|
2009
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2010
|
+
},
|
|
2011
|
+
"organizationId": {
|
|
2012
|
+
"type": "string",
|
|
2013
|
+
"description": "Unique identifier for a given Organization."
|
|
2014
|
+
},
|
|
2015
|
+
"parameters": {
|
|
2016
|
+
"$ref": "#/definitions/v1CreatePolicyIntentV3"
|
|
2017
|
+
}
|
|
2018
|
+
},
|
|
2019
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2020
|
+
},
|
|
2021
|
+
"v1CreatePolicyResult": {
|
|
2022
|
+
"type": "object",
|
|
2023
|
+
"properties": {
|
|
2024
|
+
"policyId": {
|
|
2025
|
+
"type": "string",
|
|
2026
|
+
"description": "Unique identifier for a given Policy."
|
|
2027
|
+
}
|
|
2028
|
+
},
|
|
2029
|
+
"required": ["policyId"]
|
|
2030
|
+
},
|
|
2031
|
+
"v1CreatePrivateKeyTagIntent": {
|
|
2032
|
+
"type": "object",
|
|
2033
|
+
"properties": {
|
|
2034
|
+
"privateKeyTagName": {
|
|
2035
|
+
"type": "string",
|
|
2036
|
+
"description": "Human-readable name for a Private Key Tag.",
|
|
2037
|
+
"title": "@inject_tag: validate:\"required,tk_label,tk_label_length\""
|
|
2038
|
+
},
|
|
2039
|
+
"privateKeyIds": {
|
|
2040
|
+
"type": "array",
|
|
2041
|
+
"items": {
|
|
2042
|
+
"type": "string"
|
|
2043
|
+
},
|
|
2044
|
+
"description": "A list of Private Key IDs.",
|
|
2045
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
2046
|
+
}
|
|
2047
|
+
},
|
|
2048
|
+
"required": ["privateKeyTagName", "privateKeyIds"]
|
|
2049
|
+
},
|
|
2050
|
+
"v1CreatePrivateKeyTagResult": {
|
|
2051
|
+
"type": "object",
|
|
2052
|
+
"properties": {
|
|
2053
|
+
"privateKeyTagId": {
|
|
2054
|
+
"type": "string",
|
|
2055
|
+
"description": "Unique identifier for a given Private Key Tag."
|
|
2056
|
+
},
|
|
2057
|
+
"privateKeyIds": {
|
|
2058
|
+
"type": "array",
|
|
2059
|
+
"items": {
|
|
2060
|
+
"type": "string"
|
|
2061
|
+
},
|
|
2062
|
+
"description": "A list of Private Key IDs."
|
|
2063
|
+
}
|
|
2064
|
+
},
|
|
2065
|
+
"required": ["privateKeyTagId", "privateKeyIds"]
|
|
2066
|
+
},
|
|
2067
|
+
"v1CreatePrivateKeysIntent": {
|
|
2068
|
+
"type": "object",
|
|
2069
|
+
"properties": {
|
|
2070
|
+
"privateKeys": {
|
|
2071
|
+
"type": "array",
|
|
2072
|
+
"items": {
|
|
2073
|
+
"$ref": "#/definitions/v1PrivateKeyParams"
|
|
2074
|
+
},
|
|
2075
|
+
"description": "A list of Private Keys.",
|
|
2076
|
+
"title": "@inject_tag: validate:\"dive,required\""
|
|
2077
|
+
}
|
|
2078
|
+
},
|
|
2079
|
+
"required": ["privateKeys"]
|
|
2080
|
+
},
|
|
2081
|
+
"v1CreatePrivateKeysRequest": {
|
|
2082
|
+
"type": "object",
|
|
2083
|
+
"properties": {
|
|
2084
|
+
"type": {
|
|
2085
|
+
"type": "string",
|
|
2086
|
+
"enum": ["ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"]
|
|
2087
|
+
},
|
|
2088
|
+
"timestampMs": {
|
|
2089
|
+
"type": "string",
|
|
2090
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2091
|
+
},
|
|
2092
|
+
"organizationId": {
|
|
2093
|
+
"type": "string",
|
|
2094
|
+
"description": "Unique identifier for a given Organization."
|
|
2095
|
+
},
|
|
2096
|
+
"parameters": {
|
|
2097
|
+
"$ref": "#/definitions/v1CreatePrivateKeysIntent"
|
|
2098
|
+
}
|
|
2099
|
+
},
|
|
2100
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2101
|
+
},
|
|
2102
|
+
"v1CreatePrivateKeysResult": {
|
|
2103
|
+
"type": "object",
|
|
2104
|
+
"properties": {
|
|
2105
|
+
"privateKeyIds": {
|
|
2106
|
+
"type": "array",
|
|
2107
|
+
"items": {
|
|
2108
|
+
"type": "string"
|
|
2109
|
+
},
|
|
2110
|
+
"description": "A list of Private Key IDs."
|
|
2111
|
+
}
|
|
2112
|
+
},
|
|
2113
|
+
"required": ["privateKeyIds"]
|
|
2114
|
+
},
|
|
2115
|
+
"v1CreateUserTagIntent": {
|
|
2116
|
+
"type": "object",
|
|
2117
|
+
"properties": {
|
|
2118
|
+
"userTagName": {
|
|
2119
|
+
"type": "string",
|
|
2120
|
+
"description": "Human-readable name for a User Tag.",
|
|
2121
|
+
"title": "@inject_tag: validate:\"required,tk_label,tk_label_length\""
|
|
2122
|
+
},
|
|
2123
|
+
"userIds": {
|
|
2124
|
+
"type": "array",
|
|
2125
|
+
"items": {
|
|
2126
|
+
"type": "string"
|
|
2127
|
+
},
|
|
2128
|
+
"description": "A list of User IDs.",
|
|
2129
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
2130
|
+
}
|
|
2131
|
+
},
|
|
2132
|
+
"required": ["userTagName", "userIds"]
|
|
2133
|
+
},
|
|
2134
|
+
"v1CreateUserTagResult": {
|
|
2135
|
+
"type": "object",
|
|
2136
|
+
"properties": {
|
|
2137
|
+
"userTagId": {
|
|
2138
|
+
"type": "string",
|
|
2139
|
+
"description": "Unique identifier for a given User Tag."
|
|
2140
|
+
},
|
|
2141
|
+
"userIds": {
|
|
2142
|
+
"type": "array",
|
|
2143
|
+
"items": {
|
|
2144
|
+
"type": "string"
|
|
2145
|
+
},
|
|
2146
|
+
"description": "A list of User IDs."
|
|
2147
|
+
}
|
|
2148
|
+
},
|
|
2149
|
+
"required": ["userTagId", "userIds"]
|
|
2150
|
+
},
|
|
2151
|
+
"v1CreateUsersIntent": {
|
|
2152
|
+
"type": "object",
|
|
2153
|
+
"properties": {
|
|
2154
|
+
"users": {
|
|
2155
|
+
"type": "array",
|
|
2156
|
+
"items": {
|
|
2157
|
+
"$ref": "#/definitions/v1UserParams"
|
|
2158
|
+
},
|
|
2159
|
+
"description": "A list of Users.",
|
|
2160
|
+
"title": "@inject_tag: validate:\"required,dive,required\""
|
|
2161
|
+
}
|
|
2162
|
+
},
|
|
2163
|
+
"required": ["users"]
|
|
2164
|
+
},
|
|
2165
|
+
"v1CreateUsersRequest": {
|
|
2166
|
+
"type": "object",
|
|
2167
|
+
"properties": {
|
|
2168
|
+
"type": {
|
|
2169
|
+
"type": "string",
|
|
2170
|
+
"enum": ["ACTIVITY_TYPE_CREATE_USERS"]
|
|
2171
|
+
},
|
|
2172
|
+
"timestampMs": {
|
|
2173
|
+
"type": "string",
|
|
2174
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2175
|
+
},
|
|
2176
|
+
"organizationId": {
|
|
2177
|
+
"type": "string",
|
|
2178
|
+
"description": "Unique identifier for a given Organization."
|
|
2179
|
+
},
|
|
2180
|
+
"parameters": {
|
|
2181
|
+
"$ref": "#/definitions/v1CreateUsersIntent"
|
|
2182
|
+
}
|
|
2183
|
+
},
|
|
2184
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2185
|
+
},
|
|
2186
|
+
"v1CreateUsersResult": {
|
|
2187
|
+
"type": "object",
|
|
2188
|
+
"properties": {
|
|
2189
|
+
"userIds": {
|
|
2190
|
+
"type": "array",
|
|
2191
|
+
"items": {
|
|
2192
|
+
"type": "string"
|
|
2193
|
+
},
|
|
2194
|
+
"description": "A list of User IDs."
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
"required": ["userIds"]
|
|
2198
|
+
},
|
|
2199
|
+
"v1CredPropsAuthenticationExtensionsClientOutputs": {
|
|
2200
|
+
"type": "object",
|
|
2201
|
+
"properties": {
|
|
2202
|
+
"rk": {
|
|
2203
|
+
"type": "boolean"
|
|
2204
|
+
}
|
|
2205
|
+
},
|
|
2206
|
+
"required": ["rk"]
|
|
2207
|
+
},
|
|
2208
|
+
"v1Credential": {
|
|
2209
|
+
"type": "object",
|
|
2210
|
+
"properties": {
|
|
2211
|
+
"publicKey": {
|
|
2212
|
+
"type": "string",
|
|
2213
|
+
"description": "The public component of a cryptographic key pair used to sign messages and transactions."
|
|
2214
|
+
},
|
|
2215
|
+
"type": {
|
|
2216
|
+
"$ref": "#/definitions/v1CredentialType"
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
"required": ["publicKey", "type"]
|
|
2220
|
+
},
|
|
2221
|
+
"v1CredentialType": {
|
|
2222
|
+
"type": "string",
|
|
2223
|
+
"enum": [
|
|
2224
|
+
"CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR",
|
|
2225
|
+
"CREDENTIAL_TYPE_API_KEY_P256"
|
|
2226
|
+
]
|
|
2227
|
+
},
|
|
2228
|
+
"v1DeleteApiKeysIntent": {
|
|
2229
|
+
"type": "object",
|
|
2230
|
+
"properties": {
|
|
2231
|
+
"userId": {
|
|
2232
|
+
"type": "string",
|
|
2233
|
+
"description": "Unique identifier for a given User.",
|
|
2234
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2235
|
+
},
|
|
2236
|
+
"apiKeyIds": {
|
|
2237
|
+
"type": "array",
|
|
2238
|
+
"items": {
|
|
2239
|
+
"type": "string"
|
|
2240
|
+
},
|
|
2241
|
+
"description": "A list of API Key IDs.",
|
|
2242
|
+
"title": "@inject_tag: validate:\"required,dive,required,uuid\""
|
|
2243
|
+
}
|
|
2244
|
+
},
|
|
2245
|
+
"required": ["userId", "apiKeyIds"]
|
|
2246
|
+
},
|
|
2247
|
+
"v1DeleteApiKeysRequest": {
|
|
2248
|
+
"type": "object",
|
|
2249
|
+
"properties": {
|
|
2250
|
+
"type": {
|
|
2251
|
+
"type": "string",
|
|
2252
|
+
"enum": ["ACTIVITY_TYPE_DELETE_API_KEYS"]
|
|
2253
|
+
},
|
|
2254
|
+
"timestampMs": {
|
|
2255
|
+
"type": "string",
|
|
2256
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2257
|
+
},
|
|
2258
|
+
"organizationId": {
|
|
2259
|
+
"type": "string",
|
|
2260
|
+
"description": "Unique identifier for a given Organization."
|
|
2261
|
+
},
|
|
2262
|
+
"parameters": {
|
|
2263
|
+
"$ref": "#/definitions/v1DeleteApiKeysIntent"
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2267
|
+
},
|
|
2268
|
+
"v1DeleteApiKeysResult": {
|
|
2269
|
+
"type": "object",
|
|
2270
|
+
"properties": {
|
|
2271
|
+
"apiKeyIds": {
|
|
2272
|
+
"type": "array",
|
|
2273
|
+
"items": {
|
|
2274
|
+
"type": "string"
|
|
2275
|
+
},
|
|
2276
|
+
"description": "A list of API Key IDs."
|
|
2277
|
+
}
|
|
2278
|
+
},
|
|
2279
|
+
"required": ["apiKeyIds"]
|
|
2280
|
+
},
|
|
2281
|
+
"v1DeleteAuthenticatorsIntent": {
|
|
2282
|
+
"type": "object",
|
|
2283
|
+
"properties": {
|
|
2284
|
+
"userId": {
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"description": "Unique identifier for a given User.",
|
|
2287
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2288
|
+
},
|
|
2289
|
+
"authenticatorIds": {
|
|
2290
|
+
"type": "array",
|
|
2291
|
+
"items": {
|
|
2292
|
+
"type": "string"
|
|
2293
|
+
},
|
|
2294
|
+
"description": "A list of Authenticator IDs.",
|
|
2295
|
+
"title": "@inject_tag: validate:\"required,div,required,uuid\""
|
|
2296
|
+
}
|
|
2297
|
+
},
|
|
2298
|
+
"required": ["userId", "authenticatorIds"]
|
|
2299
|
+
},
|
|
2300
|
+
"v1DeleteAuthenticatorsResult": {
|
|
2301
|
+
"type": "object",
|
|
2302
|
+
"properties": {
|
|
2303
|
+
"authenticatorIds": {
|
|
2304
|
+
"type": "array",
|
|
2305
|
+
"items": {
|
|
2306
|
+
"type": "string"
|
|
2307
|
+
},
|
|
2308
|
+
"description": "Unique identifier for a given Authenticator."
|
|
2309
|
+
}
|
|
2310
|
+
},
|
|
2311
|
+
"required": ["authenticatorIds"]
|
|
2312
|
+
},
|
|
2313
|
+
"v1DeleteInvitationIntent": {
|
|
2314
|
+
"type": "object",
|
|
2315
|
+
"properties": {
|
|
2316
|
+
"invitationId": {
|
|
2317
|
+
"type": "string",
|
|
2318
|
+
"description": "Unique identifier for a given Invitation object.",
|
|
2319
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2320
|
+
}
|
|
2321
|
+
},
|
|
2322
|
+
"required": ["invitationId"]
|
|
2323
|
+
},
|
|
2324
|
+
"v1DeleteInvitationRequest": {
|
|
2325
|
+
"type": "object",
|
|
2326
|
+
"properties": {
|
|
2327
|
+
"type": {
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"enum": ["ACTIVITY_TYPE_DELETE_INVITATION"]
|
|
2330
|
+
},
|
|
2331
|
+
"timestampMs": {
|
|
2332
|
+
"type": "string",
|
|
2333
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2334
|
+
},
|
|
2335
|
+
"organizationId": {
|
|
2336
|
+
"type": "string",
|
|
2337
|
+
"description": "Unique identifier for a given Organization."
|
|
2338
|
+
},
|
|
2339
|
+
"parameters": {
|
|
2340
|
+
"$ref": "#/definitions/v1DeleteInvitationIntent"
|
|
2341
|
+
}
|
|
2342
|
+
},
|
|
2343
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2344
|
+
},
|
|
2345
|
+
"v1DeleteInvitationResult": {
|
|
2346
|
+
"type": "object",
|
|
2347
|
+
"properties": {
|
|
2348
|
+
"invitationId": {
|
|
2349
|
+
"type": "string",
|
|
2350
|
+
"description": "Unique identifier for a given Invitation."
|
|
2351
|
+
}
|
|
2352
|
+
},
|
|
2353
|
+
"required": ["invitationId"]
|
|
2354
|
+
},
|
|
2355
|
+
"v1DeleteOrganizationIntent": {
|
|
2356
|
+
"type": "object",
|
|
2357
|
+
"properties": {
|
|
2358
|
+
"organizationId": {
|
|
2359
|
+
"type": "string",
|
|
2360
|
+
"description": "Unique identifier for a given Organization.",
|
|
2361
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2364
|
+
"required": ["organizationId"]
|
|
2365
|
+
},
|
|
2366
|
+
"v1DeleteOrganizationResult": {
|
|
2367
|
+
"type": "object",
|
|
2368
|
+
"properties": {
|
|
2369
|
+
"organizationId": {
|
|
2370
|
+
"type": "string",
|
|
2371
|
+
"description": "Unique identifier for a given Organization."
|
|
2372
|
+
}
|
|
2373
|
+
},
|
|
2374
|
+
"required": ["organizationId"]
|
|
2375
|
+
},
|
|
2376
|
+
"v1DeletePaymentMethodIntent": {
|
|
2377
|
+
"type": "object",
|
|
2378
|
+
"properties": {
|
|
2379
|
+
"paymentMethodId": {
|
|
2380
|
+
"type": "string",
|
|
2381
|
+
"description": "The payment method that the customer wants to remove."
|
|
2382
|
+
}
|
|
2383
|
+
},
|
|
2384
|
+
"required": ["paymentMethodId"]
|
|
2385
|
+
},
|
|
2386
|
+
"v1DeletePaymentMethodResult": {
|
|
2387
|
+
"type": "object",
|
|
2388
|
+
"properties": {
|
|
2389
|
+
"paymentMethodId": {
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"description": "The payment method that was removed."
|
|
2392
|
+
}
|
|
2393
|
+
},
|
|
2394
|
+
"required": ["paymentMethodId"]
|
|
2395
|
+
},
|
|
2396
|
+
"v1DeletePolicyIntent": {
|
|
2397
|
+
"type": "object",
|
|
2398
|
+
"properties": {
|
|
2399
|
+
"policyId": {
|
|
2400
|
+
"type": "string",
|
|
2401
|
+
"description": "Unique identifier for a given Policy.",
|
|
2402
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2403
|
+
}
|
|
2404
|
+
},
|
|
2405
|
+
"required": ["policyId"]
|
|
2406
|
+
},
|
|
2407
|
+
"v1DeletePolicyRequest": {
|
|
2408
|
+
"type": "object",
|
|
2409
|
+
"properties": {
|
|
2410
|
+
"type": {
|
|
2411
|
+
"type": "string",
|
|
2412
|
+
"enum": ["ACTIVITY_TYPE_DELETE_POLICY"]
|
|
2413
|
+
},
|
|
2414
|
+
"timestampMs": {
|
|
2415
|
+
"type": "string",
|
|
2416
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
2417
|
+
},
|
|
2418
|
+
"organizationId": {
|
|
2419
|
+
"type": "string",
|
|
2420
|
+
"description": "Unique identifier for a given Organization."
|
|
2421
|
+
},
|
|
2422
|
+
"parameters": {
|
|
2423
|
+
"$ref": "#/definitions/v1DeletePolicyIntent"
|
|
2424
|
+
}
|
|
2425
|
+
},
|
|
2426
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2427
|
+
},
|
|
2428
|
+
"v1DeletePolicyResult": {
|
|
2429
|
+
"type": "object",
|
|
2430
|
+
"properties": {
|
|
2431
|
+
"policyId": {
|
|
2432
|
+
"type": "string",
|
|
2433
|
+
"description": "Unique identifier for a given Policy."
|
|
2434
|
+
}
|
|
2435
|
+
},
|
|
2436
|
+
"required": ["policyId"]
|
|
2437
|
+
},
|
|
2438
|
+
"v1DeletePrivateKeyTagsIntent": {
|
|
2439
|
+
"type": "object",
|
|
2440
|
+
"properties": {
|
|
2441
|
+
"privateKeyTagIds": {
|
|
2442
|
+
"type": "array",
|
|
2443
|
+
"items": {
|
|
2444
|
+
"type": "string"
|
|
2445
|
+
},
|
|
2446
|
+
"description": "A list of Private Key Tag IDs.",
|
|
2447
|
+
"title": "@inject_tag: validate:\"required,dive,required,uuid\""
|
|
2448
|
+
}
|
|
2449
|
+
},
|
|
2450
|
+
"required": ["privateKeyTagIds"]
|
|
2451
|
+
},
|
|
2452
|
+
"v1DeletePrivateKeyTagsResult": {
|
|
2453
|
+
"type": "object",
|
|
2454
|
+
"properties": {
|
|
2455
|
+
"privateKeyTagIds": {
|
|
2456
|
+
"type": "array",
|
|
2457
|
+
"items": {
|
|
2458
|
+
"type": "string"
|
|
2459
|
+
},
|
|
2460
|
+
"description": "A list of Private Key Tag IDs."
|
|
2461
|
+
},
|
|
2462
|
+
"privateKeyIds": {
|
|
2463
|
+
"type": "array",
|
|
2464
|
+
"items": {
|
|
2465
|
+
"type": "string"
|
|
2466
|
+
},
|
|
2467
|
+
"description": "A list of Private Key IDs."
|
|
2468
|
+
}
|
|
2469
|
+
},
|
|
2470
|
+
"required": ["privateKeyTagIds", "privateKeyIds"]
|
|
2471
|
+
},
|
|
2472
|
+
"v1DeleteUserTagsIntent": {
|
|
2473
|
+
"type": "object",
|
|
2474
|
+
"properties": {
|
|
2475
|
+
"userTagIds": {
|
|
2476
|
+
"type": "array",
|
|
2477
|
+
"items": {
|
|
2478
|
+
"type": "string"
|
|
2479
|
+
},
|
|
2480
|
+
"description": "A list of User Tag IDs.",
|
|
2481
|
+
"title": "@inject_tag: validate:\"required,dive,required,uuid\""
|
|
2482
|
+
}
|
|
2483
|
+
},
|
|
2484
|
+
"required": ["userTagIds"]
|
|
2485
|
+
},
|
|
2486
|
+
"v1DeleteUserTagsResult": {
|
|
2487
|
+
"type": "object",
|
|
2488
|
+
"properties": {
|
|
2489
|
+
"userTagIds": {
|
|
2490
|
+
"type": "array",
|
|
2491
|
+
"items": {
|
|
2492
|
+
"type": "string"
|
|
2493
|
+
},
|
|
2494
|
+
"description": "A list of User Tag IDs."
|
|
2495
|
+
},
|
|
2496
|
+
"userIds": {
|
|
2497
|
+
"type": "array",
|
|
2498
|
+
"items": {
|
|
2499
|
+
"type": "string"
|
|
2500
|
+
},
|
|
2501
|
+
"description": "A list of User IDs."
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"required": ["userTagIds", "userIds"]
|
|
2505
|
+
},
|
|
2506
|
+
"v1DeleteUsersIntent": {
|
|
2507
|
+
"type": "object",
|
|
2508
|
+
"properties": {
|
|
2509
|
+
"userIds": {
|
|
2510
|
+
"type": "array",
|
|
2511
|
+
"items": {
|
|
2512
|
+
"type": "string"
|
|
2513
|
+
},
|
|
2514
|
+
"description": "A list of User IDs.",
|
|
2515
|
+
"title": "@inject_tag: validate:\"required,dive,required,uuid\""
|
|
2516
|
+
}
|
|
2517
|
+
},
|
|
2518
|
+
"required": ["userIds"]
|
|
2519
|
+
},
|
|
2520
|
+
"v1DeleteUsersResult": {
|
|
2521
|
+
"type": "object",
|
|
2522
|
+
"properties": {
|
|
2523
|
+
"userIds": {
|
|
2524
|
+
"type": "array",
|
|
2525
|
+
"items": {
|
|
2526
|
+
"type": "string"
|
|
2527
|
+
},
|
|
2528
|
+
"description": "A list of User IDs."
|
|
2529
|
+
}
|
|
2530
|
+
},
|
|
2531
|
+
"required": ["userIds"]
|
|
2532
|
+
},
|
|
2533
|
+
"v1DisablePrivateKeyIntent": {
|
|
2534
|
+
"type": "object",
|
|
2535
|
+
"properties": {
|
|
2536
|
+
"privateKeyId": {
|
|
2537
|
+
"type": "string",
|
|
2538
|
+
"description": "Unique identifier for a given Private Key.",
|
|
2539
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2540
|
+
}
|
|
2541
|
+
},
|
|
2542
|
+
"required": ["privateKeyId"]
|
|
2543
|
+
},
|
|
2544
|
+
"v1DisablePrivateKeyResult": {
|
|
2545
|
+
"type": "object",
|
|
2546
|
+
"properties": {
|
|
2547
|
+
"privateKeyId": {
|
|
2548
|
+
"type": "string",
|
|
2549
|
+
"description": "Unique identifier for a given Private Key."
|
|
2550
|
+
}
|
|
2551
|
+
},
|
|
2552
|
+
"required": ["privateKeyId"]
|
|
2553
|
+
},
|
|
2554
|
+
"v1GetActivitiesRequest": {
|
|
2555
|
+
"type": "object",
|
|
2556
|
+
"properties": {
|
|
2557
|
+
"organizationId": {
|
|
2558
|
+
"type": "string",
|
|
2559
|
+
"description": "Unique identifier for a given Organization."
|
|
2560
|
+
},
|
|
2561
|
+
"filterByStatus": {
|
|
2562
|
+
"type": "array",
|
|
2563
|
+
"items": {
|
|
2564
|
+
"$ref": "#/definitions/v1ActivityStatus"
|
|
2565
|
+
},
|
|
2566
|
+
"description": "Array of Activity Statuses filtering which Activities will be listed in the response."
|
|
2567
|
+
},
|
|
2568
|
+
"paginationOptions": {
|
|
2569
|
+
"$ref": "#/definitions/v1PaginationOptions"
|
|
2570
|
+
}
|
|
2571
|
+
},
|
|
2572
|
+
"required": ["organizationId"]
|
|
2573
|
+
},
|
|
2574
|
+
"v1GetActivitiesResponse": {
|
|
2575
|
+
"type": "object",
|
|
2576
|
+
"properties": {
|
|
2577
|
+
"activities": {
|
|
2578
|
+
"type": "array",
|
|
2579
|
+
"items": {
|
|
2580
|
+
"$ref": "#/definitions/v1Activity"
|
|
2581
|
+
},
|
|
2582
|
+
"description": "A list of Activities."
|
|
2583
|
+
}
|
|
2584
|
+
},
|
|
2585
|
+
"required": ["activities"]
|
|
2586
|
+
},
|
|
2587
|
+
"v1GetActivityRequest": {
|
|
2588
|
+
"type": "object",
|
|
2589
|
+
"properties": {
|
|
2590
|
+
"organizationId": {
|
|
2591
|
+
"type": "string",
|
|
2592
|
+
"description": "Unique identifier for a given Organization."
|
|
2593
|
+
},
|
|
2594
|
+
"activityId": {
|
|
2595
|
+
"type": "string",
|
|
2596
|
+
"description": "Unique identifier for a given Activity object."
|
|
2597
|
+
}
|
|
2598
|
+
},
|
|
2599
|
+
"required": ["organizationId", "activityId"]
|
|
2600
|
+
},
|
|
2601
|
+
"v1GetOrganizationRequest": {
|
|
2602
|
+
"type": "object",
|
|
2603
|
+
"properties": {
|
|
2604
|
+
"organizationId": {
|
|
2605
|
+
"type": "string",
|
|
2606
|
+
"description": "Unique identifier for a given Organization."
|
|
2607
|
+
}
|
|
2608
|
+
},
|
|
2609
|
+
"required": ["organizationId"]
|
|
2610
|
+
},
|
|
2611
|
+
"v1GetOrganizationResponse": {
|
|
2612
|
+
"type": "object",
|
|
2613
|
+
"properties": {
|
|
2614
|
+
"organizationData": {
|
|
2615
|
+
"$ref": "#/definitions/v1OrganizationData"
|
|
2616
|
+
}
|
|
2617
|
+
},
|
|
2618
|
+
"required": ["organizationData"]
|
|
2619
|
+
},
|
|
2620
|
+
"v1GetPoliciesRequest": {
|
|
2621
|
+
"type": "object",
|
|
2622
|
+
"properties": {
|
|
2623
|
+
"organizationId": {
|
|
2624
|
+
"type": "string",
|
|
2625
|
+
"description": "Unique identifier for a given Organization."
|
|
2626
|
+
}
|
|
2627
|
+
},
|
|
2628
|
+
"required": ["organizationId"]
|
|
2629
|
+
},
|
|
2630
|
+
"v1GetPoliciesResponse": {
|
|
2631
|
+
"type": "object",
|
|
2632
|
+
"properties": {
|
|
2633
|
+
"policies": {
|
|
2634
|
+
"type": "array",
|
|
2635
|
+
"items": {
|
|
2636
|
+
"$ref": "#/definitions/v1Policy"
|
|
2637
|
+
},
|
|
2638
|
+
"description": "A list of Policies."
|
|
2639
|
+
}
|
|
2640
|
+
},
|
|
2641
|
+
"required": ["policies"]
|
|
2642
|
+
},
|
|
2643
|
+
"v1GetPolicyRequest": {
|
|
2644
|
+
"type": "object",
|
|
2645
|
+
"properties": {
|
|
2646
|
+
"organizationId": {
|
|
2647
|
+
"type": "string",
|
|
2648
|
+
"description": "Unique identifier for a given Organization."
|
|
2649
|
+
},
|
|
2650
|
+
"policyId": {
|
|
2651
|
+
"type": "string",
|
|
2652
|
+
"description": "Unique identifier for a given Policy."
|
|
2653
|
+
}
|
|
2654
|
+
},
|
|
2655
|
+
"required": ["organizationId", "policyId"]
|
|
2656
|
+
},
|
|
2657
|
+
"v1GetPolicyResponse": {
|
|
2658
|
+
"type": "object",
|
|
2659
|
+
"properties": {
|
|
2660
|
+
"policy": {
|
|
2661
|
+
"$ref": "#/definitions/v1Policy"
|
|
2662
|
+
}
|
|
2663
|
+
},
|
|
2664
|
+
"required": ["policy"]
|
|
2665
|
+
},
|
|
2666
|
+
"v1GetPrivateKeyRequest": {
|
|
2667
|
+
"type": "object",
|
|
2668
|
+
"properties": {
|
|
2669
|
+
"organizationId": {
|
|
2670
|
+
"type": "string",
|
|
2671
|
+
"description": "Unique identifier for a given Organization."
|
|
2672
|
+
},
|
|
2673
|
+
"privateKeyId": {
|
|
2674
|
+
"type": "string",
|
|
2675
|
+
"description": "Unique identifier for a given Private Key."
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
"required": ["organizationId", "privateKeyId"]
|
|
2679
|
+
},
|
|
2680
|
+
"v1GetPrivateKeyResponse": {
|
|
2681
|
+
"type": "object",
|
|
2682
|
+
"properties": {
|
|
2683
|
+
"privateKey": {
|
|
2684
|
+
"$ref": "#/definitions/v1PrivateKey"
|
|
2685
|
+
}
|
|
2686
|
+
},
|
|
2687
|
+
"required": ["privateKey"]
|
|
2688
|
+
},
|
|
2689
|
+
"v1GetPrivateKeysRequest": {
|
|
2690
|
+
"type": "object",
|
|
2691
|
+
"properties": {
|
|
2692
|
+
"organizationId": {
|
|
2693
|
+
"type": "string",
|
|
2694
|
+
"description": "Unique identifier for a given Organization."
|
|
2695
|
+
}
|
|
2696
|
+
},
|
|
2697
|
+
"required": ["organizationId"]
|
|
2698
|
+
},
|
|
2699
|
+
"v1GetPrivateKeysResponse": {
|
|
2700
|
+
"type": "object",
|
|
2701
|
+
"properties": {
|
|
2702
|
+
"privateKeys": {
|
|
2703
|
+
"type": "array",
|
|
2704
|
+
"items": {
|
|
2705
|
+
"$ref": "#/definitions/v1PrivateKey"
|
|
2706
|
+
},
|
|
2707
|
+
"description": "A list of Private Keys."
|
|
2708
|
+
}
|
|
2709
|
+
},
|
|
2710
|
+
"required": ["privateKeys"]
|
|
2711
|
+
},
|
|
2712
|
+
"v1GetUserRequest": {
|
|
2713
|
+
"type": "object",
|
|
2714
|
+
"properties": {
|
|
2715
|
+
"organizationId": {
|
|
2716
|
+
"type": "string",
|
|
2717
|
+
"description": "Unique identifier for a given Organization."
|
|
2718
|
+
},
|
|
2719
|
+
"userId": {
|
|
2720
|
+
"type": "string",
|
|
2721
|
+
"description": "Unique identifier for a given User."
|
|
2722
|
+
}
|
|
2723
|
+
},
|
|
2724
|
+
"required": ["organizationId", "userId"]
|
|
2725
|
+
},
|
|
2726
|
+
"v1GetUserResponse": {
|
|
2727
|
+
"type": "object",
|
|
2728
|
+
"properties": {
|
|
2729
|
+
"user": {
|
|
2730
|
+
"$ref": "#/definitions/v1User"
|
|
2731
|
+
}
|
|
2732
|
+
},
|
|
2733
|
+
"required": ["user"]
|
|
2734
|
+
},
|
|
2735
|
+
"v1GetUsersRequest": {
|
|
2736
|
+
"type": "object",
|
|
2737
|
+
"properties": {
|
|
2738
|
+
"organizationId": {
|
|
2739
|
+
"type": "string",
|
|
2740
|
+
"description": "Unique identifier for a given Organization."
|
|
2741
|
+
}
|
|
2742
|
+
},
|
|
2743
|
+
"required": ["organizationId"]
|
|
2744
|
+
},
|
|
2745
|
+
"v1GetUsersResponse": {
|
|
2746
|
+
"type": "object",
|
|
2747
|
+
"properties": {
|
|
2748
|
+
"users": {
|
|
2749
|
+
"type": "array",
|
|
2750
|
+
"items": {
|
|
2751
|
+
"$ref": "#/definitions/v1User"
|
|
2752
|
+
},
|
|
2753
|
+
"description": "A list of Users."
|
|
2754
|
+
}
|
|
2755
|
+
},
|
|
2756
|
+
"required": ["users"]
|
|
2757
|
+
},
|
|
2758
|
+
"v1GetWhoamiRequest": {
|
|
2759
|
+
"type": "object",
|
|
2760
|
+
"properties": {
|
|
2761
|
+
"organizationId": {
|
|
2762
|
+
"type": "string",
|
|
2763
|
+
"description": "Unique identifier for a given Organization."
|
|
2764
|
+
}
|
|
2765
|
+
},
|
|
2766
|
+
"required": ["organizationId"]
|
|
2767
|
+
},
|
|
2768
|
+
"v1GetWhoamiResponse": {
|
|
2769
|
+
"type": "object",
|
|
2770
|
+
"properties": {
|
|
2771
|
+
"organizationId": {
|
|
2772
|
+
"type": "string",
|
|
2773
|
+
"description": "Unique identifier for a given Organization."
|
|
2774
|
+
},
|
|
2775
|
+
"organizationName": {
|
|
2776
|
+
"type": "string",
|
|
2777
|
+
"description": "Human-readable name for an Organization."
|
|
2778
|
+
},
|
|
2779
|
+
"userId": {
|
|
2780
|
+
"type": "string",
|
|
2781
|
+
"description": "Unique identifier for a given User."
|
|
2782
|
+
},
|
|
2783
|
+
"username": {
|
|
2784
|
+
"type": "string",
|
|
2785
|
+
"description": "Human-readable name for a User."
|
|
2786
|
+
}
|
|
2787
|
+
},
|
|
2788
|
+
"required": ["organizationId", "organizationName", "userId", "username"]
|
|
2789
|
+
},
|
|
2790
|
+
"v1HashFunction": {
|
|
2791
|
+
"type": "string",
|
|
2792
|
+
"enum": [
|
|
2793
|
+
"HASH_FUNCTION_NO_OP",
|
|
2794
|
+
"HASH_FUNCTION_SHA256",
|
|
2795
|
+
"HASH_FUNCTION_KECCAK256"
|
|
2796
|
+
],
|
|
2797
|
+
"description": " - HASH_FUNCTION_UNSPECIFIED: Default value if hash function is not set explicitly\n - HASH_FUNCTION_NO_OP: No-op function. Useful if you want to pass raw bytes to sign\n - HASH_FUNCTION_SHA256: Standard SHA-256\n - HASH_FUNCTION_KECCAK256: Keccak-256 (not the same as NIST SHA-3!).\nThis is the hash function used in the Ethereum ecosystem."
|
|
2798
|
+
},
|
|
2799
|
+
"v1Intent": {
|
|
2800
|
+
"type": "object",
|
|
2801
|
+
"properties": {
|
|
2802
|
+
"createOrganizationIntent": {
|
|
2803
|
+
"$ref": "#/definitions/v1CreateOrganizationIntent"
|
|
2804
|
+
},
|
|
2805
|
+
"createAuthenticatorsIntent": {
|
|
2806
|
+
"$ref": "#/definitions/v1CreateAuthenticatorsIntent"
|
|
2807
|
+
},
|
|
2808
|
+
"createUsersIntent": {
|
|
2809
|
+
"$ref": "#/definitions/v1CreateUsersIntent"
|
|
2810
|
+
},
|
|
2811
|
+
"createPrivateKeysIntent": {
|
|
2812
|
+
"$ref": "#/definitions/v1CreatePrivateKeysIntent"
|
|
2813
|
+
},
|
|
2814
|
+
"signRawPayloadIntent": {
|
|
2815
|
+
"$ref": "#/definitions/v1SignRawPayloadIntent"
|
|
2816
|
+
},
|
|
2817
|
+
"createInvitationsIntent": {
|
|
2818
|
+
"$ref": "#/definitions/v1CreateInvitationsIntent"
|
|
2819
|
+
},
|
|
2820
|
+
"acceptInvitationIntent": {
|
|
2821
|
+
"$ref": "#/definitions/v1AcceptInvitationIntent"
|
|
2822
|
+
},
|
|
2823
|
+
"createPolicyIntent": {
|
|
2824
|
+
"$ref": "#/definitions/v1CreatePolicyIntent"
|
|
2825
|
+
},
|
|
2826
|
+
"disablePrivateKeyIntent": {
|
|
2827
|
+
"$ref": "#/definitions/v1DisablePrivateKeyIntent"
|
|
2828
|
+
},
|
|
2829
|
+
"deleteUsersIntent": {
|
|
2830
|
+
"$ref": "#/definitions/v1DeleteUsersIntent"
|
|
2831
|
+
},
|
|
2832
|
+
"deleteAuthenticatorsIntent": {
|
|
2833
|
+
"$ref": "#/definitions/v1DeleteAuthenticatorsIntent"
|
|
2834
|
+
},
|
|
2835
|
+
"deleteInvitationIntent": {
|
|
2836
|
+
"$ref": "#/definitions/v1DeleteInvitationIntent"
|
|
2837
|
+
},
|
|
2838
|
+
"deleteOrganizationIntent": {
|
|
2839
|
+
"$ref": "#/definitions/v1DeleteOrganizationIntent"
|
|
2840
|
+
},
|
|
2841
|
+
"deletePolicyIntent": {
|
|
2842
|
+
"$ref": "#/definitions/v1DeletePolicyIntent"
|
|
2843
|
+
},
|
|
2844
|
+
"createUserTagIntent": {
|
|
2845
|
+
"$ref": "#/definitions/v1CreateUserTagIntent"
|
|
2846
|
+
},
|
|
2847
|
+
"deleteUserTagsIntent": {
|
|
2848
|
+
"$ref": "#/definitions/v1DeleteUserTagsIntent"
|
|
2849
|
+
},
|
|
2850
|
+
"signTransactionIntent": {
|
|
2851
|
+
"$ref": "#/definitions/v1SignTransactionIntent"
|
|
2852
|
+
},
|
|
2853
|
+
"createApiKeysIntent": {
|
|
2854
|
+
"$ref": "#/definitions/v1CreateApiKeysIntent"
|
|
2855
|
+
},
|
|
2856
|
+
"deleteApiKeysIntent": {
|
|
2857
|
+
"$ref": "#/definitions/v1DeleteApiKeysIntent"
|
|
2858
|
+
},
|
|
2859
|
+
"approveActivityIntent": {
|
|
2860
|
+
"$ref": "#/definitions/v1ApproveActivityIntent"
|
|
2861
|
+
},
|
|
2862
|
+
"rejectActivityIntent": {
|
|
2863
|
+
"$ref": "#/definitions/v1RejectActivityIntent"
|
|
2864
|
+
},
|
|
2865
|
+
"createPrivateKeyTagIntent": {
|
|
2866
|
+
"$ref": "#/definitions/v1CreatePrivateKeyTagIntent"
|
|
2867
|
+
},
|
|
2868
|
+
"deletePrivateKeyTagsIntent": {
|
|
2869
|
+
"$ref": "#/definitions/v1DeletePrivateKeyTagsIntent"
|
|
2870
|
+
},
|
|
2871
|
+
"createPolicyIntentV2": {
|
|
2872
|
+
"$ref": "#/definitions/v1CreatePolicyIntentV2"
|
|
2873
|
+
},
|
|
2874
|
+
"setPaymentMethodIntent": {
|
|
2875
|
+
"$ref": "#/definitions/v1SetPaymentMethodIntent"
|
|
2876
|
+
},
|
|
2877
|
+
"activateBillingTierIntent": {
|
|
2878
|
+
"$ref": "#/definitions/v1ActivateBillingTierIntent"
|
|
2879
|
+
},
|
|
2880
|
+
"deletePaymentMethodIntent": {
|
|
2881
|
+
"$ref": "#/definitions/v1DeletePaymentMethodIntent"
|
|
2882
|
+
},
|
|
2883
|
+
"createPolicyIntentV3": {
|
|
2884
|
+
"$ref": "#/definitions/v1CreatePolicyIntentV3"
|
|
2885
|
+
},
|
|
2886
|
+
"createApiOnlyUsersIntent": {
|
|
2887
|
+
"$ref": "#/definitions/v1CreateApiOnlyUsersIntent"
|
|
2888
|
+
}
|
|
2889
|
+
},
|
|
2890
|
+
"description": "Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action.",
|
|
2891
|
+
"required": ["createOrganizationIntent"]
|
|
2892
|
+
},
|
|
2893
|
+
"v1Invitation": {
|
|
2894
|
+
"type": "object",
|
|
2895
|
+
"properties": {
|
|
2896
|
+
"invitationId": {
|
|
2897
|
+
"type": "string",
|
|
2898
|
+
"description": "Unique identifier for a given Invitation object."
|
|
2899
|
+
},
|
|
2900
|
+
"receiverUserName": {
|
|
2901
|
+
"type": "string",
|
|
2902
|
+
"description": "The name of the intended Invitation recipient."
|
|
2903
|
+
},
|
|
2904
|
+
"receiverEmail": {
|
|
2905
|
+
"type": "string",
|
|
2906
|
+
"description": "The email address of the intended Invitation recipient."
|
|
2907
|
+
},
|
|
2908
|
+
"receiverUserTags": {
|
|
2909
|
+
"type": "array",
|
|
2910
|
+
"items": {
|
|
2911
|
+
"type": "string"
|
|
2912
|
+
},
|
|
2913
|
+
"description": "A list of tags assigned to the Invitation recipient."
|
|
2914
|
+
},
|
|
2915
|
+
"accessType": {
|
|
2916
|
+
"$ref": "#/definitions/externaldatav1AccessType"
|
|
2917
|
+
},
|
|
2918
|
+
"status": {
|
|
2919
|
+
"$ref": "#/definitions/v1InvitationStatus"
|
|
2920
|
+
},
|
|
2921
|
+
"createdAt": {
|
|
2922
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
2923
|
+
},
|
|
2924
|
+
"updatedAt": {
|
|
2925
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
2926
|
+
},
|
|
2927
|
+
"senderUserId": {
|
|
2928
|
+
"type": "string",
|
|
2929
|
+
"description": "Unique identifier for the Sender of an Invitation."
|
|
2930
|
+
}
|
|
2931
|
+
},
|
|
2932
|
+
"required": [
|
|
2933
|
+
"invitationId",
|
|
2934
|
+
"receiverUserName",
|
|
2935
|
+
"receiverEmail",
|
|
2936
|
+
"receiverUserTags",
|
|
2937
|
+
"accessType",
|
|
2938
|
+
"status",
|
|
2939
|
+
"createdAt",
|
|
2940
|
+
"updatedAt",
|
|
2941
|
+
"senderUserId"
|
|
2942
|
+
]
|
|
2943
|
+
},
|
|
2944
|
+
"v1InvitationParams": {
|
|
2945
|
+
"type": "object",
|
|
2946
|
+
"properties": {
|
|
2947
|
+
"receiverUserName": {
|
|
2948
|
+
"type": "string",
|
|
2949
|
+
"description": "The name of the intended Invitation recipient.",
|
|
2950
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
2951
|
+
},
|
|
2952
|
+
"receiverUserEmail": {
|
|
2953
|
+
"type": "string",
|
|
2954
|
+
"description": "The email address of the intended Invitation recipient.",
|
|
2955
|
+
"title": "@inject_tag: validate:\"required,email,tk_email\""
|
|
2956
|
+
},
|
|
2957
|
+
"receiverUserTags": {
|
|
2958
|
+
"type": "array",
|
|
2959
|
+
"items": {
|
|
2960
|
+
"type": "string"
|
|
2961
|
+
},
|
|
2962
|
+
"description": "A list of tags assigned to the Invitation recipient.",
|
|
2963
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
2964
|
+
},
|
|
2965
|
+
"accessType": {
|
|
2966
|
+
"$ref": "#/definitions/immutableactivityv1AccessType"
|
|
2967
|
+
},
|
|
2968
|
+
"senderUserId": {
|
|
2969
|
+
"type": "string",
|
|
2970
|
+
"description": "Unique identifier for the Sender of an Invitation.",
|
|
2971
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
2972
|
+
}
|
|
2973
|
+
},
|
|
2974
|
+
"required": [
|
|
2975
|
+
"receiverUserName",
|
|
2976
|
+
"receiverUserEmail",
|
|
2977
|
+
"receiverUserTags",
|
|
2978
|
+
"accessType",
|
|
2979
|
+
"senderUserId"
|
|
2980
|
+
]
|
|
2981
|
+
},
|
|
2982
|
+
"v1InvitationStatus": {
|
|
2983
|
+
"type": "string",
|
|
2984
|
+
"enum": [
|
|
2985
|
+
"INVITATION_STATUS_CREATED",
|
|
2986
|
+
"INVITATION_STATUS_ACCEPTED",
|
|
2987
|
+
"INVITATION_STATUS_REVOKED"
|
|
2988
|
+
]
|
|
2989
|
+
},
|
|
2990
|
+
"v1OrganizationData": {
|
|
2991
|
+
"type": "object",
|
|
2992
|
+
"properties": {
|
|
2993
|
+
"organizationId": {
|
|
2994
|
+
"type": "string"
|
|
2995
|
+
},
|
|
2996
|
+
"name": {
|
|
2997
|
+
"type": "string"
|
|
2998
|
+
},
|
|
2999
|
+
"users": {
|
|
3000
|
+
"type": "array",
|
|
3001
|
+
"items": {
|
|
3002
|
+
"$ref": "#/definitions/v1User"
|
|
3003
|
+
}
|
|
3004
|
+
},
|
|
3005
|
+
"policies": {
|
|
3006
|
+
"type": "array",
|
|
3007
|
+
"items": {
|
|
3008
|
+
"$ref": "#/definitions/v1Policy"
|
|
3009
|
+
}
|
|
3010
|
+
},
|
|
3011
|
+
"privateKeys": {
|
|
3012
|
+
"type": "array",
|
|
3013
|
+
"items": {
|
|
3014
|
+
"$ref": "#/definitions/v1PrivateKey"
|
|
3015
|
+
}
|
|
3016
|
+
},
|
|
3017
|
+
"invitations": {
|
|
3018
|
+
"type": "array",
|
|
3019
|
+
"items": {
|
|
3020
|
+
"$ref": "#/definitions/v1Invitation"
|
|
3021
|
+
}
|
|
3022
|
+
},
|
|
3023
|
+
"tags": {
|
|
3024
|
+
"type": "array",
|
|
3025
|
+
"items": {
|
|
3026
|
+
"$ref": "#/definitions/datav1Tag"
|
|
3027
|
+
}
|
|
3028
|
+
},
|
|
3029
|
+
"deletedUsers": {
|
|
3030
|
+
"type": "array",
|
|
3031
|
+
"items": {
|
|
3032
|
+
"$ref": "#/definitions/v1User"
|
|
3033
|
+
}
|
|
3034
|
+
},
|
|
3035
|
+
"deletedPolicies": {
|
|
3036
|
+
"type": "array",
|
|
3037
|
+
"items": {
|
|
3038
|
+
"$ref": "#/definitions/v1Policy"
|
|
3039
|
+
}
|
|
3040
|
+
},
|
|
3041
|
+
"disabledPrivateKeys": {
|
|
3042
|
+
"type": "array",
|
|
3043
|
+
"items": {
|
|
3044
|
+
"$ref": "#/definitions/v1PrivateKey"
|
|
3045
|
+
}
|
|
3046
|
+
},
|
|
3047
|
+
"deletedInvitations": {
|
|
3048
|
+
"type": "array",
|
|
3049
|
+
"items": {
|
|
3050
|
+
"$ref": "#/definitions/v1Invitation"
|
|
3051
|
+
}
|
|
3052
|
+
},
|
|
3053
|
+
"deletedApiKeys": {
|
|
3054
|
+
"type": "array",
|
|
3055
|
+
"items": {
|
|
3056
|
+
"$ref": "#/definitions/v1ApiKey"
|
|
3057
|
+
}
|
|
3058
|
+
},
|
|
3059
|
+
"deletedAuthenticators": {
|
|
3060
|
+
"type": "array",
|
|
3061
|
+
"items": {
|
|
3062
|
+
"$ref": "#/definitions/v1Authenticator"
|
|
3063
|
+
}
|
|
3064
|
+
},
|
|
3065
|
+
"deletedTags": {
|
|
3066
|
+
"type": "array",
|
|
3067
|
+
"items": {
|
|
3068
|
+
"$ref": "#/definitions/datav1Tag"
|
|
3069
|
+
}
|
|
3070
|
+
}
|
|
3071
|
+
},
|
|
3072
|
+
"description": "This proto definition is used in our external-facing APIs.\nIt's important to leverage annotations because they're used in our external interfaces."
|
|
3073
|
+
},
|
|
3074
|
+
"v1PaginationOptions": {
|
|
3075
|
+
"type": "object",
|
|
3076
|
+
"properties": {
|
|
3077
|
+
"limit": {
|
|
3078
|
+
"type": "integer",
|
|
3079
|
+
"format": "int32",
|
|
3080
|
+
"description": "A limit of the number of object to be returned, between 1 and 100. Defaults to 10 if omitted or set to 0."
|
|
3081
|
+
},
|
|
3082
|
+
"before": {
|
|
3083
|
+
"type": "string",
|
|
3084
|
+
"description": "A pagination cursor. This is an object ID that enables you to fetch all objects before this ID."
|
|
3085
|
+
},
|
|
3086
|
+
"after": {
|
|
3087
|
+
"type": "string",
|
|
3088
|
+
"description": "A pagination cursor. This is an object ID that enables you to fetch all objects after this ID."
|
|
3089
|
+
}
|
|
3090
|
+
}
|
|
3091
|
+
},
|
|
3092
|
+
"v1PayloadEncoding": {
|
|
3093
|
+
"type": "string",
|
|
3094
|
+
"enum": ["PAYLOAD_ENCODING_HEXADECIMAL", "PAYLOAD_ENCODING_TEXT_UTF8"],
|
|
3095
|
+
"title": "- PAYLOAD_ENCODING_UNSPECIFIED: Default value if payload encoding is not set explicitly\n - PAYLOAD_ENCODING_HEXADECIMAL: Payload is encoded in hexadecimal\nWe accept 0x-prefixed or non-0x prefixed payloads.\nWe accept any casing (uppercase, lowercase, or mixed)\n - PAYLOAD_ENCODING_TEXT_UTF8: Payload is encoded as utf-8 text\nWill be converted to bytes for signature with Rust's standard String.as_bytes()"
|
|
3096
|
+
},
|
|
3097
|
+
"v1Policy": {
|
|
3098
|
+
"type": "object",
|
|
3099
|
+
"properties": {
|
|
3100
|
+
"policyId": {
|
|
3101
|
+
"type": "string",
|
|
3102
|
+
"description": "Unique identifier for a given Policy."
|
|
3103
|
+
},
|
|
3104
|
+
"policyName": {
|
|
3105
|
+
"type": "string",
|
|
3106
|
+
"description": "Human-readable name for a Policy."
|
|
3107
|
+
},
|
|
3108
|
+
"effect": {
|
|
3109
|
+
"$ref": "#/definitions/externaldatav1Effect"
|
|
3110
|
+
},
|
|
3111
|
+
"selectors": {
|
|
3112
|
+
"type": "array",
|
|
3113
|
+
"items": {
|
|
3114
|
+
"$ref": "#/definitions/externaldatav1Selector"
|
|
3115
|
+
},
|
|
3116
|
+
"description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details."
|
|
3117
|
+
},
|
|
3118
|
+
"createdAt": {
|
|
3119
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3120
|
+
},
|
|
3121
|
+
"updatedAt": {
|
|
3122
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3123
|
+
},
|
|
3124
|
+
"notes": {
|
|
3125
|
+
"type": "string",
|
|
3126
|
+
"description": "Human-readable notes added by a User to describe a particular policy."
|
|
3127
|
+
},
|
|
3128
|
+
"consensus": {
|
|
3129
|
+
"type": "string",
|
|
3130
|
+
"description": "A consensus expression that evalutes to true or false."
|
|
3131
|
+
},
|
|
3132
|
+
"condition": {
|
|
3133
|
+
"type": "string",
|
|
3134
|
+
"description": "A condition expression that evalutes to true or false."
|
|
3135
|
+
}
|
|
3136
|
+
},
|
|
3137
|
+
"required": [
|
|
3138
|
+
"policyId",
|
|
3139
|
+
"policyName",
|
|
3140
|
+
"effect",
|
|
3141
|
+
"selectors",
|
|
3142
|
+
"createdAt",
|
|
3143
|
+
"updatedAt",
|
|
3144
|
+
"notes",
|
|
3145
|
+
"consensus",
|
|
3146
|
+
"condition"
|
|
3147
|
+
]
|
|
3148
|
+
},
|
|
3149
|
+
"v1PrivateKey": {
|
|
3150
|
+
"type": "object",
|
|
3151
|
+
"properties": {
|
|
3152
|
+
"privateKeyId": {
|
|
3153
|
+
"type": "string",
|
|
3154
|
+
"description": "Unique identifier for a given Private Key."
|
|
3155
|
+
},
|
|
3156
|
+
"publicKey": {
|
|
3157
|
+
"type": "string",
|
|
3158
|
+
"description": "The public component of a cryptographic key pair used to sign messages and transactions."
|
|
3159
|
+
},
|
|
3160
|
+
"privateKeyName": {
|
|
3161
|
+
"type": "string",
|
|
3162
|
+
"description": "Human-readable name for a Private Key."
|
|
3163
|
+
},
|
|
3164
|
+
"curve": {
|
|
3165
|
+
"$ref": "#/definitions/externaldatav1Curve"
|
|
3166
|
+
},
|
|
3167
|
+
"addresses": {
|
|
3168
|
+
"type": "array",
|
|
3169
|
+
"items": {
|
|
3170
|
+
"$ref": "#/definitions/externaldatav1Address"
|
|
3171
|
+
},
|
|
3172
|
+
"description": "Derived cryptocurrency addresses for a given Private Key."
|
|
3173
|
+
},
|
|
3174
|
+
"privateKeyTags": {
|
|
3175
|
+
"type": "array",
|
|
3176
|
+
"items": {
|
|
3177
|
+
"type": "string"
|
|
3178
|
+
},
|
|
3179
|
+
"description": "A list of Private Key Tag IDs."
|
|
3180
|
+
},
|
|
3181
|
+
"createdAt": {
|
|
3182
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3183
|
+
}
|
|
3184
|
+
},
|
|
3185
|
+
"required": [
|
|
3186
|
+
"privateKeyId",
|
|
3187
|
+
"publicKey",
|
|
3188
|
+
"privateKeyName",
|
|
3189
|
+
"curve",
|
|
3190
|
+
"addresses",
|
|
3191
|
+
"privateKeyTags",
|
|
3192
|
+
"createdAt"
|
|
3193
|
+
]
|
|
3194
|
+
},
|
|
3195
|
+
"v1PrivateKeyParams": {
|
|
3196
|
+
"type": "object",
|
|
3197
|
+
"properties": {
|
|
3198
|
+
"privateKeyName": {
|
|
3199
|
+
"type": "string",
|
|
3200
|
+
"description": "Human-readable name for a Private Key.",
|
|
3201
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
3202
|
+
},
|
|
3203
|
+
"curve": {
|
|
3204
|
+
"$ref": "#/definitions/immutableactivityv1Curve"
|
|
3205
|
+
},
|
|
3206
|
+
"privateKeyTags": {
|
|
3207
|
+
"type": "array",
|
|
3208
|
+
"items": {
|
|
3209
|
+
"type": "string"
|
|
3210
|
+
},
|
|
3211
|
+
"description": "A list of Private Key Tag IDs.",
|
|
3212
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
3213
|
+
},
|
|
3214
|
+
"addressFormats": {
|
|
3215
|
+
"type": "array",
|
|
3216
|
+
"items": {
|
|
3217
|
+
"$ref": "#/definitions/immutableactivityv1AddressFormat"
|
|
3218
|
+
},
|
|
3219
|
+
"description": "Cryptocurrency-specific formats for a derived address (e.g., Ethereum).",
|
|
3220
|
+
"title": "@inject_tag: validate:\"required\""
|
|
3221
|
+
}
|
|
3222
|
+
},
|
|
3223
|
+
"required": [
|
|
3224
|
+
"privateKeyName",
|
|
3225
|
+
"curve",
|
|
3226
|
+
"privateKeyTags",
|
|
3227
|
+
"addressFormats"
|
|
3228
|
+
]
|
|
3229
|
+
},
|
|
3230
|
+
"v1PublicKeyCredentialWithAttestation": {
|
|
3231
|
+
"type": "object",
|
|
3232
|
+
"properties": {
|
|
3233
|
+
"id": {
|
|
3234
|
+
"type": "string"
|
|
3235
|
+
},
|
|
3236
|
+
"type": {
|
|
3237
|
+
"type": "string",
|
|
3238
|
+
"enum": ["public-key"],
|
|
3239
|
+
"title": "Must be literal string \"public-key\""
|
|
3240
|
+
},
|
|
3241
|
+
"rawId": {
|
|
3242
|
+
"type": "string",
|
|
3243
|
+
"title": "ENCODING: base64url"
|
|
3244
|
+
},
|
|
3245
|
+
"authenticatorAttachment": {
|
|
3246
|
+
"type": "string",
|
|
3247
|
+
"enum": ["cross-platform", "platform"],
|
|
3248
|
+
"x-nullable": true
|
|
3249
|
+
},
|
|
3250
|
+
"response": {
|
|
3251
|
+
"$ref": "#/definitions/v1AuthenticatorAttestationResponse"
|
|
3252
|
+
},
|
|
3253
|
+
"clientExtensionResults": {
|
|
3254
|
+
"$ref": "#/definitions/v1SimpleClientExtensionResults"
|
|
3255
|
+
}
|
|
3256
|
+
},
|
|
3257
|
+
"required": ["id", "type", "rawId", "response", "clientExtensionResults"]
|
|
3258
|
+
},
|
|
3259
|
+
"v1RejectActivityIntent": {
|
|
3260
|
+
"type": "object",
|
|
3261
|
+
"properties": {
|
|
3262
|
+
"fingerprint": {
|
|
3263
|
+
"type": "string",
|
|
3264
|
+
"description": "An artifact verifying a User's action.",
|
|
3265
|
+
"title": "@inject_tag: validate:\"required\""
|
|
3266
|
+
}
|
|
3267
|
+
},
|
|
3268
|
+
"required": ["fingerprint"]
|
|
3269
|
+
},
|
|
3270
|
+
"v1Result": {
|
|
3271
|
+
"type": "object",
|
|
3272
|
+
"properties": {
|
|
3273
|
+
"createOrganizationResult": {
|
|
3274
|
+
"$ref": "#/definitions/v1CreateOrganizationResult"
|
|
3275
|
+
},
|
|
3276
|
+
"createAuthenticatorsResult": {
|
|
3277
|
+
"$ref": "#/definitions/v1CreateAuthenticatorsResult"
|
|
3278
|
+
},
|
|
3279
|
+
"createUsersResult": {
|
|
3280
|
+
"$ref": "#/definitions/v1CreateUsersResult"
|
|
3281
|
+
},
|
|
3282
|
+
"createPrivateKeysResult": {
|
|
3283
|
+
"$ref": "#/definitions/v1CreatePrivateKeysResult"
|
|
3284
|
+
},
|
|
3285
|
+
"createInvitationsResult": {
|
|
3286
|
+
"$ref": "#/definitions/v1CreateInvitationsResult"
|
|
3287
|
+
},
|
|
3288
|
+
"acceptInvitationResult": {
|
|
3289
|
+
"$ref": "#/definitions/v1AcceptInvitationResult"
|
|
3290
|
+
},
|
|
3291
|
+
"signRawPayloadResult": {
|
|
3292
|
+
"$ref": "#/definitions/v1SignRawPayloadResult"
|
|
3293
|
+
},
|
|
3294
|
+
"createPolicyResult": {
|
|
3295
|
+
"$ref": "#/definitions/v1CreatePolicyResult"
|
|
3296
|
+
},
|
|
3297
|
+
"disablePrivateKeyResult": {
|
|
3298
|
+
"$ref": "#/definitions/v1DisablePrivateKeyResult"
|
|
3299
|
+
},
|
|
3300
|
+
"deleteUsersResult": {
|
|
3301
|
+
"$ref": "#/definitions/v1DeleteUsersResult"
|
|
3302
|
+
},
|
|
3303
|
+
"deleteAuthenticatorsResult": {
|
|
3304
|
+
"$ref": "#/definitions/v1DeleteAuthenticatorsResult"
|
|
3305
|
+
},
|
|
3306
|
+
"deleteInvitationResult": {
|
|
3307
|
+
"$ref": "#/definitions/v1DeleteInvitationResult"
|
|
3308
|
+
},
|
|
3309
|
+
"deleteOrganizationResult": {
|
|
3310
|
+
"$ref": "#/definitions/v1DeleteOrganizationResult"
|
|
3311
|
+
},
|
|
3312
|
+
"deletePolicyResult": {
|
|
3313
|
+
"$ref": "#/definitions/v1DeletePolicyResult"
|
|
3314
|
+
},
|
|
3315
|
+
"createUserTagResult": {
|
|
3316
|
+
"$ref": "#/definitions/v1CreateUserTagResult"
|
|
3317
|
+
},
|
|
3318
|
+
"deleteUserTagsResult": {
|
|
3319
|
+
"$ref": "#/definitions/v1DeleteUserTagsResult"
|
|
3320
|
+
},
|
|
3321
|
+
"signTransactionResult": {
|
|
3322
|
+
"$ref": "#/definitions/v1SignTransactionResult"
|
|
3323
|
+
},
|
|
3324
|
+
"deleteApiKeysResult": {
|
|
3325
|
+
"$ref": "#/definitions/v1DeleteApiKeysResult"
|
|
3326
|
+
},
|
|
3327
|
+
"createApiKeysResult": {
|
|
3328
|
+
"$ref": "#/definitions/v1CreateApiKeysResult"
|
|
3329
|
+
},
|
|
3330
|
+
"createPrivateKeyTagResult": {
|
|
3331
|
+
"$ref": "#/definitions/v1CreatePrivateKeyTagResult"
|
|
3332
|
+
},
|
|
3333
|
+
"deletePrivateKeyTagsResult": {
|
|
3334
|
+
"$ref": "#/definitions/v1DeletePrivateKeyTagsResult"
|
|
3335
|
+
},
|
|
3336
|
+
"setPaymentMethodResult": {
|
|
3337
|
+
"$ref": "#/definitions/v1SetPaymentMethodResult"
|
|
3338
|
+
},
|
|
3339
|
+
"activateBillingTierResult": {
|
|
3340
|
+
"$ref": "#/definitions/v1ActivateBillingTierResult"
|
|
3341
|
+
},
|
|
3342
|
+
"deletePaymentMethodResult": {
|
|
3343
|
+
"$ref": "#/definitions/v1DeletePaymentMethodResult"
|
|
3344
|
+
},
|
|
3345
|
+
"createApiOnlyUsersResult": {
|
|
3346
|
+
"$ref": "#/definitions/v1CreateApiOnlyUsersResult"
|
|
3347
|
+
}
|
|
3348
|
+
},
|
|
3349
|
+
"description": "Result of the intended action."
|
|
3350
|
+
},
|
|
3351
|
+
"v1SelectorV2": {
|
|
3352
|
+
"type": "object",
|
|
3353
|
+
"properties": {
|
|
3354
|
+
"subject": {
|
|
3355
|
+
"type": "string"
|
|
3356
|
+
},
|
|
3357
|
+
"operator": {
|
|
3358
|
+
"$ref": "#/definitions/immutableactivityv1Operator"
|
|
3359
|
+
},
|
|
3360
|
+
"targets": {
|
|
3361
|
+
"type": "array",
|
|
3362
|
+
"items": {
|
|
3363
|
+
"type": "string"
|
|
3364
|
+
}
|
|
3365
|
+
}
|
|
3366
|
+
}
|
|
3367
|
+
},
|
|
3368
|
+
"v1SetPaymentMethodIntent": {
|
|
3369
|
+
"type": "object",
|
|
3370
|
+
"properties": {
|
|
3371
|
+
"number": {
|
|
3372
|
+
"type": "string",
|
|
3373
|
+
"description": "The account number of the customer's credit card.",
|
|
3374
|
+
"title": "@inject_tag: validate:\"required,max=16,numeric\""
|
|
3375
|
+
},
|
|
3376
|
+
"cvv": {
|
|
3377
|
+
"type": "string",
|
|
3378
|
+
"description": "The verification digits of the customer's credit card.",
|
|
3379
|
+
"title": "@inject_tag: validate:\"required,max=4,numeric\""
|
|
3380
|
+
},
|
|
3381
|
+
"expiryMonth": {
|
|
3382
|
+
"type": "string",
|
|
3383
|
+
"description": "The month that the credit card expires.",
|
|
3384
|
+
"title": "@inject_tag: validate:\"required,numeric,len=2\""
|
|
3385
|
+
},
|
|
3386
|
+
"expiryYear": {
|
|
3387
|
+
"type": "string",
|
|
3388
|
+
"description": "The year that the credit card expires.",
|
|
3389
|
+
"title": "@inject_tag: validate:\"required,numeric,len=4\""
|
|
3390
|
+
},
|
|
3391
|
+
"cardHolderEmail": {
|
|
3392
|
+
"type": "string",
|
|
3393
|
+
"description": "The email that will receive invoices for the credit card.",
|
|
3394
|
+
"title": "@inject_tag: validate:\"required,email,tk_email\""
|
|
3395
|
+
},
|
|
3396
|
+
"cardHolderName": {
|
|
3397
|
+
"type": "string",
|
|
3398
|
+
"description": "The name associated with the credit card.",
|
|
3399
|
+
"title": "@inject_tag: validate:\"required,tk_label_length\""
|
|
3400
|
+
}
|
|
3401
|
+
},
|
|
3402
|
+
"required": [
|
|
3403
|
+
"number",
|
|
3404
|
+
"cvv",
|
|
3405
|
+
"expiryMonth",
|
|
3406
|
+
"expiryYear",
|
|
3407
|
+
"cardHolderEmail",
|
|
3408
|
+
"cardHolderName"
|
|
3409
|
+
]
|
|
3410
|
+
},
|
|
3411
|
+
"v1SetPaymentMethodResult": {
|
|
3412
|
+
"type": "object",
|
|
3413
|
+
"properties": {
|
|
3414
|
+
"lastFour": {
|
|
3415
|
+
"type": "string",
|
|
3416
|
+
"description": "The last four digits of the credit card added."
|
|
3417
|
+
},
|
|
3418
|
+
"cardHolderName": {
|
|
3419
|
+
"type": "string",
|
|
3420
|
+
"description": "The name associated with the payment method."
|
|
3421
|
+
},
|
|
3422
|
+
"cardHolderEmail": {
|
|
3423
|
+
"type": "string",
|
|
3424
|
+
"description": "The email address associated with the payment method."
|
|
3425
|
+
}
|
|
3426
|
+
},
|
|
3427
|
+
"required": ["lastFour", "cardHolderName", "cardHolderEmail"]
|
|
3428
|
+
},
|
|
3429
|
+
"v1SignRawPayloadIntent": {
|
|
3430
|
+
"type": "object",
|
|
3431
|
+
"properties": {
|
|
3432
|
+
"privateKeyId": {
|
|
3433
|
+
"type": "string",
|
|
3434
|
+
"description": "Unique identifier for a given Private Key.",
|
|
3435
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
3436
|
+
},
|
|
3437
|
+
"payload": {
|
|
3438
|
+
"type": "string",
|
|
3439
|
+
"description": "Raw unsigned payload to be signed.",
|
|
3440
|
+
"title": "@inject_tag: validate:\"required\""
|
|
3441
|
+
},
|
|
3442
|
+
"encoding": {
|
|
3443
|
+
"$ref": "#/definitions/v1PayloadEncoding"
|
|
3444
|
+
},
|
|
3445
|
+
"hashFunction": {
|
|
3446
|
+
"$ref": "#/definitions/v1HashFunction"
|
|
3447
|
+
}
|
|
3448
|
+
},
|
|
3449
|
+
"required": ["privateKeyId", "payload", "encoding", "hashFunction"]
|
|
3450
|
+
},
|
|
3451
|
+
"v1SignRawPayloadRequest": {
|
|
3452
|
+
"type": "object",
|
|
3453
|
+
"properties": {
|
|
3454
|
+
"type": {
|
|
3455
|
+
"type": "string",
|
|
3456
|
+
"enum": ["ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"]
|
|
3457
|
+
},
|
|
3458
|
+
"timestampMs": {
|
|
3459
|
+
"type": "string",
|
|
3460
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3461
|
+
},
|
|
3462
|
+
"organizationId": {
|
|
3463
|
+
"type": "string",
|
|
3464
|
+
"description": "Unique identifier for a given Organization."
|
|
3465
|
+
},
|
|
3466
|
+
"parameters": {
|
|
3467
|
+
"$ref": "#/definitions/v1SignRawPayloadIntent"
|
|
3468
|
+
}
|
|
3469
|
+
},
|
|
3470
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3471
|
+
},
|
|
3472
|
+
"v1SignRawPayloadResult": {
|
|
3473
|
+
"type": "object",
|
|
3474
|
+
"properties": {
|
|
3475
|
+
"r": {
|
|
3476
|
+
"type": "string",
|
|
3477
|
+
"description": "Component of an ECSDA signature."
|
|
3478
|
+
},
|
|
3479
|
+
"s": {
|
|
3480
|
+
"type": "string",
|
|
3481
|
+
"description": "Component of an ECSDA signature."
|
|
3482
|
+
},
|
|
3483
|
+
"v": {
|
|
3484
|
+
"type": "string",
|
|
3485
|
+
"description": "Component of an ECSDA signature."
|
|
3486
|
+
}
|
|
3487
|
+
},
|
|
3488
|
+
"required": ["r", "s", "v"]
|
|
3489
|
+
},
|
|
3490
|
+
"v1SignTransactionIntent": {
|
|
3491
|
+
"type": "object",
|
|
3492
|
+
"properties": {
|
|
3493
|
+
"privateKeyId": {
|
|
3494
|
+
"type": "string",
|
|
3495
|
+
"description": "Unique identifier for a given Private Key.",
|
|
3496
|
+
"title": "@inject_tag: validate:\"required,uuid\""
|
|
3497
|
+
},
|
|
3498
|
+
"unsignedTransaction": {
|
|
3499
|
+
"type": "string",
|
|
3500
|
+
"description": "Raw unsigned transaction to be signed by a particular Private Key.",
|
|
3501
|
+
"title": "@inject_tag: validate:\"required\""
|
|
3502
|
+
},
|
|
3503
|
+
"type": {
|
|
3504
|
+
"$ref": "#/definitions/immutableactivityv1TransactionType"
|
|
3505
|
+
}
|
|
3506
|
+
},
|
|
3507
|
+
"required": ["privateKeyId", "unsignedTransaction", "type"]
|
|
3508
|
+
},
|
|
3509
|
+
"v1SignTransactionRequest": {
|
|
3510
|
+
"type": "object",
|
|
3511
|
+
"properties": {
|
|
3512
|
+
"type": {
|
|
3513
|
+
"type": "string",
|
|
3514
|
+
"enum": ["ACTIVITY_TYPE_SIGN_TRANSACTION"]
|
|
3515
|
+
},
|
|
3516
|
+
"timestampMs": {
|
|
3517
|
+
"type": "string",
|
|
3518
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3519
|
+
},
|
|
3520
|
+
"organizationId": {
|
|
3521
|
+
"type": "string",
|
|
3522
|
+
"description": "Unique identifier for a given Organization."
|
|
3523
|
+
},
|
|
3524
|
+
"parameters": {
|
|
3525
|
+
"$ref": "#/definitions/v1SignTransactionIntent"
|
|
3526
|
+
}
|
|
3527
|
+
},
|
|
3528
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3529
|
+
},
|
|
3530
|
+
"v1SignTransactionResult": {
|
|
3531
|
+
"type": "object",
|
|
3532
|
+
"properties": {
|
|
3533
|
+
"signedTransaction": {
|
|
3534
|
+
"type": "string"
|
|
3535
|
+
}
|
|
3536
|
+
},
|
|
3537
|
+
"required": ["signedTransaction"]
|
|
3538
|
+
},
|
|
3539
|
+
"v1SimpleClientExtensionResults": {
|
|
3540
|
+
"type": "object",
|
|
3541
|
+
"properties": {
|
|
3542
|
+
"appid": {
|
|
3543
|
+
"type": "boolean"
|
|
3544
|
+
},
|
|
3545
|
+
"appidExclude": {
|
|
3546
|
+
"type": "boolean"
|
|
3547
|
+
},
|
|
3548
|
+
"credProps": {
|
|
3549
|
+
"$ref": "#/definitions/v1CredPropsAuthenticationExtensionsClientOutputs"
|
|
3550
|
+
}
|
|
3551
|
+
}
|
|
3552
|
+
},
|
|
3553
|
+
"v1TagType": {
|
|
3554
|
+
"type": "string",
|
|
3555
|
+
"enum": ["TAG_TYPE_USER", "TAG_TYPE_PRIVATE_KEY"]
|
|
3556
|
+
},
|
|
3557
|
+
"v1Timestamp": {
|
|
3558
|
+
"type": "object",
|
|
3559
|
+
"properties": {
|
|
3560
|
+
"seconds": {
|
|
3561
|
+
"type": "string"
|
|
3562
|
+
},
|
|
3563
|
+
"nanos": {
|
|
3564
|
+
"type": "string"
|
|
3565
|
+
}
|
|
3566
|
+
},
|
|
3567
|
+
"required": ["seconds", "nanos"]
|
|
3568
|
+
},
|
|
3569
|
+
"v1User": {
|
|
3570
|
+
"type": "object",
|
|
3571
|
+
"properties": {
|
|
3572
|
+
"userId": {
|
|
3573
|
+
"type": "string",
|
|
3574
|
+
"description": "Unique identifier for a given User."
|
|
3575
|
+
},
|
|
3576
|
+
"userName": {
|
|
3577
|
+
"type": "string",
|
|
3578
|
+
"description": "Human-readable name for a User."
|
|
3579
|
+
},
|
|
3580
|
+
"userEmail": {
|
|
3581
|
+
"type": "string",
|
|
3582
|
+
"description": "The user's email address.",
|
|
3583
|
+
"title": "some users do not have emails (programmatic users)"
|
|
3584
|
+
},
|
|
3585
|
+
"accessType": {
|
|
3586
|
+
"$ref": "#/definitions/externaldatav1AccessType"
|
|
3587
|
+
},
|
|
3588
|
+
"authenticators": {
|
|
3589
|
+
"type": "array",
|
|
3590
|
+
"items": {
|
|
3591
|
+
"$ref": "#/definitions/v1Authenticator"
|
|
3592
|
+
},
|
|
3593
|
+
"description": "A list of Authenticator parameters."
|
|
3594
|
+
},
|
|
3595
|
+
"apiKeys": {
|
|
3596
|
+
"type": "array",
|
|
3597
|
+
"items": {
|
|
3598
|
+
"$ref": "#/definitions/v1ApiKey"
|
|
3599
|
+
},
|
|
3600
|
+
"description": "A list of API Key parameters."
|
|
3601
|
+
},
|
|
3602
|
+
"userTags": {
|
|
3603
|
+
"type": "array",
|
|
3604
|
+
"items": {
|
|
3605
|
+
"type": "string"
|
|
3606
|
+
},
|
|
3607
|
+
"description": "A list of User Tag IDs."
|
|
3608
|
+
},
|
|
3609
|
+
"createdAt": {
|
|
3610
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3611
|
+
},
|
|
3612
|
+
"updatedAt": {
|
|
3613
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3614
|
+
}
|
|
3615
|
+
},
|
|
3616
|
+
"required": [
|
|
3617
|
+
"userId",
|
|
3618
|
+
"userName",
|
|
3619
|
+
"accessType",
|
|
3620
|
+
"authenticators",
|
|
3621
|
+
"apiKeys",
|
|
3622
|
+
"userTags",
|
|
3623
|
+
"createdAt",
|
|
3624
|
+
"updatedAt"
|
|
3625
|
+
]
|
|
3626
|
+
},
|
|
3627
|
+
"v1UserParams": {
|
|
3628
|
+
"type": "object",
|
|
3629
|
+
"properties": {
|
|
3630
|
+
"userName": {
|
|
3631
|
+
"type": "string",
|
|
3632
|
+
"description": "Human-readable name for a User.",
|
|
3633
|
+
"title": "@inject_tag: validate:\"required,tk_label_length,tk_label\""
|
|
3634
|
+
},
|
|
3635
|
+
"userEmail": {
|
|
3636
|
+
"type": "string",
|
|
3637
|
+
"description": "The user's email address.",
|
|
3638
|
+
"title": "@inject_tag: validate:\"omitempty,email,tk_email\""
|
|
3639
|
+
},
|
|
3640
|
+
"accessType": {
|
|
3641
|
+
"$ref": "#/definitions/immutableactivityv1AccessType"
|
|
3642
|
+
},
|
|
3643
|
+
"apiKeys": {
|
|
3644
|
+
"type": "array",
|
|
3645
|
+
"items": {
|
|
3646
|
+
"$ref": "#/definitions/v1ApiKeyParams"
|
|
3647
|
+
},
|
|
3648
|
+
"description": "A list of API Key parameters.",
|
|
3649
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
3650
|
+
},
|
|
3651
|
+
"authenticators": {
|
|
3652
|
+
"type": "array",
|
|
3653
|
+
"items": {
|
|
3654
|
+
"$ref": "#/definitions/v1AuthenticatorParams"
|
|
3655
|
+
},
|
|
3656
|
+
"description": "A list of Authenticator parameters.",
|
|
3657
|
+
"title": "@inject_tag: validate:\"dive\""
|
|
3658
|
+
},
|
|
3659
|
+
"userTags": {
|
|
3660
|
+
"type": "array",
|
|
3661
|
+
"items": {
|
|
3662
|
+
"type": "string"
|
|
3663
|
+
},
|
|
3664
|
+
"description": "A list of User Tag IDs.",
|
|
3665
|
+
"title": "@inject_tag: validate:\"dive,uuid\""
|
|
3666
|
+
}
|
|
3667
|
+
},
|
|
3668
|
+
"required": [
|
|
3669
|
+
"userName",
|
|
3670
|
+
"accessType",
|
|
3671
|
+
"apiKeys",
|
|
3672
|
+
"authenticators",
|
|
3673
|
+
"userTags"
|
|
3674
|
+
]
|
|
3675
|
+
},
|
|
3676
|
+
"v1Vote": {
|
|
3677
|
+
"type": "object",
|
|
3678
|
+
"properties": {
|
|
3679
|
+
"id": {
|
|
3680
|
+
"type": "string",
|
|
3681
|
+
"description": "Unique identifier for a given Vote object."
|
|
3682
|
+
},
|
|
3683
|
+
"userId": {
|
|
3684
|
+
"type": "string",
|
|
3685
|
+
"description": "Unique identifier for a given User."
|
|
3686
|
+
},
|
|
3687
|
+
"user": {
|
|
3688
|
+
"$ref": "#/definitions/v1User"
|
|
3689
|
+
},
|
|
3690
|
+
"activityId": {
|
|
3691
|
+
"type": "string",
|
|
3692
|
+
"description": "Unique identifier for a given Activity object."
|
|
3693
|
+
},
|
|
3694
|
+
"selection": {
|
|
3695
|
+
"type": "string",
|
|
3696
|
+
"enum": ["VOTE_SELECTION_APPROVED", "VOTE_SELECTION_REJECTED"]
|
|
3697
|
+
},
|
|
3698
|
+
"message": {
|
|
3699
|
+
"type": "string",
|
|
3700
|
+
"description": "The raw message being signed within a Vote."
|
|
3701
|
+
},
|
|
3702
|
+
"publicKey": {
|
|
3703
|
+
"type": "string",
|
|
3704
|
+
"description": "The public component of a cryptographic key pair used to sign messages and transactions."
|
|
3705
|
+
},
|
|
3706
|
+
"signature": {
|
|
3707
|
+
"type": "string",
|
|
3708
|
+
"description": "The signature applied to a particular vote."
|
|
3709
|
+
},
|
|
3710
|
+
"scheme": {
|
|
3711
|
+
"type": "string",
|
|
3712
|
+
"description": "Method used to produce a signature."
|
|
3713
|
+
},
|
|
3714
|
+
"createdAt": {
|
|
3715
|
+
"$ref": "#/definitions/v1Timestamp"
|
|
3716
|
+
}
|
|
3717
|
+
},
|
|
3718
|
+
"description": "Object representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.",
|
|
3719
|
+
"required": [
|
|
3720
|
+
"id",
|
|
3721
|
+
"userId",
|
|
3722
|
+
"user",
|
|
3723
|
+
"activityId",
|
|
3724
|
+
"selection",
|
|
3725
|
+
"message",
|
|
3726
|
+
"publicKey",
|
|
3727
|
+
"signature",
|
|
3728
|
+
"scheme",
|
|
3729
|
+
"createdAt"
|
|
3730
|
+
]
|
|
3731
|
+
}
|
|
3732
|
+
},
|
|
3733
|
+
"securityDefinitions": {
|
|
3734
|
+
"ApiKeyAuth": {
|
|
3735
|
+
"type": "apiKey",
|
|
3736
|
+
"name": "X-Stamp",
|
|
3737
|
+
"in": "header"
|
|
3738
|
+
}
|
|
3739
|
+
},
|
|
3740
|
+
"security": [
|
|
3741
|
+
{
|
|
3742
|
+
"ApiKeyAuth": []
|
|
3743
|
+
}
|
|
3744
|
+
],
|
|
3745
|
+
"x-readme": {
|
|
3746
|
+
"explorer-enabled": true,
|
|
3747
|
+
"proxy-enabled": true,
|
|
3748
|
+
"samples-languages": ["curl", "javascript"]
|
|
3749
|
+
}
|
|
3750
|
+
}
|