@turnkey/http 1.0.1 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/README.md +22 -17
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts +548 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts.map +1 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js +938 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js.map +1 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts +1516 -281
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.js +25 -9
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.js.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.swagger.json +437 -706
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts +210 -789
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts.map +1 -1
- package/dist/async.d.ts +20 -1
- package/dist/async.d.ts.map +1 -1
- package/dist/async.js +78 -2
- package/dist/async.js.map +1 -1
- package/dist/base.d.ts +51 -1
- package/dist/base.d.ts.map +1 -1
- package/dist/base.js +27 -5
- package/dist/base.js.map +1 -1
- package/dist/config.d.ts +6 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +6 -0
- package/dist/config.js.map +1 -1
- package/dist/encoding.d.ts +0 -4
- package/dist/encoding.d.ts.map +1 -1
- package/dist/encoding.js +1 -24
- package/dist/encoding.js.map +1 -1
- package/dist/index.d.ts +5 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -4
- package/dist/index.js.map +1 -1
- package/dist/shared.d.ts +1 -27
- package/dist/shared.d.ts.map +1 -1
- package/dist/shared.js +4 -13
- package/dist/shared.js.map +1 -1
- package/dist/universal.d.ts +1 -3
- package/dist/universal.d.ts.map +1 -1
- package/dist/universal.js +2 -10
- package/dist/universal.js.map +1 -1
- package/package.json +5 -3
- package/dist/stamp.node.d.ts +0 -3
- package/dist/stamp.node.d.ts.map +0 -1
- package/dist/stamp.node.js +0 -51
- package/dist/stamp.node.js.map +0 -1
- package/dist/stamp.webcrypto.d.ts +0 -4
- package/dist/stamp.webcrypto.d.ts.map +0 -1
- package/dist/stamp.webcrypto.js +0 -110
- package/dist/stamp.webcrypto.js.map +0 -1
- package/dist/tink/bytes.d.ts +0 -45
- package/dist/tink/bytes.d.ts.map +0 -1
- package/dist/tink/bytes.js +0 -82
- package/dist/tink/bytes.js.map +0 -1
- package/dist/tink/elliptic_curves.d.ts +0 -14
- package/dist/tink/elliptic_curves.d.ts.map +0 -1
- package/dist/tink/elliptic_curves.js +0 -178
- package/dist/tink/elliptic_curves.js.map +0 -1
|
@@ -139,6 +139,10 @@ export type paths = {
|
|
|
139
139
|
/** Set the threshold and members of the root quorum. This must be approved by the current root quorum. */
|
|
140
140
|
post: operations["PublicApiService_UpdateRootQuorum"];
|
|
141
141
|
};
|
|
142
|
+
"/public/v1/submit/update_user": {
|
|
143
|
+
/** Update a User in an existing Organization */
|
|
144
|
+
post: operations["PublicApiService_UpdateUser"];
|
|
145
|
+
};
|
|
142
146
|
"/public/v1/submit/update_user_tag": {
|
|
143
147
|
/** Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail. */
|
|
144
148
|
post: operations["PublicApiService_UpdateUserTag"];
|
|
@@ -163,30 +167,20 @@ export type definitions = {
|
|
|
163
167
|
format?: definitions["externaldatav1AddressFormat"];
|
|
164
168
|
address?: string;
|
|
165
169
|
};
|
|
166
|
-
/**
|
|
167
|
-
* @description - ADDRESS_FORMAT_UNCOMPRESSED: 04<X_COORDINATE><Y_COORDINATE>
|
|
168
|
-
* - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate
|
|
169
|
-
* - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.
|
|
170
|
-
* @enum {string}
|
|
171
|
-
*/
|
|
170
|
+
/** @enum {string} */
|
|
172
171
|
externaldatav1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM";
|
|
173
172
|
/** @enum {string} */
|
|
174
173
|
externaldatav1AuthenticatorTransport: "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID";
|
|
175
|
-
/**
|
|
176
|
-
* @description Cryptographic Curve used to generate a given Private Key.
|
|
177
|
-
* @enum {string}
|
|
178
|
-
*/
|
|
174
|
+
/** @enum {string} */
|
|
179
175
|
externaldatav1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
180
176
|
/** @enum {string} */
|
|
181
177
|
externaldatav1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
182
|
-
/**
|
|
183
|
-
* @description Logical operators.
|
|
184
|
-
* @enum {string}
|
|
185
|
-
*/
|
|
178
|
+
/** @enum {string} */
|
|
186
179
|
externaldatav1Operator: "OPERATOR_EQUAL" | "OPERATOR_MORE_THAN" | "OPERATOR_MORE_THAN_OR_EQUAL" | "OPERATOR_LESS_THAN" | "OPERATOR_LESS_THAN_OR_EQUAL" | "OPERATOR_CONTAINS" | "OPERATOR_NOT_EQUAL" | "OPERATOR_IN" | "OPERATOR_NOT_IN" | "OPERATOR_CONTAINS_ONE" | "OPERATOR_CONTAINS_ALL";
|
|
187
180
|
externaldatav1Selector: {
|
|
188
181
|
/** @description The resource being referenced within a policy (e.g., user.tags or activities.type). */
|
|
189
182
|
subject: string;
|
|
183
|
+
/** @description Logical operators like OPERATOR_CONTAINS or OPERATOR_EQUAL. */
|
|
190
184
|
operator: definitions["externaldatav1Operator"];
|
|
191
185
|
/** @description The specific parameter from the subject being referenced, like a specific user ID. */
|
|
192
186
|
targets: string[];
|
|
@@ -197,17 +191,9 @@ export type definitions = {
|
|
|
197
191
|
format?: definitions["immutableactivityv1AddressFormat"];
|
|
198
192
|
address?: string;
|
|
199
193
|
};
|
|
200
|
-
/**
|
|
201
|
-
* @description - ADDRESS_FORMAT_UNCOMPRESSED: 04<X_COORDINATE><Y_COORDINATE>
|
|
202
|
-
* - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate
|
|
203
|
-
* - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.
|
|
204
|
-
* @enum {string}
|
|
205
|
-
*/
|
|
194
|
+
/** @enum {string} */
|
|
206
195
|
immutableactivityv1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM";
|
|
207
|
-
/**
|
|
208
|
-
* @description Cryptographic Curve used to generate a given Private Key.
|
|
209
|
-
* @enum {string}
|
|
210
|
-
*/
|
|
196
|
+
/** @enum {string} */
|
|
211
197
|
immutableactivityv1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
212
198
|
/** @enum {string} */
|
|
213
199
|
immutableactivityv1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
@@ -218,10 +204,7 @@ export type definitions = {
|
|
|
218
204
|
operator?: definitions["immutableactivityv1Operator"];
|
|
219
205
|
target?: string;
|
|
220
206
|
};
|
|
221
|
-
/**
|
|
222
|
-
* - TRANSACTION_TYPE_ETHEREUM: Unsigned Ethereum transaction, RLP-encoded and hex-encoded
|
|
223
|
-
* @enum {string}
|
|
224
|
-
*/
|
|
207
|
+
/** @enum {string} */
|
|
225
208
|
immutableactivityv1TransactionType: "TRANSACTION_TYPE_ETHEREUM";
|
|
226
209
|
/** @enum {string} */
|
|
227
210
|
immutablewebauthnv1AuthenticatorTransport: "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID";
|
|
@@ -237,29 +220,19 @@ export type definitions = {
|
|
|
237
220
|
details?: definitions["protobufAny"][];
|
|
238
221
|
};
|
|
239
222
|
v1AcceptInvitationIntent: {
|
|
240
|
-
/**
|
|
241
|
-
* @inject_tag: validate:"required,uuid"
|
|
242
|
-
* @description Unique identifier for a given Invitation object.
|
|
243
|
-
*/
|
|
223
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
244
224
|
invitationId: string;
|
|
245
|
-
/**
|
|
246
|
-
* @inject_tag: validate:"required,uuid"
|
|
247
|
-
* @description Unique identifier for a given User.
|
|
248
|
-
*/
|
|
225
|
+
/** @description Unique identifier for a given User. */
|
|
249
226
|
userId: string;
|
|
227
|
+
/** @description WebAuthN hardware devices that can be used to log in to the Turnkey web app. */
|
|
250
228
|
authenticator: definitions["v1AuthenticatorParams"];
|
|
251
229
|
};
|
|
252
230
|
v1AcceptInvitationIntentV2: {
|
|
253
|
-
/**
|
|
254
|
-
* @inject_tag: validate:"required,uuid"
|
|
255
|
-
* @description Unique identifier for a given Invitation object.
|
|
256
|
-
*/
|
|
231
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
257
232
|
invitationId: string;
|
|
258
|
-
/**
|
|
259
|
-
* @inject_tag: validate:"required,uuid"
|
|
260
|
-
* @description Unique identifier for a given User.
|
|
261
|
-
*/
|
|
233
|
+
/** @description Unique identifier for a given User. */
|
|
262
234
|
userId: string;
|
|
235
|
+
/** @description WebAuthN hardware devices that can be used to log in to the Turnkey web app. */
|
|
263
236
|
authenticator: definitions["v1AuthenticatorParamsV2"];
|
|
264
237
|
};
|
|
265
238
|
v1AcceptInvitationResult: {
|
|
@@ -269,25 +242,25 @@ export type definitions = {
|
|
|
269
242
|
userId: string;
|
|
270
243
|
};
|
|
271
244
|
v1ActivateBillingTierIntent: {
|
|
272
|
-
/**
|
|
273
|
-
* @inject_tag: validate:"required"
|
|
274
|
-
* @description The product that the customer wants to subscribe to.
|
|
275
|
-
*/
|
|
245
|
+
/** @description The product that the customer wants to subscribe to. */
|
|
276
246
|
productId: string;
|
|
277
247
|
};
|
|
278
248
|
v1ActivateBillingTierResult: {
|
|
279
249
|
/** @description The id of the product being subscribed to. */
|
|
280
250
|
productId: string;
|
|
281
251
|
};
|
|
282
|
-
/** @description An action that can that can be taken within the Turnkey infrastructure. */
|
|
283
252
|
v1Activity: {
|
|
284
253
|
/** @description Unique identifier for a given Activity object. */
|
|
285
254
|
id: string;
|
|
286
255
|
/** @description Unique identifier for a given Organization. */
|
|
287
256
|
organizationId: string;
|
|
257
|
+
/** @description The current processing status of a specified Activity. */
|
|
288
258
|
status: definitions["v1ActivityStatus"];
|
|
259
|
+
/** @description Type of Activity, such as Add User, or Sign Transaction. */
|
|
289
260
|
type: definitions["v1ActivityType"];
|
|
261
|
+
/** @description Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action. */
|
|
290
262
|
intent: definitions["v1Intent"];
|
|
263
|
+
/** @description Result of the intended action. */
|
|
291
264
|
result: definitions["v1Result"];
|
|
292
265
|
/** @description A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. */
|
|
293
266
|
votes: definitions["v1Vote"][];
|
|
@@ -299,19 +272,15 @@ export type definitions = {
|
|
|
299
272
|
updatedAt: definitions["v1Timestamp"];
|
|
300
273
|
};
|
|
301
274
|
v1ActivityResponse: {
|
|
275
|
+
/** @description An action that can that can be taken within the Turnkey infrastructure. */
|
|
302
276
|
activity: definitions["v1Activity"];
|
|
303
277
|
};
|
|
304
|
-
/**
|
|
305
|
-
* @description The current processing status of an Activity.
|
|
306
|
-
* @enum {string}
|
|
307
|
-
*/
|
|
278
|
+
/** @enum {string} */
|
|
308
279
|
v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
|
|
309
|
-
/**
|
|
310
|
-
|
|
311
|
-
* @enum {string}
|
|
312
|
-
*/
|
|
313
|
-
v1ActivityType: "ACTIVITY_TYPE_CREATE_API_KEYS" | "ACTIVITY_TYPE_CREATE_USERS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD" | "ACTIVITY_TYPE_CREATE_INVITATIONS" | "ACTIVITY_TYPE_ACCEPT_INVITATION" | "ACTIVITY_TYPE_CREATE_POLICY" | "ACTIVITY_TYPE_DISABLE_PRIVATE_KEY" | "ACTIVITY_TYPE_DELETE_USERS" | "ACTIVITY_TYPE_DELETE_API_KEYS" | "ACTIVITY_TYPE_DELETE_INVITATION" | "ACTIVITY_TYPE_DELETE_ORGANIZATION" | "ACTIVITY_TYPE_DELETE_POLICY" | "ACTIVITY_TYPE_CREATE_USER_TAG" | "ACTIVITY_TYPE_DELETE_USER_TAGS" | "ACTIVITY_TYPE_CREATE_ORGANIZATION" | "ACTIVITY_TYPE_SIGN_TRANSACTION" | "ACTIVITY_TYPE_APPROVE_ACTIVITY" | "ACTIVITY_TYPE_REJECT_ACTIVITY" | "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD" | "ACTIVITY_TYPE_ACTIVATE_BILLING_TIER" | "ACTIVITY_TYPE_DELETE_PAYMENT_METHOD" | "ACTIVITY_TYPE_CREATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_POLICY_V3" | "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" | "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" | "ACTIVITY_TYPE_UPDATE_USER_TAG" | "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2" | "ACTIVITY_TYPE_CREATE_ORGANIZATION_V2" | "ACTIVITY_TYPE_CREATE_USERS_V2" | "ACTIVITY_TYPE_ACCEPT_INVITATION_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2" | "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" | "ACTIVITY_TYPE_UPDATE_POLICY";
|
|
280
|
+
/** @enum {string} */
|
|
281
|
+
v1ActivityType: "ACTIVITY_TYPE_CREATE_API_KEYS" | "ACTIVITY_TYPE_CREATE_USERS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD" | "ACTIVITY_TYPE_CREATE_INVITATIONS" | "ACTIVITY_TYPE_ACCEPT_INVITATION" | "ACTIVITY_TYPE_CREATE_POLICY" | "ACTIVITY_TYPE_DISABLE_PRIVATE_KEY" | "ACTIVITY_TYPE_DELETE_USERS" | "ACTIVITY_TYPE_DELETE_API_KEYS" | "ACTIVITY_TYPE_DELETE_INVITATION" | "ACTIVITY_TYPE_DELETE_ORGANIZATION" | "ACTIVITY_TYPE_DELETE_POLICY" | "ACTIVITY_TYPE_CREATE_USER_TAG" | "ACTIVITY_TYPE_DELETE_USER_TAGS" | "ACTIVITY_TYPE_CREATE_ORGANIZATION" | "ACTIVITY_TYPE_SIGN_TRANSACTION" | "ACTIVITY_TYPE_APPROVE_ACTIVITY" | "ACTIVITY_TYPE_REJECT_ACTIVITY" | "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD" | "ACTIVITY_TYPE_ACTIVATE_BILLING_TIER" | "ACTIVITY_TYPE_DELETE_PAYMENT_METHOD" | "ACTIVITY_TYPE_CREATE_POLICY_V2" | "ACTIVITY_TYPE_CREATE_POLICY_V3" | "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" | "ACTIVITY_TYPE_UPDATE_ROOT_QUORUM" | "ACTIVITY_TYPE_UPDATE_USER_TAG" | "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG" | "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2" | "ACTIVITY_TYPE_CREATE_ORGANIZATION_V2" | "ACTIVITY_TYPE_CREATE_USERS_V2" | "ACTIVITY_TYPE_ACCEPT_INVITATION_V2" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2" | "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS" | "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" | "ACTIVITY_TYPE_UPDATE_USER" | "ACTIVITY_TYPE_UPDATE_POLICY" | "ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2";
|
|
314
282
|
v1ApiKey: {
|
|
283
|
+
/** @description A User credential that can be used to authenticate to Turnkey. */
|
|
315
284
|
credential: definitions["v1Credential"];
|
|
316
285
|
/** @description Unique identifier for a given API Key. */
|
|
317
286
|
apiKeyId: string;
|
|
@@ -321,44 +290,23 @@ export type definitions = {
|
|
|
321
290
|
updatedAt: definitions["v1Timestamp"];
|
|
322
291
|
};
|
|
323
292
|
v1ApiKeyParams: {
|
|
324
|
-
/**
|
|
325
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
326
|
-
* @description Human-readable name for an API Key.
|
|
327
|
-
*/
|
|
293
|
+
/** @description Human-readable name for an API Key. */
|
|
328
294
|
apiKeyName: string;
|
|
329
|
-
/**
|
|
330
|
-
* @inject_tag: validate:"hexadecimal,len=66"
|
|
331
|
-
* @description The public component of a cryptographic key pair used to sign messages and transactions.
|
|
332
|
-
*/
|
|
295
|
+
/** @description The public component of a cryptographic key pair used to sign messages and transactions. */
|
|
333
296
|
publicKey: string;
|
|
334
297
|
};
|
|
335
298
|
v1ApiOnlyUserParams: {
|
|
336
|
-
/**
|
|
337
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
338
|
-
* @description The name of the new API-only User.
|
|
339
|
-
*/
|
|
299
|
+
/** @description The name of the new API-only User. */
|
|
340
300
|
userName: string;
|
|
341
|
-
/**
|
|
342
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
343
|
-
* @description The email address for this API-only User (optional).
|
|
344
|
-
*/
|
|
301
|
+
/** @description The email address for this API-only User (optional). */
|
|
345
302
|
userEmail?: string;
|
|
346
|
-
/**
|
|
347
|
-
* @inject_tag: validate:"dive,uuid"
|
|
348
|
-
* @description A list of tags assigned to the new API-only User.
|
|
349
|
-
*/
|
|
303
|
+
/** @description A list of tags assigned to the new API-only User. */
|
|
350
304
|
userTags: string[];
|
|
351
|
-
/**
|
|
352
|
-
* @inject_tag: validate:"dive,uuid"
|
|
353
|
-
* @description A list of API Key parameters.
|
|
354
|
-
*/
|
|
305
|
+
/** @description A list of API Key parameters. */
|
|
355
306
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
356
307
|
};
|
|
357
308
|
v1ApproveActivityIntent: {
|
|
358
|
-
/**
|
|
359
|
-
* @inject_tag: validate:"required"
|
|
360
|
-
* @description An artifact verifying a User's action.
|
|
361
|
-
*/
|
|
309
|
+
/** @description An artifact verifying a User's action. */
|
|
362
310
|
fingerprint: string;
|
|
363
311
|
};
|
|
364
312
|
v1ApproveActivityRequest: {
|
|
@@ -371,20 +319,11 @@ export type definitions = {
|
|
|
371
319
|
parameters: definitions["v1ApproveActivityIntent"];
|
|
372
320
|
};
|
|
373
321
|
v1Attestation: {
|
|
374
|
-
/**
|
|
375
|
-
* @inject_tag: validate:"required,max=256"
|
|
376
|
-
* @description The cbor encoded then base64 url encoded id of the credential.
|
|
377
|
-
*/
|
|
322
|
+
/** @description The cbor encoded then base64 url encoded id of the credential. */
|
|
378
323
|
credentialId: string;
|
|
379
|
-
/**
|
|
380
|
-
* @inject_tag: validate:"required"
|
|
381
|
-
* @description A base64 url encoded payload containing metadata about the signing context and the challenge.
|
|
382
|
-
*/
|
|
324
|
+
/** @description A base64 url encoded payload containing metadata about the signing context and the challenge. */
|
|
383
325
|
clientDataJson: string;
|
|
384
|
-
/**
|
|
385
|
-
* @inject_tag: validate:"required"
|
|
386
|
-
* @description A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
|
|
387
|
-
*/
|
|
326
|
+
/** @description A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. */
|
|
388
327
|
attestationObject: string;
|
|
389
328
|
/** @description The type of authenticator transports. */
|
|
390
329
|
transports: definitions["immutablewebauthnv1AuthenticatorTransport"][];
|
|
@@ -399,6 +338,7 @@ export type definitions = {
|
|
|
399
338
|
credentialId: string;
|
|
400
339
|
/** @description The type of Authenticator device. */
|
|
401
340
|
model: string;
|
|
341
|
+
/** @description A User credential that can be used to authenticate to Turnkey. */
|
|
402
342
|
credential: definitions["v1Credential"];
|
|
403
343
|
/** @description Unique identifier for a given Authenticator. */
|
|
404
344
|
authenticatorId: string;
|
|
@@ -408,55 +348,33 @@ export type definitions = {
|
|
|
408
348
|
updatedAt: definitions["v1Timestamp"];
|
|
409
349
|
};
|
|
410
350
|
v1AuthenticatorAttestationResponse: {
|
|
411
|
-
/** ENCODING: base64url */
|
|
412
351
|
clientDataJson: string;
|
|
413
|
-
/** ENCODING: base64url */
|
|
414
352
|
attestationObject: string;
|
|
415
353
|
transports?: definitions["immutablewebauthnv1AuthenticatorTransport"][];
|
|
416
354
|
/** @enum {string} */
|
|
417
355
|
authenticatorAttachment?: "cross-platform" | "platform" | null;
|
|
418
356
|
};
|
|
419
357
|
v1AuthenticatorParams: {
|
|
420
|
-
/**
|
|
421
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
422
|
-
* @description Human-readable name for an Authenticator.
|
|
423
|
-
*/
|
|
358
|
+
/** @description Human-readable name for an Authenticator. */
|
|
424
359
|
authenticatorName: string;
|
|
425
|
-
/**
|
|
426
|
-
* @inject_tag: validate:"required,uuid"
|
|
427
|
-
* @description Unique identifier for a given User.
|
|
428
|
-
*/
|
|
360
|
+
/** @description Unique identifier for a given User. */
|
|
429
361
|
userId: string;
|
|
430
362
|
attestation: definitions["v1PublicKeyCredentialWithAttestation"];
|
|
431
|
-
/**
|
|
432
|
-
* @inject_tag: validate:"required,max=256"
|
|
433
|
-
* @description Challenge presented for authentication purposes.
|
|
434
|
-
*/
|
|
363
|
+
/** @description Challenge presented for authentication purposes. */
|
|
435
364
|
challenge: string;
|
|
436
365
|
};
|
|
437
366
|
v1AuthenticatorParamsV2: {
|
|
438
|
-
/**
|
|
439
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
440
|
-
* @description Human-readable name for an Authenticator.
|
|
441
|
-
*/
|
|
367
|
+
/** @description Human-readable name for an Authenticator. */
|
|
442
368
|
authenticatorName: string;
|
|
443
|
-
/**
|
|
444
|
-
* @inject_tag: validate:"required,max=256"
|
|
445
|
-
* @description Challenge presented for authentication purposes.
|
|
446
|
-
*/
|
|
369
|
+
/** @description Challenge presented for authentication purposes. */
|
|
447
370
|
challenge: string;
|
|
371
|
+
/** @description The attestation that proves custody of the authenticator and provides metadata about it. */
|
|
448
372
|
attestation: definitions["v1Attestation"];
|
|
449
373
|
};
|
|
450
374
|
v1CreateApiKeysIntent: {
|
|
451
|
-
/**
|
|
452
|
-
* @inject_tag: validate:"dive,required"
|
|
453
|
-
* @description A list of API Keys.
|
|
454
|
-
*/
|
|
375
|
+
/** @description A list of API Keys. */
|
|
455
376
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
456
|
-
/**
|
|
457
|
-
* @inject_tag: validate:"required,uuid"
|
|
458
|
-
* @description Unique identifier for a given User.
|
|
459
|
-
*/
|
|
377
|
+
/** @description Unique identifier for a given User. */
|
|
460
378
|
userId: string;
|
|
461
379
|
};
|
|
462
380
|
v1CreateApiKeysRequest: {
|
|
@@ -473,10 +391,7 @@ export type definitions = {
|
|
|
473
391
|
apiKeyIds: string[];
|
|
474
392
|
};
|
|
475
393
|
v1CreateApiOnlyUsersIntent: {
|
|
476
|
-
/**
|
|
477
|
-
* @inject_tag: validate:"required,dive,required"
|
|
478
|
-
* @description A list of API-only Users to create.
|
|
479
|
-
*/
|
|
394
|
+
/** @description A list of API-only Users to create. */
|
|
480
395
|
apiOnlyUsers: definitions["v1ApiOnlyUserParams"][];
|
|
481
396
|
};
|
|
482
397
|
v1CreateApiOnlyUsersRequest: {
|
|
@@ -493,27 +408,15 @@ export type definitions = {
|
|
|
493
408
|
userIds: string[];
|
|
494
409
|
};
|
|
495
410
|
v1CreateAuthenticatorsIntent: {
|
|
496
|
-
/**
|
|
497
|
-
* @inject_tag: validate:"dive,required"
|
|
498
|
-
* @description A list of Authenticators.
|
|
499
|
-
*/
|
|
411
|
+
/** @description A list of Authenticators. */
|
|
500
412
|
authenticators: definitions["v1AuthenticatorParams"][];
|
|
501
|
-
/**
|
|
502
|
-
* @inject_tag: validate:"required,uuid"
|
|
503
|
-
* @description Unique identifier for a given User.
|
|
504
|
-
*/
|
|
413
|
+
/** @description Unique identifier for a given User. */
|
|
505
414
|
userId: string;
|
|
506
415
|
};
|
|
507
416
|
v1CreateAuthenticatorsIntentV2: {
|
|
508
|
-
/**
|
|
509
|
-
* @inject_tag: validate:"dive,required"
|
|
510
|
-
* @description A list of Authenticators.
|
|
511
|
-
*/
|
|
417
|
+
/** @description A list of Authenticators. */
|
|
512
418
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
513
|
-
/**
|
|
514
|
-
* @inject_tag: validate:"required,uuid"
|
|
515
|
-
* @description Unique identifier for a given User.
|
|
516
|
-
*/
|
|
419
|
+
/** @description Unique identifier for a given User. */
|
|
517
420
|
userId: string;
|
|
518
421
|
};
|
|
519
422
|
v1CreateAuthenticatorsRequest: {
|
|
@@ -530,10 +433,7 @@ export type definitions = {
|
|
|
530
433
|
authenticatorIds: string[];
|
|
531
434
|
};
|
|
532
435
|
v1CreateInvitationsIntent: {
|
|
533
|
-
/**
|
|
534
|
-
* @inject_tag: validate:"required,dive,required"
|
|
535
|
-
* @description A list of Invitations.
|
|
536
|
-
*/
|
|
436
|
+
/** @description A list of Invitations. */
|
|
537
437
|
invitations: definitions["v1InvitationParams"][];
|
|
538
438
|
};
|
|
539
439
|
v1CreateInvitationsRequest: {
|
|
@@ -550,39 +450,23 @@ export type definitions = {
|
|
|
550
450
|
invitationIds: string[];
|
|
551
451
|
};
|
|
552
452
|
v1CreateOrganizationIntent: {
|
|
553
|
-
/**
|
|
554
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
555
|
-
* @description Human-readable name for an Organization.
|
|
556
|
-
*/
|
|
453
|
+
/** @description Human-readable name for an Organization. */
|
|
557
454
|
organizationName: string;
|
|
558
|
-
/**
|
|
559
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
560
|
-
* @description The root user's email address.
|
|
561
|
-
*/
|
|
455
|
+
/** @description The root user's email address. */
|
|
562
456
|
rootEmail: string;
|
|
457
|
+
/** @description The root user's Authenticator. */
|
|
563
458
|
rootAuthenticator: definitions["v1AuthenticatorParams"];
|
|
564
|
-
/**
|
|
565
|
-
* @inject_tag: validate:"uuid"
|
|
566
|
-
* @description Unique identifier for the root user object.
|
|
567
|
-
*/
|
|
459
|
+
/** @description Unique identifier for the root user object. */
|
|
568
460
|
rootUserId?: string;
|
|
569
461
|
};
|
|
570
462
|
v1CreateOrganizationIntentV2: {
|
|
571
|
-
/**
|
|
572
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
573
|
-
* @description Human-readable name for an Organization.
|
|
574
|
-
*/
|
|
463
|
+
/** @description Human-readable name for an Organization. */
|
|
575
464
|
organizationName: string;
|
|
576
|
-
/**
|
|
577
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
578
|
-
* @description The root user's email address.
|
|
579
|
-
*/
|
|
465
|
+
/** @description The root user's email address. */
|
|
580
466
|
rootEmail: string;
|
|
467
|
+
/** @description The root user's Authenticator. */
|
|
581
468
|
rootAuthenticator: definitions["v1AuthenticatorParamsV2"];
|
|
582
|
-
/**
|
|
583
|
-
* @inject_tag: validate:"uuid"
|
|
584
|
-
* @description Unique identifier for the root user object.
|
|
585
|
-
*/
|
|
469
|
+
/** @description Unique identifier for the root user object. */
|
|
586
470
|
rootUserId?: string;
|
|
587
471
|
};
|
|
588
472
|
v1CreateOrganizationResult: {
|
|
@@ -590,39 +474,27 @@ export type definitions = {
|
|
|
590
474
|
organizationId: string;
|
|
591
475
|
};
|
|
592
476
|
v1CreatePolicyIntent: {
|
|
593
|
-
/**
|
|
594
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
595
|
-
* @description Human-readable name for a Policy.
|
|
596
|
-
*/
|
|
477
|
+
/** @description Human-readable name for a Policy. */
|
|
597
478
|
policyName: string;
|
|
598
|
-
/**
|
|
599
|
-
* @inject_tag: validate:"required,dive,required"
|
|
600
|
-
* @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
|
|
601
|
-
*/
|
|
479
|
+
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
602
480
|
selectors: definitions["immutableactivityv1Selector"][];
|
|
481
|
+
/** @description The instruction to DENY or ALLOW a particular activity following policy selector(s). */
|
|
603
482
|
effect: definitions["immutableactivityv1Effect"];
|
|
604
483
|
notes?: string;
|
|
605
484
|
};
|
|
606
485
|
v1CreatePolicyIntentV2: {
|
|
607
|
-
/**
|
|
608
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
609
|
-
* @description Human-readable name for a Policy.
|
|
610
|
-
*/
|
|
486
|
+
/** @description Human-readable name for a Policy. */
|
|
611
487
|
policyName: string;
|
|
612
|
-
/**
|
|
613
|
-
* @inject_tag: validate:"required,dive,required"
|
|
614
|
-
* @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
|
|
615
|
-
*/
|
|
488
|
+
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
616
489
|
selectors: definitions["v1SelectorV2"][];
|
|
490
|
+
/** @description Whether to ALLOW or DENY requests that match the condition and consensus requirements. */
|
|
617
491
|
effect: definitions["immutableactivityv1Effect"];
|
|
618
492
|
notes?: string;
|
|
619
493
|
};
|
|
620
494
|
v1CreatePolicyIntentV3: {
|
|
621
|
-
/**
|
|
622
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
623
|
-
* @description Human-readable name for a Policy.
|
|
624
|
-
*/
|
|
495
|
+
/** @description Human-readable name for a Policy. */
|
|
625
496
|
policyName: string;
|
|
497
|
+
/** @description The instruction to DENY or ALLOW an activity. */
|
|
626
498
|
effect: definitions["immutableactivityv1Effect"];
|
|
627
499
|
/** @description The condition expression that triggers the Effect */
|
|
628
500
|
condition?: string;
|
|
@@ -644,15 +516,9 @@ export type definitions = {
|
|
|
644
516
|
policyId: string;
|
|
645
517
|
};
|
|
646
518
|
v1CreatePrivateKeyTagIntent: {
|
|
647
|
-
/**
|
|
648
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
649
|
-
* @description Human-readable name for a Private Key Tag.
|
|
650
|
-
*/
|
|
519
|
+
/** @description Human-readable name for a Private Key Tag. */
|
|
651
520
|
privateKeyTagName: string;
|
|
652
|
-
/**
|
|
653
|
-
* @inject_tag: validate:"dive,uuid"
|
|
654
|
-
* @description A list of Private Key IDs.
|
|
655
|
-
*/
|
|
521
|
+
/** @description A list of Private Key IDs. */
|
|
656
522
|
privateKeyIds: string[];
|
|
657
523
|
};
|
|
658
524
|
v1CreatePrivateKeyTagRequest: {
|
|
@@ -671,17 +537,11 @@ export type definitions = {
|
|
|
671
537
|
privateKeyIds: string[];
|
|
672
538
|
};
|
|
673
539
|
v1CreatePrivateKeysIntent: {
|
|
674
|
-
/**
|
|
675
|
-
* @inject_tag: validate:"dive,required"
|
|
676
|
-
* @description A list of Private Keys.
|
|
677
|
-
*/
|
|
540
|
+
/** @description A list of Private Keys. */
|
|
678
541
|
privateKeys: definitions["v1PrivateKeyParams"][];
|
|
679
542
|
};
|
|
680
543
|
v1CreatePrivateKeysIntentV2: {
|
|
681
|
-
/**
|
|
682
|
-
* @inject_tag: validate:"dive,required"
|
|
683
|
-
* @description A list of Private Keys.
|
|
684
|
-
*/
|
|
544
|
+
/** @description A list of Private Keys. */
|
|
685
545
|
privateKeys: definitions["v1PrivateKeyParams"][];
|
|
686
546
|
};
|
|
687
547
|
v1CreatePrivateKeysRequest: {
|
|
@@ -702,26 +562,17 @@ export type definitions = {
|
|
|
702
562
|
privateKeys: definitions["v1PrivateKeyResult"][];
|
|
703
563
|
};
|
|
704
564
|
v1CreateSubOrganizationIntent: {
|
|
705
|
-
/**
|
|
706
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
707
|
-
* @description Name for this sub-organization
|
|
708
|
-
*/
|
|
565
|
+
/** @description Name for this sub-organization */
|
|
709
566
|
name: string;
|
|
567
|
+
/** @description Root User authenticator for this new sub-organization */
|
|
710
568
|
rootAuthenticator: definitions["v1AuthenticatorParamsV2"];
|
|
711
569
|
};
|
|
712
570
|
v1CreateSubOrganizationIntentV2: {
|
|
713
|
-
/**
|
|
714
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
715
|
-
* @description Name for this sub-organization
|
|
716
|
-
*/
|
|
571
|
+
/** @description Name for this sub-organization */
|
|
717
572
|
subOrganizationName: string;
|
|
718
|
-
/**
|
|
719
|
-
* @inject_tag: validate:"required"
|
|
720
|
-
* @description Root users to create within this sub-organization
|
|
721
|
-
*/
|
|
573
|
+
/** @description Root users to create within this sub-organization */
|
|
722
574
|
rootUsers: definitions["v1RootUserParams"][];
|
|
723
575
|
/**
|
|
724
|
-
* @inject_tag: validate:"required"
|
|
725
576
|
* Format: int32
|
|
726
577
|
* @description The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
|
|
727
578
|
*/
|
|
@@ -740,15 +591,9 @@ export type definitions = {
|
|
|
740
591
|
subOrganizationId: string;
|
|
741
592
|
};
|
|
742
593
|
v1CreateUserTagIntent: {
|
|
743
|
-
/**
|
|
744
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
745
|
-
* @description Human-readable name for a User Tag.
|
|
746
|
-
*/
|
|
594
|
+
/** @description Human-readable name for a User Tag. */
|
|
747
595
|
userTagName: string;
|
|
748
|
-
/**
|
|
749
|
-
* @inject_tag: validate:"dive,uuid"
|
|
750
|
-
* @description A list of User IDs.
|
|
751
|
-
*/
|
|
596
|
+
/** @description A list of User IDs. */
|
|
752
597
|
userIds: string[];
|
|
753
598
|
};
|
|
754
599
|
v1CreateUserTagRequest: {
|
|
@@ -767,17 +612,11 @@ export type definitions = {
|
|
|
767
612
|
userIds: string[];
|
|
768
613
|
};
|
|
769
614
|
v1CreateUsersIntent: {
|
|
770
|
-
/**
|
|
771
|
-
* @inject_tag: validate:"required,dive,required"
|
|
772
|
-
* @description A list of Users.
|
|
773
|
-
*/
|
|
615
|
+
/** @description A list of Users. */
|
|
774
616
|
users: definitions["v1UserParams"][];
|
|
775
617
|
};
|
|
776
618
|
v1CreateUsersIntentV2: {
|
|
777
|
-
/**
|
|
778
|
-
* @inject_tag: validate:"required,dive,required"
|
|
779
|
-
* @description A list of Users.
|
|
780
|
-
*/
|
|
619
|
+
/** @description A list of Users. */
|
|
781
620
|
users: definitions["v1UserParamsV2"][];
|
|
782
621
|
};
|
|
783
622
|
v1CreateUsersRequest: {
|
|
@@ -804,15 +643,9 @@ export type definitions = {
|
|
|
804
643
|
/** @enum {string} */
|
|
805
644
|
v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256";
|
|
806
645
|
v1DeleteApiKeysIntent: {
|
|
807
|
-
/**
|
|
808
|
-
* @inject_tag: validate:"required,uuid"
|
|
809
|
-
* @description Unique identifier for a given User.
|
|
810
|
-
*/
|
|
646
|
+
/** @description Unique identifier for a given User. */
|
|
811
647
|
userId: string;
|
|
812
|
-
/**
|
|
813
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
814
|
-
* @description A list of API Key IDs.
|
|
815
|
-
*/
|
|
648
|
+
/** @description A list of API Key IDs. */
|
|
816
649
|
apiKeyIds: string[];
|
|
817
650
|
};
|
|
818
651
|
v1DeleteApiKeysRequest: {
|
|
@@ -829,15 +662,9 @@ export type definitions = {
|
|
|
829
662
|
apiKeyIds: string[];
|
|
830
663
|
};
|
|
831
664
|
v1DeleteAuthenticatorsIntent: {
|
|
832
|
-
/**
|
|
833
|
-
* @inject_tag: validate:"required,uuid"
|
|
834
|
-
* @description Unique identifier for a given User.
|
|
835
|
-
*/
|
|
665
|
+
/** @description Unique identifier for a given User. */
|
|
836
666
|
userId: string;
|
|
837
|
-
/**
|
|
838
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
839
|
-
* @description A list of Authenticator IDs.
|
|
840
|
-
*/
|
|
667
|
+
/** @description A list of Authenticator IDs. */
|
|
841
668
|
authenticatorIds: string[];
|
|
842
669
|
};
|
|
843
670
|
v1DeleteAuthenticatorsRequest: {
|
|
@@ -854,10 +681,7 @@ export type definitions = {
|
|
|
854
681
|
authenticatorIds: string[];
|
|
855
682
|
};
|
|
856
683
|
v1DeleteInvitationIntent: {
|
|
857
|
-
/**
|
|
858
|
-
* @inject_tag: validate:"required,uuid"
|
|
859
|
-
* @description Unique identifier for a given Invitation object.
|
|
860
|
-
*/
|
|
684
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
861
685
|
invitationId: string;
|
|
862
686
|
};
|
|
863
687
|
v1DeleteInvitationRequest: {
|
|
@@ -874,10 +698,7 @@ export type definitions = {
|
|
|
874
698
|
invitationId: string;
|
|
875
699
|
};
|
|
876
700
|
v1DeleteOrganizationIntent: {
|
|
877
|
-
/**
|
|
878
|
-
* @inject_tag: validate:"required,uuid"
|
|
879
|
-
* @description Unique identifier for a given Organization.
|
|
880
|
-
*/
|
|
701
|
+
/** @description Unique identifier for a given Organization. */
|
|
881
702
|
organizationId: string;
|
|
882
703
|
};
|
|
883
704
|
v1DeleteOrganizationResult: {
|
|
@@ -893,10 +714,7 @@ export type definitions = {
|
|
|
893
714
|
paymentMethodId: string;
|
|
894
715
|
};
|
|
895
716
|
v1DeletePolicyIntent: {
|
|
896
|
-
/**
|
|
897
|
-
* @inject_tag: validate:"required,uuid"
|
|
898
|
-
* @description Unique identifier for a given Policy.
|
|
899
|
-
*/
|
|
717
|
+
/** @description Unique identifier for a given Policy. */
|
|
900
718
|
policyId: string;
|
|
901
719
|
};
|
|
902
720
|
v1DeletePolicyRequest: {
|
|
@@ -913,10 +731,7 @@ export type definitions = {
|
|
|
913
731
|
policyId: string;
|
|
914
732
|
};
|
|
915
733
|
v1DeletePrivateKeyTagsIntent: {
|
|
916
|
-
/**
|
|
917
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
918
|
-
* @description A list of Private Key Tag IDs.
|
|
919
|
-
*/
|
|
734
|
+
/** @description A list of Private Key Tag IDs. */
|
|
920
735
|
privateKeyTagIds: string[];
|
|
921
736
|
};
|
|
922
737
|
v1DeletePrivateKeyTagsResult: {
|
|
@@ -926,10 +741,7 @@ export type definitions = {
|
|
|
926
741
|
privateKeyIds: string[];
|
|
927
742
|
};
|
|
928
743
|
v1DeleteUserTagsIntent: {
|
|
929
|
-
/**
|
|
930
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
931
|
-
* @description A list of User Tag IDs.
|
|
932
|
-
*/
|
|
744
|
+
/** @description A list of User Tag IDs. */
|
|
933
745
|
userTagIds: string[];
|
|
934
746
|
};
|
|
935
747
|
v1DeleteUserTagsResult: {
|
|
@@ -939,10 +751,7 @@ export type definitions = {
|
|
|
939
751
|
userIds: string[];
|
|
940
752
|
};
|
|
941
753
|
v1DeleteUsersIntent: {
|
|
942
|
-
/**
|
|
943
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
944
|
-
* @description A list of User IDs.
|
|
945
|
-
*/
|
|
754
|
+
/** @description A list of User IDs. */
|
|
946
755
|
userIds: string[];
|
|
947
756
|
};
|
|
948
757
|
v1DeleteUsersResult: {
|
|
@@ -950,10 +759,7 @@ export type definitions = {
|
|
|
950
759
|
userIds: string[];
|
|
951
760
|
};
|
|
952
761
|
v1DisablePrivateKeyIntent: {
|
|
953
|
-
/**
|
|
954
|
-
* @inject_tag: validate:"required,uuid"
|
|
955
|
-
* @description Unique identifier for a given Private Key.
|
|
956
|
-
*/
|
|
762
|
+
/** @description Unique identifier for a given Private Key. */
|
|
957
763
|
privateKeyId: string;
|
|
958
764
|
};
|
|
959
765
|
v1DisablePrivateKeyResult: {
|
|
@@ -965,6 +771,7 @@ export type definitions = {
|
|
|
965
771
|
organizationId: string;
|
|
966
772
|
/** @description Array of Activity Statuses filtering which Activities will be listed in the response. */
|
|
967
773
|
filterByStatus?: definitions["v1ActivityStatus"][];
|
|
774
|
+
/** @description Parameters used for cursor-based pagination. */
|
|
968
775
|
paginationOptions?: definitions["v1Pagination"];
|
|
969
776
|
/** @description Array of Activity Types filtering which Activities will be listed in the response. */
|
|
970
777
|
filterByType?: definitions["v1ActivityType"][];
|
|
@@ -986,6 +793,7 @@ export type definitions = {
|
|
|
986
793
|
authenticatorId: string;
|
|
987
794
|
};
|
|
988
795
|
v1GetAuthenticatorResponse: {
|
|
796
|
+
/** @description An authenticator. */
|
|
989
797
|
authenticator: definitions["v1Authenticator"];
|
|
990
798
|
};
|
|
991
799
|
v1GetAuthenticatorsRequest: {
|
|
@@ -1003,6 +811,7 @@ export type definitions = {
|
|
|
1003
811
|
organizationId: string;
|
|
1004
812
|
};
|
|
1005
813
|
v1GetOrganizationResponse: {
|
|
814
|
+
/** @description Object representing the full current and deleted / disabled collection of Users, Policies, Private Keys, and Invitations attributable to a particular Organization. */
|
|
1006
815
|
organizationData: definitions["v1OrganizationData"];
|
|
1007
816
|
};
|
|
1008
817
|
v1GetPoliciesRequest: {
|
|
@@ -1020,6 +829,7 @@ export type definitions = {
|
|
|
1020
829
|
policyId: string;
|
|
1021
830
|
};
|
|
1022
831
|
v1GetPolicyResponse: {
|
|
832
|
+
/** @description Object that codifies rules defining the actions that are permissible within an Organization. */
|
|
1023
833
|
policy: definitions["v1Policy"];
|
|
1024
834
|
};
|
|
1025
835
|
v1GetPrivateKeyRequest: {
|
|
@@ -1029,6 +839,7 @@ export type definitions = {
|
|
|
1029
839
|
privateKeyId: string;
|
|
1030
840
|
};
|
|
1031
841
|
v1GetPrivateKeyResponse: {
|
|
842
|
+
/** @description Cryptographic public/private key pair that can be used for cryptocurrency needs or more generalized encryption. */
|
|
1032
843
|
privateKey: definitions["v1PrivateKey"];
|
|
1033
844
|
};
|
|
1034
845
|
v1GetPrivateKeysRequest: {
|
|
@@ -1046,6 +857,7 @@ export type definitions = {
|
|
|
1046
857
|
userId: string;
|
|
1047
858
|
};
|
|
1048
859
|
v1GetUserResponse: {
|
|
860
|
+
/** @description Web and/or API user within your Organization. */
|
|
1049
861
|
user: definitions["v1User"];
|
|
1050
862
|
};
|
|
1051
863
|
v1GetUsersRequest: {
|
|
@@ -1070,18 +882,8 @@ export type definitions = {
|
|
|
1070
882
|
/** @description Human-readable name for a User. */
|
|
1071
883
|
username: string;
|
|
1072
884
|
};
|
|
1073
|
-
/**
|
|
1074
|
-
* @description - HASH_FUNCTION_UNSPECIFIED: Default value if a hash function is not set explicitly.
|
|
1075
|
-
* - HASH_FUNCTION_NO_OP: No-op function. Useful if you want to pass raw digests to sign (ECDSA-only)
|
|
1076
|
-
* - HASH_FUNCTION_SHA256: Standard SHA-256. Used in the Bitcoin ecosystem.
|
|
1077
|
-
* - HASH_FUNCTION_KECCAK256: Keccak-256 (not the same as NIST SHA-3!).
|
|
1078
|
-
* This is the hash function used in the Ethereum ecosystem.
|
|
1079
|
-
* - HASH_FUNCTION_NOT_APPLICABLE: Callers must use this enum value when signing with ed25519 keys.
|
|
1080
|
-
* This is because, unlike ECDSA, EdDSA's API does not support signing raw digests (see RFC 8032).
|
|
1081
|
-
* @enum {string}
|
|
1082
|
-
*/
|
|
885
|
+
/** @enum {string} */
|
|
1083
886
|
v1HashFunction: "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE";
|
|
1084
|
-
/** @description Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action. */
|
|
1085
887
|
v1Intent: {
|
|
1086
888
|
createOrganizationIntent: definitions["v1CreateOrganizationIntent"];
|
|
1087
889
|
createAuthenticatorsIntent?: definitions["v1CreateAuthenticatorsIntent"];
|
|
@@ -1123,7 +925,9 @@ export type definitions = {
|
|
|
1123
925
|
createSubOrganizationIntentV2?: definitions["v1CreateSubOrganizationIntentV2"];
|
|
1124
926
|
updateAllowedOriginsIntent?: definitions["v1UpdateAllowedOriginsIntent"];
|
|
1125
927
|
createPrivateKeysIntentV2?: definitions["v1CreatePrivateKeysIntentV2"];
|
|
928
|
+
updateUserIntent?: definitions["v1UpdateUserIntent"];
|
|
1126
929
|
updatePolicyIntent?: definitions["v1UpdatePolicyIntent"];
|
|
930
|
+
setPaymentMethodIntentV2?: definitions["v1SetPaymentMethodIntentV2"];
|
|
1127
931
|
};
|
|
1128
932
|
v1Invitation: {
|
|
1129
933
|
/** @description Unique identifier for a given Invitation object. */
|
|
@@ -1134,7 +938,9 @@ export type definitions = {
|
|
|
1134
938
|
receiverEmail: string;
|
|
1135
939
|
/** @description A list of tags assigned to the Invitation recipient. */
|
|
1136
940
|
receiverUserTags: string[];
|
|
941
|
+
/** @description The User's permissible access method(s). */
|
|
1137
942
|
accessType: definitions["externaldatav1AccessType"];
|
|
943
|
+
/** @description The current processing status of a specified Invitation. */
|
|
1138
944
|
status: definitions["v1InvitationStatus"];
|
|
1139
945
|
createdAt: definitions["v1Timestamp"];
|
|
1140
946
|
updatedAt: definitions["v1Timestamp"];
|
|
@@ -1142,26 +948,15 @@ export type definitions = {
|
|
|
1142
948
|
senderUserId: string;
|
|
1143
949
|
};
|
|
1144
950
|
v1InvitationParams: {
|
|
1145
|
-
/**
|
|
1146
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1147
|
-
* @description The name of the intended Invitation recipient.
|
|
1148
|
-
*/
|
|
951
|
+
/** @description The name of the intended Invitation recipient. */
|
|
1149
952
|
receiverUserName: string;
|
|
1150
|
-
/**
|
|
1151
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
1152
|
-
* @description The email address of the intended Invitation recipient.
|
|
1153
|
-
*/
|
|
953
|
+
/** @description The email address of the intended Invitation recipient. */
|
|
1154
954
|
receiverUserEmail: string;
|
|
1155
|
-
/**
|
|
1156
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1157
|
-
* @description A list of tags assigned to the Invitation recipient.
|
|
1158
|
-
*/
|
|
955
|
+
/** @description A list of tags assigned to the Invitation recipient. */
|
|
1159
956
|
receiverUserTags: string[];
|
|
957
|
+
/** @description The User's permissible access method(s). */
|
|
1160
958
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1161
|
-
/**
|
|
1162
|
-
* @inject_tag: validate:"required,uuid"
|
|
1163
|
-
* @description Unique identifier for the Sender of an Invitation.
|
|
1164
|
-
*/
|
|
959
|
+
/** @description Unique identifier for the Sender of an Invitation. */
|
|
1165
960
|
senderUserId: string;
|
|
1166
961
|
};
|
|
1167
962
|
/** @enum {string} */
|
|
@@ -1169,10 +964,6 @@ export type definitions = {
|
|
|
1169
964
|
v1NOOPCodegenAnchorResponse: {
|
|
1170
965
|
stamp: definitions["v1WebAuthnStamp"];
|
|
1171
966
|
};
|
|
1172
|
-
/**
|
|
1173
|
-
* @description This proto definition is used in our external-facing APIs.
|
|
1174
|
-
* It's important to leverage annotations because they're used in our external interfaces.
|
|
1175
|
-
*/
|
|
1176
967
|
v1OrganizationData: {
|
|
1177
968
|
organizationId?: string;
|
|
1178
969
|
name?: string;
|
|
@@ -1186,31 +977,21 @@ export type definitions = {
|
|
|
1186
977
|
allowedOrigins?: string[];
|
|
1187
978
|
};
|
|
1188
979
|
v1Pagination: {
|
|
1189
|
-
/**
|
|
1190
|
-
|
|
1191
|
-
* @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10 if omitted or set to 0.
|
|
1192
|
-
*/
|
|
1193
|
-
limit?: number;
|
|
980
|
+
/** @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10. */
|
|
981
|
+
limit?: string;
|
|
1194
982
|
/** @description A pagination cursor. This is an object ID that enables you to fetch all objects before this ID. */
|
|
1195
983
|
before?: string;
|
|
1196
984
|
/** @description A pagination cursor. This is an object ID that enables you to fetch all objects after this ID. */
|
|
1197
985
|
after?: string;
|
|
1198
986
|
};
|
|
1199
|
-
/**
|
|
1200
|
-
* - PAYLOAD_ENCODING_UNSPECIFIED: Default value if payload encoding is not set explicitly
|
|
1201
|
-
* - PAYLOAD_ENCODING_HEXADECIMAL: Payload is encoded in hexadecimal
|
|
1202
|
-
* We accept 0x-prefixed or non-0x prefixed payloads.
|
|
1203
|
-
* We accept any casing (uppercase, lowercase, or mixed)
|
|
1204
|
-
* - PAYLOAD_ENCODING_TEXT_UTF8: Payload is encoded as utf-8 text
|
|
1205
|
-
* Will be converted to bytes for signature with Rust's standard String.as_bytes()
|
|
1206
|
-
* @enum {string}
|
|
1207
|
-
*/
|
|
987
|
+
/** @enum {string} */
|
|
1208
988
|
v1PayloadEncoding: "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8";
|
|
1209
989
|
v1Policy: {
|
|
1210
990
|
/** @description Unique identifier for a given Policy. */
|
|
1211
991
|
policyId: string;
|
|
1212
992
|
/** @description Human-readable name for a Policy. */
|
|
1213
993
|
policyName: string;
|
|
994
|
+
/** @description The instruction to DENY or ALLOW a particular activity following policy selector(s). */
|
|
1214
995
|
effect: definitions["externaldatav1Effect"];
|
|
1215
996
|
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
1216
997
|
selectors: definitions["externaldatav1Selector"][];
|
|
@@ -1230,6 +1011,7 @@ export type definitions = {
|
|
|
1230
1011
|
publicKey: string;
|
|
1231
1012
|
/** @description Human-readable name for a Private Key. */
|
|
1232
1013
|
privateKeyName: string;
|
|
1014
|
+
/** @description Cryptographic Curve used to generate a given Private Key. */
|
|
1233
1015
|
curve: definitions["externaldatav1Curve"];
|
|
1234
1016
|
/** @description Derived cryptocurrency addresses for a given Private Key. */
|
|
1235
1017
|
addresses: definitions["externaldatav1Address"][];
|
|
@@ -1238,21 +1020,13 @@ export type definitions = {
|
|
|
1238
1020
|
createdAt: definitions["v1Timestamp"];
|
|
1239
1021
|
};
|
|
1240
1022
|
v1PrivateKeyParams: {
|
|
1241
|
-
/**
|
|
1242
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1243
|
-
* @description Human-readable name for a Private Key.
|
|
1244
|
-
*/
|
|
1023
|
+
/** @description Human-readable name for a Private Key. */
|
|
1245
1024
|
privateKeyName: string;
|
|
1025
|
+
/** @description Cryptographic Curve used to generate a given Private Key. */
|
|
1246
1026
|
curve: definitions["immutableactivityv1Curve"];
|
|
1247
|
-
/**
|
|
1248
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1249
|
-
* @description A list of Private Key Tag IDs.
|
|
1250
|
-
*/
|
|
1027
|
+
/** @description A list of Private Key Tag IDs. */
|
|
1251
1028
|
privateKeyTags: string[];
|
|
1252
|
-
/**
|
|
1253
|
-
* @inject_tag: validate:"dive"
|
|
1254
|
-
* @description Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
|
|
1255
|
-
*/
|
|
1029
|
+
/** @description Cryptocurrency-specific formats for a derived address (e.g., Ethereum). */
|
|
1256
1030
|
addressFormats: definitions["immutableactivityv1AddressFormat"][];
|
|
1257
1031
|
};
|
|
1258
1032
|
v1PrivateKeyResult: {
|
|
@@ -1261,12 +1035,8 @@ export type definitions = {
|
|
|
1261
1035
|
};
|
|
1262
1036
|
v1PublicKeyCredentialWithAttestation: {
|
|
1263
1037
|
id: string;
|
|
1264
|
-
/**
|
|
1265
|
-
* Must be literal string "public-key"
|
|
1266
|
-
* @enum {string}
|
|
1267
|
-
*/
|
|
1038
|
+
/** @enum {string} */
|
|
1268
1039
|
type: "public-key";
|
|
1269
|
-
/** ENCODING: base64url */
|
|
1270
1040
|
rawId: string;
|
|
1271
1041
|
/** @enum {string} */
|
|
1272
1042
|
authenticatorAttachment?: "cross-platform" | "platform" | null;
|
|
@@ -1283,10 +1053,7 @@ export type definitions = {
|
|
|
1283
1053
|
userIds: string[];
|
|
1284
1054
|
};
|
|
1285
1055
|
v1RejectActivityIntent: {
|
|
1286
|
-
/**
|
|
1287
|
-
* @inject_tag: validate:"required"
|
|
1288
|
-
* @description An artifact verifying a User's action.
|
|
1289
|
-
*/
|
|
1056
|
+
/** @description An artifact verifying a User's action. */
|
|
1290
1057
|
fingerprint: string;
|
|
1291
1058
|
};
|
|
1292
1059
|
v1RejectActivityRequest: {
|
|
@@ -1298,7 +1065,6 @@ export type definitions = {
|
|
|
1298
1065
|
organizationId: string;
|
|
1299
1066
|
parameters: definitions["v1RejectActivityIntent"];
|
|
1300
1067
|
};
|
|
1301
|
-
/** @description Result of the intended action. */
|
|
1302
1068
|
v1Result: {
|
|
1303
1069
|
createOrganizationResult?: definitions["v1CreateOrganizationResult"];
|
|
1304
1070
|
createAuthenticatorsResult?: definitions["v1CreateAuthenticatorsResult"];
|
|
@@ -1331,28 +1097,17 @@ export type definitions = {
|
|
|
1331
1097
|
createSubOrganizationResult?: definitions["v1CreateSubOrganizationResult"];
|
|
1332
1098
|
updateAllowedOriginsResult?: definitions["v1UpdateAllowedOriginsResult"];
|
|
1333
1099
|
createPrivateKeysResultV2?: definitions["v1CreatePrivateKeysResultV2"];
|
|
1100
|
+
updateUserResult?: definitions["v1UpdateUserResult"];
|
|
1334
1101
|
updatePolicyResult?: definitions["v1UpdatePolicyResult"];
|
|
1335
1102
|
};
|
|
1336
1103
|
v1RootUserParams: {
|
|
1337
|
-
/**
|
|
1338
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1339
|
-
* @description Human-readable name for a User.
|
|
1340
|
-
*/
|
|
1104
|
+
/** @description Human-readable name for a User. */
|
|
1341
1105
|
userName: string;
|
|
1342
|
-
/**
|
|
1343
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1344
|
-
* @description The user's email address.
|
|
1345
|
-
*/
|
|
1106
|
+
/** @description The user's email address. */
|
|
1346
1107
|
userEmail?: string;
|
|
1347
|
-
/**
|
|
1348
|
-
* @inject_tag: validate:"dive"
|
|
1349
|
-
* @description A list of API Key parameters.
|
|
1350
|
-
*/
|
|
1108
|
+
/** @description A list of API Key parameters. */
|
|
1351
1109
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1352
|
-
/**
|
|
1353
|
-
* @inject_tag: validate:"dive"
|
|
1354
|
-
* @description A list of Authenticator parameters.
|
|
1355
|
-
*/
|
|
1110
|
+
/** @description A list of Authenticator parameters. */
|
|
1356
1111
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
1357
1112
|
};
|
|
1358
1113
|
v1SelectorV2: {
|
|
@@ -1361,35 +1116,25 @@ export type definitions = {
|
|
|
1361
1116
|
targets?: string[];
|
|
1362
1117
|
};
|
|
1363
1118
|
v1SetPaymentMethodIntent: {
|
|
1364
|
-
/**
|
|
1365
|
-
* @inject_tag: validate:"required,max=16,numeric"
|
|
1366
|
-
* @description The account number of the customer's credit card.
|
|
1367
|
-
*/
|
|
1119
|
+
/** @description The account number of the customer's credit card. */
|
|
1368
1120
|
number: string;
|
|
1369
|
-
/**
|
|
1370
|
-
* @inject_tag: validate:"required,max=4,numeric"
|
|
1371
|
-
* @description The verification digits of the customer's credit card.
|
|
1372
|
-
*/
|
|
1121
|
+
/** @description The verification digits of the customer's credit card. */
|
|
1373
1122
|
cvv: string;
|
|
1374
|
-
/**
|
|
1375
|
-
* @inject_tag: validate:"required,numeric,len=2"
|
|
1376
|
-
* @description The month that the credit card expires.
|
|
1377
|
-
*/
|
|
1123
|
+
/** @description The month that the credit card expires. */
|
|
1378
1124
|
expiryMonth: string;
|
|
1379
|
-
/**
|
|
1380
|
-
* @inject_tag: validate:"required,numeric,len=4"
|
|
1381
|
-
* @description The year that the credit card expires.
|
|
1382
|
-
*/
|
|
1125
|
+
/** @description The year that the credit card expires. */
|
|
1383
1126
|
expiryYear: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
1386
|
-
* @description The email that will receive invoices for the credit card.
|
|
1387
|
-
*/
|
|
1127
|
+
/** @description The email that will receive invoices for the credit card. */
|
|
1388
1128
|
cardHolderEmail: string;
|
|
1389
|
-
/**
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1129
|
+
/** @description The name associated with the credit card. */
|
|
1130
|
+
cardHolderName: string;
|
|
1131
|
+
};
|
|
1132
|
+
v1SetPaymentMethodIntentV2: {
|
|
1133
|
+
/** @description The id of the payment method that was created clientside. */
|
|
1134
|
+
paymentMethodId: string;
|
|
1135
|
+
/** @description The email that will receive invoices for the credit card. */
|
|
1136
|
+
cardHolderEmail: string;
|
|
1137
|
+
/** @description The name associated with the credit card. */
|
|
1393
1138
|
cardHolderName: string;
|
|
1394
1139
|
};
|
|
1395
1140
|
v1SetPaymentMethodResult: {
|
|
@@ -1401,17 +1146,13 @@ export type definitions = {
|
|
|
1401
1146
|
cardHolderEmail: string;
|
|
1402
1147
|
};
|
|
1403
1148
|
v1SignRawPayloadIntent: {
|
|
1404
|
-
/**
|
|
1405
|
-
* @inject_tag: validate:"required,uuid"
|
|
1406
|
-
* @description Unique identifier for a given Private Key.
|
|
1407
|
-
*/
|
|
1149
|
+
/** @description Unique identifier for a given Private Key. */
|
|
1408
1150
|
privateKeyId: string;
|
|
1409
|
-
/**
|
|
1410
|
-
* @inject_tag: validate:"required"
|
|
1411
|
-
* @description Raw unsigned payload to be signed.
|
|
1412
|
-
*/
|
|
1151
|
+
/** @description Raw unsigned payload to be signed. */
|
|
1413
1152
|
payload: string;
|
|
1153
|
+
/** @description Encoding of the `payload` string. Turnkey uses this information to convert `payload` into bytes with the correct decoder (e.g. hex, utf8). */
|
|
1414
1154
|
encoding: definitions["v1PayloadEncoding"];
|
|
1155
|
+
/** @description Hash function to apply to payload bytes before signing. This field must be set to HASH_FUNCTION_NOT_APPLICABLE for EdDSA/ed25519 signature requests; configurable payload hashing is not supported by RFC 8032. */
|
|
1415
1156
|
hashFunction: definitions["v1HashFunction"];
|
|
1416
1157
|
};
|
|
1417
1158
|
v1SignRawPayloadRequest: {
|
|
@@ -1432,15 +1173,9 @@ export type definitions = {
|
|
|
1432
1173
|
v: string;
|
|
1433
1174
|
};
|
|
1434
1175
|
v1SignTransactionIntent: {
|
|
1435
|
-
/**
|
|
1436
|
-
* @inject_tag: validate:"required,uuid"
|
|
1437
|
-
* @description Unique identifier for a given Private Key.
|
|
1438
|
-
*/
|
|
1176
|
+
/** @description Unique identifier for a given Private Key. */
|
|
1439
1177
|
privateKeyId: string;
|
|
1440
|
-
/**
|
|
1441
|
-
* @inject_tag: validate:"required"
|
|
1442
|
-
* @description Raw unsigned transaction to be signed by a particular Private Key.
|
|
1443
|
-
*/
|
|
1178
|
+
/** @description Raw unsigned transaction to be signed by a particular Private Key. */
|
|
1444
1179
|
unsignedTransaction: string;
|
|
1445
1180
|
type: definitions["immutableactivityv1TransactionType"];
|
|
1446
1181
|
};
|
|
@@ -1468,10 +1203,7 @@ export type definitions = {
|
|
|
1468
1203
|
nanos: string;
|
|
1469
1204
|
};
|
|
1470
1205
|
v1UpdateAllowedOriginsIntent: {
|
|
1471
|
-
/**
|
|
1472
|
-
* @inject_tag: validate:"required"
|
|
1473
|
-
* @description Additional origins requests are allowed from besides Turnkey origins
|
|
1474
|
-
*/
|
|
1206
|
+
/** @description Additional origins requests are allowed from besides Turnkey origins */
|
|
1475
1207
|
allowedOrigins: string[];
|
|
1476
1208
|
};
|
|
1477
1209
|
v1UpdateAllowedOriginsRequest: {
|
|
@@ -1487,16 +1219,11 @@ export type definitions = {
|
|
|
1487
1219
|
[key: string]: unknown;
|
|
1488
1220
|
};
|
|
1489
1221
|
v1UpdatePolicyIntent: {
|
|
1490
|
-
/**
|
|
1491
|
-
* @inject_tag: validate:"uuid"
|
|
1492
|
-
* @description Unique identifier for a given Policy.
|
|
1493
|
-
*/
|
|
1222
|
+
/** @description Unique identifier for a given Policy. */
|
|
1494
1223
|
policyId: string;
|
|
1495
|
-
/**
|
|
1496
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1497
|
-
* @description Human-readable name for a Policy.
|
|
1498
|
-
*/
|
|
1224
|
+
/** @description Human-readable name for a Policy. */
|
|
1499
1225
|
policyName?: string;
|
|
1226
|
+
/** @description The instruction to DENY or ALLOW an activity (optional). */
|
|
1500
1227
|
policyEffect?: definitions["immutableactivityv1Effect"];
|
|
1501
1228
|
/** @description The condition expression that triggers the Effect (optional). */
|
|
1502
1229
|
policyCondition?: string;
|
|
@@ -1519,25 +1246,13 @@ export type definitions = {
|
|
|
1519
1246
|
policyId: string;
|
|
1520
1247
|
};
|
|
1521
1248
|
v1UpdatePrivateKeyTagIntent: {
|
|
1522
|
-
/**
|
|
1523
|
-
* @inject_tag: validate:"uuid"
|
|
1524
|
-
* @description Unique identifier for a given Private Key Tag.
|
|
1525
|
-
*/
|
|
1249
|
+
/** @description Unique identifier for a given Private Key Tag. */
|
|
1526
1250
|
privateKeyTagId: string;
|
|
1527
|
-
/**
|
|
1528
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1529
|
-
* @description The new, human-readable name for the tag with the given ID.
|
|
1530
|
-
*/
|
|
1251
|
+
/** @description The new, human-readable name for the tag with the given ID. */
|
|
1531
1252
|
newPrivateKeyTagName?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1534
|
-
* @description A list of Private Keys IDs to add this tag to.
|
|
1535
|
-
*/
|
|
1253
|
+
/** @description A list of Private Keys IDs to add this tag to. */
|
|
1536
1254
|
addPrivateKeyIds: string[];
|
|
1537
|
-
/**
|
|
1538
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1539
|
-
* @description A list of Private Key IDs to remove this tag from.
|
|
1540
|
-
*/
|
|
1255
|
+
/** @description A list of Private Key IDs to remove this tag from. */
|
|
1541
1256
|
removePrivateKeyIds: string[];
|
|
1542
1257
|
};
|
|
1543
1258
|
v1UpdatePrivateKeyTagRequest: {
|
|
@@ -1555,15 +1270,11 @@ export type definitions = {
|
|
|
1555
1270
|
};
|
|
1556
1271
|
v1UpdateRootQuorumIntent: {
|
|
1557
1272
|
/**
|
|
1558
|
-
* @inject_tag: validate:"required"
|
|
1559
1273
|
* Format: int32
|
|
1560
1274
|
* @description The threshold of unique approvals to reach quorum.
|
|
1561
1275
|
*/
|
|
1562
1276
|
threshold: number;
|
|
1563
|
-
/**
|
|
1564
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1565
|
-
* @description The unique identifiers of users who comprise the quorum set.
|
|
1566
|
-
*/
|
|
1277
|
+
/** @description The unique identifiers of users who comprise the quorum set. */
|
|
1567
1278
|
userIds: string[];
|
|
1568
1279
|
};
|
|
1569
1280
|
v1UpdateRootQuorumRequest: {
|
|
@@ -1578,26 +1289,37 @@ export type definitions = {
|
|
|
1578
1289
|
v1UpdateRootQuorumResult: {
|
|
1579
1290
|
[key: string]: unknown;
|
|
1580
1291
|
};
|
|
1292
|
+
v1UpdateUserIntent: {
|
|
1293
|
+
/** @description Unique identifier for a given User. */
|
|
1294
|
+
userId: string;
|
|
1295
|
+
/** @description Human-readable name for a User. */
|
|
1296
|
+
userName?: string;
|
|
1297
|
+
/** @description The user's email address. */
|
|
1298
|
+
userEmail?: string;
|
|
1299
|
+
/** @description An updated list of User Tags to apply to this User. */
|
|
1300
|
+
userTagIds?: string[];
|
|
1301
|
+
};
|
|
1302
|
+
v1UpdateUserRequest: {
|
|
1303
|
+
/** @enum {string} */
|
|
1304
|
+
type: "ACTIVITY_TYPE_UPDATE_USER";
|
|
1305
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
1306
|
+
timestampMs: string;
|
|
1307
|
+
/** @description Unique identifier for a given Organization. */
|
|
1308
|
+
organizationId: string;
|
|
1309
|
+
parameters: definitions["v1UpdateUserIntent"];
|
|
1310
|
+
};
|
|
1311
|
+
v1UpdateUserResult: {
|
|
1312
|
+
/** @description A User ID. */
|
|
1313
|
+
userId: string;
|
|
1314
|
+
};
|
|
1581
1315
|
v1UpdateUserTagIntent: {
|
|
1582
|
-
/**
|
|
1583
|
-
* @inject_tag: validate:"uuid"
|
|
1584
|
-
* @description Unique identifier for a given User Tag.
|
|
1585
|
-
*/
|
|
1316
|
+
/** @description Unique identifier for a given User Tag. */
|
|
1586
1317
|
userTagId: string;
|
|
1587
|
-
/**
|
|
1588
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1589
|
-
* @description The new, human-readable name for the tag with the given ID.
|
|
1590
|
-
*/
|
|
1318
|
+
/** @description The new, human-readable name for the tag with the given ID. */
|
|
1591
1319
|
newUserTagName?: string;
|
|
1592
|
-
/**
|
|
1593
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1594
|
-
* @description A list of User IDs to add this tag to.
|
|
1595
|
-
*/
|
|
1320
|
+
/** @description A list of User IDs to add this tag to. */
|
|
1596
1321
|
addUserIds: string[];
|
|
1597
|
-
/**
|
|
1598
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1599
|
-
* @description A list of User IDs to remove this tag from.
|
|
1600
|
-
*/
|
|
1322
|
+
/** @description A list of User IDs to remove this tag from. */
|
|
1601
1323
|
removeUserIds: string[];
|
|
1602
1324
|
};
|
|
1603
1325
|
v1UpdateUserTagRequest: {
|
|
@@ -1618,11 +1340,9 @@ export type definitions = {
|
|
|
1618
1340
|
userId: string;
|
|
1619
1341
|
/** @description Human-readable name for a User. */
|
|
1620
1342
|
userName: string;
|
|
1621
|
-
/**
|
|
1622
|
-
* some users do not have emails (programmatic users)
|
|
1623
|
-
* @description The user's email address.
|
|
1624
|
-
*/
|
|
1343
|
+
/** @description The user's email address. */
|
|
1625
1344
|
userEmail?: string;
|
|
1345
|
+
/** @description The User's permissible access method(s). */
|
|
1626
1346
|
accessType: definitions["externaldatav1AccessType"];
|
|
1627
1347
|
/** @description A list of Authenticator parameters. */
|
|
1628
1348
|
authenticators: definitions["v1Authenticator"][];
|
|
@@ -1634,67 +1354,39 @@ export type definitions = {
|
|
|
1634
1354
|
updatedAt: definitions["v1Timestamp"];
|
|
1635
1355
|
};
|
|
1636
1356
|
v1UserParams: {
|
|
1637
|
-
/**
|
|
1638
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1639
|
-
* @description Human-readable name for a User.
|
|
1640
|
-
*/
|
|
1357
|
+
/** @description Human-readable name for a User. */
|
|
1641
1358
|
userName: string;
|
|
1642
|
-
/**
|
|
1643
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1644
|
-
* @description The user's email address.
|
|
1645
|
-
*/
|
|
1359
|
+
/** @description The user's email address. */
|
|
1646
1360
|
userEmail?: string;
|
|
1361
|
+
/** @description The User's permissible access method(s). */
|
|
1647
1362
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1648
|
-
/**
|
|
1649
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1650
|
-
* @description A list of API Key parameters.
|
|
1651
|
-
*/
|
|
1363
|
+
/** @description A list of API Key parameters. */
|
|
1652
1364
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1653
|
-
/**
|
|
1654
|
-
* @inject_tag: validate:"dive"
|
|
1655
|
-
* @description A list of Authenticator parameters.
|
|
1656
|
-
*/
|
|
1365
|
+
/** @description A list of Authenticator parameters. */
|
|
1657
1366
|
authenticators: definitions["v1AuthenticatorParams"][];
|
|
1658
|
-
/**
|
|
1659
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1660
|
-
* @description A list of User Tag IDs.
|
|
1661
|
-
*/
|
|
1367
|
+
/** @description A list of User Tag IDs. */
|
|
1662
1368
|
userTags: string[];
|
|
1663
1369
|
};
|
|
1664
1370
|
v1UserParamsV2: {
|
|
1665
|
-
/**
|
|
1666
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1667
|
-
* @description Human-readable name for a User.
|
|
1668
|
-
*/
|
|
1371
|
+
/** @description Human-readable name for a User. */
|
|
1669
1372
|
userName: string;
|
|
1670
|
-
/**
|
|
1671
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1672
|
-
* @description The user's email address.
|
|
1673
|
-
*/
|
|
1373
|
+
/** @description The user's email address. */
|
|
1674
1374
|
userEmail?: string;
|
|
1375
|
+
/** @description The User's permissible access method(s). */
|
|
1675
1376
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1676
|
-
/**
|
|
1677
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1678
|
-
* @description A list of API Key parameters.
|
|
1679
|
-
*/
|
|
1377
|
+
/** @description A list of API Key parameters. */
|
|
1680
1378
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1681
|
-
/**
|
|
1682
|
-
* @inject_tag: validate:"dive"
|
|
1683
|
-
* @description A list of Authenticator parameters.
|
|
1684
|
-
*/
|
|
1379
|
+
/** @description A list of Authenticator parameters. */
|
|
1685
1380
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
1686
|
-
/**
|
|
1687
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1688
|
-
* @description A list of User Tag IDs.
|
|
1689
|
-
*/
|
|
1381
|
+
/** @description A list of User Tag IDs. */
|
|
1690
1382
|
userTags: string[];
|
|
1691
1383
|
};
|
|
1692
|
-
/** @description Object representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. */
|
|
1693
1384
|
v1Vote: {
|
|
1694
1385
|
/** @description Unique identifier for a given Vote object. */
|
|
1695
1386
|
id: string;
|
|
1696
1387
|
/** @description Unique identifier for a given User. */
|
|
1697
1388
|
userId: string;
|
|
1389
|
+
/** @description Web and/or API user within your Organization. */
|
|
1698
1390
|
user: definitions["v1User"];
|
|
1699
1391
|
/** @description Unique identifier for a given Activity object. */
|
|
1700
1392
|
activityId: string;
|
|
@@ -1710,7 +1402,6 @@ export type definitions = {
|
|
|
1710
1402
|
scheme: string;
|
|
1711
1403
|
createdAt: definitions["v1Timestamp"];
|
|
1712
1404
|
};
|
|
1713
|
-
/** We expect this to be passed in as a JSON-encoded, then base64-encoded string within a X-Stamp-Webauthn header */
|
|
1714
1405
|
v1WebAuthnStamp: {
|
|
1715
1406
|
/** @description A base64 url encoded Unique identifier for a given credential. */
|
|
1716
1407
|
credentialId: string;
|
|
@@ -1735,14 +1426,6 @@ export type operations = {
|
|
|
1735
1426
|
200: {
|
|
1736
1427
|
schema: definitions["v1ActivityResponse"];
|
|
1737
1428
|
};
|
|
1738
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1739
|
-
403: {
|
|
1740
|
-
schema: unknown;
|
|
1741
|
-
};
|
|
1742
|
-
/** Returned when the resource does not exist. */
|
|
1743
|
-
404: {
|
|
1744
|
-
schema: string;
|
|
1745
|
-
};
|
|
1746
1429
|
/** An unexpected error response. */
|
|
1747
1430
|
default: {
|
|
1748
1431
|
schema: definitions["rpcStatus"];
|
|
@@ -1761,14 +1444,6 @@ export type operations = {
|
|
|
1761
1444
|
200: {
|
|
1762
1445
|
schema: definitions["v1GetAuthenticatorResponse"];
|
|
1763
1446
|
};
|
|
1764
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1765
|
-
403: {
|
|
1766
|
-
schema: unknown;
|
|
1767
|
-
};
|
|
1768
|
-
/** Returned when the resource does not exist. */
|
|
1769
|
-
404: {
|
|
1770
|
-
schema: string;
|
|
1771
|
-
};
|
|
1772
1447
|
/** An unexpected error response. */
|
|
1773
1448
|
default: {
|
|
1774
1449
|
schema: definitions["rpcStatus"];
|
|
@@ -1787,14 +1462,6 @@ export type operations = {
|
|
|
1787
1462
|
200: {
|
|
1788
1463
|
schema: definitions["v1GetAuthenticatorsResponse"];
|
|
1789
1464
|
};
|
|
1790
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1791
|
-
403: {
|
|
1792
|
-
schema: unknown;
|
|
1793
|
-
};
|
|
1794
|
-
/** Returned when the resource does not exist. */
|
|
1795
|
-
404: {
|
|
1796
|
-
schema: string;
|
|
1797
|
-
};
|
|
1798
1465
|
/** An unexpected error response. */
|
|
1799
1466
|
default: {
|
|
1800
1467
|
schema: definitions["rpcStatus"];
|
|
@@ -1813,14 +1480,6 @@ export type operations = {
|
|
|
1813
1480
|
200: {
|
|
1814
1481
|
schema: definitions["v1GetOrganizationResponse"];
|
|
1815
1482
|
};
|
|
1816
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1817
|
-
403: {
|
|
1818
|
-
schema: unknown;
|
|
1819
|
-
};
|
|
1820
|
-
/** Returned when the resource does not exist. */
|
|
1821
|
-
404: {
|
|
1822
|
-
schema: string;
|
|
1823
|
-
};
|
|
1824
1483
|
/** An unexpected error response. */
|
|
1825
1484
|
default: {
|
|
1826
1485
|
schema: definitions["rpcStatus"];
|
|
@@ -1839,14 +1498,6 @@ export type operations = {
|
|
|
1839
1498
|
200: {
|
|
1840
1499
|
schema: definitions["v1GetPolicyResponse"];
|
|
1841
1500
|
};
|
|
1842
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1843
|
-
403: {
|
|
1844
|
-
schema: unknown;
|
|
1845
|
-
};
|
|
1846
|
-
/** Returned when the resource does not exist. */
|
|
1847
|
-
404: {
|
|
1848
|
-
schema: string;
|
|
1849
|
-
};
|
|
1850
1501
|
/** An unexpected error response. */
|
|
1851
1502
|
default: {
|
|
1852
1503
|
schema: definitions["rpcStatus"];
|
|
@@ -1865,14 +1516,6 @@ export type operations = {
|
|
|
1865
1516
|
200: {
|
|
1866
1517
|
schema: definitions["v1GetPrivateKeyResponse"];
|
|
1867
1518
|
};
|
|
1868
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1869
|
-
403: {
|
|
1870
|
-
schema: unknown;
|
|
1871
|
-
};
|
|
1872
|
-
/** Returned when the resource does not exist. */
|
|
1873
|
-
404: {
|
|
1874
|
-
schema: string;
|
|
1875
|
-
};
|
|
1876
1519
|
/** An unexpected error response. */
|
|
1877
1520
|
default: {
|
|
1878
1521
|
schema: definitions["rpcStatus"];
|
|
@@ -1891,14 +1534,6 @@ export type operations = {
|
|
|
1891
1534
|
200: {
|
|
1892
1535
|
schema: definitions["v1GetUserResponse"];
|
|
1893
1536
|
};
|
|
1894
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1895
|
-
403: {
|
|
1896
|
-
schema: unknown;
|
|
1897
|
-
};
|
|
1898
|
-
/** Returned when the resource does not exist. */
|
|
1899
|
-
404: {
|
|
1900
|
-
schema: string;
|
|
1901
|
-
};
|
|
1902
1537
|
/** An unexpected error response. */
|
|
1903
1538
|
default: {
|
|
1904
1539
|
schema: definitions["rpcStatus"];
|
|
@@ -1917,14 +1552,6 @@ export type operations = {
|
|
|
1917
1552
|
200: {
|
|
1918
1553
|
schema: definitions["v1GetActivitiesResponse"];
|
|
1919
1554
|
};
|
|
1920
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1921
|
-
403: {
|
|
1922
|
-
schema: unknown;
|
|
1923
|
-
};
|
|
1924
|
-
/** Returned when the resource does not exist. */
|
|
1925
|
-
404: {
|
|
1926
|
-
schema: string;
|
|
1927
|
-
};
|
|
1928
1555
|
/** An unexpected error response. */
|
|
1929
1556
|
default: {
|
|
1930
1557
|
schema: definitions["rpcStatus"];
|
|
@@ -1943,14 +1570,6 @@ export type operations = {
|
|
|
1943
1570
|
200: {
|
|
1944
1571
|
schema: definitions["v1GetPoliciesResponse"];
|
|
1945
1572
|
};
|
|
1946
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1947
|
-
403: {
|
|
1948
|
-
schema: unknown;
|
|
1949
|
-
};
|
|
1950
|
-
/** Returned when the resource does not exist. */
|
|
1951
|
-
404: {
|
|
1952
|
-
schema: string;
|
|
1953
|
-
};
|
|
1954
1573
|
/** An unexpected error response. */
|
|
1955
1574
|
default: {
|
|
1956
1575
|
schema: definitions["rpcStatus"];
|
|
@@ -1969,14 +1588,6 @@ export type operations = {
|
|
|
1969
1588
|
200: {
|
|
1970
1589
|
schema: definitions["v1GetPrivateKeysResponse"];
|
|
1971
1590
|
};
|
|
1972
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1973
|
-
403: {
|
|
1974
|
-
schema: unknown;
|
|
1975
|
-
};
|
|
1976
|
-
/** Returned when the resource does not exist. */
|
|
1977
|
-
404: {
|
|
1978
|
-
schema: string;
|
|
1979
|
-
};
|
|
1980
1591
|
/** An unexpected error response. */
|
|
1981
1592
|
default: {
|
|
1982
1593
|
schema: definitions["rpcStatus"];
|
|
@@ -1995,14 +1606,6 @@ export type operations = {
|
|
|
1995
1606
|
200: {
|
|
1996
1607
|
schema: definitions["v1GetUsersResponse"];
|
|
1997
1608
|
};
|
|
1998
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1999
|
-
403: {
|
|
2000
|
-
schema: unknown;
|
|
2001
|
-
};
|
|
2002
|
-
/** Returned when the resource does not exist. */
|
|
2003
|
-
404: {
|
|
2004
|
-
schema: string;
|
|
2005
|
-
};
|
|
2006
1609
|
/** An unexpected error response. */
|
|
2007
1610
|
default: {
|
|
2008
1611
|
schema: definitions["rpcStatus"];
|
|
@@ -2021,14 +1624,6 @@ export type operations = {
|
|
|
2021
1624
|
200: {
|
|
2022
1625
|
schema: definitions["v1GetWhoamiResponse"];
|
|
2023
1626
|
};
|
|
2024
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2025
|
-
403: {
|
|
2026
|
-
schema: unknown;
|
|
2027
|
-
};
|
|
2028
|
-
/** Returned when the resource does not exist. */
|
|
2029
|
-
404: {
|
|
2030
|
-
schema: string;
|
|
2031
|
-
};
|
|
2032
1627
|
/** An unexpected error response. */
|
|
2033
1628
|
default: {
|
|
2034
1629
|
schema: definitions["rpcStatus"];
|
|
@@ -2047,14 +1642,6 @@ export type operations = {
|
|
|
2047
1642
|
200: {
|
|
2048
1643
|
schema: definitions["v1ActivityResponse"];
|
|
2049
1644
|
};
|
|
2050
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2051
|
-
403: {
|
|
2052
|
-
schema: unknown;
|
|
2053
|
-
};
|
|
2054
|
-
/** Returned when the resource does not exist. */
|
|
2055
|
-
404: {
|
|
2056
|
-
schema: string;
|
|
2057
|
-
};
|
|
2058
1645
|
/** An unexpected error response. */
|
|
2059
1646
|
default: {
|
|
2060
1647
|
schema: definitions["rpcStatus"];
|
|
@@ -2073,14 +1660,6 @@ export type operations = {
|
|
|
2073
1660
|
200: {
|
|
2074
1661
|
schema: definitions["v1ActivityResponse"];
|
|
2075
1662
|
};
|
|
2076
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2077
|
-
403: {
|
|
2078
|
-
schema: unknown;
|
|
2079
|
-
};
|
|
2080
|
-
/** Returned when the resource does not exist. */
|
|
2081
|
-
404: {
|
|
2082
|
-
schema: string;
|
|
2083
|
-
};
|
|
2084
1663
|
/** An unexpected error response. */
|
|
2085
1664
|
default: {
|
|
2086
1665
|
schema: definitions["rpcStatus"];
|
|
@@ -2099,14 +1678,6 @@ export type operations = {
|
|
|
2099
1678
|
200: {
|
|
2100
1679
|
schema: definitions["v1ActivityResponse"];
|
|
2101
1680
|
};
|
|
2102
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2103
|
-
403: {
|
|
2104
|
-
schema: unknown;
|
|
2105
|
-
};
|
|
2106
|
-
/** Returned when the resource does not exist. */
|
|
2107
|
-
404: {
|
|
2108
|
-
schema: string;
|
|
2109
|
-
};
|
|
2110
1681
|
/** An unexpected error response. */
|
|
2111
1682
|
default: {
|
|
2112
1683
|
schema: definitions["rpcStatus"];
|
|
@@ -2125,14 +1696,6 @@ export type operations = {
|
|
|
2125
1696
|
200: {
|
|
2126
1697
|
schema: definitions["v1ActivityResponse"];
|
|
2127
1698
|
};
|
|
2128
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2129
|
-
403: {
|
|
2130
|
-
schema: unknown;
|
|
2131
|
-
};
|
|
2132
|
-
/** Returned when the resource does not exist. */
|
|
2133
|
-
404: {
|
|
2134
|
-
schema: string;
|
|
2135
|
-
};
|
|
2136
1699
|
/** An unexpected error response. */
|
|
2137
1700
|
default: {
|
|
2138
1701
|
schema: definitions["rpcStatus"];
|
|
@@ -2151,14 +1714,6 @@ export type operations = {
|
|
|
2151
1714
|
200: {
|
|
2152
1715
|
schema: definitions["v1ActivityResponse"];
|
|
2153
1716
|
};
|
|
2154
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2155
|
-
403: {
|
|
2156
|
-
schema: unknown;
|
|
2157
|
-
};
|
|
2158
|
-
/** Returned when the resource does not exist. */
|
|
2159
|
-
404: {
|
|
2160
|
-
schema: string;
|
|
2161
|
-
};
|
|
2162
1717
|
/** An unexpected error response. */
|
|
2163
1718
|
default: {
|
|
2164
1719
|
schema: definitions["rpcStatus"];
|
|
@@ -2177,14 +1732,6 @@ export type operations = {
|
|
|
2177
1732
|
200: {
|
|
2178
1733
|
schema: definitions["v1ActivityResponse"];
|
|
2179
1734
|
};
|
|
2180
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2181
|
-
403: {
|
|
2182
|
-
schema: unknown;
|
|
2183
|
-
};
|
|
2184
|
-
/** Returned when the resource does not exist. */
|
|
2185
|
-
404: {
|
|
2186
|
-
schema: string;
|
|
2187
|
-
};
|
|
2188
1735
|
/** An unexpected error response. */
|
|
2189
1736
|
default: {
|
|
2190
1737
|
schema: definitions["rpcStatus"];
|
|
@@ -2203,14 +1750,6 @@ export type operations = {
|
|
|
2203
1750
|
200: {
|
|
2204
1751
|
schema: definitions["v1ActivityResponse"];
|
|
2205
1752
|
};
|
|
2206
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2207
|
-
403: {
|
|
2208
|
-
schema: unknown;
|
|
2209
|
-
};
|
|
2210
|
-
/** Returned when the resource does not exist. */
|
|
2211
|
-
404: {
|
|
2212
|
-
schema: string;
|
|
2213
|
-
};
|
|
2214
1753
|
/** An unexpected error response. */
|
|
2215
1754
|
default: {
|
|
2216
1755
|
schema: definitions["rpcStatus"];
|
|
@@ -2229,14 +1768,6 @@ export type operations = {
|
|
|
2229
1768
|
200: {
|
|
2230
1769
|
schema: definitions["v1ActivityResponse"];
|
|
2231
1770
|
};
|
|
2232
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2233
|
-
403: {
|
|
2234
|
-
schema: unknown;
|
|
2235
|
-
};
|
|
2236
|
-
/** Returned when the resource does not exist. */
|
|
2237
|
-
404: {
|
|
2238
|
-
schema: string;
|
|
2239
|
-
};
|
|
2240
1771
|
/** An unexpected error response. */
|
|
2241
1772
|
default: {
|
|
2242
1773
|
schema: definitions["rpcStatus"];
|
|
@@ -2255,14 +1786,6 @@ export type operations = {
|
|
|
2255
1786
|
200: {
|
|
2256
1787
|
schema: definitions["v1ActivityResponse"];
|
|
2257
1788
|
};
|
|
2258
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2259
|
-
403: {
|
|
2260
|
-
schema: unknown;
|
|
2261
|
-
};
|
|
2262
|
-
/** Returned when the resource does not exist. */
|
|
2263
|
-
404: {
|
|
2264
|
-
schema: string;
|
|
2265
|
-
};
|
|
2266
1789
|
/** An unexpected error response. */
|
|
2267
1790
|
default: {
|
|
2268
1791
|
schema: definitions["rpcStatus"];
|
|
@@ -2281,14 +1804,6 @@ export type operations = {
|
|
|
2281
1804
|
200: {
|
|
2282
1805
|
schema: definitions["v1ActivityResponse"];
|
|
2283
1806
|
};
|
|
2284
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2285
|
-
403: {
|
|
2286
|
-
schema: unknown;
|
|
2287
|
-
};
|
|
2288
|
-
/** Returned when the resource does not exist. */
|
|
2289
|
-
404: {
|
|
2290
|
-
schema: string;
|
|
2291
|
-
};
|
|
2292
1807
|
/** An unexpected error response. */
|
|
2293
1808
|
default: {
|
|
2294
1809
|
schema: definitions["rpcStatus"];
|
|
@@ -2307,14 +1822,6 @@ export type operations = {
|
|
|
2307
1822
|
200: {
|
|
2308
1823
|
schema: definitions["v1ActivityResponse"];
|
|
2309
1824
|
};
|
|
2310
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2311
|
-
403: {
|
|
2312
|
-
schema: unknown;
|
|
2313
|
-
};
|
|
2314
|
-
/** Returned when the resource does not exist. */
|
|
2315
|
-
404: {
|
|
2316
|
-
schema: string;
|
|
2317
|
-
};
|
|
2318
1825
|
/** An unexpected error response. */
|
|
2319
1826
|
default: {
|
|
2320
1827
|
schema: definitions["rpcStatus"];
|
|
@@ -2333,14 +1840,6 @@ export type operations = {
|
|
|
2333
1840
|
200: {
|
|
2334
1841
|
schema: definitions["v1ActivityResponse"];
|
|
2335
1842
|
};
|
|
2336
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2337
|
-
403: {
|
|
2338
|
-
schema: unknown;
|
|
2339
|
-
};
|
|
2340
|
-
/** Returned when the resource does not exist. */
|
|
2341
|
-
404: {
|
|
2342
|
-
schema: string;
|
|
2343
|
-
};
|
|
2344
1843
|
/** An unexpected error response. */
|
|
2345
1844
|
default: {
|
|
2346
1845
|
schema: definitions["rpcStatus"];
|
|
@@ -2359,14 +1858,6 @@ export type operations = {
|
|
|
2359
1858
|
200: {
|
|
2360
1859
|
schema: definitions["v1ActivityResponse"];
|
|
2361
1860
|
};
|
|
2362
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2363
|
-
403: {
|
|
2364
|
-
schema: unknown;
|
|
2365
|
-
};
|
|
2366
|
-
/** Returned when the resource does not exist. */
|
|
2367
|
-
404: {
|
|
2368
|
-
schema: string;
|
|
2369
|
-
};
|
|
2370
1861
|
/** An unexpected error response. */
|
|
2371
1862
|
default: {
|
|
2372
1863
|
schema: definitions["rpcStatus"];
|
|
@@ -2385,14 +1876,6 @@ export type operations = {
|
|
|
2385
1876
|
200: {
|
|
2386
1877
|
schema: definitions["v1ActivityResponse"];
|
|
2387
1878
|
};
|
|
2388
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2389
|
-
403: {
|
|
2390
|
-
schema: unknown;
|
|
2391
|
-
};
|
|
2392
|
-
/** Returned when the resource does not exist. */
|
|
2393
|
-
404: {
|
|
2394
|
-
schema: string;
|
|
2395
|
-
};
|
|
2396
1879
|
/** An unexpected error response. */
|
|
2397
1880
|
default: {
|
|
2398
1881
|
schema: definitions["rpcStatus"];
|
|
@@ -2411,14 +1894,6 @@ export type operations = {
|
|
|
2411
1894
|
200: {
|
|
2412
1895
|
schema: definitions["v1ActivityResponse"];
|
|
2413
1896
|
};
|
|
2414
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2415
|
-
403: {
|
|
2416
|
-
schema: unknown;
|
|
2417
|
-
};
|
|
2418
|
-
/** Returned when the resource does not exist. */
|
|
2419
|
-
404: {
|
|
2420
|
-
schema: string;
|
|
2421
|
-
};
|
|
2422
1897
|
/** An unexpected error response. */
|
|
2423
1898
|
default: {
|
|
2424
1899
|
schema: definitions["rpcStatus"];
|
|
@@ -2437,14 +1912,6 @@ export type operations = {
|
|
|
2437
1912
|
200: {
|
|
2438
1913
|
schema: definitions["v1ActivityResponse"];
|
|
2439
1914
|
};
|
|
2440
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2441
|
-
403: {
|
|
2442
|
-
schema: unknown;
|
|
2443
|
-
};
|
|
2444
|
-
/** Returned when the resource does not exist. */
|
|
2445
|
-
404: {
|
|
2446
|
-
schema: string;
|
|
2447
|
-
};
|
|
2448
1915
|
/** An unexpected error response. */
|
|
2449
1916
|
default: {
|
|
2450
1917
|
schema: definitions["rpcStatus"];
|
|
@@ -2463,14 +1930,6 @@ export type operations = {
|
|
|
2463
1930
|
200: {
|
|
2464
1931
|
schema: definitions["v1ActivityResponse"];
|
|
2465
1932
|
};
|
|
2466
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2467
|
-
403: {
|
|
2468
|
-
schema: unknown;
|
|
2469
|
-
};
|
|
2470
|
-
/** Returned when the resource does not exist. */
|
|
2471
|
-
404: {
|
|
2472
|
-
schema: string;
|
|
2473
|
-
};
|
|
2474
1933
|
/** An unexpected error response. */
|
|
2475
1934
|
default: {
|
|
2476
1935
|
schema: definitions["rpcStatus"];
|
|
@@ -2489,14 +1948,6 @@ export type operations = {
|
|
|
2489
1948
|
200: {
|
|
2490
1949
|
schema: definitions["v1ActivityResponse"];
|
|
2491
1950
|
};
|
|
2492
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2493
|
-
403: {
|
|
2494
|
-
schema: unknown;
|
|
2495
|
-
};
|
|
2496
|
-
/** Returned when the resource does not exist. */
|
|
2497
|
-
404: {
|
|
2498
|
-
schema: string;
|
|
2499
|
-
};
|
|
2500
1951
|
/** An unexpected error response. */
|
|
2501
1952
|
default: {
|
|
2502
1953
|
schema: definitions["rpcStatus"];
|
|
@@ -2515,14 +1966,6 @@ export type operations = {
|
|
|
2515
1966
|
200: {
|
|
2516
1967
|
schema: definitions["v1ActivityResponse"];
|
|
2517
1968
|
};
|
|
2518
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2519
|
-
403: {
|
|
2520
|
-
schema: unknown;
|
|
2521
|
-
};
|
|
2522
|
-
/** Returned when the resource does not exist. */
|
|
2523
|
-
404: {
|
|
2524
|
-
schema: string;
|
|
2525
|
-
};
|
|
2526
1969
|
/** An unexpected error response. */
|
|
2527
1970
|
default: {
|
|
2528
1971
|
schema: definitions["rpcStatus"];
|
|
@@ -2541,14 +1984,6 @@ export type operations = {
|
|
|
2541
1984
|
200: {
|
|
2542
1985
|
schema: definitions["v1ActivityResponse"];
|
|
2543
1986
|
};
|
|
2544
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2545
|
-
403: {
|
|
2546
|
-
schema: unknown;
|
|
2547
|
-
};
|
|
2548
|
-
/** Returned when the resource does not exist. */
|
|
2549
|
-
404: {
|
|
2550
|
-
schema: string;
|
|
2551
|
-
};
|
|
2552
1987
|
/** An unexpected error response. */
|
|
2553
1988
|
default: {
|
|
2554
1989
|
schema: definitions["rpcStatus"];
|
|
@@ -2567,14 +2002,6 @@ export type operations = {
|
|
|
2567
2002
|
200: {
|
|
2568
2003
|
schema: definitions["v1ActivityResponse"];
|
|
2569
2004
|
};
|
|
2570
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2571
|
-
403: {
|
|
2572
|
-
schema: unknown;
|
|
2573
|
-
};
|
|
2574
|
-
/** Returned when the resource does not exist. */
|
|
2575
|
-
404: {
|
|
2576
|
-
schema: string;
|
|
2577
|
-
};
|
|
2578
2005
|
/** An unexpected error response. */
|
|
2579
2006
|
default: {
|
|
2580
2007
|
schema: definitions["rpcStatus"];
|
|
@@ -2593,13 +2020,23 @@ export type operations = {
|
|
|
2593
2020
|
200: {
|
|
2594
2021
|
schema: definitions["v1ActivityResponse"];
|
|
2595
2022
|
};
|
|
2596
|
-
/**
|
|
2597
|
-
|
|
2598
|
-
schema:
|
|
2023
|
+
/** An unexpected error response. */
|
|
2024
|
+
default: {
|
|
2025
|
+
schema: definitions["rpcStatus"];
|
|
2026
|
+
};
|
|
2027
|
+
};
|
|
2028
|
+
};
|
|
2029
|
+
/** Update a User in an existing Organization */
|
|
2030
|
+
PublicApiService_UpdateUser: {
|
|
2031
|
+
parameters: {
|
|
2032
|
+
body: {
|
|
2033
|
+
body: definitions["v1UpdateUserRequest"];
|
|
2599
2034
|
};
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2035
|
+
};
|
|
2036
|
+
responses: {
|
|
2037
|
+
/** A successful response. */
|
|
2038
|
+
200: {
|
|
2039
|
+
schema: definitions["v1ActivityResponse"];
|
|
2603
2040
|
};
|
|
2604
2041
|
/** An unexpected error response. */
|
|
2605
2042
|
default: {
|
|
@@ -2619,14 +2056,6 @@ export type operations = {
|
|
|
2619
2056
|
200: {
|
|
2620
2057
|
schema: definitions["v1ActivityResponse"];
|
|
2621
2058
|
};
|
|
2622
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2623
|
-
403: {
|
|
2624
|
-
schema: unknown;
|
|
2625
|
-
};
|
|
2626
|
-
/** Returned when the resource does not exist. */
|
|
2627
|
-
404: {
|
|
2628
|
-
schema: string;
|
|
2629
|
-
};
|
|
2630
2059
|
/** An unexpected error response. */
|
|
2631
2060
|
default: {
|
|
2632
2061
|
schema: definitions["rpcStatus"];
|
|
@@ -2639,14 +2068,6 @@ export type operations = {
|
|
|
2639
2068
|
200: {
|
|
2640
2069
|
schema: definitions["v1NOOPCodegenAnchorResponse"];
|
|
2641
2070
|
};
|
|
2642
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2643
|
-
403: {
|
|
2644
|
-
schema: unknown;
|
|
2645
|
-
};
|
|
2646
|
-
/** Returned when the resource does not exist. */
|
|
2647
|
-
404: {
|
|
2648
|
-
schema: string;
|
|
2649
|
-
};
|
|
2650
2071
|
/** An unexpected error response. */
|
|
2651
2072
|
default: {
|
|
2652
2073
|
schema: definitions["rpcStatus"];
|