@turnkey/http 0.16.0 → 0.17.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 +17 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts +4064 -202
- 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 +66 -1
- 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 +684 -22
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts +379 -12
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -43,6 +43,10 @@ export type paths = {
|
|
|
43
43
|
/** Get basic information about your current API user and your organization */
|
|
44
44
|
post: operations["PublicApiService_GetWhoami"];
|
|
45
45
|
};
|
|
46
|
+
"/public/v1/submit/approve_activity": {
|
|
47
|
+
/** Approve an Activity */
|
|
48
|
+
post: operations["PublicApiService_ApproveActivity"];
|
|
49
|
+
};
|
|
46
50
|
"/public/v1/submit/create_api_keys": {
|
|
47
51
|
/** Add api keys to an existing User */
|
|
48
52
|
post: operations["PublicApiService_CreateApiKeys"];
|
|
@@ -51,6 +55,10 @@ export type paths = {
|
|
|
51
55
|
/** Create API-only Users in an existing Organization */
|
|
52
56
|
post: operations["PublicApiService_CreateApiOnlyUsers"];
|
|
53
57
|
};
|
|
58
|
+
"/public/v1/submit/create_authenticators": {
|
|
59
|
+
/** Create Authenticators to authenticate requests to Turnkey */
|
|
60
|
+
post: operations["PublicApiService_CreateAuthenticators"];
|
|
61
|
+
};
|
|
54
62
|
"/public/v1/submit/create_invitations": {
|
|
55
63
|
/** Create Invitations to join an existing Organization */
|
|
56
64
|
post: operations["PublicApiService_CreateInvitations"];
|
|
@@ -79,6 +87,10 @@ export type paths = {
|
|
|
79
87
|
/** Delete an existing Policy */
|
|
80
88
|
post: operations["PublicApiService_DeletePolicy"];
|
|
81
89
|
};
|
|
90
|
+
"/public/v1/submit/reject_activity": {
|
|
91
|
+
/** Reject an Activity */
|
|
92
|
+
post: operations["PublicApiService_RejectActivity"];
|
|
93
|
+
};
|
|
82
94
|
"/public/v1/submit/sign_raw_payload": {
|
|
83
95
|
/** Sign a raw payload with a Private Key */
|
|
84
96
|
post: operations["PublicApiService_SignRawPayload"];
|
|
@@ -87,6 +99,14 @@ export type paths = {
|
|
|
87
99
|
/** Sign a transaction with a Private Key */
|
|
88
100
|
post: operations["PublicApiService_SignTransaction"];
|
|
89
101
|
};
|
|
102
|
+
"/public/v1/submit/update_private_key_tag": {
|
|
103
|
+
/** Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail. */
|
|
104
|
+
post: operations["PublicApiService_UpdatePrivateKeyTag"];
|
|
105
|
+
};
|
|
106
|
+
"/public/v1/submit/update_user_tag": {
|
|
107
|
+
/** 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. */
|
|
108
|
+
post: operations["PublicApiService_UpdateUserTag"];
|
|
109
|
+
};
|
|
90
110
|
"/tkhq/public/v1/query/get_private_key": {
|
|
91
111
|
/** Get details about a Private Key */
|
|
92
112
|
post: operations["PublicApiService_GetPrivateKeyBackwardsCompat"];
|
|
@@ -121,7 +141,7 @@ export type definitions = {
|
|
|
121
141
|
* @description Cryptographic Curve used to generate a given Private Key.
|
|
122
142
|
* @enum {string}
|
|
123
143
|
*/
|
|
124
|
-
externaldatav1Curve: "CURVE_SECP256K1";
|
|
144
|
+
externaldatav1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
125
145
|
/** @enum {string} */
|
|
126
146
|
externaldatav1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
127
147
|
/**
|
|
@@ -149,7 +169,7 @@ export type definitions = {
|
|
|
149
169
|
* @description Cryptographic Curve used to generate a given Private Key.
|
|
150
170
|
* @enum {string}
|
|
151
171
|
*/
|
|
152
|
-
immutableactivityv1Curve: "CURVE_SECP256K1";
|
|
172
|
+
immutableactivityv1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
153
173
|
/** @enum {string} */
|
|
154
174
|
immutableactivityv1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
155
175
|
/** @enum {string} */
|
|
@@ -190,6 +210,19 @@ export type definitions = {
|
|
|
190
210
|
userId: string;
|
|
191
211
|
authenticator: definitions["v1AuthenticatorParams"];
|
|
192
212
|
};
|
|
213
|
+
v1AcceptInvitationIntentV2: {
|
|
214
|
+
/**
|
|
215
|
+
* @inject_tag: validate:"required,uuid"
|
|
216
|
+
* @description Unique identifier for a given Invitation object.
|
|
217
|
+
*/
|
|
218
|
+
invitationId: string;
|
|
219
|
+
/**
|
|
220
|
+
* @inject_tag: validate:"required,uuid"
|
|
221
|
+
* @description Unique identifier for a given User.
|
|
222
|
+
*/
|
|
223
|
+
userId: string;
|
|
224
|
+
authenticator: definitions["v1AuthenticatorParamsV2"];
|
|
225
|
+
};
|
|
193
226
|
v1AcceptInvitationResult: {
|
|
194
227
|
/** @description Unique identifier for a given Invitation. */
|
|
195
228
|
invitationId: string;
|
|
@@ -238,7 +271,7 @@ export type definitions = {
|
|
|
238
271
|
* @description Type of Activity, such as Add User, or Sign Transaction.
|
|
239
272
|
* @enum {string}
|
|
240
273
|
*/
|
|
241
|
-
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";
|
|
274
|
+
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";
|
|
242
275
|
v1ApiKey: {
|
|
243
276
|
credential: definitions["v1Credential"];
|
|
244
277
|
/** @description Unique identifier for a given API Key. */
|
|
@@ -289,6 +322,34 @@ export type definitions = {
|
|
|
289
322
|
*/
|
|
290
323
|
fingerprint: string;
|
|
291
324
|
};
|
|
325
|
+
v1ApproveActivityRequest: {
|
|
326
|
+
/** @enum {string} */
|
|
327
|
+
type: "ACTIVITY_TYPE_APPROVE_ACTIVITY";
|
|
328
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
329
|
+
timestampMs: string;
|
|
330
|
+
/** @description Unique identifier for a given Organization. */
|
|
331
|
+
organizationId: string;
|
|
332
|
+
parameters: definitions["v1ApproveActivityIntent"];
|
|
333
|
+
};
|
|
334
|
+
v1Attestation: {
|
|
335
|
+
/**
|
|
336
|
+
* @inject_tag: validate:"required,max=256"
|
|
337
|
+
* @description The cbor encoded then base64 url encoded id of the credential.
|
|
338
|
+
*/
|
|
339
|
+
credentialId: string;
|
|
340
|
+
/**
|
|
341
|
+
* @inject_tag: validate:"required"
|
|
342
|
+
* @description A base64 url encoded payload containing metadata about the signing context and the challenge.
|
|
343
|
+
*/
|
|
344
|
+
clientDataJson: string;
|
|
345
|
+
/**
|
|
346
|
+
* @inject_tag: validate:"required"
|
|
347
|
+
* @description A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
|
|
348
|
+
*/
|
|
349
|
+
attestationObject: string;
|
|
350
|
+
/** @description The type of authenticator transports. */
|
|
351
|
+
transports: definitions["immutablewebauthnv1AuthenticatorTransport"][];
|
|
352
|
+
};
|
|
292
353
|
v1Authenticator: {
|
|
293
354
|
/** @description Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE). */
|
|
294
355
|
transports: definitions["externaldatav1AuthenticatorTransport"][];
|
|
@@ -336,6 +397,19 @@ export type definitions = {
|
|
|
336
397
|
*/
|
|
337
398
|
challenge: string;
|
|
338
399
|
};
|
|
400
|
+
v1AuthenticatorParamsV2: {
|
|
401
|
+
/**
|
|
402
|
+
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
403
|
+
* @description Human-readable name for an Authenticator.
|
|
404
|
+
*/
|
|
405
|
+
authenticatorName: string;
|
|
406
|
+
/**
|
|
407
|
+
* @inject_tag: validate:"required,max=256"
|
|
408
|
+
* @description Challenge presented for authentication purposes.
|
|
409
|
+
*/
|
|
410
|
+
challenge: string;
|
|
411
|
+
attestation: definitions["v1Attestation"];
|
|
412
|
+
};
|
|
339
413
|
v1CreateApiKeysIntent: {
|
|
340
414
|
/**
|
|
341
415
|
* @inject_tag: validate:"dive,required"
|
|
@@ -393,6 +467,27 @@ export type definitions = {
|
|
|
393
467
|
*/
|
|
394
468
|
userId: string;
|
|
395
469
|
};
|
|
470
|
+
v1CreateAuthenticatorsIntentV2: {
|
|
471
|
+
/**
|
|
472
|
+
* @inject_tag: validate:"dive,required"
|
|
473
|
+
* @description A list of Authenticators.
|
|
474
|
+
*/
|
|
475
|
+
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
476
|
+
/**
|
|
477
|
+
* @inject_tag: validate:"required,uuid"
|
|
478
|
+
* @description Unique identifier for a given User.
|
|
479
|
+
*/
|
|
480
|
+
userId: string;
|
|
481
|
+
};
|
|
482
|
+
v1CreateAuthenticatorsRequest: {
|
|
483
|
+
/** @enum {string} */
|
|
484
|
+
type: "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2";
|
|
485
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
486
|
+
timestampMs: string;
|
|
487
|
+
/** @description Unique identifier for a given Organization. */
|
|
488
|
+
organizationId: string;
|
|
489
|
+
parameters: definitions["v1CreateAuthenticatorsIntentV2"];
|
|
490
|
+
};
|
|
396
491
|
v1CreateAuthenticatorsResult: {
|
|
397
492
|
/** @description A list of Authenticator IDs. */
|
|
398
493
|
authenticatorIds: string[];
|
|
@@ -435,6 +530,24 @@ export type definitions = {
|
|
|
435
530
|
*/
|
|
436
531
|
rootUserId?: string;
|
|
437
532
|
};
|
|
533
|
+
v1CreateOrganizationIntentV2: {
|
|
534
|
+
/**
|
|
535
|
+
* @inject_tag: validate:"required,tk_label_length"
|
|
536
|
+
* @description Human-readable name for an Organization.
|
|
537
|
+
*/
|
|
538
|
+
organizationName: string;
|
|
539
|
+
/**
|
|
540
|
+
* @inject_tag: validate:"required,email,tk_email"
|
|
541
|
+
* @description The root user's email address.
|
|
542
|
+
*/
|
|
543
|
+
rootEmail: string;
|
|
544
|
+
rootAuthenticator: definitions["v1AuthenticatorParamsV2"];
|
|
545
|
+
/**
|
|
546
|
+
* @inject_tag: validate:"uuid"
|
|
547
|
+
* @description Unique identifier for the root user object.
|
|
548
|
+
*/
|
|
549
|
+
rootUserId?: string;
|
|
550
|
+
};
|
|
438
551
|
v1CreateOrganizationResult: {
|
|
439
552
|
/** @description Unique identifier for a given Organization. */
|
|
440
553
|
organizationId: string;
|
|
@@ -556,14 +669,21 @@ export type definitions = {
|
|
|
556
669
|
*/
|
|
557
670
|
users: definitions["v1UserParams"][];
|
|
558
671
|
};
|
|
672
|
+
v1CreateUsersIntentV2: {
|
|
673
|
+
/**
|
|
674
|
+
* @inject_tag: validate:"required,dive,required"
|
|
675
|
+
* @description A list of Users.
|
|
676
|
+
*/
|
|
677
|
+
users: definitions["v1UserParamsV2"][];
|
|
678
|
+
};
|
|
559
679
|
v1CreateUsersRequest: {
|
|
560
680
|
/** @enum {string} */
|
|
561
|
-
type: "
|
|
681
|
+
type: "ACTIVITY_TYPE_CREATE_USERS_V2";
|
|
562
682
|
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
563
683
|
timestampMs: string;
|
|
564
684
|
/** @description Unique identifier for a given Organization. */
|
|
565
685
|
organizationId: string;
|
|
566
|
-
parameters: definitions["
|
|
686
|
+
parameters: definitions["v1CreateUsersIntentV2"];
|
|
567
687
|
};
|
|
568
688
|
v1CreateUsersResult: {
|
|
569
689
|
/** @description A list of User IDs. */
|
|
@@ -611,7 +731,7 @@ export type definitions = {
|
|
|
611
731
|
*/
|
|
612
732
|
userId: string;
|
|
613
733
|
/**
|
|
614
|
-
* @inject_tag: validate:"required,
|
|
734
|
+
* @inject_tag: validate:"required,dive,required,uuid"
|
|
615
735
|
* @description A list of Authenticator IDs.
|
|
616
736
|
*/
|
|
617
737
|
authenticatorIds: string[];
|
|
@@ -732,7 +852,7 @@ export type definitions = {
|
|
|
732
852
|
organizationId: string;
|
|
733
853
|
/** @description Array of Activity Statuses filtering which Activities will be listed in the response. */
|
|
734
854
|
filterByStatus?: definitions["v1ActivityStatus"][];
|
|
735
|
-
paginationOptions?: definitions["
|
|
855
|
+
paginationOptions?: definitions["v1Pagination"];
|
|
736
856
|
};
|
|
737
857
|
v1GetActivitiesResponse: {
|
|
738
858
|
/** @description A list of Activities. */
|
|
@@ -817,14 +937,16 @@ export type definitions = {
|
|
|
817
937
|
username: string;
|
|
818
938
|
};
|
|
819
939
|
/**
|
|
820
|
-
* @description - HASH_FUNCTION_UNSPECIFIED: Default value if hash function is not set explicitly
|
|
821
|
-
* - HASH_FUNCTION_NO_OP: No-op function. Useful if you want to pass raw
|
|
822
|
-
* - HASH_FUNCTION_SHA256: Standard SHA-256
|
|
940
|
+
* @description - HASH_FUNCTION_UNSPECIFIED: Default value if a hash function is not set explicitly.
|
|
941
|
+
* - HASH_FUNCTION_NO_OP: No-op function. Useful if you want to pass raw digests to sign (ECDSA-only)
|
|
942
|
+
* - HASH_FUNCTION_SHA256: Standard SHA-256. Used in the Bitcoin ecosystem.
|
|
823
943
|
* - HASH_FUNCTION_KECCAK256: Keccak-256 (not the same as NIST SHA-3!).
|
|
824
944
|
* This is the hash function used in the Ethereum ecosystem.
|
|
945
|
+
* - HASH_FUNCTION_NOT_APPLICABLE: Callers must use this enum value when signing with ed25519 keys.
|
|
946
|
+
* This is because, unlike ECDSA, EdDSA's API does not support signing raw digests (see RFC 8032).
|
|
825
947
|
* @enum {string}
|
|
826
948
|
*/
|
|
827
|
-
v1HashFunction: "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256";
|
|
949
|
+
v1HashFunction: "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE";
|
|
828
950
|
/** @description Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action. */
|
|
829
951
|
v1Intent: {
|
|
830
952
|
createOrganizationIntent: definitions["v1CreateOrganizationIntent"];
|
|
@@ -857,6 +979,12 @@ export type definitions = {
|
|
|
857
979
|
createPolicyIntentV3?: definitions["v1CreatePolicyIntentV3"];
|
|
858
980
|
createApiOnlyUsersIntent?: definitions["v1CreateApiOnlyUsersIntent"];
|
|
859
981
|
updateRootQuorumIntent?: definitions["v1UpdateRootQuorumIntent"];
|
|
982
|
+
updateUserTagIntent?: definitions["v1UpdateUserTagIntent"];
|
|
983
|
+
updatePrivateKeyTagIntent?: definitions["v1UpdatePrivateKeyTagIntent"];
|
|
984
|
+
createAuthenticatorsIntentV2?: definitions["v1CreateAuthenticatorsIntentV2"];
|
|
985
|
+
acceptInvitationIntentV2?: definitions["v1AcceptInvitationIntentV2"];
|
|
986
|
+
createOrganizationIntentV2?: definitions["v1CreateOrganizationIntentV2"];
|
|
987
|
+
createUsersIntentV2?: definitions["v1CreateUsersIntentV2"];
|
|
860
988
|
};
|
|
861
989
|
v1Invitation: {
|
|
862
990
|
/** @description Unique identifier for a given Invitation object. */
|
|
@@ -919,7 +1047,7 @@ export type definitions = {
|
|
|
919
1047
|
deletedAuthenticators?: definitions["v1Authenticator"][];
|
|
920
1048
|
deletedTags?: definitions["datav1Tag"][];
|
|
921
1049
|
};
|
|
922
|
-
|
|
1050
|
+
v1Pagination: {
|
|
923
1051
|
/**
|
|
924
1052
|
* Format: int32
|
|
925
1053
|
* @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10 if omitted or set to 0.
|
|
@@ -1010,6 +1138,15 @@ export type definitions = {
|
|
|
1010
1138
|
*/
|
|
1011
1139
|
fingerprint: string;
|
|
1012
1140
|
};
|
|
1141
|
+
v1RejectActivityRequest: {
|
|
1142
|
+
/** @enum {string} */
|
|
1143
|
+
type: "ACTIVITY_TYPE_REJECT_ACTIVITY";
|
|
1144
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
1145
|
+
timestampMs: string;
|
|
1146
|
+
/** @description Unique identifier for a given Organization. */
|
|
1147
|
+
organizationId: string;
|
|
1148
|
+
parameters: definitions["v1RejectActivityIntent"];
|
|
1149
|
+
};
|
|
1013
1150
|
/** @description Result of the intended action. */
|
|
1014
1151
|
v1Result: {
|
|
1015
1152
|
createOrganizationResult?: definitions["v1CreateOrganizationResult"];
|
|
@@ -1038,6 +1175,8 @@ export type definitions = {
|
|
|
1038
1175
|
deletePaymentMethodResult?: definitions["v1DeletePaymentMethodResult"];
|
|
1039
1176
|
createApiOnlyUsersResult?: definitions["v1CreateApiOnlyUsersResult"];
|
|
1040
1177
|
updateRootQuorumResult?: definitions["v1UpdateRootQuorumResult"];
|
|
1178
|
+
updateUserTagResult?: definitions["v1UpdateUserTagResult"];
|
|
1179
|
+
updatePrivateKeyTagResult?: definitions["v1UpdatePrivateKeyTagResult"];
|
|
1041
1180
|
};
|
|
1042
1181
|
v1SelectorV2: {
|
|
1043
1182
|
subject?: string;
|
|
@@ -1151,6 +1290,41 @@ export type definitions = {
|
|
|
1151
1290
|
seconds: string;
|
|
1152
1291
|
nanos: string;
|
|
1153
1292
|
};
|
|
1293
|
+
v1UpdatePrivateKeyTagIntent: {
|
|
1294
|
+
/**
|
|
1295
|
+
* @inject_tag: validate:"uuid"
|
|
1296
|
+
* @description Unique identifier for a given Private Key Tag.
|
|
1297
|
+
*/
|
|
1298
|
+
privateKeyTagId: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1301
|
+
* @description The new, human-readable name for the tag with the given ID.
|
|
1302
|
+
*/
|
|
1303
|
+
newPrivateKeyTagName?: string;
|
|
1304
|
+
/**
|
|
1305
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1306
|
+
* @description A list of Private Keys IDs to add this tag to.
|
|
1307
|
+
*/
|
|
1308
|
+
addPrivateKeyIds: string[];
|
|
1309
|
+
/**
|
|
1310
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1311
|
+
* @description A list of Private Key IDs to remove this tag from.
|
|
1312
|
+
*/
|
|
1313
|
+
removePrivateKeyIds: string[];
|
|
1314
|
+
};
|
|
1315
|
+
v1UpdatePrivateKeyTagRequest: {
|
|
1316
|
+
/** @enum {string} */
|
|
1317
|
+
type: "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG";
|
|
1318
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
1319
|
+
timestampMs: string;
|
|
1320
|
+
/** @description Unique identifier for a given Organization. */
|
|
1321
|
+
organizationId: string;
|
|
1322
|
+
parameters: definitions["v1UpdatePrivateKeyTagIntent"];
|
|
1323
|
+
};
|
|
1324
|
+
v1UpdatePrivateKeyTagResult: {
|
|
1325
|
+
/** @description Unique identifier for a given Private Key Tag. */
|
|
1326
|
+
privateKeyTagId: string;
|
|
1327
|
+
};
|
|
1154
1328
|
v1UpdateRootQuorumIntent: {
|
|
1155
1329
|
/**
|
|
1156
1330
|
* @inject_tag: validate:"required"
|
|
@@ -1167,6 +1341,41 @@ export type definitions = {
|
|
|
1167
1341
|
v1UpdateRootQuorumResult: {
|
|
1168
1342
|
[key: string]: unknown;
|
|
1169
1343
|
};
|
|
1344
|
+
v1UpdateUserTagIntent: {
|
|
1345
|
+
/**
|
|
1346
|
+
* @inject_tag: validate:"uuid"
|
|
1347
|
+
* @description Unique identifier for a given User Tag.
|
|
1348
|
+
*/
|
|
1349
|
+
userTagId: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1352
|
+
* @description The new, human-readable name for the tag with the given ID.
|
|
1353
|
+
*/
|
|
1354
|
+
newUserTagName?: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1357
|
+
* @description A list of User IDs to add this tag to.
|
|
1358
|
+
*/
|
|
1359
|
+
addUserIds: string[];
|
|
1360
|
+
/**
|
|
1361
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1362
|
+
* @description A list of User IDs to remove this tag from.
|
|
1363
|
+
*/
|
|
1364
|
+
removeUserIds: string[];
|
|
1365
|
+
};
|
|
1366
|
+
v1UpdateUserTagRequest: {
|
|
1367
|
+
/** @enum {string} */
|
|
1368
|
+
type: "ACTIVITY_TYPE_UPDATE_USER_TAG";
|
|
1369
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
1370
|
+
timestampMs: string;
|
|
1371
|
+
/** @description Unique identifier for a given Organization. */
|
|
1372
|
+
organizationId: string;
|
|
1373
|
+
parameters: definitions["v1UpdateUserTagIntent"];
|
|
1374
|
+
};
|
|
1375
|
+
v1UpdateUserTagResult: {
|
|
1376
|
+
/** @description Unique identifier for a given User Tag. */
|
|
1377
|
+
userTagId: string;
|
|
1378
|
+
};
|
|
1170
1379
|
v1User: {
|
|
1171
1380
|
/** @description Unique identifier for a given User. */
|
|
1172
1381
|
userId: string;
|
|
@@ -1215,6 +1424,34 @@ export type definitions = {
|
|
|
1215
1424
|
*/
|
|
1216
1425
|
userTags: string[];
|
|
1217
1426
|
};
|
|
1427
|
+
v1UserParamsV2: {
|
|
1428
|
+
/**
|
|
1429
|
+
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1430
|
+
* @description Human-readable name for a User.
|
|
1431
|
+
*/
|
|
1432
|
+
userName: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1435
|
+
* @description The user's email address.
|
|
1436
|
+
*/
|
|
1437
|
+
userEmail?: string;
|
|
1438
|
+
accessType: definitions["immutableactivityv1AccessType"];
|
|
1439
|
+
/**
|
|
1440
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1441
|
+
* @description A list of API Key parameters.
|
|
1442
|
+
*/
|
|
1443
|
+
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1444
|
+
/**
|
|
1445
|
+
* @inject_tag: validate:"dive"
|
|
1446
|
+
* @description A list of Authenticator parameters.
|
|
1447
|
+
*/
|
|
1448
|
+
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
1449
|
+
/**
|
|
1450
|
+
* @inject_tag: validate:"dive,uuid"
|
|
1451
|
+
* @description A list of User Tag IDs.
|
|
1452
|
+
*/
|
|
1453
|
+
userTags: string[];
|
|
1454
|
+
};
|
|
1218
1455
|
/** @description Object representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. */
|
|
1219
1456
|
v1Vote: {
|
|
1220
1457
|
/** @description Unique identifier for a given Vote object. */
|
|
@@ -1498,6 +1735,32 @@ export type operations = {
|
|
|
1498
1735
|
};
|
|
1499
1736
|
};
|
|
1500
1737
|
};
|
|
1738
|
+
/** Approve an Activity */
|
|
1739
|
+
PublicApiService_ApproveActivity: {
|
|
1740
|
+
parameters: {
|
|
1741
|
+
body: {
|
|
1742
|
+
body: definitions["v1ApproveActivityRequest"];
|
|
1743
|
+
};
|
|
1744
|
+
};
|
|
1745
|
+
responses: {
|
|
1746
|
+
/** A successful response. */
|
|
1747
|
+
200: {
|
|
1748
|
+
schema: definitions["v1ActivityResponse"];
|
|
1749
|
+
};
|
|
1750
|
+
/** Returned when the user does not have permission to access the resource. */
|
|
1751
|
+
403: {
|
|
1752
|
+
schema: unknown;
|
|
1753
|
+
};
|
|
1754
|
+
/** Returned when the resource does not exist. */
|
|
1755
|
+
404: {
|
|
1756
|
+
schema: string;
|
|
1757
|
+
};
|
|
1758
|
+
/** An unexpected error response. */
|
|
1759
|
+
default: {
|
|
1760
|
+
schema: definitions["rpcStatus"];
|
|
1761
|
+
};
|
|
1762
|
+
};
|
|
1763
|
+
};
|
|
1501
1764
|
/** Add api keys to an existing User */
|
|
1502
1765
|
PublicApiService_CreateApiKeys: {
|
|
1503
1766
|
parameters: {
|
|
@@ -1550,6 +1813,32 @@ export type operations = {
|
|
|
1550
1813
|
};
|
|
1551
1814
|
};
|
|
1552
1815
|
};
|
|
1816
|
+
/** Create Authenticators to authenticate requests to Turnkey */
|
|
1817
|
+
PublicApiService_CreateAuthenticators: {
|
|
1818
|
+
parameters: {
|
|
1819
|
+
body: {
|
|
1820
|
+
body: definitions["v1CreateAuthenticatorsRequest"];
|
|
1821
|
+
};
|
|
1822
|
+
};
|
|
1823
|
+
responses: {
|
|
1824
|
+
/** A successful response. */
|
|
1825
|
+
200: {
|
|
1826
|
+
schema: definitions["v1ActivityResponse"];
|
|
1827
|
+
};
|
|
1828
|
+
/** Returned when the user does not have permission to access the resource. */
|
|
1829
|
+
403: {
|
|
1830
|
+
schema: unknown;
|
|
1831
|
+
};
|
|
1832
|
+
/** Returned when the resource does not exist. */
|
|
1833
|
+
404: {
|
|
1834
|
+
schema: string;
|
|
1835
|
+
};
|
|
1836
|
+
/** An unexpected error response. */
|
|
1837
|
+
default: {
|
|
1838
|
+
schema: definitions["rpcStatus"];
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
};
|
|
1553
1842
|
/** Create Invitations to join an existing Organization */
|
|
1554
1843
|
PublicApiService_CreateInvitations: {
|
|
1555
1844
|
parameters: {
|
|
@@ -1732,6 +2021,32 @@ export type operations = {
|
|
|
1732
2021
|
};
|
|
1733
2022
|
};
|
|
1734
2023
|
};
|
|
2024
|
+
/** Reject an Activity */
|
|
2025
|
+
PublicApiService_RejectActivity: {
|
|
2026
|
+
parameters: {
|
|
2027
|
+
body: {
|
|
2028
|
+
body: definitions["v1RejectActivityRequest"];
|
|
2029
|
+
};
|
|
2030
|
+
};
|
|
2031
|
+
responses: {
|
|
2032
|
+
/** A successful response. */
|
|
2033
|
+
200: {
|
|
2034
|
+
schema: definitions["v1ActivityResponse"];
|
|
2035
|
+
};
|
|
2036
|
+
/** Returned when the user does not have permission to access the resource. */
|
|
2037
|
+
403: {
|
|
2038
|
+
schema: unknown;
|
|
2039
|
+
};
|
|
2040
|
+
/** Returned when the resource does not exist. */
|
|
2041
|
+
404: {
|
|
2042
|
+
schema: string;
|
|
2043
|
+
};
|
|
2044
|
+
/** An unexpected error response. */
|
|
2045
|
+
default: {
|
|
2046
|
+
schema: definitions["rpcStatus"];
|
|
2047
|
+
};
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
1735
2050
|
/** Sign a raw payload with a Private Key */
|
|
1736
2051
|
PublicApiService_SignRawPayload: {
|
|
1737
2052
|
parameters: {
|
|
@@ -1784,6 +2099,58 @@ export type operations = {
|
|
|
1784
2099
|
};
|
|
1785
2100
|
};
|
|
1786
2101
|
};
|
|
2102
|
+
/** Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail. */
|
|
2103
|
+
PublicApiService_UpdatePrivateKeyTag: {
|
|
2104
|
+
parameters: {
|
|
2105
|
+
body: {
|
|
2106
|
+
body: definitions["v1UpdatePrivateKeyTagRequest"];
|
|
2107
|
+
};
|
|
2108
|
+
};
|
|
2109
|
+
responses: {
|
|
2110
|
+
/** A successful response. */
|
|
2111
|
+
200: {
|
|
2112
|
+
schema: definitions["v1ActivityResponse"];
|
|
2113
|
+
};
|
|
2114
|
+
/** Returned when the user does not have permission to access the resource. */
|
|
2115
|
+
403: {
|
|
2116
|
+
schema: unknown;
|
|
2117
|
+
};
|
|
2118
|
+
/** Returned when the resource does not exist. */
|
|
2119
|
+
404: {
|
|
2120
|
+
schema: string;
|
|
2121
|
+
};
|
|
2122
|
+
/** An unexpected error response. */
|
|
2123
|
+
default: {
|
|
2124
|
+
schema: definitions["rpcStatus"];
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
2127
|
+
};
|
|
2128
|
+
/** 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. */
|
|
2129
|
+
PublicApiService_UpdateUserTag: {
|
|
2130
|
+
parameters: {
|
|
2131
|
+
body: {
|
|
2132
|
+
body: definitions["v1UpdateUserTagRequest"];
|
|
2133
|
+
};
|
|
2134
|
+
};
|
|
2135
|
+
responses: {
|
|
2136
|
+
/** A successful response. */
|
|
2137
|
+
200: {
|
|
2138
|
+
schema: definitions["v1ActivityResponse"];
|
|
2139
|
+
};
|
|
2140
|
+
/** Returned when the user does not have permission to access the resource. */
|
|
2141
|
+
403: {
|
|
2142
|
+
schema: unknown;
|
|
2143
|
+
};
|
|
2144
|
+
/** Returned when the resource does not exist. */
|
|
2145
|
+
404: {
|
|
2146
|
+
schema: string;
|
|
2147
|
+
};
|
|
2148
|
+
/** An unexpected error response. */
|
|
2149
|
+
default: {
|
|
2150
|
+
schema: definitions["rpcStatus"];
|
|
2151
|
+
};
|
|
2152
|
+
};
|
|
2153
|
+
};
|
|
1787
2154
|
/** Get details about a Private Key */
|
|
1788
2155
|
PublicApiService_GetPrivateKeyBackwardsCompat: {
|
|
1789
2156
|
parameters: {
|