@turnkey/http 1.2.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +43 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts +123 -3
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js +208 -5
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts +12243 -617
- 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 +199 -7
- 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 +1071 -108
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts +500 -64
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts.map +1 -1
- package/dist/webauthn.d.ts.map +1 -1
- package/dist/webauthn.js +14 -0
- package/dist/webauthn.js.map +1 -1
- package/package.json +2 -2
|
@@ -22,9 +22,17 @@
|
|
|
22
22
|
"name": "Policies",
|
|
23
23
|
"description": "Policies allow for deep customization of the security of your Organization. They can be used to grant permissions or restrict usage of Users and Private Keys. The Policy Engine analyzes all of your Policies on each request to determine whether an Activity is allowed.\n\nSee [Policy Overview](../managing-policies/overview) for more information"
|
|
24
24
|
},
|
|
25
|
+
{
|
|
26
|
+
"name": "Wallets",
|
|
27
|
+
"description": "Wallets contain collections of deterministically generated cryptographic public / private key pairs that share a common seed. Turnkey securely holds the common seed, but only you can access it. In most cases, Wallets should be preferred over Private Keys since they can be represented by a mnemonic phrase, used across a variety of cryptographic curves, and can derive many addresses."
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "Signatures",
|
|
31
|
+
"description": "Signatures are used to validate the authenticity and integrity of a digital message. Signatures are a fundamental building block in blockchains. Turnkey makes it easy to produce signatures by allowing you to sign with an address. If Turnkey doesn't yet support an address format you need, you can generate and sign with the public key instead by using the address format `ADDRESS_FORMAT_COMPRESSED`."
|
|
32
|
+
},
|
|
25
33
|
{
|
|
26
34
|
"name": "Private Keys",
|
|
27
|
-
"description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption.
|
|
35
|
+
"description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption. Turnkey securely holds all Private Key materials for you, but only you can access them."
|
|
28
36
|
},
|
|
29
37
|
{
|
|
30
38
|
"name": "Private Key Tags",
|
|
@@ -796,6 +804,70 @@
|
|
|
796
804
|
"tags": ["Users"]
|
|
797
805
|
}
|
|
798
806
|
},
|
|
807
|
+
"/public/v1/submit/create_wallet": {
|
|
808
|
+
"post": {
|
|
809
|
+
"summary": "Create Wallet",
|
|
810
|
+
"description": "Create a Wallet and derive addresses",
|
|
811
|
+
"operationId": "PublicApiService_CreateWallet",
|
|
812
|
+
"responses": {
|
|
813
|
+
"200": {
|
|
814
|
+
"description": "A successful response.",
|
|
815
|
+
"schema": {
|
|
816
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
817
|
+
}
|
|
818
|
+
},
|
|
819
|
+
"default": {
|
|
820
|
+
"description": "An unexpected error response.",
|
|
821
|
+
"schema": {
|
|
822
|
+
"$ref": "#/definitions/rpcStatus"
|
|
823
|
+
}
|
|
824
|
+
}
|
|
825
|
+
},
|
|
826
|
+
"parameters": [
|
|
827
|
+
{
|
|
828
|
+
"name": "body",
|
|
829
|
+
"in": "body",
|
|
830
|
+
"required": true,
|
|
831
|
+
"schema": {
|
|
832
|
+
"$ref": "#/definitions/v1CreateWalletRequest"
|
|
833
|
+
}
|
|
834
|
+
}
|
|
835
|
+
],
|
|
836
|
+
"tags": ["Wallets"]
|
|
837
|
+
}
|
|
838
|
+
},
|
|
839
|
+
"/public/v1/submit/create_wallet_accounts": {
|
|
840
|
+
"post": {
|
|
841
|
+
"summary": "Create Wallet Accounts",
|
|
842
|
+
"description": "Derive additional addresses using an existing wallet",
|
|
843
|
+
"operationId": "PublicApiService_CreateWalletAccounts",
|
|
844
|
+
"responses": {
|
|
845
|
+
"200": {
|
|
846
|
+
"description": "A successful response.",
|
|
847
|
+
"schema": {
|
|
848
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
849
|
+
}
|
|
850
|
+
},
|
|
851
|
+
"default": {
|
|
852
|
+
"description": "An unexpected error response.",
|
|
853
|
+
"schema": {
|
|
854
|
+
"$ref": "#/definitions/rpcStatus"
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
},
|
|
858
|
+
"parameters": [
|
|
859
|
+
{
|
|
860
|
+
"name": "body",
|
|
861
|
+
"in": "body",
|
|
862
|
+
"required": true,
|
|
863
|
+
"schema": {
|
|
864
|
+
"$ref": "#/definitions/v1CreateWalletAccountsRequest"
|
|
865
|
+
}
|
|
866
|
+
}
|
|
867
|
+
],
|
|
868
|
+
"tags": ["Wallets"]
|
|
869
|
+
}
|
|
870
|
+
},
|
|
799
871
|
"/public/v1/submit/delete_api_keys": {
|
|
800
872
|
"post": {
|
|
801
873
|
"summary": "Delete API Keys",
|
|
@@ -860,7 +932,7 @@
|
|
|
860
932
|
"tags": ["Authenticators"]
|
|
861
933
|
}
|
|
862
934
|
},
|
|
863
|
-
"/public/v1/submit/
|
|
935
|
+
"/public/v1/submit/delete_invitation": {
|
|
864
936
|
"post": {
|
|
865
937
|
"summary": "Delete Invitation",
|
|
866
938
|
"description": "Delete an existing Invitation",
|
|
@@ -924,6 +996,134 @@
|
|
|
924
996
|
"tags": ["Policies"]
|
|
925
997
|
}
|
|
926
998
|
},
|
|
999
|
+
"/public/v1/submit/export_private_key": {
|
|
1000
|
+
"post": {
|
|
1001
|
+
"summary": "Export Private Key",
|
|
1002
|
+
"description": "Exports a Private Key",
|
|
1003
|
+
"operationId": "PublicApiService_ExportPrivateKey",
|
|
1004
|
+
"responses": {
|
|
1005
|
+
"200": {
|
|
1006
|
+
"description": "A successful response.",
|
|
1007
|
+
"schema": {
|
|
1008
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1009
|
+
}
|
|
1010
|
+
},
|
|
1011
|
+
"default": {
|
|
1012
|
+
"description": "An unexpected error response.",
|
|
1013
|
+
"schema": {
|
|
1014
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1015
|
+
}
|
|
1016
|
+
}
|
|
1017
|
+
},
|
|
1018
|
+
"parameters": [
|
|
1019
|
+
{
|
|
1020
|
+
"name": "body",
|
|
1021
|
+
"in": "body",
|
|
1022
|
+
"required": true,
|
|
1023
|
+
"schema": {
|
|
1024
|
+
"$ref": "#/definitions/v1ExportPrivateKeyRequest"
|
|
1025
|
+
}
|
|
1026
|
+
}
|
|
1027
|
+
],
|
|
1028
|
+
"tags": ["Private Keys"]
|
|
1029
|
+
}
|
|
1030
|
+
},
|
|
1031
|
+
"/public/v1/submit/export_wallet": {
|
|
1032
|
+
"post": {
|
|
1033
|
+
"summary": "Export Wallet",
|
|
1034
|
+
"description": "Exports a Wallet",
|
|
1035
|
+
"operationId": "PublicApiService_ExportWallet",
|
|
1036
|
+
"responses": {
|
|
1037
|
+
"200": {
|
|
1038
|
+
"description": "A successful response.",
|
|
1039
|
+
"schema": {
|
|
1040
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
"default": {
|
|
1044
|
+
"description": "An unexpected error response.",
|
|
1045
|
+
"schema": {
|
|
1046
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1047
|
+
}
|
|
1048
|
+
}
|
|
1049
|
+
},
|
|
1050
|
+
"parameters": [
|
|
1051
|
+
{
|
|
1052
|
+
"name": "body",
|
|
1053
|
+
"in": "body",
|
|
1054
|
+
"required": true,
|
|
1055
|
+
"schema": {
|
|
1056
|
+
"$ref": "#/definitions/v1ExportWalletRequest"
|
|
1057
|
+
}
|
|
1058
|
+
}
|
|
1059
|
+
],
|
|
1060
|
+
"tags": ["Wallets"]
|
|
1061
|
+
}
|
|
1062
|
+
},
|
|
1063
|
+
"/public/v1/submit/init_user_email_recovery": {
|
|
1064
|
+
"post": {
|
|
1065
|
+
"summary": "Init Email Recovery",
|
|
1066
|
+
"description": "Initializes a new email recovery",
|
|
1067
|
+
"operationId": "PublicApiService_InitUserEmailRecovery",
|
|
1068
|
+
"responses": {
|
|
1069
|
+
"200": {
|
|
1070
|
+
"description": "A successful response.",
|
|
1071
|
+
"schema": {
|
|
1072
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"default": {
|
|
1076
|
+
"description": "An unexpected error response.",
|
|
1077
|
+
"schema": {
|
|
1078
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1079
|
+
}
|
|
1080
|
+
}
|
|
1081
|
+
},
|
|
1082
|
+
"parameters": [
|
|
1083
|
+
{
|
|
1084
|
+
"name": "body",
|
|
1085
|
+
"in": "body",
|
|
1086
|
+
"required": true,
|
|
1087
|
+
"schema": {
|
|
1088
|
+
"$ref": "#/definitions/v1InitUserEmailRecoveryRequest"
|
|
1089
|
+
}
|
|
1090
|
+
}
|
|
1091
|
+
],
|
|
1092
|
+
"tags": ["User Recovery"]
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"/public/v1/submit/recover_user": {
|
|
1096
|
+
"post": {
|
|
1097
|
+
"summary": "Recover a user",
|
|
1098
|
+
"description": "Completes the process of recovering a user by adding an authenticator",
|
|
1099
|
+
"operationId": "PublicApiService_RecoverUser",
|
|
1100
|
+
"responses": {
|
|
1101
|
+
"200": {
|
|
1102
|
+
"description": "A successful response.",
|
|
1103
|
+
"schema": {
|
|
1104
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1105
|
+
}
|
|
1106
|
+
},
|
|
1107
|
+
"default": {
|
|
1108
|
+
"description": "An unexpected error response.",
|
|
1109
|
+
"schema": {
|
|
1110
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1111
|
+
}
|
|
1112
|
+
}
|
|
1113
|
+
},
|
|
1114
|
+
"parameters": [
|
|
1115
|
+
{
|
|
1116
|
+
"name": "body",
|
|
1117
|
+
"in": "body",
|
|
1118
|
+
"required": true,
|
|
1119
|
+
"schema": {
|
|
1120
|
+
"$ref": "#/definitions/v1RecoverUserRequest"
|
|
1121
|
+
}
|
|
1122
|
+
}
|
|
1123
|
+
],
|
|
1124
|
+
"tags": ["User Recovery"]
|
|
1125
|
+
}
|
|
1126
|
+
},
|
|
927
1127
|
"/public/v1/submit/reject_activity": {
|
|
928
1128
|
"post": {
|
|
929
1129
|
"summary": "Reject Activity",
|
|
@@ -956,10 +1156,74 @@
|
|
|
956
1156
|
"tags": ["Consensus"]
|
|
957
1157
|
}
|
|
958
1158
|
},
|
|
1159
|
+
"/public/v1/submit/remove_organization_feature": {
|
|
1160
|
+
"post": {
|
|
1161
|
+
"summary": "Remove Organization Feature",
|
|
1162
|
+
"description": "Removes an organization feature",
|
|
1163
|
+
"operationId": "PublicApiService_RemoveOrganizationFeature",
|
|
1164
|
+
"responses": {
|
|
1165
|
+
"200": {
|
|
1166
|
+
"description": "A successful response.",
|
|
1167
|
+
"schema": {
|
|
1168
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1169
|
+
}
|
|
1170
|
+
},
|
|
1171
|
+
"default": {
|
|
1172
|
+
"description": "An unexpected error response.",
|
|
1173
|
+
"schema": {
|
|
1174
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1175
|
+
}
|
|
1176
|
+
}
|
|
1177
|
+
},
|
|
1178
|
+
"parameters": [
|
|
1179
|
+
{
|
|
1180
|
+
"name": "body",
|
|
1181
|
+
"in": "body",
|
|
1182
|
+
"required": true,
|
|
1183
|
+
"schema": {
|
|
1184
|
+
"$ref": "#/definitions/v1RemoveOrganizationFeatureRequest"
|
|
1185
|
+
}
|
|
1186
|
+
}
|
|
1187
|
+
],
|
|
1188
|
+
"tags": ["Features"]
|
|
1189
|
+
}
|
|
1190
|
+
},
|
|
1191
|
+
"/public/v1/submit/set_organization_feature": {
|
|
1192
|
+
"post": {
|
|
1193
|
+
"summary": "Set Organization Feature",
|
|
1194
|
+
"description": "Sets an organization feature",
|
|
1195
|
+
"operationId": "PublicApiService_SetOrganizationFeature",
|
|
1196
|
+
"responses": {
|
|
1197
|
+
"200": {
|
|
1198
|
+
"description": "A successful response.",
|
|
1199
|
+
"schema": {
|
|
1200
|
+
"$ref": "#/definitions/v1ActivityResponse"
|
|
1201
|
+
}
|
|
1202
|
+
},
|
|
1203
|
+
"default": {
|
|
1204
|
+
"description": "An unexpected error response.",
|
|
1205
|
+
"schema": {
|
|
1206
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1207
|
+
}
|
|
1208
|
+
}
|
|
1209
|
+
},
|
|
1210
|
+
"parameters": [
|
|
1211
|
+
{
|
|
1212
|
+
"name": "body",
|
|
1213
|
+
"in": "body",
|
|
1214
|
+
"required": true,
|
|
1215
|
+
"schema": {
|
|
1216
|
+
"$ref": "#/definitions/v1SetOrganizationFeatureRequest"
|
|
1217
|
+
}
|
|
1218
|
+
}
|
|
1219
|
+
],
|
|
1220
|
+
"tags": ["Features"]
|
|
1221
|
+
}
|
|
1222
|
+
},
|
|
959
1223
|
"/public/v1/submit/sign_raw_payload": {
|
|
960
1224
|
"post": {
|
|
961
1225
|
"summary": "Sign Raw Payload",
|
|
962
|
-
"description": "Sign a raw payload
|
|
1226
|
+
"description": "Sign a raw payload",
|
|
963
1227
|
"operationId": "PublicApiService_SignRawPayload",
|
|
964
1228
|
"responses": {
|
|
965
1229
|
"200": {
|
|
@@ -985,13 +1249,13 @@
|
|
|
985
1249
|
}
|
|
986
1250
|
}
|
|
987
1251
|
],
|
|
988
|
-
"tags": ["
|
|
1252
|
+
"tags": ["Signatures"]
|
|
989
1253
|
}
|
|
990
1254
|
},
|
|
991
1255
|
"/public/v1/submit/sign_transaction": {
|
|
992
1256
|
"post": {
|
|
993
1257
|
"summary": "Sign Transaction",
|
|
994
|
-
"description": "Sign a transaction
|
|
1258
|
+
"description": "Sign a transaction",
|
|
995
1259
|
"operationId": "PublicApiService_SignTransaction",
|
|
996
1260
|
"responses": {
|
|
997
1261
|
"200": {
|
|
@@ -1017,7 +1281,7 @@
|
|
|
1017
1281
|
}
|
|
1018
1282
|
}
|
|
1019
1283
|
],
|
|
1020
|
-
"tags": ["
|
|
1284
|
+
"tags": ["Signatures"]
|
|
1021
1285
|
}
|
|
1022
1286
|
},
|
|
1023
1287
|
"/public/v1/submit/update_allowed_origins": {
|
|
@@ -1049,7 +1313,7 @@
|
|
|
1049
1313
|
}
|
|
1050
1314
|
}
|
|
1051
1315
|
],
|
|
1052
|
-
"tags": ["
|
|
1316
|
+
"tags": ["Features"]
|
|
1053
1317
|
}
|
|
1054
1318
|
},
|
|
1055
1319
|
"/public/v1/submit/update_policy": {
|
|
@@ -1249,10 +1513,10 @@
|
|
|
1249
1513
|
"$ref": "#/definitions/v1TagType"
|
|
1250
1514
|
},
|
|
1251
1515
|
"createdAt": {
|
|
1252
|
-
"$ref": "#/definitions/
|
|
1516
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1253
1517
|
},
|
|
1254
1518
|
"updatedAt": {
|
|
1255
|
-
"$ref": "#/definitions/
|
|
1519
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1256
1520
|
}
|
|
1257
1521
|
},
|
|
1258
1522
|
"required": ["tagId", "tagName", "tagType", "createdAt", "updatedAt"]
|
|
@@ -1290,6 +1554,27 @@
|
|
|
1290
1554
|
"AUTHENTICATOR_TRANSPORT_HYBRID"
|
|
1291
1555
|
]
|
|
1292
1556
|
},
|
|
1557
|
+
"externaldatav1Credential": {
|
|
1558
|
+
"type": "object",
|
|
1559
|
+
"properties": {
|
|
1560
|
+
"publicKey": {
|
|
1561
|
+
"type": "string",
|
|
1562
|
+
"description": "The public component of a cryptographic key pair used to sign messages and transactions."
|
|
1563
|
+
},
|
|
1564
|
+
"type": {
|
|
1565
|
+
"$ref": "#/definitions/externaldatav1CredentialType"
|
|
1566
|
+
}
|
|
1567
|
+
},
|
|
1568
|
+
"required": ["publicKey", "type"]
|
|
1569
|
+
},
|
|
1570
|
+
"externaldatav1CredentialType": {
|
|
1571
|
+
"type": "string",
|
|
1572
|
+
"enum": [
|
|
1573
|
+
"CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR",
|
|
1574
|
+
"CREDENTIAL_TYPE_API_KEY_P256",
|
|
1575
|
+
"CREDENTIAL_TYPE_RECOVER_USER_KEY_P256"
|
|
1576
|
+
]
|
|
1577
|
+
},
|
|
1293
1578
|
"externaldatav1Curve": {
|
|
1294
1579
|
"type": "string",
|
|
1295
1580
|
"enum": ["CURVE_SECP256K1", "CURVE_ED25519"]
|
|
@@ -1314,6 +1599,24 @@
|
|
|
1314
1599
|
"OPERATOR_CONTAINS_ALL"
|
|
1315
1600
|
]
|
|
1316
1601
|
},
|
|
1602
|
+
"externaldatav1Quorum": {
|
|
1603
|
+
"type": "object",
|
|
1604
|
+
"properties": {
|
|
1605
|
+
"threshold": {
|
|
1606
|
+
"type": "integer",
|
|
1607
|
+
"format": "int32",
|
|
1608
|
+
"description": "Count of unique approvals required to meet quorum."
|
|
1609
|
+
},
|
|
1610
|
+
"userIds": {
|
|
1611
|
+
"type": "array",
|
|
1612
|
+
"items": {
|
|
1613
|
+
"type": "string"
|
|
1614
|
+
},
|
|
1615
|
+
"description": "Unique identifiers of quorum set members."
|
|
1616
|
+
}
|
|
1617
|
+
},
|
|
1618
|
+
"required": ["threshold", "userIds"]
|
|
1619
|
+
},
|
|
1317
1620
|
"externaldatav1Selector": {
|
|
1318
1621
|
"type": "object",
|
|
1319
1622
|
"properties": {
|
|
@@ -1335,6 +1638,18 @@
|
|
|
1335
1638
|
},
|
|
1336
1639
|
"required": ["subject", "operator", "targets"]
|
|
1337
1640
|
},
|
|
1641
|
+
"externaldatav1Timestamp": {
|
|
1642
|
+
"type": "object",
|
|
1643
|
+
"properties": {
|
|
1644
|
+
"seconds": {
|
|
1645
|
+
"type": "string"
|
|
1646
|
+
},
|
|
1647
|
+
"nanos": {
|
|
1648
|
+
"type": "string"
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
"required": ["seconds", "nanos"]
|
|
1652
|
+
},
|
|
1338
1653
|
"immutableactivityv1AccessType": {
|
|
1339
1654
|
"type": "string",
|
|
1340
1655
|
"enum": ["ACCESS_TYPE_WEB", "ACCESS_TYPE_API", "ACCESS_TYPE_ALL"]
|
|
@@ -1343,28 +1658,25 @@
|
|
|
1343
1658
|
"type": "object",
|
|
1344
1659
|
"properties": {
|
|
1345
1660
|
"format": {
|
|
1346
|
-
"$ref": "#/definitions/
|
|
1661
|
+
"$ref": "#/definitions/immutablecommonv1AddressFormat"
|
|
1347
1662
|
},
|
|
1348
1663
|
"address": {
|
|
1349
1664
|
"type": "string"
|
|
1350
1665
|
}
|
|
1351
1666
|
}
|
|
1352
1667
|
},
|
|
1353
|
-
"
|
|
1354
|
-
"type": "string",
|
|
1355
|
-
"enum": [
|
|
1356
|
-
"ADDRESS_FORMAT_UNCOMPRESSED",
|
|
1357
|
-
"ADDRESS_FORMAT_COMPRESSED",
|
|
1358
|
-
"ADDRESS_FORMAT_ETHEREUM"
|
|
1359
|
-
]
|
|
1360
|
-
},
|
|
1361
|
-
"immutableactivityv1Curve": {
|
|
1668
|
+
"immutableactivityv1Effect": {
|
|
1362
1669
|
"type": "string",
|
|
1363
|
-
"enum": ["
|
|
1670
|
+
"enum": ["EFFECT_ALLOW", "EFFECT_DENY"]
|
|
1364
1671
|
},
|
|
1365
|
-
"
|
|
1672
|
+
"immutableactivityv1HashFunction": {
|
|
1366
1673
|
"type": "string",
|
|
1367
|
-
"enum": [
|
|
1674
|
+
"enum": [
|
|
1675
|
+
"HASH_FUNCTION_NO_OP",
|
|
1676
|
+
"HASH_FUNCTION_SHA256",
|
|
1677
|
+
"HASH_FUNCTION_KECCAK256",
|
|
1678
|
+
"HASH_FUNCTION_NOT_APPLICABLE"
|
|
1679
|
+
]
|
|
1368
1680
|
},
|
|
1369
1681
|
"immutableactivityv1Operator": {
|
|
1370
1682
|
"type": "string",
|
|
@@ -1382,6 +1694,10 @@
|
|
|
1382
1694
|
"OPERATOR_CONTAINS_ALL"
|
|
1383
1695
|
]
|
|
1384
1696
|
},
|
|
1697
|
+
"immutableactivityv1PayloadEncoding": {
|
|
1698
|
+
"type": "string",
|
|
1699
|
+
"enum": ["PAYLOAD_ENCODING_HEXADECIMAL", "PAYLOAD_ENCODING_TEXT_UTF8"]
|
|
1700
|
+
},
|
|
1385
1701
|
"immutableactivityv1Selector": {
|
|
1386
1702
|
"type": "object",
|
|
1387
1703
|
"properties": {
|
|
@@ -1396,9 +1712,19 @@
|
|
|
1396
1712
|
}
|
|
1397
1713
|
}
|
|
1398
1714
|
},
|
|
1399
|
-
"
|
|
1715
|
+
"immutablecommonv1AddressFormat": {
|
|
1400
1716
|
"type": "string",
|
|
1401
|
-
"enum": [
|
|
1717
|
+
"enum": [
|
|
1718
|
+
"ADDRESS_FORMAT_UNCOMPRESSED",
|
|
1719
|
+
"ADDRESS_FORMAT_COMPRESSED",
|
|
1720
|
+
"ADDRESS_FORMAT_ETHEREUM",
|
|
1721
|
+
"ADDRESS_FORMAT_SOLANA",
|
|
1722
|
+
"ADDRESS_FORMAT_COSMOS"
|
|
1723
|
+
]
|
|
1724
|
+
},
|
|
1725
|
+
"immutablecommonv1Curve": {
|
|
1726
|
+
"type": "string",
|
|
1727
|
+
"enum": ["CURVE_SECP256K1", "CURVE_ED25519"]
|
|
1402
1728
|
},
|
|
1403
1729
|
"immutablewebauthnv1AuthenticatorTransport": {
|
|
1404
1730
|
"type": "string",
|
|
@@ -1554,10 +1880,10 @@
|
|
|
1554
1880
|
"type": "boolean"
|
|
1555
1881
|
},
|
|
1556
1882
|
"createdAt": {
|
|
1557
|
-
"$ref": "#/definitions/
|
|
1883
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1558
1884
|
},
|
|
1559
1885
|
"updatedAt": {
|
|
1560
|
-
"$ref": "#/definitions/
|
|
1886
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1561
1887
|
}
|
|
1562
1888
|
},
|
|
1563
1889
|
"required": [
|
|
@@ -1642,14 +1968,25 @@
|
|
|
1642
1968
|
"ACTIVITY_TYPE_UPDATE_USER",
|
|
1643
1969
|
"ACTIVITY_TYPE_UPDATE_POLICY",
|
|
1644
1970
|
"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2",
|
|
1645
|
-
"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"
|
|
1971
|
+
"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3",
|
|
1972
|
+
"ACTIVITY_TYPE_CREATE_WALLET",
|
|
1973
|
+
"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS",
|
|
1974
|
+
"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
|
|
1975
|
+
"ACTIVITY_TYPE_RECOVER_USER",
|
|
1976
|
+
"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE",
|
|
1977
|
+
"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE",
|
|
1978
|
+
"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
|
|
1979
|
+
"ACTIVITY_TYPE_SIGN_TRANSACTION_V2",
|
|
1980
|
+
"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY",
|
|
1981
|
+
"ACTIVITY_TYPE_EXPORT_WALLET",
|
|
1982
|
+
"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"
|
|
1646
1983
|
]
|
|
1647
1984
|
},
|
|
1648
1985
|
"v1ApiKey": {
|
|
1649
1986
|
"type": "object",
|
|
1650
1987
|
"properties": {
|
|
1651
1988
|
"credential": {
|
|
1652
|
-
"$ref": "#/definitions/
|
|
1989
|
+
"$ref": "#/definitions/externaldatav1Credential",
|
|
1653
1990
|
"description": "A User credential that can be used to authenticate to Turnkey."
|
|
1654
1991
|
},
|
|
1655
1992
|
"apiKeyId": {
|
|
@@ -1661,10 +1998,10 @@
|
|
|
1661
1998
|
"description": "Human-readable name for an API Key."
|
|
1662
1999
|
},
|
|
1663
2000
|
"createdAt": {
|
|
1664
|
-
"$ref": "#/definitions/
|
|
2001
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1665
2002
|
},
|
|
1666
2003
|
"updatedAt": {
|
|
1667
|
-
"$ref": "#/definitions/
|
|
2004
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1668
2005
|
}
|
|
1669
2006
|
},
|
|
1670
2007
|
"required": [
|
|
@@ -1805,7 +2142,7 @@
|
|
|
1805
2142
|
"description": "The type of Authenticator device."
|
|
1806
2143
|
},
|
|
1807
2144
|
"credential": {
|
|
1808
|
-
"$ref": "#/definitions/
|
|
2145
|
+
"$ref": "#/definitions/externaldatav1Credential",
|
|
1809
2146
|
"description": "A User credential that can be used to authenticate to Turnkey."
|
|
1810
2147
|
},
|
|
1811
2148
|
"authenticatorId": {
|
|
@@ -1817,10 +2154,10 @@
|
|
|
1817
2154
|
"description": "Human-readable name for an Authenticator."
|
|
1818
2155
|
},
|
|
1819
2156
|
"createdAt": {
|
|
1820
|
-
"$ref": "#/definitions/
|
|
2157
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1821
2158
|
},
|
|
1822
2159
|
"updatedAt": {
|
|
1823
|
-
"$ref": "#/definitions/
|
|
2160
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
1824
2161
|
}
|
|
1825
2162
|
},
|
|
1826
2163
|
"required": [
|
|
@@ -2480,12 +2817,43 @@
|
|
|
2480
2817
|
"privateKeys"
|
|
2481
2818
|
]
|
|
2482
2819
|
},
|
|
2820
|
+
"v1CreateSubOrganizationIntentV4": {
|
|
2821
|
+
"type": "object",
|
|
2822
|
+
"properties": {
|
|
2823
|
+
"subOrganizationName": {
|
|
2824
|
+
"type": "string",
|
|
2825
|
+
"description": "Name for this sub-organization"
|
|
2826
|
+
},
|
|
2827
|
+
"rootUsers": {
|
|
2828
|
+
"type": "array",
|
|
2829
|
+
"items": {
|
|
2830
|
+
"type": "object",
|
|
2831
|
+
"$ref": "#/definitions/v1RootUserParams"
|
|
2832
|
+
},
|
|
2833
|
+
"description": "Root users to create within this sub-organization"
|
|
2834
|
+
},
|
|
2835
|
+
"rootQuorumThreshold": {
|
|
2836
|
+
"type": "integer",
|
|
2837
|
+
"format": "int32",
|
|
2838
|
+
"description": "The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users"
|
|
2839
|
+
},
|
|
2840
|
+
"wallet": {
|
|
2841
|
+
"$ref": "#/definitions/v1WalletParams",
|
|
2842
|
+
"description": "The wallet to create for the sub-organization"
|
|
2843
|
+
},
|
|
2844
|
+
"disableEmailRecovery": {
|
|
2845
|
+
"type": "boolean",
|
|
2846
|
+
"description": "Disable email recovery for the sub-organization"
|
|
2847
|
+
}
|
|
2848
|
+
},
|
|
2849
|
+
"required": ["subOrganizationName", "rootUsers", "rootQuorumThreshold"]
|
|
2850
|
+
},
|
|
2483
2851
|
"v1CreateSubOrganizationRequest": {
|
|
2484
2852
|
"type": "object",
|
|
2485
2853
|
"properties": {
|
|
2486
2854
|
"type": {
|
|
2487
2855
|
"type": "string",
|
|
2488
|
-
"enum": ["
|
|
2856
|
+
"enum": ["ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"]
|
|
2489
2857
|
},
|
|
2490
2858
|
"timestampMs": {
|
|
2491
2859
|
"type": "string",
|
|
@@ -2496,7 +2864,7 @@
|
|
|
2496
2864
|
"description": "Unique identifier for a given Organization."
|
|
2497
2865
|
},
|
|
2498
2866
|
"parameters": {
|
|
2499
|
-
"$ref": "#/definitions/
|
|
2867
|
+
"$ref": "#/definitions/v1CreateSubOrganizationIntentV4"
|
|
2500
2868
|
}
|
|
2501
2869
|
},
|
|
2502
2870
|
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
@@ -2527,6 +2895,18 @@
|
|
|
2527
2895
|
},
|
|
2528
2896
|
"required": ["subOrganizationId", "privateKeys"]
|
|
2529
2897
|
},
|
|
2898
|
+
"v1CreateSubOrganizationResultV4": {
|
|
2899
|
+
"type": "object",
|
|
2900
|
+
"properties": {
|
|
2901
|
+
"subOrganizationId": {
|
|
2902
|
+
"type": "string"
|
|
2903
|
+
},
|
|
2904
|
+
"wallet": {
|
|
2905
|
+
"$ref": "#/definitions/v1WalletResult"
|
|
2906
|
+
}
|
|
2907
|
+
},
|
|
2908
|
+
"required": ["subOrganizationId"]
|
|
2909
|
+
},
|
|
2530
2910
|
"v1CreateUserTagIntent": {
|
|
2531
2911
|
"type": "object",
|
|
2532
2912
|
"properties": {
|
|
@@ -2644,34 +3024,122 @@
|
|
|
2644
3024
|
},
|
|
2645
3025
|
"required": ["userIds"]
|
|
2646
3026
|
},
|
|
2647
|
-
"
|
|
3027
|
+
"v1CreateWalletAccountsIntent": {
|
|
2648
3028
|
"type": "object",
|
|
2649
3029
|
"properties": {
|
|
2650
|
-
"
|
|
2651
|
-
"type": "
|
|
3030
|
+
"walletId": {
|
|
3031
|
+
"type": "string",
|
|
3032
|
+
"description": "Unique identifier for a given Wallet."
|
|
3033
|
+
},
|
|
3034
|
+
"accounts": {
|
|
3035
|
+
"type": "array",
|
|
3036
|
+
"items": {
|
|
3037
|
+
"type": "object",
|
|
3038
|
+
"$ref": "#/definitions/v1WalletAccountParams"
|
|
3039
|
+
},
|
|
3040
|
+
"description": "A list of wallet Accounts."
|
|
2652
3041
|
}
|
|
2653
3042
|
},
|
|
2654
|
-
"required": ["
|
|
3043
|
+
"required": ["walletId", "accounts"]
|
|
2655
3044
|
},
|
|
2656
|
-
"
|
|
3045
|
+
"v1CreateWalletAccountsRequest": {
|
|
2657
3046
|
"type": "object",
|
|
2658
3047
|
"properties": {
|
|
2659
|
-
"
|
|
3048
|
+
"type": {
|
|
2660
3049
|
"type": "string",
|
|
2661
|
-
"
|
|
3050
|
+
"enum": ["ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"]
|
|
3051
|
+
},
|
|
3052
|
+
"timestampMs": {
|
|
3053
|
+
"type": "string",
|
|
3054
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3055
|
+
},
|
|
3056
|
+
"organizationId": {
|
|
3057
|
+
"type": "string",
|
|
3058
|
+
"description": "Unique identifier for a given Organization."
|
|
3059
|
+
},
|
|
3060
|
+
"parameters": {
|
|
3061
|
+
"$ref": "#/definitions/v1CreateWalletAccountsIntent"
|
|
3062
|
+
}
|
|
3063
|
+
},
|
|
3064
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3065
|
+
},
|
|
3066
|
+
"v1CreateWalletAccountsResult": {
|
|
3067
|
+
"type": "object",
|
|
3068
|
+
"properties": {
|
|
3069
|
+
"addresses": {
|
|
3070
|
+
"type": "array",
|
|
3071
|
+
"items": {
|
|
3072
|
+
"type": "string"
|
|
3073
|
+
},
|
|
3074
|
+
"description": "A list of derived addresses."
|
|
3075
|
+
}
|
|
3076
|
+
},
|
|
3077
|
+
"required": ["addresses"]
|
|
3078
|
+
},
|
|
3079
|
+
"v1CreateWalletIntent": {
|
|
3080
|
+
"type": "object",
|
|
3081
|
+
"properties": {
|
|
3082
|
+
"walletName": {
|
|
3083
|
+
"type": "string",
|
|
3084
|
+
"description": "Human-readable name for a Wallet."
|
|
2662
3085
|
},
|
|
3086
|
+
"accounts": {
|
|
3087
|
+
"type": "array",
|
|
3088
|
+
"items": {
|
|
3089
|
+
"type": "object",
|
|
3090
|
+
"$ref": "#/definitions/v1WalletAccountParams"
|
|
3091
|
+
},
|
|
3092
|
+
"description": "A list of wallet Accounts."
|
|
3093
|
+
}
|
|
3094
|
+
},
|
|
3095
|
+
"required": ["walletName", "accounts"]
|
|
3096
|
+
},
|
|
3097
|
+
"v1CreateWalletRequest": {
|
|
3098
|
+
"type": "object",
|
|
3099
|
+
"properties": {
|
|
2663
3100
|
"type": {
|
|
2664
|
-
"
|
|
3101
|
+
"type": "string",
|
|
3102
|
+
"enum": ["ACTIVITY_TYPE_CREATE_WALLET"]
|
|
3103
|
+
},
|
|
3104
|
+
"timestampMs": {
|
|
3105
|
+
"type": "string",
|
|
3106
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3107
|
+
},
|
|
3108
|
+
"organizationId": {
|
|
3109
|
+
"type": "string",
|
|
3110
|
+
"description": "Unique identifier for a given Organization."
|
|
3111
|
+
},
|
|
3112
|
+
"parameters": {
|
|
3113
|
+
"$ref": "#/definitions/v1CreateWalletIntent"
|
|
2665
3114
|
}
|
|
2666
3115
|
},
|
|
2667
|
-
"required": ["
|
|
3116
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
2668
3117
|
},
|
|
2669
|
-
"
|
|
2670
|
-
"type": "
|
|
2671
|
-
"
|
|
2672
|
-
"
|
|
2673
|
-
|
|
2674
|
-
|
|
3118
|
+
"v1CreateWalletResult": {
|
|
3119
|
+
"type": "object",
|
|
3120
|
+
"properties": {
|
|
3121
|
+
"walletId": {
|
|
3122
|
+
"type": "string",
|
|
3123
|
+
"description": "A list of Wallet IDs."
|
|
3124
|
+
},
|
|
3125
|
+
"addresses": {
|
|
3126
|
+
"type": "array",
|
|
3127
|
+
"items": {
|
|
3128
|
+
"type": "string"
|
|
3129
|
+
},
|
|
3130
|
+
"description": "A list of account addresses."
|
|
3131
|
+
}
|
|
3132
|
+
},
|
|
3133
|
+
"required": ["walletId", "addresses"]
|
|
3134
|
+
},
|
|
3135
|
+
"v1CredPropsAuthenticationExtensionsClientOutputs": {
|
|
3136
|
+
"type": "object",
|
|
3137
|
+
"properties": {
|
|
3138
|
+
"rk": {
|
|
3139
|
+
"type": "boolean"
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
"required": ["rk"]
|
|
2675
3143
|
},
|
|
2676
3144
|
"v1DeleteApiKeysIntent": {
|
|
2677
3145
|
"type": "object",
|
|
@@ -3009,6 +3477,123 @@
|
|
|
3009
3477
|
},
|
|
3010
3478
|
"required": ["privateKeyId"]
|
|
3011
3479
|
},
|
|
3480
|
+
"v1ExportPrivateKeyIntent": {
|
|
3481
|
+
"type": "object",
|
|
3482
|
+
"properties": {
|
|
3483
|
+
"privateKeyId": {
|
|
3484
|
+
"type": "string",
|
|
3485
|
+
"description": "Unique identifier for a given Private Key."
|
|
3486
|
+
},
|
|
3487
|
+
"targetPublicKey": {
|
|
3488
|
+
"type": "string",
|
|
3489
|
+
"description": "Client-side public key generated by the user, to which the export bundle will be encrypted."
|
|
3490
|
+
}
|
|
3491
|
+
},
|
|
3492
|
+
"required": ["privateKeyId", "targetPublicKey"]
|
|
3493
|
+
},
|
|
3494
|
+
"v1ExportPrivateKeyRequest": {
|
|
3495
|
+
"type": "object",
|
|
3496
|
+
"properties": {
|
|
3497
|
+
"type": {
|
|
3498
|
+
"type": "string",
|
|
3499
|
+
"enum": ["ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"]
|
|
3500
|
+
},
|
|
3501
|
+
"timestampMs": {
|
|
3502
|
+
"type": "string",
|
|
3503
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3504
|
+
},
|
|
3505
|
+
"organizationId": {
|
|
3506
|
+
"type": "string",
|
|
3507
|
+
"description": "Unique identifier for a given Organization."
|
|
3508
|
+
},
|
|
3509
|
+
"parameters": {
|
|
3510
|
+
"$ref": "#/definitions/v1ExportPrivateKeyIntent"
|
|
3511
|
+
}
|
|
3512
|
+
},
|
|
3513
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3514
|
+
},
|
|
3515
|
+
"v1ExportPrivateKeyResult": {
|
|
3516
|
+
"type": "object",
|
|
3517
|
+
"properties": {
|
|
3518
|
+
"privateKeyId": {
|
|
3519
|
+
"type": "string",
|
|
3520
|
+
"description": "Unique identifier for a given Private Key."
|
|
3521
|
+
},
|
|
3522
|
+
"exportBundle": {
|
|
3523
|
+
"type": "string",
|
|
3524
|
+
"description": "Export bundle containing a private key encrypted to the client's target public key."
|
|
3525
|
+
}
|
|
3526
|
+
},
|
|
3527
|
+
"required": ["privateKeyId", "exportBundle"]
|
|
3528
|
+
},
|
|
3529
|
+
"v1ExportWalletIntent": {
|
|
3530
|
+
"type": "object",
|
|
3531
|
+
"properties": {
|
|
3532
|
+
"walletId": {
|
|
3533
|
+
"type": "string",
|
|
3534
|
+
"description": "Unique identifier for a given Wallet."
|
|
3535
|
+
},
|
|
3536
|
+
"targetPublicKey": {
|
|
3537
|
+
"type": "string",
|
|
3538
|
+
"description": "Client-side public key generated by the user, to which the export bundle will be encrypted."
|
|
3539
|
+
},
|
|
3540
|
+
"language": {
|
|
3541
|
+
"$ref": "#/definitions/v1MnemonicLanguage",
|
|
3542
|
+
"description": "The language of the mnemonic to export. Defaults to English."
|
|
3543
|
+
}
|
|
3544
|
+
},
|
|
3545
|
+
"required": ["walletId", "targetPublicKey"]
|
|
3546
|
+
},
|
|
3547
|
+
"v1ExportWalletRequest": {
|
|
3548
|
+
"type": "object",
|
|
3549
|
+
"properties": {
|
|
3550
|
+
"type": {
|
|
3551
|
+
"type": "string",
|
|
3552
|
+
"enum": ["ACTIVITY_TYPE_EXPORT_WALLET"]
|
|
3553
|
+
},
|
|
3554
|
+
"timestampMs": {
|
|
3555
|
+
"type": "string",
|
|
3556
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3557
|
+
},
|
|
3558
|
+
"organizationId": {
|
|
3559
|
+
"type": "string",
|
|
3560
|
+
"description": "Unique identifier for a given Organization."
|
|
3561
|
+
},
|
|
3562
|
+
"parameters": {
|
|
3563
|
+
"$ref": "#/definitions/v1ExportWalletIntent"
|
|
3564
|
+
}
|
|
3565
|
+
},
|
|
3566
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3567
|
+
},
|
|
3568
|
+
"v1ExportWalletResult": {
|
|
3569
|
+
"type": "object",
|
|
3570
|
+
"properties": {
|
|
3571
|
+
"walletId": {
|
|
3572
|
+
"type": "string",
|
|
3573
|
+
"description": "Unique identifier for a given Wallet."
|
|
3574
|
+
},
|
|
3575
|
+
"exportBundle": {
|
|
3576
|
+
"type": "string",
|
|
3577
|
+
"description": "Export bundle containing a wallet mnemonic + optional newline passphrase encrypted by the client's target public key."
|
|
3578
|
+
}
|
|
3579
|
+
},
|
|
3580
|
+
"required": ["walletId", "exportBundle"]
|
|
3581
|
+
},
|
|
3582
|
+
"v1Feature": {
|
|
3583
|
+
"type": "object",
|
|
3584
|
+
"properties": {
|
|
3585
|
+
"name": {
|
|
3586
|
+
"$ref": "#/definitions/v1FeatureName"
|
|
3587
|
+
},
|
|
3588
|
+
"value": {
|
|
3589
|
+
"type": "string"
|
|
3590
|
+
}
|
|
3591
|
+
}
|
|
3592
|
+
},
|
|
3593
|
+
"v1FeatureName": {
|
|
3594
|
+
"type": "string",
|
|
3595
|
+
"enum": ["FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY"]
|
|
3596
|
+
},
|
|
3012
3597
|
"v1GetActivitiesRequest": {
|
|
3013
3598
|
"type": "object",
|
|
3014
3599
|
"properties": {
|
|
@@ -3304,23 +3889,59 @@
|
|
|
3304
3889
|
},
|
|
3305
3890
|
"userId": {
|
|
3306
3891
|
"type": "string",
|
|
3307
|
-
"description": "Unique identifier for a given User."
|
|
3308
|
-
},
|
|
3309
|
-
"username": {
|
|
3310
|
-
"type": "string",
|
|
3311
|
-
"description": "Human-readable name for a User."
|
|
3892
|
+
"description": "Unique identifier for a given User."
|
|
3893
|
+
},
|
|
3894
|
+
"username": {
|
|
3895
|
+
"type": "string",
|
|
3896
|
+
"description": "Human-readable name for a User."
|
|
3897
|
+
}
|
|
3898
|
+
},
|
|
3899
|
+
"required": ["organizationId", "organizationName", "userId", "username"]
|
|
3900
|
+
},
|
|
3901
|
+
"v1InitUserEmailRecoveryIntent": {
|
|
3902
|
+
"type": "object",
|
|
3903
|
+
"properties": {
|
|
3904
|
+
"email": {
|
|
3905
|
+
"type": "string",
|
|
3906
|
+
"description": "Email of the user starting recovery"
|
|
3907
|
+
},
|
|
3908
|
+
"targetPublicKey": {
|
|
3909
|
+
"type": "string",
|
|
3910
|
+
"description": "Client-side public key generated by the user, to which the recovery bundle will be encrypted."
|
|
3911
|
+
}
|
|
3912
|
+
},
|
|
3913
|
+
"required": ["email", "targetPublicKey"]
|
|
3914
|
+
},
|
|
3915
|
+
"v1InitUserEmailRecoveryRequest": {
|
|
3916
|
+
"type": "object",
|
|
3917
|
+
"properties": {
|
|
3918
|
+
"type": {
|
|
3919
|
+
"type": "string",
|
|
3920
|
+
"enum": ["ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"]
|
|
3921
|
+
},
|
|
3922
|
+
"timestampMs": {
|
|
3923
|
+
"type": "string",
|
|
3924
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
3925
|
+
},
|
|
3926
|
+
"organizationId": {
|
|
3927
|
+
"type": "string",
|
|
3928
|
+
"description": "Unique identifier for a given Organization."
|
|
3929
|
+
},
|
|
3930
|
+
"parameters": {
|
|
3931
|
+
"$ref": "#/definitions/v1InitUserEmailRecoveryIntent"
|
|
3932
|
+
}
|
|
3933
|
+
},
|
|
3934
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3935
|
+
},
|
|
3936
|
+
"v1InitUserEmailRecoveryResult": {
|
|
3937
|
+
"type": "object",
|
|
3938
|
+
"properties": {
|
|
3939
|
+
"userId": {
|
|
3940
|
+
"type": "string",
|
|
3941
|
+
"description": "Unique identifier for the user being recovered."
|
|
3312
3942
|
}
|
|
3313
3943
|
},
|
|
3314
|
-
"required": ["
|
|
3315
|
-
},
|
|
3316
|
-
"v1HashFunction": {
|
|
3317
|
-
"type": "string",
|
|
3318
|
-
"enum": [
|
|
3319
|
-
"HASH_FUNCTION_NO_OP",
|
|
3320
|
-
"HASH_FUNCTION_SHA256",
|
|
3321
|
-
"HASH_FUNCTION_KECCAK256",
|
|
3322
|
-
"HASH_FUNCTION_NOT_APPLICABLE"
|
|
3323
|
-
]
|
|
3944
|
+
"required": ["userId"]
|
|
3324
3945
|
},
|
|
3325
3946
|
"v1Intent": {
|
|
3326
3947
|
"type": "object",
|
|
@@ -3456,6 +4077,39 @@
|
|
|
3456
4077
|
},
|
|
3457
4078
|
"createSubOrganizationIntentV3": {
|
|
3458
4079
|
"$ref": "#/definitions/v1CreateSubOrganizationIntentV3"
|
|
4080
|
+
},
|
|
4081
|
+
"createWalletIntent": {
|
|
4082
|
+
"$ref": "#/definitions/v1CreateWalletIntent"
|
|
4083
|
+
},
|
|
4084
|
+
"createWalletAccountsIntent": {
|
|
4085
|
+
"$ref": "#/definitions/v1CreateWalletAccountsIntent"
|
|
4086
|
+
},
|
|
4087
|
+
"initUserEmailRecoveryIntent": {
|
|
4088
|
+
"$ref": "#/definitions/v1InitUserEmailRecoveryIntent"
|
|
4089
|
+
},
|
|
4090
|
+
"recoverUserIntent": {
|
|
4091
|
+
"$ref": "#/definitions/v1RecoverUserIntent"
|
|
4092
|
+
},
|
|
4093
|
+
"setOrganizationFeatureIntent": {
|
|
4094
|
+
"$ref": "#/definitions/v1SetOrganizationFeatureIntent"
|
|
4095
|
+
},
|
|
4096
|
+
"removeOrganizationFeatureIntent": {
|
|
4097
|
+
"$ref": "#/definitions/v1RemoveOrganizationFeatureIntent"
|
|
4098
|
+
},
|
|
4099
|
+
"signRawPayloadIntentV2": {
|
|
4100
|
+
"$ref": "#/definitions/v1SignRawPayloadIntentV2"
|
|
4101
|
+
},
|
|
4102
|
+
"signTransactionIntentV2": {
|
|
4103
|
+
"$ref": "#/definitions/v1SignTransactionIntentV2"
|
|
4104
|
+
},
|
|
4105
|
+
"exportPrivateKeyIntent": {
|
|
4106
|
+
"$ref": "#/definitions/v1ExportPrivateKeyIntent"
|
|
4107
|
+
},
|
|
4108
|
+
"exportWalletIntent": {
|
|
4109
|
+
"$ref": "#/definitions/v1ExportWalletIntent"
|
|
4110
|
+
},
|
|
4111
|
+
"createSubOrganizationIntentV4": {
|
|
4112
|
+
"$ref": "#/definitions/v1CreateSubOrganizationIntentV4"
|
|
3459
4113
|
}
|
|
3460
4114
|
},
|
|
3461
4115
|
"required": ["createOrganizationIntent"]
|
|
@@ -3491,10 +4145,10 @@
|
|
|
3491
4145
|
"description": "The current processing status of a specified Invitation."
|
|
3492
4146
|
},
|
|
3493
4147
|
"createdAt": {
|
|
3494
|
-
"$ref": "#/definitions/
|
|
4148
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
3495
4149
|
},
|
|
3496
4150
|
"updatedAt": {
|
|
3497
|
-
"$ref": "#/definitions/
|
|
4151
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
3498
4152
|
},
|
|
3499
4153
|
"senderUserId": {
|
|
3500
4154
|
"type": "string",
|
|
@@ -3556,6 +4210,20 @@
|
|
|
3556
4210
|
"INVITATION_STATUS_REVOKED"
|
|
3557
4211
|
]
|
|
3558
4212
|
},
|
|
4213
|
+
"v1MnemonicLanguage": {
|
|
4214
|
+
"type": "string",
|
|
4215
|
+
"enum": [
|
|
4216
|
+
"MNEMONIC_LANGUAGE_ENGLISH",
|
|
4217
|
+
"MNEMONIC_LANGUAGE_SIMPLIFIED_CHINESE",
|
|
4218
|
+
"MNEMONIC_LANGUAGE_TRADITIONAL_CHINESE",
|
|
4219
|
+
"MNEMONIC_LANGUAGE_CZECH",
|
|
4220
|
+
"MNEMONIC_LANGUAGE_FRENCH",
|
|
4221
|
+
"MNEMONIC_LANGUAGE_ITALIAN",
|
|
4222
|
+
"MNEMONIC_LANGUAGE_JAPANESE",
|
|
4223
|
+
"MNEMONIC_LANGUAGE_KOREAN",
|
|
4224
|
+
"MNEMONIC_LANGUAGE_SPANISH"
|
|
4225
|
+
]
|
|
4226
|
+
},
|
|
3559
4227
|
"v1NOOPCodegenAnchorResponse": {
|
|
3560
4228
|
"type": "object",
|
|
3561
4229
|
"properties": {
|
|
@@ -3617,13 +4285,27 @@
|
|
|
3617
4285
|
}
|
|
3618
4286
|
},
|
|
3619
4287
|
"rootQuorum": {
|
|
3620
|
-
"$ref": "#/definitions/
|
|
4288
|
+
"$ref": "#/definitions/externaldatav1Quorum"
|
|
3621
4289
|
},
|
|
3622
4290
|
"allowedOrigins": {
|
|
3623
4291
|
"type": "array",
|
|
3624
4292
|
"items": {
|
|
3625
4293
|
"type": "string"
|
|
3626
4294
|
}
|
|
4295
|
+
},
|
|
4296
|
+
"features": {
|
|
4297
|
+
"type": "array",
|
|
4298
|
+
"items": {
|
|
4299
|
+
"type": "object",
|
|
4300
|
+
"$ref": "#/definitions/v1Feature"
|
|
4301
|
+
}
|
|
4302
|
+
},
|
|
4303
|
+
"wallets": {
|
|
4304
|
+
"type": "array",
|
|
4305
|
+
"items": {
|
|
4306
|
+
"type": "object",
|
|
4307
|
+
"$ref": "#/definitions/v1Wallet"
|
|
4308
|
+
}
|
|
3627
4309
|
}
|
|
3628
4310
|
}
|
|
3629
4311
|
},
|
|
@@ -3644,9 +4326,9 @@
|
|
|
3644
4326
|
}
|
|
3645
4327
|
}
|
|
3646
4328
|
},
|
|
3647
|
-
"
|
|
4329
|
+
"v1PathFormat": {
|
|
3648
4330
|
"type": "string",
|
|
3649
|
-
"enum": ["
|
|
4331
|
+
"enum": ["PATH_FORMAT_BIP32"]
|
|
3650
4332
|
},
|
|
3651
4333
|
"v1Policy": {
|
|
3652
4334
|
"type": "object",
|
|
@@ -3672,10 +4354,10 @@
|
|
|
3672
4354
|
"description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details."
|
|
3673
4355
|
},
|
|
3674
4356
|
"createdAt": {
|
|
3675
|
-
"$ref": "#/definitions/
|
|
4357
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
3676
4358
|
},
|
|
3677
4359
|
"updatedAt": {
|
|
3678
|
-
"$ref": "#/definitions/
|
|
4360
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
3679
4361
|
},
|
|
3680
4362
|
"notes": {
|
|
3681
4363
|
"type": "string",
|
|
@@ -3737,7 +4419,14 @@
|
|
|
3737
4419
|
"description": "A list of Private Key Tag IDs."
|
|
3738
4420
|
},
|
|
3739
4421
|
"createdAt": {
|
|
3740
|
-
"$ref": "#/definitions/
|
|
4422
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
4423
|
+
},
|
|
4424
|
+
"updatedAt": {
|
|
4425
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
4426
|
+
},
|
|
4427
|
+
"exported": {
|
|
4428
|
+
"type": "boolean",
|
|
4429
|
+
"description": "True when a given Private Key is exported, false otherwise."
|
|
3741
4430
|
}
|
|
3742
4431
|
},
|
|
3743
4432
|
"required": [
|
|
@@ -3747,7 +4436,9 @@
|
|
|
3747
4436
|
"curve",
|
|
3748
4437
|
"addresses",
|
|
3749
4438
|
"privateKeyTags",
|
|
3750
|
-
"createdAt"
|
|
4439
|
+
"createdAt",
|
|
4440
|
+
"updatedAt",
|
|
4441
|
+
"exported"
|
|
3751
4442
|
]
|
|
3752
4443
|
},
|
|
3753
4444
|
"v1PrivateKeyParams": {
|
|
@@ -3758,7 +4449,7 @@
|
|
|
3758
4449
|
"description": "Human-readable name for a Private Key."
|
|
3759
4450
|
},
|
|
3760
4451
|
"curve": {
|
|
3761
|
-
"$ref": "#/definitions/
|
|
4452
|
+
"$ref": "#/definitions/immutablecommonv1Curve",
|
|
3762
4453
|
"description": "Cryptographic Curve used to generate a given Private Key."
|
|
3763
4454
|
},
|
|
3764
4455
|
"privateKeyTags": {
|
|
@@ -3771,7 +4462,7 @@
|
|
|
3771
4462
|
"addressFormats": {
|
|
3772
4463
|
"type": "array",
|
|
3773
4464
|
"items": {
|
|
3774
|
-
"$ref": "#/definitions/
|
|
4465
|
+
"$ref": "#/definitions/immutablecommonv1AddressFormat"
|
|
3775
4466
|
},
|
|
3776
4467
|
"description": "Cryptocurrency-specific formats for a derived address (e.g., Ethereum)."
|
|
3777
4468
|
}
|
|
@@ -3825,23 +4516,53 @@
|
|
|
3825
4516
|
},
|
|
3826
4517
|
"required": ["id", "type", "rawId", "response", "clientExtensionResults"]
|
|
3827
4518
|
},
|
|
3828
|
-
"
|
|
4519
|
+
"v1RecoverUserIntent": {
|
|
3829
4520
|
"type": "object",
|
|
3830
4521
|
"properties": {
|
|
3831
|
-
"
|
|
3832
|
-
"
|
|
3833
|
-
"
|
|
3834
|
-
"description": "Count of unique approvals required to meet quorum."
|
|
4522
|
+
"authenticator": {
|
|
4523
|
+
"$ref": "#/definitions/v1AuthenticatorParamsV2",
|
|
4524
|
+
"description": "The new authenticator to register."
|
|
3835
4525
|
},
|
|
3836
|
-
"
|
|
4526
|
+
"userId": {
|
|
4527
|
+
"type": "string",
|
|
4528
|
+
"description": "Unique identifier for the user performing recovery."
|
|
4529
|
+
}
|
|
4530
|
+
},
|
|
4531
|
+
"required": ["authenticator", "userId"]
|
|
4532
|
+
},
|
|
4533
|
+
"v1RecoverUserRequest": {
|
|
4534
|
+
"type": "object",
|
|
4535
|
+
"properties": {
|
|
4536
|
+
"type": {
|
|
4537
|
+
"type": "string",
|
|
4538
|
+
"enum": ["ACTIVITY_TYPE_RECOVER_USER"]
|
|
4539
|
+
},
|
|
4540
|
+
"timestampMs": {
|
|
4541
|
+
"type": "string",
|
|
4542
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
4543
|
+
},
|
|
4544
|
+
"organizationId": {
|
|
4545
|
+
"type": "string",
|
|
4546
|
+
"description": "Unique identifier for a given Organization."
|
|
4547
|
+
},
|
|
4548
|
+
"parameters": {
|
|
4549
|
+
"$ref": "#/definitions/v1RecoverUserIntent"
|
|
4550
|
+
}
|
|
4551
|
+
},
|
|
4552
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
4553
|
+
},
|
|
4554
|
+
"v1RecoverUserResult": {
|
|
4555
|
+
"type": "object",
|
|
4556
|
+
"properties": {
|
|
4557
|
+
"authenticatorId": {
|
|
3837
4558
|
"type": "array",
|
|
3838
4559
|
"items": {
|
|
3839
4560
|
"type": "string"
|
|
3840
4561
|
},
|
|
3841
|
-
"description": "
|
|
4562
|
+
"description": "ID of the authenticator created."
|
|
3842
4563
|
}
|
|
3843
4564
|
},
|
|
3844
|
-
"required": ["
|
|
4565
|
+
"required": ["authenticatorId"]
|
|
3845
4566
|
},
|
|
3846
4567
|
"v1RejectActivityIntent": {
|
|
3847
4568
|
"type": "object",
|
|
@@ -3874,6 +4595,51 @@
|
|
|
3874
4595
|
},
|
|
3875
4596
|
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
3876
4597
|
},
|
|
4598
|
+
"v1RemoveOrganizationFeatureIntent": {
|
|
4599
|
+
"type": "object",
|
|
4600
|
+
"properties": {
|
|
4601
|
+
"name": {
|
|
4602
|
+
"$ref": "#/definitions/v1FeatureName",
|
|
4603
|
+
"description": "Name of the feature to remove"
|
|
4604
|
+
}
|
|
4605
|
+
},
|
|
4606
|
+
"required": ["name"]
|
|
4607
|
+
},
|
|
4608
|
+
"v1RemoveOrganizationFeatureRequest": {
|
|
4609
|
+
"type": "object",
|
|
4610
|
+
"properties": {
|
|
4611
|
+
"type": {
|
|
4612
|
+
"type": "string",
|
|
4613
|
+
"enum": ["ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"]
|
|
4614
|
+
},
|
|
4615
|
+
"timestampMs": {
|
|
4616
|
+
"type": "string",
|
|
4617
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
4618
|
+
},
|
|
4619
|
+
"organizationId": {
|
|
4620
|
+
"type": "string",
|
|
4621
|
+
"description": "Unique identifier for a given Organization."
|
|
4622
|
+
},
|
|
4623
|
+
"parameters": {
|
|
4624
|
+
"$ref": "#/definitions/v1RemoveOrganizationFeatureIntent"
|
|
4625
|
+
}
|
|
4626
|
+
},
|
|
4627
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
4628
|
+
},
|
|
4629
|
+
"v1RemoveOrganizationFeatureResult": {
|
|
4630
|
+
"type": "object",
|
|
4631
|
+
"properties": {
|
|
4632
|
+
"features": {
|
|
4633
|
+
"type": "array",
|
|
4634
|
+
"items": {
|
|
4635
|
+
"type": "object",
|
|
4636
|
+
"$ref": "#/definitions/v1Feature"
|
|
4637
|
+
},
|
|
4638
|
+
"description": "Resulting list of organization features."
|
|
4639
|
+
}
|
|
4640
|
+
},
|
|
4641
|
+
"required": ["features"]
|
|
4642
|
+
},
|
|
3877
4643
|
"v1Result": {
|
|
3878
4644
|
"type": "object",
|
|
3879
4645
|
"properties": {
|
|
@@ -3978,6 +4744,33 @@
|
|
|
3978
4744
|
},
|
|
3979
4745
|
"createSubOrganizationResultV3": {
|
|
3980
4746
|
"$ref": "#/definitions/v1CreateSubOrganizationResultV3"
|
|
4747
|
+
},
|
|
4748
|
+
"createWalletResult": {
|
|
4749
|
+
"$ref": "#/definitions/v1CreateWalletResult"
|
|
4750
|
+
},
|
|
4751
|
+
"createWalletAccountsResult": {
|
|
4752
|
+
"$ref": "#/definitions/v1CreateWalletAccountsResult"
|
|
4753
|
+
},
|
|
4754
|
+
"initUserEmailRecoveryResult": {
|
|
4755
|
+
"$ref": "#/definitions/v1InitUserEmailRecoveryResult"
|
|
4756
|
+
},
|
|
4757
|
+
"recoverUserResult": {
|
|
4758
|
+
"$ref": "#/definitions/v1RecoverUserResult"
|
|
4759
|
+
},
|
|
4760
|
+
"setOrganizationFeatureResult": {
|
|
4761
|
+
"$ref": "#/definitions/v1SetOrganizationFeatureResult"
|
|
4762
|
+
},
|
|
4763
|
+
"removeOrganizationFeatureResult": {
|
|
4764
|
+
"$ref": "#/definitions/v1RemoveOrganizationFeatureResult"
|
|
4765
|
+
},
|
|
4766
|
+
"exportPrivateKeyResult": {
|
|
4767
|
+
"$ref": "#/definitions/v1ExportPrivateKeyResult"
|
|
4768
|
+
},
|
|
4769
|
+
"exportWalletResult": {
|
|
4770
|
+
"$ref": "#/definitions/v1ExportWalletResult"
|
|
4771
|
+
},
|
|
4772
|
+
"createSubOrganizationResultV4": {
|
|
4773
|
+
"$ref": "#/definitions/v1CreateSubOrganizationResultV4"
|
|
3981
4774
|
}
|
|
3982
4775
|
}
|
|
3983
4776
|
},
|
|
@@ -4028,6 +4821,55 @@
|
|
|
4028
4821
|
}
|
|
4029
4822
|
}
|
|
4030
4823
|
},
|
|
4824
|
+
"v1SetOrganizationFeatureIntent": {
|
|
4825
|
+
"type": "object",
|
|
4826
|
+
"properties": {
|
|
4827
|
+
"name": {
|
|
4828
|
+
"$ref": "#/definitions/v1FeatureName",
|
|
4829
|
+
"description": "Name of the feature to set"
|
|
4830
|
+
},
|
|
4831
|
+
"value": {
|
|
4832
|
+
"type": "string",
|
|
4833
|
+
"description": "Optional value for the feature. Will override existing values if feature is already set."
|
|
4834
|
+
}
|
|
4835
|
+
},
|
|
4836
|
+
"required": ["name", "value"]
|
|
4837
|
+
},
|
|
4838
|
+
"v1SetOrganizationFeatureRequest": {
|
|
4839
|
+
"type": "object",
|
|
4840
|
+
"properties": {
|
|
4841
|
+
"type": {
|
|
4842
|
+
"type": "string",
|
|
4843
|
+
"enum": ["ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"]
|
|
4844
|
+
},
|
|
4845
|
+
"timestampMs": {
|
|
4846
|
+
"type": "string",
|
|
4847
|
+
"description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests."
|
|
4848
|
+
},
|
|
4849
|
+
"organizationId": {
|
|
4850
|
+
"type": "string",
|
|
4851
|
+
"description": "Unique identifier for a given Organization."
|
|
4852
|
+
},
|
|
4853
|
+
"parameters": {
|
|
4854
|
+
"$ref": "#/definitions/v1SetOrganizationFeatureIntent"
|
|
4855
|
+
}
|
|
4856
|
+
},
|
|
4857
|
+
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
4858
|
+
},
|
|
4859
|
+
"v1SetOrganizationFeatureResult": {
|
|
4860
|
+
"type": "object",
|
|
4861
|
+
"properties": {
|
|
4862
|
+
"features": {
|
|
4863
|
+
"type": "array",
|
|
4864
|
+
"items": {
|
|
4865
|
+
"type": "object",
|
|
4866
|
+
"$ref": "#/definitions/v1Feature"
|
|
4867
|
+
},
|
|
4868
|
+
"description": "Resulting list of organization features."
|
|
4869
|
+
}
|
|
4870
|
+
},
|
|
4871
|
+
"required": ["features"]
|
|
4872
|
+
},
|
|
4031
4873
|
"v1SetPaymentMethodIntent": {
|
|
4032
4874
|
"type": "object",
|
|
4033
4875
|
"properties": {
|
|
@@ -4113,22 +4955,44 @@
|
|
|
4113
4955
|
"description": "Raw unsigned payload to be signed."
|
|
4114
4956
|
},
|
|
4115
4957
|
"encoding": {
|
|
4116
|
-
"$ref": "#/definitions/
|
|
4958
|
+
"$ref": "#/definitions/immutableactivityv1PayloadEncoding",
|
|
4117
4959
|
"description": "Encoding of the `payload` string. Turnkey uses this information to convert `payload` into bytes with the correct decoder (e.g. hex, utf8)."
|
|
4118
4960
|
},
|
|
4119
4961
|
"hashFunction": {
|
|
4120
|
-
"$ref": "#/definitions/
|
|
4962
|
+
"$ref": "#/definitions/immutableactivityv1HashFunction",
|
|
4121
4963
|
"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."
|
|
4122
4964
|
}
|
|
4123
4965
|
},
|
|
4124
4966
|
"required": ["privateKeyId", "payload", "encoding", "hashFunction"]
|
|
4125
4967
|
},
|
|
4968
|
+
"v1SignRawPayloadIntentV2": {
|
|
4969
|
+
"type": "object",
|
|
4970
|
+
"properties": {
|
|
4971
|
+
"signWith": {
|
|
4972
|
+
"type": "string",
|
|
4973
|
+
"description": "A Wallet account address, Private Key address, or Private Key identifier."
|
|
4974
|
+
},
|
|
4975
|
+
"payload": {
|
|
4976
|
+
"type": "string",
|
|
4977
|
+
"description": "Raw unsigned payload to be signed."
|
|
4978
|
+
},
|
|
4979
|
+
"encoding": {
|
|
4980
|
+
"$ref": "#/definitions/immutableactivityv1PayloadEncoding",
|
|
4981
|
+
"description": "Encoding of the `payload` string. Turnkey uses this information to convert `payload` into bytes with the correct decoder (e.g. hex, utf8)."
|
|
4982
|
+
},
|
|
4983
|
+
"hashFunction": {
|
|
4984
|
+
"$ref": "#/definitions/immutableactivityv1HashFunction",
|
|
4985
|
+
"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."
|
|
4986
|
+
}
|
|
4987
|
+
},
|
|
4988
|
+
"required": ["signWith", "payload", "encoding", "hashFunction"]
|
|
4989
|
+
},
|
|
4126
4990
|
"v1SignRawPayloadRequest": {
|
|
4127
4991
|
"type": "object",
|
|
4128
4992
|
"properties": {
|
|
4129
4993
|
"type": {
|
|
4130
4994
|
"type": "string",
|
|
4131
|
-
"enum": ["
|
|
4995
|
+
"enum": ["ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"]
|
|
4132
4996
|
},
|
|
4133
4997
|
"timestampMs": {
|
|
4134
4998
|
"type": "string",
|
|
@@ -4139,7 +5003,7 @@
|
|
|
4139
5003
|
"description": "Unique identifier for a given Organization."
|
|
4140
5004
|
},
|
|
4141
5005
|
"parameters": {
|
|
4142
|
-
"$ref": "#/definitions/
|
|
5006
|
+
"$ref": "#/definitions/v1SignRawPayloadIntentV2"
|
|
4143
5007
|
}
|
|
4144
5008
|
},
|
|
4145
5009
|
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
@@ -4174,17 +5038,34 @@
|
|
|
4174
5038
|
"description": "Raw unsigned transaction to be signed by a particular Private Key."
|
|
4175
5039
|
},
|
|
4176
5040
|
"type": {
|
|
4177
|
-
"$ref": "#/definitions/
|
|
5041
|
+
"$ref": "#/definitions/v1TransactionType"
|
|
4178
5042
|
}
|
|
4179
5043
|
},
|
|
4180
5044
|
"required": ["privateKeyId", "unsignedTransaction", "type"]
|
|
4181
5045
|
},
|
|
5046
|
+
"v1SignTransactionIntentV2": {
|
|
5047
|
+
"type": "object",
|
|
5048
|
+
"properties": {
|
|
5049
|
+
"signWith": {
|
|
5050
|
+
"type": "string",
|
|
5051
|
+
"description": "A Wallet account address, Private Key address, or Private Key identifier."
|
|
5052
|
+
},
|
|
5053
|
+
"unsignedTransaction": {
|
|
5054
|
+
"type": "string",
|
|
5055
|
+
"description": "Raw unsigned transaction to be signed"
|
|
5056
|
+
},
|
|
5057
|
+
"type": {
|
|
5058
|
+
"$ref": "#/definitions/v1TransactionType"
|
|
5059
|
+
}
|
|
5060
|
+
},
|
|
5061
|
+
"required": ["signWith", "unsignedTransaction", "type"]
|
|
5062
|
+
},
|
|
4182
5063
|
"v1SignTransactionRequest": {
|
|
4183
5064
|
"type": "object",
|
|
4184
5065
|
"properties": {
|
|
4185
5066
|
"type": {
|
|
4186
5067
|
"type": "string",
|
|
4187
|
-
"enum": ["
|
|
5068
|
+
"enum": ["ACTIVITY_TYPE_SIGN_TRANSACTION_V2"]
|
|
4188
5069
|
},
|
|
4189
5070
|
"timestampMs": {
|
|
4190
5071
|
"type": "string",
|
|
@@ -4195,7 +5076,7 @@
|
|
|
4195
5076
|
"description": "Unique identifier for a given Organization."
|
|
4196
5077
|
},
|
|
4197
5078
|
"parameters": {
|
|
4198
|
-
"$ref": "#/definitions/
|
|
5079
|
+
"$ref": "#/definitions/v1SignTransactionIntentV2"
|
|
4199
5080
|
}
|
|
4200
5081
|
},
|
|
4201
5082
|
"required": ["type", "timestampMs", "organizationId", "parameters"]
|
|
@@ -4227,17 +5108,9 @@
|
|
|
4227
5108
|
"type": "string",
|
|
4228
5109
|
"enum": ["TAG_TYPE_USER", "TAG_TYPE_PRIVATE_KEY"]
|
|
4229
5110
|
},
|
|
4230
|
-
"
|
|
4231
|
-
"type": "
|
|
4232
|
-
"
|
|
4233
|
-
"seconds": {
|
|
4234
|
-
"type": "string"
|
|
4235
|
-
},
|
|
4236
|
-
"nanos": {
|
|
4237
|
-
"type": "string"
|
|
4238
|
-
}
|
|
4239
|
-
},
|
|
4240
|
-
"required": ["seconds", "nanos"]
|
|
5111
|
+
"v1TransactionType": {
|
|
5112
|
+
"type": "string",
|
|
5113
|
+
"enum": ["TRANSACTION_TYPE_ETHEREUM"]
|
|
4241
5114
|
},
|
|
4242
5115
|
"v1UpdateAllowedOriginsIntent": {
|
|
4243
5116
|
"type": "object",
|
|
@@ -4596,10 +5469,10 @@
|
|
|
4596
5469
|
"description": "A list of User Tag IDs."
|
|
4597
5470
|
},
|
|
4598
5471
|
"createdAt": {
|
|
4599
|
-
"$ref": "#/definitions/
|
|
5472
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
4600
5473
|
},
|
|
4601
5474
|
"updatedAt": {
|
|
4602
|
-
"$ref": "#/definitions/
|
|
5475
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
4603
5476
|
}
|
|
4604
5477
|
},
|
|
4605
5478
|
"required": [
|
|
@@ -4747,7 +5620,7 @@
|
|
|
4747
5620
|
"description": "Method used to produce a signature."
|
|
4748
5621
|
},
|
|
4749
5622
|
"createdAt": {
|
|
4750
|
-
"$ref": "#/definitions/
|
|
5623
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
4751
5624
|
}
|
|
4752
5625
|
},
|
|
4753
5626
|
"required": [
|
|
@@ -4763,6 +5636,92 @@
|
|
|
4763
5636
|
"createdAt"
|
|
4764
5637
|
]
|
|
4765
5638
|
},
|
|
5639
|
+
"v1Wallet": {
|
|
5640
|
+
"type": "object",
|
|
5641
|
+
"properties": {
|
|
5642
|
+
"walletId": {
|
|
5643
|
+
"type": "string",
|
|
5644
|
+
"description": "Unique identifier for a given Wallet."
|
|
5645
|
+
},
|
|
5646
|
+
"walletName": {
|
|
5647
|
+
"type": "string",
|
|
5648
|
+
"description": "Human-readable name for a Wallet."
|
|
5649
|
+
},
|
|
5650
|
+
"createdAt": {
|
|
5651
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
5652
|
+
},
|
|
5653
|
+
"updatedAt": {
|
|
5654
|
+
"$ref": "#/definitions/externaldatav1Timestamp"
|
|
5655
|
+
},
|
|
5656
|
+
"exported": {
|
|
5657
|
+
"type": "boolean",
|
|
5658
|
+
"description": "True when a given Wallet is exported, false otherwise."
|
|
5659
|
+
}
|
|
5660
|
+
},
|
|
5661
|
+
"required": [
|
|
5662
|
+
"walletId",
|
|
5663
|
+
"walletName",
|
|
5664
|
+
"createdAt",
|
|
5665
|
+
"updatedAt",
|
|
5666
|
+
"exported"
|
|
5667
|
+
]
|
|
5668
|
+
},
|
|
5669
|
+
"v1WalletAccountParams": {
|
|
5670
|
+
"type": "object",
|
|
5671
|
+
"properties": {
|
|
5672
|
+
"curve": {
|
|
5673
|
+
"$ref": "#/definitions/immutablecommonv1Curve",
|
|
5674
|
+
"description": "Cryptographic curve used to generate a wallet Account."
|
|
5675
|
+
},
|
|
5676
|
+
"pathFormat": {
|
|
5677
|
+
"$ref": "#/definitions/v1PathFormat",
|
|
5678
|
+
"description": "Path format used to generate a wallet Account."
|
|
5679
|
+
},
|
|
5680
|
+
"path": {
|
|
5681
|
+
"type": "string",
|
|
5682
|
+
"description": "Path used to generate a wallet Account."
|
|
5683
|
+
},
|
|
5684
|
+
"addressFormat": {
|
|
5685
|
+
"$ref": "#/definitions/immutablecommonv1AddressFormat",
|
|
5686
|
+
"description": "Address format used to generate a wallet Acccount."
|
|
5687
|
+
}
|
|
5688
|
+
},
|
|
5689
|
+
"required": ["curve", "pathFormat", "path", "addressFormat"]
|
|
5690
|
+
},
|
|
5691
|
+
"v1WalletParams": {
|
|
5692
|
+
"type": "object",
|
|
5693
|
+
"properties": {
|
|
5694
|
+
"walletName": {
|
|
5695
|
+
"type": "string",
|
|
5696
|
+
"description": "Human-readable name for a Wallet."
|
|
5697
|
+
},
|
|
5698
|
+
"accounts": {
|
|
5699
|
+
"type": "array",
|
|
5700
|
+
"items": {
|
|
5701
|
+
"type": "object",
|
|
5702
|
+
"$ref": "#/definitions/v1WalletAccountParams"
|
|
5703
|
+
},
|
|
5704
|
+
"description": "A list of wallet Accounts."
|
|
5705
|
+
}
|
|
5706
|
+
},
|
|
5707
|
+
"required": ["walletName", "accounts"]
|
|
5708
|
+
},
|
|
5709
|
+
"v1WalletResult": {
|
|
5710
|
+
"type": "object",
|
|
5711
|
+
"properties": {
|
|
5712
|
+
"walletId": {
|
|
5713
|
+
"type": "string"
|
|
5714
|
+
},
|
|
5715
|
+
"addresses": {
|
|
5716
|
+
"type": "array",
|
|
5717
|
+
"items": {
|
|
5718
|
+
"type": "string"
|
|
5719
|
+
},
|
|
5720
|
+
"description": "A list of account addresses."
|
|
5721
|
+
}
|
|
5722
|
+
},
|
|
5723
|
+
"required": ["walletId", "addresses"]
|
|
5724
|
+
},
|
|
4766
5725
|
"v1WebAuthnStamp": {
|
|
4767
5726
|
"type": "object",
|
|
4768
5727
|
"properties": {
|
|
@@ -4814,15 +5773,19 @@
|
|
|
4814
5773
|
"x-tagGroups": [
|
|
4815
5774
|
{
|
|
4816
5775
|
"name": "ORGANIZATIONS",
|
|
4817
|
-
"tags": ["Organizations", "Invitations", "Policies"]
|
|
5776
|
+
"tags": ["Organizations", "Invitations", "Policies", "Features"]
|
|
4818
5777
|
},
|
|
4819
5778
|
{
|
|
4820
5779
|
"name": "PRIVATE KEYS",
|
|
4821
|
-
"tags": ["Private Keys", "Private Key Tags"]
|
|
5780
|
+
"tags": ["Wallets", "Signatures", "Private Keys", "Private Key Tags"]
|
|
4822
5781
|
},
|
|
4823
5782
|
{
|
|
4824
5783
|
"name": "USERS",
|
|
4825
|
-
"tags": ["Users", "User Tags", "
|
|
5784
|
+
"tags": ["Users", "User Tags", "User Recovery"]
|
|
5785
|
+
},
|
|
5786
|
+
{
|
|
5787
|
+
"name": "CREDENTIALS",
|
|
5788
|
+
"tags": ["Authenticators", "API Keys", "Who am I?"]
|
|
4826
5789
|
},
|
|
4827
5790
|
{
|
|
4828
5791
|
"name": "ACTIVITIES",
|