@turnkey/http 1.0.0 → 1.1.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 +30 -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 +3066 -691
- 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 +74 -38
- 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 +576 -713
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts +282 -788
- 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 +4 -2
- 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
|
@@ -99,6 +99,10 @@ export type paths = {
|
|
|
99
99
|
/** Remove api keys from a User */
|
|
100
100
|
post: operations["PublicApiService_DeleteApiKeys"];
|
|
101
101
|
};
|
|
102
|
+
"/public/v1/submit/delete_authenticators": {
|
|
103
|
+
/** Remove authenticators from a User */
|
|
104
|
+
post: operations["PublicApiService_DeleteAuthenticators"];
|
|
105
|
+
};
|
|
102
106
|
"/public/v1/submit/delete_invitations": {
|
|
103
107
|
/** Delete an existing Invitation */
|
|
104
108
|
post: operations["PublicApiService_DeleteInvitation"];
|
|
@@ -123,6 +127,10 @@ export type paths = {
|
|
|
123
127
|
/** Update the allowable origins for credentials and requests */
|
|
124
128
|
post: operations["PublicApiService_UpdateAllowedOrigins"];
|
|
125
129
|
};
|
|
130
|
+
"/public/v1/submit/update_policy": {
|
|
131
|
+
/** Update an existing Policy */
|
|
132
|
+
post: operations["PublicApiService_UpdatePolicy"];
|
|
133
|
+
};
|
|
126
134
|
"/public/v1/submit/update_private_key_tag": {
|
|
127
135
|
/** 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. */
|
|
128
136
|
post: operations["PublicApiService_UpdatePrivateKeyTag"];
|
|
@@ -131,6 +139,10 @@ export type paths = {
|
|
|
131
139
|
/** Set the threshold and members of the root quorum. This must be approved by the current root quorum. */
|
|
132
140
|
post: operations["PublicApiService_UpdateRootQuorum"];
|
|
133
141
|
};
|
|
142
|
+
"/public/v1/submit/update_user": {
|
|
143
|
+
/** Update a User in an existing Organization */
|
|
144
|
+
post: operations["PublicApiService_UpdateUser"];
|
|
145
|
+
};
|
|
134
146
|
"/public/v1/submit/update_user_tag": {
|
|
135
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. */
|
|
136
148
|
post: operations["PublicApiService_UpdateUserTag"];
|
|
@@ -138,10 +150,6 @@ export type paths = {
|
|
|
138
150
|
"/tkhq/api/v1/noop-codegen-anchor": {
|
|
139
151
|
post: operations["PublicApiService_NOOPCodegenAnchor"];
|
|
140
152
|
};
|
|
141
|
-
"/tkhq/public/v1/query/get_private_key": {
|
|
142
|
-
/** Get details about a Private Key */
|
|
143
|
-
post: operations["PublicApiService_GetPrivateKeyBackwardsCompat"];
|
|
144
|
-
};
|
|
145
153
|
};
|
|
146
154
|
export type definitions = {
|
|
147
155
|
datav1Tag: {
|
|
@@ -159,30 +167,20 @@ export type definitions = {
|
|
|
159
167
|
format?: definitions["externaldatav1AddressFormat"];
|
|
160
168
|
address?: string;
|
|
161
169
|
};
|
|
162
|
-
/**
|
|
163
|
-
* @description - ADDRESS_FORMAT_UNCOMPRESSED: 04<X_COORDINATE><Y_COORDINATE>
|
|
164
|
-
* - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate
|
|
165
|
-
* - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.
|
|
166
|
-
* @enum {string}
|
|
167
|
-
*/
|
|
170
|
+
/** @enum {string} */
|
|
168
171
|
externaldatav1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM";
|
|
169
172
|
/** @enum {string} */
|
|
170
173
|
externaldatav1AuthenticatorTransport: "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID";
|
|
171
|
-
/**
|
|
172
|
-
* @description Cryptographic Curve used to generate a given Private Key.
|
|
173
|
-
* @enum {string}
|
|
174
|
-
*/
|
|
174
|
+
/** @enum {string} */
|
|
175
175
|
externaldatav1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
176
176
|
/** @enum {string} */
|
|
177
177
|
externaldatav1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
178
|
-
/**
|
|
179
|
-
* @description Logical operators.
|
|
180
|
-
* @enum {string}
|
|
181
|
-
*/
|
|
178
|
+
/** @enum {string} */
|
|
182
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";
|
|
183
180
|
externaldatav1Selector: {
|
|
184
181
|
/** @description The resource being referenced within a policy (e.g., user.tags or activities.type). */
|
|
185
182
|
subject: string;
|
|
183
|
+
/** @description Logical operators like OPERATOR_CONTAINS or OPERATOR_EQUAL. */
|
|
186
184
|
operator: definitions["externaldatav1Operator"];
|
|
187
185
|
/** @description The specific parameter from the subject being referenced, like a specific user ID. */
|
|
188
186
|
targets: string[];
|
|
@@ -193,17 +191,9 @@ export type definitions = {
|
|
|
193
191
|
format?: definitions["immutableactivityv1AddressFormat"];
|
|
194
192
|
address?: string;
|
|
195
193
|
};
|
|
196
|
-
/**
|
|
197
|
-
* @description - ADDRESS_FORMAT_UNCOMPRESSED: 04<X_COORDINATE><Y_COORDINATE>
|
|
198
|
-
* - ADDRESS_FORMAT_COMPRESSED: 02 or 03, followed by the X coordinate
|
|
199
|
-
* - ADDRESS_FORMAT_ETHEREUM: Your standard Ethereum address (0x...). We apply EIP55 casing.
|
|
200
|
-
* @enum {string}
|
|
201
|
-
*/
|
|
194
|
+
/** @enum {string} */
|
|
202
195
|
immutableactivityv1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM";
|
|
203
|
-
/**
|
|
204
|
-
* @description Cryptographic Curve used to generate a given Private Key.
|
|
205
|
-
* @enum {string}
|
|
206
|
-
*/
|
|
196
|
+
/** @enum {string} */
|
|
207
197
|
immutableactivityv1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
|
|
208
198
|
/** @enum {string} */
|
|
209
199
|
immutableactivityv1Effect: "EFFECT_ALLOW" | "EFFECT_DENY";
|
|
@@ -214,10 +204,7 @@ export type definitions = {
|
|
|
214
204
|
operator?: definitions["immutableactivityv1Operator"];
|
|
215
205
|
target?: string;
|
|
216
206
|
};
|
|
217
|
-
/**
|
|
218
|
-
* - TRANSACTION_TYPE_ETHEREUM: Unsigned Ethereum transaction, RLP-encoded and hex-encoded
|
|
219
|
-
* @enum {string}
|
|
220
|
-
*/
|
|
207
|
+
/** @enum {string} */
|
|
221
208
|
immutableactivityv1TransactionType: "TRANSACTION_TYPE_ETHEREUM";
|
|
222
209
|
/** @enum {string} */
|
|
223
210
|
immutablewebauthnv1AuthenticatorTransport: "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_HYBRID";
|
|
@@ -233,29 +220,19 @@ export type definitions = {
|
|
|
233
220
|
details?: definitions["protobufAny"][];
|
|
234
221
|
};
|
|
235
222
|
v1AcceptInvitationIntent: {
|
|
236
|
-
/**
|
|
237
|
-
* @inject_tag: validate:"required,uuid"
|
|
238
|
-
* @description Unique identifier for a given Invitation object.
|
|
239
|
-
*/
|
|
223
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
240
224
|
invitationId: string;
|
|
241
|
-
/**
|
|
242
|
-
* @inject_tag: validate:"required,uuid"
|
|
243
|
-
* @description Unique identifier for a given User.
|
|
244
|
-
*/
|
|
225
|
+
/** @description Unique identifier for a given User. */
|
|
245
226
|
userId: string;
|
|
227
|
+
/** @description WebAuthN hardware devices that can be used to log in to the Turnkey web app. */
|
|
246
228
|
authenticator: definitions["v1AuthenticatorParams"];
|
|
247
229
|
};
|
|
248
230
|
v1AcceptInvitationIntentV2: {
|
|
249
|
-
/**
|
|
250
|
-
* @inject_tag: validate:"required,uuid"
|
|
251
|
-
* @description Unique identifier for a given Invitation object.
|
|
252
|
-
*/
|
|
231
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
253
232
|
invitationId: string;
|
|
254
|
-
/**
|
|
255
|
-
* @inject_tag: validate:"required,uuid"
|
|
256
|
-
* @description Unique identifier for a given User.
|
|
257
|
-
*/
|
|
233
|
+
/** @description Unique identifier for a given User. */
|
|
258
234
|
userId: string;
|
|
235
|
+
/** @description WebAuthN hardware devices that can be used to log in to the Turnkey web app. */
|
|
259
236
|
authenticator: definitions["v1AuthenticatorParamsV2"];
|
|
260
237
|
};
|
|
261
238
|
v1AcceptInvitationResult: {
|
|
@@ -265,25 +242,25 @@ export type definitions = {
|
|
|
265
242
|
userId: string;
|
|
266
243
|
};
|
|
267
244
|
v1ActivateBillingTierIntent: {
|
|
268
|
-
/**
|
|
269
|
-
* @inject_tag: validate:"required"
|
|
270
|
-
* @description The product that the customer wants to subscribe to.
|
|
271
|
-
*/
|
|
245
|
+
/** @description The product that the customer wants to subscribe to. */
|
|
272
246
|
productId: string;
|
|
273
247
|
};
|
|
274
248
|
v1ActivateBillingTierResult: {
|
|
275
249
|
/** @description The id of the product being subscribed to. */
|
|
276
250
|
productId: string;
|
|
277
251
|
};
|
|
278
|
-
/** @description An action that can that can be taken within the Turnkey infrastructure. */
|
|
279
252
|
v1Activity: {
|
|
280
253
|
/** @description Unique identifier for a given Activity object. */
|
|
281
254
|
id: string;
|
|
282
255
|
/** @description Unique identifier for a given Organization. */
|
|
283
256
|
organizationId: string;
|
|
257
|
+
/** @description The current processing status of a specified Activity. */
|
|
284
258
|
status: definitions["v1ActivityStatus"];
|
|
259
|
+
/** @description Type of Activity, such as Add User, or Sign Transaction. */
|
|
285
260
|
type: definitions["v1ActivityType"];
|
|
261
|
+
/** @description Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action. */
|
|
286
262
|
intent: definitions["v1Intent"];
|
|
263
|
+
/** @description Result of the intended action. */
|
|
287
264
|
result: definitions["v1Result"];
|
|
288
265
|
/** @description A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. */
|
|
289
266
|
votes: definitions["v1Vote"][];
|
|
@@ -295,19 +272,15 @@ export type definitions = {
|
|
|
295
272
|
updatedAt: definitions["v1Timestamp"];
|
|
296
273
|
};
|
|
297
274
|
v1ActivityResponse: {
|
|
275
|
+
/** @description An action that can that can be taken within the Turnkey infrastructure. */
|
|
298
276
|
activity: definitions["v1Activity"];
|
|
299
277
|
};
|
|
300
|
-
/**
|
|
301
|
-
* @description The current processing status of an Activity.
|
|
302
|
-
* @enum {string}
|
|
303
|
-
*/
|
|
278
|
+
/** @enum {string} */
|
|
304
279
|
v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
|
|
305
|
-
/**
|
|
306
|
-
|
|
307
|
-
* @enum {string}
|
|
308
|
-
*/
|
|
309
|
-
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";
|
|
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";
|
|
310
282
|
v1ApiKey: {
|
|
283
|
+
/** @description A User credential that can be used to authenticate to Turnkey. */
|
|
311
284
|
credential: definitions["v1Credential"];
|
|
312
285
|
/** @description Unique identifier for a given API Key. */
|
|
313
286
|
apiKeyId: string;
|
|
@@ -317,44 +290,23 @@ export type definitions = {
|
|
|
317
290
|
updatedAt: definitions["v1Timestamp"];
|
|
318
291
|
};
|
|
319
292
|
v1ApiKeyParams: {
|
|
320
|
-
/**
|
|
321
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
322
|
-
* @description Human-readable name for an API Key.
|
|
323
|
-
*/
|
|
293
|
+
/** @description Human-readable name for an API Key. */
|
|
324
294
|
apiKeyName: string;
|
|
325
|
-
/**
|
|
326
|
-
* @inject_tag: validate:"hexadecimal,len=66"
|
|
327
|
-
* @description The public component of a cryptographic key pair used to sign messages and transactions.
|
|
328
|
-
*/
|
|
295
|
+
/** @description The public component of a cryptographic key pair used to sign messages and transactions. */
|
|
329
296
|
publicKey: string;
|
|
330
297
|
};
|
|
331
298
|
v1ApiOnlyUserParams: {
|
|
332
|
-
/**
|
|
333
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
334
|
-
* @description The name of the new API-only User.
|
|
335
|
-
*/
|
|
299
|
+
/** @description The name of the new API-only User. */
|
|
336
300
|
userName: string;
|
|
337
|
-
/**
|
|
338
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
339
|
-
* @description The email address for this API-only User (optional).
|
|
340
|
-
*/
|
|
301
|
+
/** @description The email address for this API-only User (optional). */
|
|
341
302
|
userEmail?: string;
|
|
342
|
-
/**
|
|
343
|
-
* @inject_tag: validate:"dive,uuid"
|
|
344
|
-
* @description A list of tags assigned to the new API-only User.
|
|
345
|
-
*/
|
|
303
|
+
/** @description A list of tags assigned to the new API-only User. */
|
|
346
304
|
userTags: string[];
|
|
347
|
-
/**
|
|
348
|
-
* @inject_tag: validate:"dive,uuid"
|
|
349
|
-
* @description A list of API Key parameters.
|
|
350
|
-
*/
|
|
305
|
+
/** @description A list of API Key parameters. */
|
|
351
306
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
352
307
|
};
|
|
353
308
|
v1ApproveActivityIntent: {
|
|
354
|
-
/**
|
|
355
|
-
* @inject_tag: validate:"required"
|
|
356
|
-
* @description An artifact verifying a User's action.
|
|
357
|
-
*/
|
|
309
|
+
/** @description An artifact verifying a User's action. */
|
|
358
310
|
fingerprint: string;
|
|
359
311
|
};
|
|
360
312
|
v1ApproveActivityRequest: {
|
|
@@ -367,20 +319,11 @@ export type definitions = {
|
|
|
367
319
|
parameters: definitions["v1ApproveActivityIntent"];
|
|
368
320
|
};
|
|
369
321
|
v1Attestation: {
|
|
370
|
-
/**
|
|
371
|
-
* @inject_tag: validate:"required,max=256"
|
|
372
|
-
* @description The cbor encoded then base64 url encoded id of the credential.
|
|
373
|
-
*/
|
|
322
|
+
/** @description The cbor encoded then base64 url encoded id of the credential. */
|
|
374
323
|
credentialId: string;
|
|
375
|
-
/**
|
|
376
|
-
* @inject_tag: validate:"required"
|
|
377
|
-
* @description A base64 url encoded payload containing metadata about the signing context and the challenge.
|
|
378
|
-
*/
|
|
324
|
+
/** @description A base64 url encoded payload containing metadata about the signing context and the challenge. */
|
|
379
325
|
clientDataJson: string;
|
|
380
|
-
/**
|
|
381
|
-
* @inject_tag: validate:"required"
|
|
382
|
-
* @description A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
|
|
383
|
-
*/
|
|
326
|
+
/** @description A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. */
|
|
384
327
|
attestationObject: string;
|
|
385
328
|
/** @description The type of authenticator transports. */
|
|
386
329
|
transports: definitions["immutablewebauthnv1AuthenticatorTransport"][];
|
|
@@ -395,6 +338,7 @@ export type definitions = {
|
|
|
395
338
|
credentialId: string;
|
|
396
339
|
/** @description The type of Authenticator device. */
|
|
397
340
|
model: string;
|
|
341
|
+
/** @description A User credential that can be used to authenticate to Turnkey. */
|
|
398
342
|
credential: definitions["v1Credential"];
|
|
399
343
|
/** @description Unique identifier for a given Authenticator. */
|
|
400
344
|
authenticatorId: string;
|
|
@@ -404,55 +348,33 @@ export type definitions = {
|
|
|
404
348
|
updatedAt: definitions["v1Timestamp"];
|
|
405
349
|
};
|
|
406
350
|
v1AuthenticatorAttestationResponse: {
|
|
407
|
-
/** ENCODING: base64url */
|
|
408
351
|
clientDataJson: string;
|
|
409
|
-
/** ENCODING: base64url */
|
|
410
352
|
attestationObject: string;
|
|
411
353
|
transports?: definitions["immutablewebauthnv1AuthenticatorTransport"][];
|
|
412
354
|
/** @enum {string} */
|
|
413
355
|
authenticatorAttachment?: "cross-platform" | "platform" | null;
|
|
414
356
|
};
|
|
415
357
|
v1AuthenticatorParams: {
|
|
416
|
-
/**
|
|
417
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
418
|
-
* @description Human-readable name for an Authenticator.
|
|
419
|
-
*/
|
|
358
|
+
/** @description Human-readable name for an Authenticator. */
|
|
420
359
|
authenticatorName: string;
|
|
421
|
-
/**
|
|
422
|
-
* @inject_tag: validate:"required,uuid"
|
|
423
|
-
* @description Unique identifier for a given User.
|
|
424
|
-
*/
|
|
360
|
+
/** @description Unique identifier for a given User. */
|
|
425
361
|
userId: string;
|
|
426
362
|
attestation: definitions["v1PublicKeyCredentialWithAttestation"];
|
|
427
|
-
/**
|
|
428
|
-
* @inject_tag: validate:"required,max=256"
|
|
429
|
-
* @description Challenge presented for authentication purposes.
|
|
430
|
-
*/
|
|
363
|
+
/** @description Challenge presented for authentication purposes. */
|
|
431
364
|
challenge: string;
|
|
432
365
|
};
|
|
433
366
|
v1AuthenticatorParamsV2: {
|
|
434
|
-
/**
|
|
435
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
436
|
-
* @description Human-readable name for an Authenticator.
|
|
437
|
-
*/
|
|
367
|
+
/** @description Human-readable name for an Authenticator. */
|
|
438
368
|
authenticatorName: string;
|
|
439
|
-
/**
|
|
440
|
-
* @inject_tag: validate:"required,max=256"
|
|
441
|
-
* @description Challenge presented for authentication purposes.
|
|
442
|
-
*/
|
|
369
|
+
/** @description Challenge presented for authentication purposes. */
|
|
443
370
|
challenge: string;
|
|
371
|
+
/** @description The attestation that proves custody of the authenticator and provides metadata about it. */
|
|
444
372
|
attestation: definitions["v1Attestation"];
|
|
445
373
|
};
|
|
446
374
|
v1CreateApiKeysIntent: {
|
|
447
|
-
/**
|
|
448
|
-
* @inject_tag: validate:"dive,required"
|
|
449
|
-
* @description A list of API Keys.
|
|
450
|
-
*/
|
|
375
|
+
/** @description A list of API Keys. */
|
|
451
376
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
452
|
-
/**
|
|
453
|
-
* @inject_tag: validate:"required,uuid"
|
|
454
|
-
* @description Unique identifier for a given User.
|
|
455
|
-
*/
|
|
377
|
+
/** @description Unique identifier for a given User. */
|
|
456
378
|
userId: string;
|
|
457
379
|
};
|
|
458
380
|
v1CreateApiKeysRequest: {
|
|
@@ -469,10 +391,7 @@ export type definitions = {
|
|
|
469
391
|
apiKeyIds: string[];
|
|
470
392
|
};
|
|
471
393
|
v1CreateApiOnlyUsersIntent: {
|
|
472
|
-
/**
|
|
473
|
-
* @inject_tag: validate:"required,dive,required"
|
|
474
|
-
* @description A list of API-only Users to create.
|
|
475
|
-
*/
|
|
394
|
+
/** @description A list of API-only Users to create. */
|
|
476
395
|
apiOnlyUsers: definitions["v1ApiOnlyUserParams"][];
|
|
477
396
|
};
|
|
478
397
|
v1CreateApiOnlyUsersRequest: {
|
|
@@ -489,27 +408,15 @@ export type definitions = {
|
|
|
489
408
|
userIds: string[];
|
|
490
409
|
};
|
|
491
410
|
v1CreateAuthenticatorsIntent: {
|
|
492
|
-
/**
|
|
493
|
-
* @inject_tag: validate:"dive,required"
|
|
494
|
-
* @description A list of Authenticators.
|
|
495
|
-
*/
|
|
411
|
+
/** @description A list of Authenticators. */
|
|
496
412
|
authenticators: definitions["v1AuthenticatorParams"][];
|
|
497
|
-
/**
|
|
498
|
-
* @inject_tag: validate:"required,uuid"
|
|
499
|
-
* @description Unique identifier for a given User.
|
|
500
|
-
*/
|
|
413
|
+
/** @description Unique identifier for a given User. */
|
|
501
414
|
userId: string;
|
|
502
415
|
};
|
|
503
416
|
v1CreateAuthenticatorsIntentV2: {
|
|
504
|
-
/**
|
|
505
|
-
* @inject_tag: validate:"dive,required"
|
|
506
|
-
* @description A list of Authenticators.
|
|
507
|
-
*/
|
|
417
|
+
/** @description A list of Authenticators. */
|
|
508
418
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
509
|
-
/**
|
|
510
|
-
* @inject_tag: validate:"required,uuid"
|
|
511
|
-
* @description Unique identifier for a given User.
|
|
512
|
-
*/
|
|
419
|
+
/** @description Unique identifier for a given User. */
|
|
513
420
|
userId: string;
|
|
514
421
|
};
|
|
515
422
|
v1CreateAuthenticatorsRequest: {
|
|
@@ -526,10 +433,7 @@ export type definitions = {
|
|
|
526
433
|
authenticatorIds: string[];
|
|
527
434
|
};
|
|
528
435
|
v1CreateInvitationsIntent: {
|
|
529
|
-
/**
|
|
530
|
-
* @inject_tag: validate:"required,dive,required"
|
|
531
|
-
* @description A list of Invitations.
|
|
532
|
-
*/
|
|
436
|
+
/** @description A list of Invitations. */
|
|
533
437
|
invitations: definitions["v1InvitationParams"][];
|
|
534
438
|
};
|
|
535
439
|
v1CreateInvitationsRequest: {
|
|
@@ -546,39 +450,23 @@ export type definitions = {
|
|
|
546
450
|
invitationIds: string[];
|
|
547
451
|
};
|
|
548
452
|
v1CreateOrganizationIntent: {
|
|
549
|
-
/**
|
|
550
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
551
|
-
* @description Human-readable name for an Organization.
|
|
552
|
-
*/
|
|
453
|
+
/** @description Human-readable name for an Organization. */
|
|
553
454
|
organizationName: string;
|
|
554
|
-
/**
|
|
555
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
556
|
-
* @description The root user's email address.
|
|
557
|
-
*/
|
|
455
|
+
/** @description The root user's email address. */
|
|
558
456
|
rootEmail: string;
|
|
457
|
+
/** @description The root user's Authenticator. */
|
|
559
458
|
rootAuthenticator: definitions["v1AuthenticatorParams"];
|
|
560
|
-
/**
|
|
561
|
-
* @inject_tag: validate:"uuid"
|
|
562
|
-
* @description Unique identifier for the root user object.
|
|
563
|
-
*/
|
|
459
|
+
/** @description Unique identifier for the root user object. */
|
|
564
460
|
rootUserId?: string;
|
|
565
461
|
};
|
|
566
462
|
v1CreateOrganizationIntentV2: {
|
|
567
|
-
/**
|
|
568
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
569
|
-
* @description Human-readable name for an Organization.
|
|
570
|
-
*/
|
|
463
|
+
/** @description Human-readable name for an Organization. */
|
|
571
464
|
organizationName: string;
|
|
572
|
-
/**
|
|
573
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
574
|
-
* @description The root user's email address.
|
|
575
|
-
*/
|
|
465
|
+
/** @description The root user's email address. */
|
|
576
466
|
rootEmail: string;
|
|
467
|
+
/** @description The root user's Authenticator. */
|
|
577
468
|
rootAuthenticator: definitions["v1AuthenticatorParamsV2"];
|
|
578
|
-
/**
|
|
579
|
-
* @inject_tag: validate:"uuid"
|
|
580
|
-
* @description Unique identifier for the root user object.
|
|
581
|
-
*/
|
|
469
|
+
/** @description Unique identifier for the root user object. */
|
|
582
470
|
rootUserId?: string;
|
|
583
471
|
};
|
|
584
472
|
v1CreateOrganizationResult: {
|
|
@@ -586,39 +474,27 @@ export type definitions = {
|
|
|
586
474
|
organizationId: string;
|
|
587
475
|
};
|
|
588
476
|
v1CreatePolicyIntent: {
|
|
589
|
-
/**
|
|
590
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
591
|
-
* @description Human-readable name for a Policy.
|
|
592
|
-
*/
|
|
477
|
+
/** @description Human-readable name for a Policy. */
|
|
593
478
|
policyName: string;
|
|
594
|
-
/**
|
|
595
|
-
* @inject_tag: validate:"required,dive,required"
|
|
596
|
-
* @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
|
|
597
|
-
*/
|
|
479
|
+
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
598
480
|
selectors: definitions["immutableactivityv1Selector"][];
|
|
481
|
+
/** @description The instruction to DENY or ALLOW a particular activity following policy selector(s). */
|
|
599
482
|
effect: definitions["immutableactivityv1Effect"];
|
|
600
483
|
notes?: string;
|
|
601
484
|
};
|
|
602
485
|
v1CreatePolicyIntentV2: {
|
|
603
|
-
/**
|
|
604
|
-
* @inject_tag: validate:"required,tk_label_length"
|
|
605
|
-
* @description Human-readable name for a Policy.
|
|
606
|
-
*/
|
|
486
|
+
/** @description Human-readable name for a Policy. */
|
|
607
487
|
policyName: string;
|
|
608
|
-
/**
|
|
609
|
-
* @inject_tag: validate:"required,dive,required"
|
|
610
|
-
* @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
|
|
611
|
-
*/
|
|
488
|
+
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
612
489
|
selectors: definitions["v1SelectorV2"][];
|
|
490
|
+
/** @description Whether to ALLOW or DENY requests that match the condition and consensus requirements. */
|
|
613
491
|
effect: definitions["immutableactivityv1Effect"];
|
|
614
492
|
notes?: string;
|
|
615
493
|
};
|
|
616
494
|
v1CreatePolicyIntentV3: {
|
|
617
|
-
/**
|
|
618
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
619
|
-
* @description Human-readable name for a Policy.
|
|
620
|
-
*/
|
|
495
|
+
/** @description Human-readable name for a Policy. */
|
|
621
496
|
policyName: string;
|
|
497
|
+
/** @description The instruction to DENY or ALLOW an activity. */
|
|
622
498
|
effect: definitions["immutableactivityv1Effect"];
|
|
623
499
|
/** @description The condition expression that triggers the Effect */
|
|
624
500
|
condition?: string;
|
|
@@ -640,15 +516,9 @@ export type definitions = {
|
|
|
640
516
|
policyId: string;
|
|
641
517
|
};
|
|
642
518
|
v1CreatePrivateKeyTagIntent: {
|
|
643
|
-
/**
|
|
644
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
645
|
-
* @description Human-readable name for a Private Key Tag.
|
|
646
|
-
*/
|
|
519
|
+
/** @description Human-readable name for a Private Key Tag. */
|
|
647
520
|
privateKeyTagName: string;
|
|
648
|
-
/**
|
|
649
|
-
* @inject_tag: validate:"dive,uuid"
|
|
650
|
-
* @description A list of Private Key IDs.
|
|
651
|
-
*/
|
|
521
|
+
/** @description A list of Private Key IDs. */
|
|
652
522
|
privateKeyIds: string[];
|
|
653
523
|
};
|
|
654
524
|
v1CreatePrivateKeyTagRequest: {
|
|
@@ -667,17 +537,11 @@ export type definitions = {
|
|
|
667
537
|
privateKeyIds: string[];
|
|
668
538
|
};
|
|
669
539
|
v1CreatePrivateKeysIntent: {
|
|
670
|
-
/**
|
|
671
|
-
* @inject_tag: validate:"dive,required"
|
|
672
|
-
* @description A list of Private Keys.
|
|
673
|
-
*/
|
|
540
|
+
/** @description A list of Private Keys. */
|
|
674
541
|
privateKeys: definitions["v1PrivateKeyParams"][];
|
|
675
542
|
};
|
|
676
543
|
v1CreatePrivateKeysIntentV2: {
|
|
677
|
-
/**
|
|
678
|
-
* @inject_tag: validate:"dive,required"
|
|
679
|
-
* @description A list of Private Keys.
|
|
680
|
-
*/
|
|
544
|
+
/** @description A list of Private Keys. */
|
|
681
545
|
privateKeys: definitions["v1PrivateKeyParams"][];
|
|
682
546
|
};
|
|
683
547
|
v1CreatePrivateKeysRequest: {
|
|
@@ -698,26 +562,17 @@ export type definitions = {
|
|
|
698
562
|
privateKeys: definitions["v1PrivateKeyResult"][];
|
|
699
563
|
};
|
|
700
564
|
v1CreateSubOrganizationIntent: {
|
|
701
|
-
/**
|
|
702
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
703
|
-
* @description Name for this sub-organization
|
|
704
|
-
*/
|
|
565
|
+
/** @description Name for this sub-organization */
|
|
705
566
|
name: string;
|
|
567
|
+
/** @description Root User authenticator for this new sub-organization */
|
|
706
568
|
rootAuthenticator: definitions["v1AuthenticatorParamsV2"];
|
|
707
569
|
};
|
|
708
570
|
v1CreateSubOrganizationIntentV2: {
|
|
709
|
-
/**
|
|
710
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
711
|
-
* @description Name for this sub-organization
|
|
712
|
-
*/
|
|
571
|
+
/** @description Name for this sub-organization */
|
|
713
572
|
subOrganizationName: string;
|
|
714
|
-
/**
|
|
715
|
-
* @inject_tag: validate:"required"
|
|
716
|
-
* @description Root users to create within this sub-organization
|
|
717
|
-
*/
|
|
573
|
+
/** @description Root users to create within this sub-organization */
|
|
718
574
|
rootUsers: definitions["v1RootUserParams"][];
|
|
719
575
|
/**
|
|
720
|
-
* @inject_tag: validate:"required"
|
|
721
576
|
* Format: int32
|
|
722
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
|
|
723
578
|
*/
|
|
@@ -736,15 +591,9 @@ export type definitions = {
|
|
|
736
591
|
subOrganizationId: string;
|
|
737
592
|
};
|
|
738
593
|
v1CreateUserTagIntent: {
|
|
739
|
-
/**
|
|
740
|
-
* @inject_tag: validate:"required,tk_label,tk_label_length"
|
|
741
|
-
* @description Human-readable name for a User Tag.
|
|
742
|
-
*/
|
|
594
|
+
/** @description Human-readable name for a User Tag. */
|
|
743
595
|
userTagName: string;
|
|
744
|
-
/**
|
|
745
|
-
* @inject_tag: validate:"dive,uuid"
|
|
746
|
-
* @description A list of User IDs.
|
|
747
|
-
*/
|
|
596
|
+
/** @description A list of User IDs. */
|
|
748
597
|
userIds: string[];
|
|
749
598
|
};
|
|
750
599
|
v1CreateUserTagRequest: {
|
|
@@ -763,17 +612,11 @@ export type definitions = {
|
|
|
763
612
|
userIds: string[];
|
|
764
613
|
};
|
|
765
614
|
v1CreateUsersIntent: {
|
|
766
|
-
/**
|
|
767
|
-
* @inject_tag: validate:"required,dive,required"
|
|
768
|
-
* @description A list of Users.
|
|
769
|
-
*/
|
|
615
|
+
/** @description A list of Users. */
|
|
770
616
|
users: definitions["v1UserParams"][];
|
|
771
617
|
};
|
|
772
618
|
v1CreateUsersIntentV2: {
|
|
773
|
-
/**
|
|
774
|
-
* @inject_tag: validate:"required,dive,required"
|
|
775
|
-
* @description A list of Users.
|
|
776
|
-
*/
|
|
619
|
+
/** @description A list of Users. */
|
|
777
620
|
users: definitions["v1UserParamsV2"][];
|
|
778
621
|
};
|
|
779
622
|
v1CreateUsersRequest: {
|
|
@@ -800,15 +643,9 @@ export type definitions = {
|
|
|
800
643
|
/** @enum {string} */
|
|
801
644
|
v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256";
|
|
802
645
|
v1DeleteApiKeysIntent: {
|
|
803
|
-
/**
|
|
804
|
-
* @inject_tag: validate:"required,uuid"
|
|
805
|
-
* @description Unique identifier for a given User.
|
|
806
|
-
*/
|
|
646
|
+
/** @description Unique identifier for a given User. */
|
|
807
647
|
userId: string;
|
|
808
|
-
/**
|
|
809
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
810
|
-
* @description A list of API Key IDs.
|
|
811
|
-
*/
|
|
648
|
+
/** @description A list of API Key IDs. */
|
|
812
649
|
apiKeyIds: string[];
|
|
813
650
|
};
|
|
814
651
|
v1DeleteApiKeysRequest: {
|
|
@@ -825,26 +662,26 @@ export type definitions = {
|
|
|
825
662
|
apiKeyIds: string[];
|
|
826
663
|
};
|
|
827
664
|
v1DeleteAuthenticatorsIntent: {
|
|
828
|
-
/**
|
|
829
|
-
* @inject_tag: validate:"required,uuid"
|
|
830
|
-
* @description Unique identifier for a given User.
|
|
831
|
-
*/
|
|
665
|
+
/** @description Unique identifier for a given User. */
|
|
832
666
|
userId: string;
|
|
833
|
-
/**
|
|
834
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
835
|
-
* @description A list of Authenticator IDs.
|
|
836
|
-
*/
|
|
667
|
+
/** @description A list of Authenticator IDs. */
|
|
837
668
|
authenticatorIds: string[];
|
|
838
669
|
};
|
|
670
|
+
v1DeleteAuthenticatorsRequest: {
|
|
671
|
+
/** @enum {string} */
|
|
672
|
+
type: "ACTIVITY_TYPE_DELETE_AUTHENTICATORS";
|
|
673
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
674
|
+
timestampMs: string;
|
|
675
|
+
/** @description Unique identifier for a given Organization. */
|
|
676
|
+
organizationId: string;
|
|
677
|
+
parameters: definitions["v1DeleteAuthenticatorsIntent"];
|
|
678
|
+
};
|
|
839
679
|
v1DeleteAuthenticatorsResult: {
|
|
840
680
|
/** @description Unique identifier for a given Authenticator. */
|
|
841
681
|
authenticatorIds: string[];
|
|
842
682
|
};
|
|
843
683
|
v1DeleteInvitationIntent: {
|
|
844
|
-
/**
|
|
845
|
-
* @inject_tag: validate:"required,uuid"
|
|
846
|
-
* @description Unique identifier for a given Invitation object.
|
|
847
|
-
*/
|
|
684
|
+
/** @description Unique identifier for a given Invitation object. */
|
|
848
685
|
invitationId: string;
|
|
849
686
|
};
|
|
850
687
|
v1DeleteInvitationRequest: {
|
|
@@ -861,10 +698,7 @@ export type definitions = {
|
|
|
861
698
|
invitationId: string;
|
|
862
699
|
};
|
|
863
700
|
v1DeleteOrganizationIntent: {
|
|
864
|
-
/**
|
|
865
|
-
* @inject_tag: validate:"required,uuid"
|
|
866
|
-
* @description Unique identifier for a given Organization.
|
|
867
|
-
*/
|
|
701
|
+
/** @description Unique identifier for a given Organization. */
|
|
868
702
|
organizationId: string;
|
|
869
703
|
};
|
|
870
704
|
v1DeleteOrganizationResult: {
|
|
@@ -880,10 +714,7 @@ export type definitions = {
|
|
|
880
714
|
paymentMethodId: string;
|
|
881
715
|
};
|
|
882
716
|
v1DeletePolicyIntent: {
|
|
883
|
-
/**
|
|
884
|
-
* @inject_tag: validate:"required,uuid"
|
|
885
|
-
* @description Unique identifier for a given Policy.
|
|
886
|
-
*/
|
|
717
|
+
/** @description Unique identifier for a given Policy. */
|
|
887
718
|
policyId: string;
|
|
888
719
|
};
|
|
889
720
|
v1DeletePolicyRequest: {
|
|
@@ -900,10 +731,7 @@ export type definitions = {
|
|
|
900
731
|
policyId: string;
|
|
901
732
|
};
|
|
902
733
|
v1DeletePrivateKeyTagsIntent: {
|
|
903
|
-
/**
|
|
904
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
905
|
-
* @description A list of Private Key Tag IDs.
|
|
906
|
-
*/
|
|
734
|
+
/** @description A list of Private Key Tag IDs. */
|
|
907
735
|
privateKeyTagIds: string[];
|
|
908
736
|
};
|
|
909
737
|
v1DeletePrivateKeyTagsResult: {
|
|
@@ -913,10 +741,7 @@ export type definitions = {
|
|
|
913
741
|
privateKeyIds: string[];
|
|
914
742
|
};
|
|
915
743
|
v1DeleteUserTagsIntent: {
|
|
916
|
-
/**
|
|
917
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
918
|
-
* @description A list of User Tag IDs.
|
|
919
|
-
*/
|
|
744
|
+
/** @description A list of User Tag IDs. */
|
|
920
745
|
userTagIds: string[];
|
|
921
746
|
};
|
|
922
747
|
v1DeleteUserTagsResult: {
|
|
@@ -926,10 +751,7 @@ export type definitions = {
|
|
|
926
751
|
userIds: string[];
|
|
927
752
|
};
|
|
928
753
|
v1DeleteUsersIntent: {
|
|
929
|
-
/**
|
|
930
|
-
* @inject_tag: validate:"required,dive,required,uuid"
|
|
931
|
-
* @description A list of User IDs.
|
|
932
|
-
*/
|
|
754
|
+
/** @description A list of User IDs. */
|
|
933
755
|
userIds: string[];
|
|
934
756
|
};
|
|
935
757
|
v1DeleteUsersResult: {
|
|
@@ -937,10 +759,7 @@ export type definitions = {
|
|
|
937
759
|
userIds: string[];
|
|
938
760
|
};
|
|
939
761
|
v1DisablePrivateKeyIntent: {
|
|
940
|
-
/**
|
|
941
|
-
* @inject_tag: validate:"required,uuid"
|
|
942
|
-
* @description Unique identifier for a given Private Key.
|
|
943
|
-
*/
|
|
762
|
+
/** @description Unique identifier for a given Private Key. */
|
|
944
763
|
privateKeyId: string;
|
|
945
764
|
};
|
|
946
765
|
v1DisablePrivateKeyResult: {
|
|
@@ -952,6 +771,7 @@ export type definitions = {
|
|
|
952
771
|
organizationId: string;
|
|
953
772
|
/** @description Array of Activity Statuses filtering which Activities will be listed in the response. */
|
|
954
773
|
filterByStatus?: definitions["v1ActivityStatus"][];
|
|
774
|
+
/** @description Parameters used for cursor-based pagination. */
|
|
955
775
|
paginationOptions?: definitions["v1Pagination"];
|
|
956
776
|
/** @description Array of Activity Types filtering which Activities will be listed in the response. */
|
|
957
777
|
filterByType?: definitions["v1ActivityType"][];
|
|
@@ -973,6 +793,7 @@ export type definitions = {
|
|
|
973
793
|
authenticatorId: string;
|
|
974
794
|
};
|
|
975
795
|
v1GetAuthenticatorResponse: {
|
|
796
|
+
/** @description An authenticator. */
|
|
976
797
|
authenticator: definitions["v1Authenticator"];
|
|
977
798
|
};
|
|
978
799
|
v1GetAuthenticatorsRequest: {
|
|
@@ -990,6 +811,7 @@ export type definitions = {
|
|
|
990
811
|
organizationId: string;
|
|
991
812
|
};
|
|
992
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. */
|
|
993
815
|
organizationData: definitions["v1OrganizationData"];
|
|
994
816
|
};
|
|
995
817
|
v1GetPoliciesRequest: {
|
|
@@ -1007,6 +829,7 @@ export type definitions = {
|
|
|
1007
829
|
policyId: string;
|
|
1008
830
|
};
|
|
1009
831
|
v1GetPolicyResponse: {
|
|
832
|
+
/** @description Object that codifies rules defining the actions that are permissible within an Organization. */
|
|
1010
833
|
policy: definitions["v1Policy"];
|
|
1011
834
|
};
|
|
1012
835
|
v1GetPrivateKeyRequest: {
|
|
@@ -1016,6 +839,7 @@ export type definitions = {
|
|
|
1016
839
|
privateKeyId: string;
|
|
1017
840
|
};
|
|
1018
841
|
v1GetPrivateKeyResponse: {
|
|
842
|
+
/** @description Cryptographic public/private key pair that can be used for cryptocurrency needs or more generalized encryption. */
|
|
1019
843
|
privateKey: definitions["v1PrivateKey"];
|
|
1020
844
|
};
|
|
1021
845
|
v1GetPrivateKeysRequest: {
|
|
@@ -1033,6 +857,7 @@ export type definitions = {
|
|
|
1033
857
|
userId: string;
|
|
1034
858
|
};
|
|
1035
859
|
v1GetUserResponse: {
|
|
860
|
+
/** @description Web and/or API user within your Organization. */
|
|
1036
861
|
user: definitions["v1User"];
|
|
1037
862
|
};
|
|
1038
863
|
v1GetUsersRequest: {
|
|
@@ -1057,18 +882,8 @@ export type definitions = {
|
|
|
1057
882
|
/** @description Human-readable name for a User. */
|
|
1058
883
|
username: string;
|
|
1059
884
|
};
|
|
1060
|
-
/**
|
|
1061
|
-
* @description - HASH_FUNCTION_UNSPECIFIED: Default value if a hash function is not set explicitly.
|
|
1062
|
-
* - HASH_FUNCTION_NO_OP: No-op function. Useful if you want to pass raw digests to sign (ECDSA-only)
|
|
1063
|
-
* - HASH_FUNCTION_SHA256: Standard SHA-256. Used in the Bitcoin ecosystem.
|
|
1064
|
-
* - HASH_FUNCTION_KECCAK256: Keccak-256 (not the same as NIST SHA-3!).
|
|
1065
|
-
* This is the hash function used in the Ethereum ecosystem.
|
|
1066
|
-
* - HASH_FUNCTION_NOT_APPLICABLE: Callers must use this enum value when signing with ed25519 keys.
|
|
1067
|
-
* This is because, unlike ECDSA, EdDSA's API does not support signing raw digests (see RFC 8032).
|
|
1068
|
-
* @enum {string}
|
|
1069
|
-
*/
|
|
885
|
+
/** @enum {string} */
|
|
1070
886
|
v1HashFunction: "HASH_FUNCTION_NO_OP" | "HASH_FUNCTION_SHA256" | "HASH_FUNCTION_KECCAK256" | "HASH_FUNCTION_NOT_APPLICABLE";
|
|
1071
|
-
/** @description Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action. */
|
|
1072
887
|
v1Intent: {
|
|
1073
888
|
createOrganizationIntent: definitions["v1CreateOrganizationIntent"];
|
|
1074
889
|
createAuthenticatorsIntent?: definitions["v1CreateAuthenticatorsIntent"];
|
|
@@ -1110,6 +925,9 @@ export type definitions = {
|
|
|
1110
925
|
createSubOrganizationIntentV2?: definitions["v1CreateSubOrganizationIntentV2"];
|
|
1111
926
|
updateAllowedOriginsIntent?: definitions["v1UpdateAllowedOriginsIntent"];
|
|
1112
927
|
createPrivateKeysIntentV2?: definitions["v1CreatePrivateKeysIntentV2"];
|
|
928
|
+
updateUserIntent?: definitions["v1UpdateUserIntent"];
|
|
929
|
+
updatePolicyIntent?: definitions["v1UpdatePolicyIntent"];
|
|
930
|
+
setPaymentMethodIntentV2?: definitions["v1SetPaymentMethodIntentV2"];
|
|
1113
931
|
};
|
|
1114
932
|
v1Invitation: {
|
|
1115
933
|
/** @description Unique identifier for a given Invitation object. */
|
|
@@ -1120,7 +938,9 @@ export type definitions = {
|
|
|
1120
938
|
receiverEmail: string;
|
|
1121
939
|
/** @description A list of tags assigned to the Invitation recipient. */
|
|
1122
940
|
receiverUserTags: string[];
|
|
941
|
+
/** @description The User's permissible access method(s). */
|
|
1123
942
|
accessType: definitions["externaldatav1AccessType"];
|
|
943
|
+
/** @description The current processing status of a specified Invitation. */
|
|
1124
944
|
status: definitions["v1InvitationStatus"];
|
|
1125
945
|
createdAt: definitions["v1Timestamp"];
|
|
1126
946
|
updatedAt: definitions["v1Timestamp"];
|
|
@@ -1128,26 +948,15 @@ export type definitions = {
|
|
|
1128
948
|
senderUserId: string;
|
|
1129
949
|
};
|
|
1130
950
|
v1InvitationParams: {
|
|
1131
|
-
/**
|
|
1132
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1133
|
-
* @description The name of the intended Invitation recipient.
|
|
1134
|
-
*/
|
|
951
|
+
/** @description The name of the intended Invitation recipient. */
|
|
1135
952
|
receiverUserName: string;
|
|
1136
|
-
/**
|
|
1137
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
1138
|
-
* @description The email address of the intended Invitation recipient.
|
|
1139
|
-
*/
|
|
953
|
+
/** @description The email address of the intended Invitation recipient. */
|
|
1140
954
|
receiverUserEmail: string;
|
|
1141
|
-
/**
|
|
1142
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1143
|
-
* @description A list of tags assigned to the Invitation recipient.
|
|
1144
|
-
*/
|
|
955
|
+
/** @description A list of tags assigned to the Invitation recipient. */
|
|
1145
956
|
receiverUserTags: string[];
|
|
957
|
+
/** @description The User's permissible access method(s). */
|
|
1146
958
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1147
|
-
/**
|
|
1148
|
-
* @inject_tag: validate:"required,uuid"
|
|
1149
|
-
* @description Unique identifier for the Sender of an Invitation.
|
|
1150
|
-
*/
|
|
959
|
+
/** @description Unique identifier for the Sender of an Invitation. */
|
|
1151
960
|
senderUserId: string;
|
|
1152
961
|
};
|
|
1153
962
|
/** @enum {string} */
|
|
@@ -1155,10 +964,6 @@ export type definitions = {
|
|
|
1155
964
|
v1NOOPCodegenAnchorResponse: {
|
|
1156
965
|
stamp: definitions["v1WebAuthnStamp"];
|
|
1157
966
|
};
|
|
1158
|
-
/**
|
|
1159
|
-
* @description This proto definition is used in our external-facing APIs.
|
|
1160
|
-
* It's important to leverage annotations because they're used in our external interfaces.
|
|
1161
|
-
*/
|
|
1162
967
|
v1OrganizationData: {
|
|
1163
968
|
organizationId?: string;
|
|
1164
969
|
name?: string;
|
|
@@ -1172,31 +977,21 @@ export type definitions = {
|
|
|
1172
977
|
allowedOrigins?: string[];
|
|
1173
978
|
};
|
|
1174
979
|
v1Pagination: {
|
|
1175
|
-
/**
|
|
1176
|
-
|
|
1177
|
-
* @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10 if omitted or set to 0.
|
|
1178
|
-
*/
|
|
1179
|
-
limit?: number;
|
|
980
|
+
/** @description A limit of the number of object to be returned, between 1 and 100. Defaults to 10. */
|
|
981
|
+
limit?: string;
|
|
1180
982
|
/** @description A pagination cursor. This is an object ID that enables you to fetch all objects before this ID. */
|
|
1181
983
|
before?: string;
|
|
1182
984
|
/** @description A pagination cursor. This is an object ID that enables you to fetch all objects after this ID. */
|
|
1183
985
|
after?: string;
|
|
1184
986
|
};
|
|
1185
|
-
/**
|
|
1186
|
-
* - PAYLOAD_ENCODING_UNSPECIFIED: Default value if payload encoding is not set explicitly
|
|
1187
|
-
* - PAYLOAD_ENCODING_HEXADECIMAL: Payload is encoded in hexadecimal
|
|
1188
|
-
* We accept 0x-prefixed or non-0x prefixed payloads.
|
|
1189
|
-
* We accept any casing (uppercase, lowercase, or mixed)
|
|
1190
|
-
* - PAYLOAD_ENCODING_TEXT_UTF8: Payload is encoded as utf-8 text
|
|
1191
|
-
* Will be converted to bytes for signature with Rust's standard String.as_bytes()
|
|
1192
|
-
* @enum {string}
|
|
1193
|
-
*/
|
|
987
|
+
/** @enum {string} */
|
|
1194
988
|
v1PayloadEncoding: "PAYLOAD_ENCODING_HEXADECIMAL" | "PAYLOAD_ENCODING_TEXT_UTF8";
|
|
1195
989
|
v1Policy: {
|
|
1196
990
|
/** @description Unique identifier for a given Policy. */
|
|
1197
991
|
policyId: string;
|
|
1198
992
|
/** @description Human-readable name for a Policy. */
|
|
1199
993
|
policyName: string;
|
|
994
|
+
/** @description The instruction to DENY or ALLOW a particular activity following policy selector(s). */
|
|
1200
995
|
effect: definitions["externaldatav1Effect"];
|
|
1201
996
|
/** @description A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. */
|
|
1202
997
|
selectors: definitions["externaldatav1Selector"][];
|
|
@@ -1216,6 +1011,7 @@ export type definitions = {
|
|
|
1216
1011
|
publicKey: string;
|
|
1217
1012
|
/** @description Human-readable name for a Private Key. */
|
|
1218
1013
|
privateKeyName: string;
|
|
1014
|
+
/** @description Cryptographic Curve used to generate a given Private Key. */
|
|
1219
1015
|
curve: definitions["externaldatav1Curve"];
|
|
1220
1016
|
/** @description Derived cryptocurrency addresses for a given Private Key. */
|
|
1221
1017
|
addresses: definitions["externaldatav1Address"][];
|
|
@@ -1224,21 +1020,13 @@ export type definitions = {
|
|
|
1224
1020
|
createdAt: definitions["v1Timestamp"];
|
|
1225
1021
|
};
|
|
1226
1022
|
v1PrivateKeyParams: {
|
|
1227
|
-
/**
|
|
1228
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1229
|
-
* @description Human-readable name for a Private Key.
|
|
1230
|
-
*/
|
|
1023
|
+
/** @description Human-readable name for a Private Key. */
|
|
1231
1024
|
privateKeyName: string;
|
|
1025
|
+
/** @description Cryptographic Curve used to generate a given Private Key. */
|
|
1232
1026
|
curve: definitions["immutableactivityv1Curve"];
|
|
1233
|
-
/**
|
|
1234
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1235
|
-
* @description A list of Private Key Tag IDs.
|
|
1236
|
-
*/
|
|
1027
|
+
/** @description A list of Private Key Tag IDs. */
|
|
1237
1028
|
privateKeyTags: string[];
|
|
1238
|
-
/**
|
|
1239
|
-
* @inject_tag: validate:"dive"
|
|
1240
|
-
* @description Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
|
|
1241
|
-
*/
|
|
1029
|
+
/** @description Cryptocurrency-specific formats for a derived address (e.g., Ethereum). */
|
|
1242
1030
|
addressFormats: definitions["immutableactivityv1AddressFormat"][];
|
|
1243
1031
|
};
|
|
1244
1032
|
v1PrivateKeyResult: {
|
|
@@ -1247,12 +1035,8 @@ export type definitions = {
|
|
|
1247
1035
|
};
|
|
1248
1036
|
v1PublicKeyCredentialWithAttestation: {
|
|
1249
1037
|
id: string;
|
|
1250
|
-
/**
|
|
1251
|
-
* Must be literal string "public-key"
|
|
1252
|
-
* @enum {string}
|
|
1253
|
-
*/
|
|
1038
|
+
/** @enum {string} */
|
|
1254
1039
|
type: "public-key";
|
|
1255
|
-
/** ENCODING: base64url */
|
|
1256
1040
|
rawId: string;
|
|
1257
1041
|
/** @enum {string} */
|
|
1258
1042
|
authenticatorAttachment?: "cross-platform" | "platform" | null;
|
|
@@ -1269,10 +1053,7 @@ export type definitions = {
|
|
|
1269
1053
|
userIds: string[];
|
|
1270
1054
|
};
|
|
1271
1055
|
v1RejectActivityIntent: {
|
|
1272
|
-
/**
|
|
1273
|
-
* @inject_tag: validate:"required"
|
|
1274
|
-
* @description An artifact verifying a User's action.
|
|
1275
|
-
*/
|
|
1056
|
+
/** @description An artifact verifying a User's action. */
|
|
1276
1057
|
fingerprint: string;
|
|
1277
1058
|
};
|
|
1278
1059
|
v1RejectActivityRequest: {
|
|
@@ -1284,7 +1065,6 @@ export type definitions = {
|
|
|
1284
1065
|
organizationId: string;
|
|
1285
1066
|
parameters: definitions["v1RejectActivityIntent"];
|
|
1286
1067
|
};
|
|
1287
|
-
/** @description Result of the intended action. */
|
|
1288
1068
|
v1Result: {
|
|
1289
1069
|
createOrganizationResult?: definitions["v1CreateOrganizationResult"];
|
|
1290
1070
|
createAuthenticatorsResult?: definitions["v1CreateAuthenticatorsResult"];
|
|
@@ -1317,27 +1097,17 @@ export type definitions = {
|
|
|
1317
1097
|
createSubOrganizationResult?: definitions["v1CreateSubOrganizationResult"];
|
|
1318
1098
|
updateAllowedOriginsResult?: definitions["v1UpdateAllowedOriginsResult"];
|
|
1319
1099
|
createPrivateKeysResultV2?: definitions["v1CreatePrivateKeysResultV2"];
|
|
1100
|
+
updateUserResult?: definitions["v1UpdateUserResult"];
|
|
1101
|
+
updatePolicyResult?: definitions["v1UpdatePolicyResult"];
|
|
1320
1102
|
};
|
|
1321
1103
|
v1RootUserParams: {
|
|
1322
|
-
/**
|
|
1323
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1324
|
-
* @description Human-readable name for a User.
|
|
1325
|
-
*/
|
|
1104
|
+
/** @description Human-readable name for a User. */
|
|
1326
1105
|
userName: string;
|
|
1327
|
-
/**
|
|
1328
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1329
|
-
* @description The user's email address.
|
|
1330
|
-
*/
|
|
1106
|
+
/** @description The user's email address. */
|
|
1331
1107
|
userEmail?: string;
|
|
1332
|
-
/**
|
|
1333
|
-
* @inject_tag: validate:"dive"
|
|
1334
|
-
* @description A list of API Key parameters.
|
|
1335
|
-
*/
|
|
1108
|
+
/** @description A list of API Key parameters. */
|
|
1336
1109
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1337
|
-
/**
|
|
1338
|
-
* @inject_tag: validate:"dive"
|
|
1339
|
-
* @description A list of Authenticator parameters.
|
|
1340
|
-
*/
|
|
1110
|
+
/** @description A list of Authenticator parameters. */
|
|
1341
1111
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
1342
1112
|
};
|
|
1343
1113
|
v1SelectorV2: {
|
|
@@ -1346,35 +1116,25 @@ export type definitions = {
|
|
|
1346
1116
|
targets?: string[];
|
|
1347
1117
|
};
|
|
1348
1118
|
v1SetPaymentMethodIntent: {
|
|
1349
|
-
/**
|
|
1350
|
-
* @inject_tag: validate:"required,max=16,numeric"
|
|
1351
|
-
* @description The account number of the customer's credit card.
|
|
1352
|
-
*/
|
|
1119
|
+
/** @description The account number of the customer's credit card. */
|
|
1353
1120
|
number: string;
|
|
1354
|
-
/**
|
|
1355
|
-
* @inject_tag: validate:"required,max=4,numeric"
|
|
1356
|
-
* @description The verification digits of the customer's credit card.
|
|
1357
|
-
*/
|
|
1121
|
+
/** @description The verification digits of the customer's credit card. */
|
|
1358
1122
|
cvv: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* @inject_tag: validate:"required,numeric,len=2"
|
|
1361
|
-
* @description The month that the credit card expires.
|
|
1362
|
-
*/
|
|
1123
|
+
/** @description The month that the credit card expires. */
|
|
1363
1124
|
expiryMonth: string;
|
|
1364
|
-
/**
|
|
1365
|
-
* @inject_tag: validate:"required,numeric,len=4"
|
|
1366
|
-
* @description The year that the credit card expires.
|
|
1367
|
-
*/
|
|
1125
|
+
/** @description The year that the credit card expires. */
|
|
1368
1126
|
expiryYear: string;
|
|
1369
|
-
/**
|
|
1370
|
-
* @inject_tag: validate:"required,email,tk_email"
|
|
1371
|
-
* @description The email that will receive invoices for the credit card.
|
|
1372
|
-
*/
|
|
1127
|
+
/** @description The email that will receive invoices for the credit card. */
|
|
1373
1128
|
cardHolderEmail: string;
|
|
1374
|
-
/**
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
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. */
|
|
1378
1138
|
cardHolderName: string;
|
|
1379
1139
|
};
|
|
1380
1140
|
v1SetPaymentMethodResult: {
|
|
@@ -1386,17 +1146,13 @@ export type definitions = {
|
|
|
1386
1146
|
cardHolderEmail: string;
|
|
1387
1147
|
};
|
|
1388
1148
|
v1SignRawPayloadIntent: {
|
|
1389
|
-
/**
|
|
1390
|
-
* @inject_tag: validate:"required,uuid"
|
|
1391
|
-
* @description Unique identifier for a given Private Key.
|
|
1392
|
-
*/
|
|
1149
|
+
/** @description Unique identifier for a given Private Key. */
|
|
1393
1150
|
privateKeyId: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* @inject_tag: validate:"required"
|
|
1396
|
-
* @description Raw unsigned payload to be signed.
|
|
1397
|
-
*/
|
|
1151
|
+
/** @description Raw unsigned payload to be signed. */
|
|
1398
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). */
|
|
1399
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. */
|
|
1400
1156
|
hashFunction: definitions["v1HashFunction"];
|
|
1401
1157
|
};
|
|
1402
1158
|
v1SignRawPayloadRequest: {
|
|
@@ -1417,15 +1173,9 @@ export type definitions = {
|
|
|
1417
1173
|
v: string;
|
|
1418
1174
|
};
|
|
1419
1175
|
v1SignTransactionIntent: {
|
|
1420
|
-
/**
|
|
1421
|
-
* @inject_tag: validate:"required,uuid"
|
|
1422
|
-
* @description Unique identifier for a given Private Key.
|
|
1423
|
-
*/
|
|
1176
|
+
/** @description Unique identifier for a given Private Key. */
|
|
1424
1177
|
privateKeyId: string;
|
|
1425
|
-
/**
|
|
1426
|
-
* @inject_tag: validate:"required"
|
|
1427
|
-
* @description Raw unsigned transaction to be signed by a particular Private Key.
|
|
1428
|
-
*/
|
|
1178
|
+
/** @description Raw unsigned transaction to be signed by a particular Private Key. */
|
|
1429
1179
|
unsignedTransaction: string;
|
|
1430
1180
|
type: definitions["immutableactivityv1TransactionType"];
|
|
1431
1181
|
};
|
|
@@ -1453,10 +1203,7 @@ export type definitions = {
|
|
|
1453
1203
|
nanos: string;
|
|
1454
1204
|
};
|
|
1455
1205
|
v1UpdateAllowedOriginsIntent: {
|
|
1456
|
-
/**
|
|
1457
|
-
* @inject_tag: validate:"required"
|
|
1458
|
-
* @description Additional origins requests are allowed from besides Turnkey origins
|
|
1459
|
-
*/
|
|
1206
|
+
/** @description Additional origins requests are allowed from besides Turnkey origins */
|
|
1460
1207
|
allowedOrigins: string[];
|
|
1461
1208
|
};
|
|
1462
1209
|
v1UpdateAllowedOriginsRequest: {
|
|
@@ -1471,26 +1218,41 @@ export type definitions = {
|
|
|
1471
1218
|
v1UpdateAllowedOriginsResult: {
|
|
1472
1219
|
[key: string]: unknown;
|
|
1473
1220
|
};
|
|
1221
|
+
v1UpdatePolicyIntent: {
|
|
1222
|
+
/** @description Unique identifier for a given Policy. */
|
|
1223
|
+
policyId: string;
|
|
1224
|
+
/** @description Human-readable name for a Policy. */
|
|
1225
|
+
policyName?: string;
|
|
1226
|
+
/** @description The instruction to DENY or ALLOW an activity (optional). */
|
|
1227
|
+
policyEffect?: definitions["immutableactivityv1Effect"];
|
|
1228
|
+
/** @description The condition expression that triggers the Effect (optional). */
|
|
1229
|
+
policyCondition?: string;
|
|
1230
|
+
/** @description The consensus expression that triggers the Effect (optional). */
|
|
1231
|
+
policyConsensus?: string;
|
|
1232
|
+
/** @description Accompanying notes for a Policy (optional). */
|
|
1233
|
+
policyNotes?: string;
|
|
1234
|
+
};
|
|
1235
|
+
v1UpdatePolicyRequest: {
|
|
1236
|
+
/** @enum {string} */
|
|
1237
|
+
type: "ACTIVITY_TYPE_UPDATE_POLICY";
|
|
1238
|
+
/** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
|
|
1239
|
+
timestampMs: string;
|
|
1240
|
+
/** @description Unique identifier for a given Organization. */
|
|
1241
|
+
organizationId: string;
|
|
1242
|
+
parameters: definitions["v1UpdatePolicyIntent"];
|
|
1243
|
+
};
|
|
1244
|
+
v1UpdatePolicyResult: {
|
|
1245
|
+
/** @description Unique identifier for a given Policy. */
|
|
1246
|
+
policyId: string;
|
|
1247
|
+
};
|
|
1474
1248
|
v1UpdatePrivateKeyTagIntent: {
|
|
1475
|
-
/**
|
|
1476
|
-
* @inject_tag: validate:"uuid"
|
|
1477
|
-
* @description Unique identifier for a given Private Key Tag.
|
|
1478
|
-
*/
|
|
1249
|
+
/** @description Unique identifier for a given Private Key Tag. */
|
|
1479
1250
|
privateKeyTagId: string;
|
|
1480
|
-
/**
|
|
1481
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1482
|
-
* @description The new, human-readable name for the tag with the given ID.
|
|
1483
|
-
*/
|
|
1251
|
+
/** @description The new, human-readable name for the tag with the given ID. */
|
|
1484
1252
|
newPrivateKeyTagName?: string;
|
|
1485
|
-
/**
|
|
1486
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1487
|
-
* @description A list of Private Keys IDs to add this tag to.
|
|
1488
|
-
*/
|
|
1253
|
+
/** @description A list of Private Keys IDs to add this tag to. */
|
|
1489
1254
|
addPrivateKeyIds: string[];
|
|
1490
|
-
/**
|
|
1491
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1492
|
-
* @description A list of Private Key IDs to remove this tag from.
|
|
1493
|
-
*/
|
|
1255
|
+
/** @description A list of Private Key IDs to remove this tag from. */
|
|
1494
1256
|
removePrivateKeyIds: string[];
|
|
1495
1257
|
};
|
|
1496
1258
|
v1UpdatePrivateKeyTagRequest: {
|
|
@@ -1508,15 +1270,11 @@ export type definitions = {
|
|
|
1508
1270
|
};
|
|
1509
1271
|
v1UpdateRootQuorumIntent: {
|
|
1510
1272
|
/**
|
|
1511
|
-
* @inject_tag: validate:"required"
|
|
1512
1273
|
* Format: int32
|
|
1513
1274
|
* @description The threshold of unique approvals to reach quorum.
|
|
1514
1275
|
*/
|
|
1515
1276
|
threshold: number;
|
|
1516
|
-
/**
|
|
1517
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1518
|
-
* @description The unique identifiers of users who comprise the quorum set.
|
|
1519
|
-
*/
|
|
1277
|
+
/** @description The unique identifiers of users who comprise the quorum set. */
|
|
1520
1278
|
userIds: string[];
|
|
1521
1279
|
};
|
|
1522
1280
|
v1UpdateRootQuorumRequest: {
|
|
@@ -1531,26 +1289,37 @@ export type definitions = {
|
|
|
1531
1289
|
v1UpdateRootQuorumResult: {
|
|
1532
1290
|
[key: string]: unknown;
|
|
1533
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
|
+
};
|
|
1534
1315
|
v1UpdateUserTagIntent: {
|
|
1535
|
-
/**
|
|
1536
|
-
* @inject_tag: validate:"uuid"
|
|
1537
|
-
* @description Unique identifier for a given User Tag.
|
|
1538
|
-
*/
|
|
1316
|
+
/** @description Unique identifier for a given User Tag. */
|
|
1539
1317
|
userTagId: string;
|
|
1540
|
-
/**
|
|
1541
|
-
* @inject_tag: validate:"omitempty,tk_label,tk_label_length"
|
|
1542
|
-
* @description The new, human-readable name for the tag with the given ID.
|
|
1543
|
-
*/
|
|
1318
|
+
/** @description The new, human-readable name for the tag with the given ID. */
|
|
1544
1319
|
newUserTagName?: string;
|
|
1545
|
-
/**
|
|
1546
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1547
|
-
* @description A list of User IDs to add this tag to.
|
|
1548
|
-
*/
|
|
1320
|
+
/** @description A list of User IDs to add this tag to. */
|
|
1549
1321
|
addUserIds: string[];
|
|
1550
|
-
/**
|
|
1551
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1552
|
-
* @description A list of User IDs to remove this tag from.
|
|
1553
|
-
*/
|
|
1322
|
+
/** @description A list of User IDs to remove this tag from. */
|
|
1554
1323
|
removeUserIds: string[];
|
|
1555
1324
|
};
|
|
1556
1325
|
v1UpdateUserTagRequest: {
|
|
@@ -1571,11 +1340,9 @@ export type definitions = {
|
|
|
1571
1340
|
userId: string;
|
|
1572
1341
|
/** @description Human-readable name for a User. */
|
|
1573
1342
|
userName: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* some users do not have emails (programmatic users)
|
|
1576
|
-
* @description The user's email address.
|
|
1577
|
-
*/
|
|
1343
|
+
/** @description The user's email address. */
|
|
1578
1344
|
userEmail?: string;
|
|
1345
|
+
/** @description The User's permissible access method(s). */
|
|
1579
1346
|
accessType: definitions["externaldatav1AccessType"];
|
|
1580
1347
|
/** @description A list of Authenticator parameters. */
|
|
1581
1348
|
authenticators: definitions["v1Authenticator"][];
|
|
@@ -1587,67 +1354,39 @@ export type definitions = {
|
|
|
1587
1354
|
updatedAt: definitions["v1Timestamp"];
|
|
1588
1355
|
};
|
|
1589
1356
|
v1UserParams: {
|
|
1590
|
-
/**
|
|
1591
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1592
|
-
* @description Human-readable name for a User.
|
|
1593
|
-
*/
|
|
1357
|
+
/** @description Human-readable name for a User. */
|
|
1594
1358
|
userName: string;
|
|
1595
|
-
/**
|
|
1596
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1597
|
-
* @description The user's email address.
|
|
1598
|
-
*/
|
|
1359
|
+
/** @description The user's email address. */
|
|
1599
1360
|
userEmail?: string;
|
|
1361
|
+
/** @description The User's permissible access method(s). */
|
|
1600
1362
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1601
|
-
/**
|
|
1602
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1603
|
-
* @description A list of API Key parameters.
|
|
1604
|
-
*/
|
|
1363
|
+
/** @description A list of API Key parameters. */
|
|
1605
1364
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1606
|
-
/**
|
|
1607
|
-
* @inject_tag: validate:"dive"
|
|
1608
|
-
* @description A list of Authenticator parameters.
|
|
1609
|
-
*/
|
|
1365
|
+
/** @description A list of Authenticator parameters. */
|
|
1610
1366
|
authenticators: definitions["v1AuthenticatorParams"][];
|
|
1611
|
-
/**
|
|
1612
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1613
|
-
* @description A list of User Tag IDs.
|
|
1614
|
-
*/
|
|
1367
|
+
/** @description A list of User Tag IDs. */
|
|
1615
1368
|
userTags: string[];
|
|
1616
1369
|
};
|
|
1617
1370
|
v1UserParamsV2: {
|
|
1618
|
-
/**
|
|
1619
|
-
* @inject_tag: validate:"required,tk_label_length,tk_label"
|
|
1620
|
-
* @description Human-readable name for a User.
|
|
1621
|
-
*/
|
|
1371
|
+
/** @description Human-readable name for a User. */
|
|
1622
1372
|
userName: string;
|
|
1623
|
-
/**
|
|
1624
|
-
* @inject_tag: validate:"omitempty,email,tk_email"
|
|
1625
|
-
* @description The user's email address.
|
|
1626
|
-
*/
|
|
1373
|
+
/** @description The user's email address. */
|
|
1627
1374
|
userEmail?: string;
|
|
1375
|
+
/** @description The User's permissible access method(s). */
|
|
1628
1376
|
accessType: definitions["immutableactivityv1AccessType"];
|
|
1629
|
-
/**
|
|
1630
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1631
|
-
* @description A list of API Key parameters.
|
|
1632
|
-
*/
|
|
1377
|
+
/** @description A list of API Key parameters. */
|
|
1633
1378
|
apiKeys: definitions["v1ApiKeyParams"][];
|
|
1634
|
-
/**
|
|
1635
|
-
* @inject_tag: validate:"dive"
|
|
1636
|
-
* @description A list of Authenticator parameters.
|
|
1637
|
-
*/
|
|
1379
|
+
/** @description A list of Authenticator parameters. */
|
|
1638
1380
|
authenticators: definitions["v1AuthenticatorParamsV2"][];
|
|
1639
|
-
/**
|
|
1640
|
-
* @inject_tag: validate:"dive,uuid"
|
|
1641
|
-
* @description A list of User Tag IDs.
|
|
1642
|
-
*/
|
|
1381
|
+
/** @description A list of User Tag IDs. */
|
|
1643
1382
|
userTags: string[];
|
|
1644
1383
|
};
|
|
1645
|
-
/** @description Object representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. */
|
|
1646
1384
|
v1Vote: {
|
|
1647
1385
|
/** @description Unique identifier for a given Vote object. */
|
|
1648
1386
|
id: string;
|
|
1649
1387
|
/** @description Unique identifier for a given User. */
|
|
1650
1388
|
userId: string;
|
|
1389
|
+
/** @description Web and/or API user within your Organization. */
|
|
1651
1390
|
user: definitions["v1User"];
|
|
1652
1391
|
/** @description Unique identifier for a given Activity object. */
|
|
1653
1392
|
activityId: string;
|
|
@@ -1663,7 +1402,6 @@ export type definitions = {
|
|
|
1663
1402
|
scheme: string;
|
|
1664
1403
|
createdAt: definitions["v1Timestamp"];
|
|
1665
1404
|
};
|
|
1666
|
-
/** We expect this to be passed in as a JSON-encoded, then base64-encoded string within a X-Stamp-Webauthn header */
|
|
1667
1405
|
v1WebAuthnStamp: {
|
|
1668
1406
|
/** @description A base64 url encoded Unique identifier for a given credential. */
|
|
1669
1407
|
credentialId: string;
|
|
@@ -1688,14 +1426,6 @@ export type operations = {
|
|
|
1688
1426
|
200: {
|
|
1689
1427
|
schema: definitions["v1ActivityResponse"];
|
|
1690
1428
|
};
|
|
1691
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1692
|
-
403: {
|
|
1693
|
-
schema: unknown;
|
|
1694
|
-
};
|
|
1695
|
-
/** Returned when the resource does not exist. */
|
|
1696
|
-
404: {
|
|
1697
|
-
schema: string;
|
|
1698
|
-
};
|
|
1699
1429
|
/** An unexpected error response. */
|
|
1700
1430
|
default: {
|
|
1701
1431
|
schema: definitions["rpcStatus"];
|
|
@@ -1714,14 +1444,6 @@ export type operations = {
|
|
|
1714
1444
|
200: {
|
|
1715
1445
|
schema: definitions["v1GetAuthenticatorResponse"];
|
|
1716
1446
|
};
|
|
1717
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1718
|
-
403: {
|
|
1719
|
-
schema: unknown;
|
|
1720
|
-
};
|
|
1721
|
-
/** Returned when the resource does not exist. */
|
|
1722
|
-
404: {
|
|
1723
|
-
schema: string;
|
|
1724
|
-
};
|
|
1725
1447
|
/** An unexpected error response. */
|
|
1726
1448
|
default: {
|
|
1727
1449
|
schema: definitions["rpcStatus"];
|
|
@@ -1740,14 +1462,6 @@ export type operations = {
|
|
|
1740
1462
|
200: {
|
|
1741
1463
|
schema: definitions["v1GetAuthenticatorsResponse"];
|
|
1742
1464
|
};
|
|
1743
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1744
|
-
403: {
|
|
1745
|
-
schema: unknown;
|
|
1746
|
-
};
|
|
1747
|
-
/** Returned when the resource does not exist. */
|
|
1748
|
-
404: {
|
|
1749
|
-
schema: string;
|
|
1750
|
-
};
|
|
1751
1465
|
/** An unexpected error response. */
|
|
1752
1466
|
default: {
|
|
1753
1467
|
schema: definitions["rpcStatus"];
|
|
@@ -1766,14 +1480,6 @@ export type operations = {
|
|
|
1766
1480
|
200: {
|
|
1767
1481
|
schema: definitions["v1GetOrganizationResponse"];
|
|
1768
1482
|
};
|
|
1769
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1770
|
-
403: {
|
|
1771
|
-
schema: unknown;
|
|
1772
|
-
};
|
|
1773
|
-
/** Returned when the resource does not exist. */
|
|
1774
|
-
404: {
|
|
1775
|
-
schema: string;
|
|
1776
|
-
};
|
|
1777
1483
|
/** An unexpected error response. */
|
|
1778
1484
|
default: {
|
|
1779
1485
|
schema: definitions["rpcStatus"];
|
|
@@ -1792,14 +1498,6 @@ export type operations = {
|
|
|
1792
1498
|
200: {
|
|
1793
1499
|
schema: definitions["v1GetPolicyResponse"];
|
|
1794
1500
|
};
|
|
1795
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1796
|
-
403: {
|
|
1797
|
-
schema: unknown;
|
|
1798
|
-
};
|
|
1799
|
-
/** Returned when the resource does not exist. */
|
|
1800
|
-
404: {
|
|
1801
|
-
schema: string;
|
|
1802
|
-
};
|
|
1803
1501
|
/** An unexpected error response. */
|
|
1804
1502
|
default: {
|
|
1805
1503
|
schema: definitions["rpcStatus"];
|
|
@@ -1818,14 +1516,6 @@ export type operations = {
|
|
|
1818
1516
|
200: {
|
|
1819
1517
|
schema: definitions["v1GetPrivateKeyResponse"];
|
|
1820
1518
|
};
|
|
1821
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1822
|
-
403: {
|
|
1823
|
-
schema: unknown;
|
|
1824
|
-
};
|
|
1825
|
-
/** Returned when the resource does not exist. */
|
|
1826
|
-
404: {
|
|
1827
|
-
schema: string;
|
|
1828
|
-
};
|
|
1829
1519
|
/** An unexpected error response. */
|
|
1830
1520
|
default: {
|
|
1831
1521
|
schema: definitions["rpcStatus"];
|
|
@@ -1844,14 +1534,6 @@ export type operations = {
|
|
|
1844
1534
|
200: {
|
|
1845
1535
|
schema: definitions["v1GetUserResponse"];
|
|
1846
1536
|
};
|
|
1847
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1848
|
-
403: {
|
|
1849
|
-
schema: unknown;
|
|
1850
|
-
};
|
|
1851
|
-
/** Returned when the resource does not exist. */
|
|
1852
|
-
404: {
|
|
1853
|
-
schema: string;
|
|
1854
|
-
};
|
|
1855
1537
|
/** An unexpected error response. */
|
|
1856
1538
|
default: {
|
|
1857
1539
|
schema: definitions["rpcStatus"];
|
|
@@ -1870,14 +1552,6 @@ export type operations = {
|
|
|
1870
1552
|
200: {
|
|
1871
1553
|
schema: definitions["v1GetActivitiesResponse"];
|
|
1872
1554
|
};
|
|
1873
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1874
|
-
403: {
|
|
1875
|
-
schema: unknown;
|
|
1876
|
-
};
|
|
1877
|
-
/** Returned when the resource does not exist. */
|
|
1878
|
-
404: {
|
|
1879
|
-
schema: string;
|
|
1880
|
-
};
|
|
1881
1555
|
/** An unexpected error response. */
|
|
1882
1556
|
default: {
|
|
1883
1557
|
schema: definitions["rpcStatus"];
|
|
@@ -1896,14 +1570,6 @@ export type operations = {
|
|
|
1896
1570
|
200: {
|
|
1897
1571
|
schema: definitions["v1GetPoliciesResponse"];
|
|
1898
1572
|
};
|
|
1899
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1900
|
-
403: {
|
|
1901
|
-
schema: unknown;
|
|
1902
|
-
};
|
|
1903
|
-
/** Returned when the resource does not exist. */
|
|
1904
|
-
404: {
|
|
1905
|
-
schema: string;
|
|
1906
|
-
};
|
|
1907
1573
|
/** An unexpected error response. */
|
|
1908
1574
|
default: {
|
|
1909
1575
|
schema: definitions["rpcStatus"];
|
|
@@ -1922,14 +1588,6 @@ export type operations = {
|
|
|
1922
1588
|
200: {
|
|
1923
1589
|
schema: definitions["v1GetPrivateKeysResponse"];
|
|
1924
1590
|
};
|
|
1925
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1926
|
-
403: {
|
|
1927
|
-
schema: unknown;
|
|
1928
|
-
};
|
|
1929
|
-
/** Returned when the resource does not exist. */
|
|
1930
|
-
404: {
|
|
1931
|
-
schema: string;
|
|
1932
|
-
};
|
|
1933
1591
|
/** An unexpected error response. */
|
|
1934
1592
|
default: {
|
|
1935
1593
|
schema: definitions["rpcStatus"];
|
|
@@ -1948,14 +1606,6 @@ export type operations = {
|
|
|
1948
1606
|
200: {
|
|
1949
1607
|
schema: definitions["v1GetUsersResponse"];
|
|
1950
1608
|
};
|
|
1951
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1952
|
-
403: {
|
|
1953
|
-
schema: unknown;
|
|
1954
|
-
};
|
|
1955
|
-
/** Returned when the resource does not exist. */
|
|
1956
|
-
404: {
|
|
1957
|
-
schema: string;
|
|
1958
|
-
};
|
|
1959
1609
|
/** An unexpected error response. */
|
|
1960
1610
|
default: {
|
|
1961
1611
|
schema: definitions["rpcStatus"];
|
|
@@ -1974,14 +1624,6 @@ export type operations = {
|
|
|
1974
1624
|
200: {
|
|
1975
1625
|
schema: definitions["v1GetWhoamiResponse"];
|
|
1976
1626
|
};
|
|
1977
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
1978
|
-
403: {
|
|
1979
|
-
schema: unknown;
|
|
1980
|
-
};
|
|
1981
|
-
/** Returned when the resource does not exist. */
|
|
1982
|
-
404: {
|
|
1983
|
-
schema: string;
|
|
1984
|
-
};
|
|
1985
1627
|
/** An unexpected error response. */
|
|
1986
1628
|
default: {
|
|
1987
1629
|
schema: definitions["rpcStatus"];
|
|
@@ -2000,14 +1642,6 @@ export type operations = {
|
|
|
2000
1642
|
200: {
|
|
2001
1643
|
schema: definitions["v1ActivityResponse"];
|
|
2002
1644
|
};
|
|
2003
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2004
|
-
403: {
|
|
2005
|
-
schema: unknown;
|
|
2006
|
-
};
|
|
2007
|
-
/** Returned when the resource does not exist. */
|
|
2008
|
-
404: {
|
|
2009
|
-
schema: string;
|
|
2010
|
-
};
|
|
2011
1645
|
/** An unexpected error response. */
|
|
2012
1646
|
default: {
|
|
2013
1647
|
schema: definitions["rpcStatus"];
|
|
@@ -2026,14 +1660,6 @@ export type operations = {
|
|
|
2026
1660
|
200: {
|
|
2027
1661
|
schema: definitions["v1ActivityResponse"];
|
|
2028
1662
|
};
|
|
2029
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2030
|
-
403: {
|
|
2031
|
-
schema: unknown;
|
|
2032
|
-
};
|
|
2033
|
-
/** Returned when the resource does not exist. */
|
|
2034
|
-
404: {
|
|
2035
|
-
schema: string;
|
|
2036
|
-
};
|
|
2037
1663
|
/** An unexpected error response. */
|
|
2038
1664
|
default: {
|
|
2039
1665
|
schema: definitions["rpcStatus"];
|
|
@@ -2052,14 +1678,6 @@ export type operations = {
|
|
|
2052
1678
|
200: {
|
|
2053
1679
|
schema: definitions["v1ActivityResponse"];
|
|
2054
1680
|
};
|
|
2055
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2056
|
-
403: {
|
|
2057
|
-
schema: unknown;
|
|
2058
|
-
};
|
|
2059
|
-
/** Returned when the resource does not exist. */
|
|
2060
|
-
404: {
|
|
2061
|
-
schema: string;
|
|
2062
|
-
};
|
|
2063
1681
|
/** An unexpected error response. */
|
|
2064
1682
|
default: {
|
|
2065
1683
|
schema: definitions["rpcStatus"];
|
|
@@ -2078,14 +1696,6 @@ export type operations = {
|
|
|
2078
1696
|
200: {
|
|
2079
1697
|
schema: definitions["v1ActivityResponse"];
|
|
2080
1698
|
};
|
|
2081
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2082
|
-
403: {
|
|
2083
|
-
schema: unknown;
|
|
2084
|
-
};
|
|
2085
|
-
/** Returned when the resource does not exist. */
|
|
2086
|
-
404: {
|
|
2087
|
-
schema: string;
|
|
2088
|
-
};
|
|
2089
1699
|
/** An unexpected error response. */
|
|
2090
1700
|
default: {
|
|
2091
1701
|
schema: definitions["rpcStatus"];
|
|
@@ -2104,14 +1714,6 @@ export type operations = {
|
|
|
2104
1714
|
200: {
|
|
2105
1715
|
schema: definitions["v1ActivityResponse"];
|
|
2106
1716
|
};
|
|
2107
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2108
|
-
403: {
|
|
2109
|
-
schema: unknown;
|
|
2110
|
-
};
|
|
2111
|
-
/** Returned when the resource does not exist. */
|
|
2112
|
-
404: {
|
|
2113
|
-
schema: string;
|
|
2114
|
-
};
|
|
2115
1717
|
/** An unexpected error response. */
|
|
2116
1718
|
default: {
|
|
2117
1719
|
schema: definitions["rpcStatus"];
|
|
@@ -2130,14 +1732,6 @@ export type operations = {
|
|
|
2130
1732
|
200: {
|
|
2131
1733
|
schema: definitions["v1ActivityResponse"];
|
|
2132
1734
|
};
|
|
2133
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2134
|
-
403: {
|
|
2135
|
-
schema: unknown;
|
|
2136
|
-
};
|
|
2137
|
-
/** Returned when the resource does not exist. */
|
|
2138
|
-
404: {
|
|
2139
|
-
schema: string;
|
|
2140
|
-
};
|
|
2141
1735
|
/** An unexpected error response. */
|
|
2142
1736
|
default: {
|
|
2143
1737
|
schema: definitions["rpcStatus"];
|
|
@@ -2156,14 +1750,6 @@ export type operations = {
|
|
|
2156
1750
|
200: {
|
|
2157
1751
|
schema: definitions["v1ActivityResponse"];
|
|
2158
1752
|
};
|
|
2159
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2160
|
-
403: {
|
|
2161
|
-
schema: unknown;
|
|
2162
|
-
};
|
|
2163
|
-
/** Returned when the resource does not exist. */
|
|
2164
|
-
404: {
|
|
2165
|
-
schema: string;
|
|
2166
|
-
};
|
|
2167
1753
|
/** An unexpected error response. */
|
|
2168
1754
|
default: {
|
|
2169
1755
|
schema: definitions["rpcStatus"];
|
|
@@ -2182,14 +1768,6 @@ export type operations = {
|
|
|
2182
1768
|
200: {
|
|
2183
1769
|
schema: definitions["v1ActivityResponse"];
|
|
2184
1770
|
};
|
|
2185
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2186
|
-
403: {
|
|
2187
|
-
schema: unknown;
|
|
2188
|
-
};
|
|
2189
|
-
/** Returned when the resource does not exist. */
|
|
2190
|
-
404: {
|
|
2191
|
-
schema: string;
|
|
2192
|
-
};
|
|
2193
1771
|
/** An unexpected error response. */
|
|
2194
1772
|
default: {
|
|
2195
1773
|
schema: definitions["rpcStatus"];
|
|
@@ -2208,14 +1786,6 @@ export type operations = {
|
|
|
2208
1786
|
200: {
|
|
2209
1787
|
schema: definitions["v1ActivityResponse"];
|
|
2210
1788
|
};
|
|
2211
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2212
|
-
403: {
|
|
2213
|
-
schema: unknown;
|
|
2214
|
-
};
|
|
2215
|
-
/** Returned when the resource does not exist. */
|
|
2216
|
-
404: {
|
|
2217
|
-
schema: string;
|
|
2218
|
-
};
|
|
2219
1789
|
/** An unexpected error response. */
|
|
2220
1790
|
default: {
|
|
2221
1791
|
schema: definitions["rpcStatus"];
|
|
@@ -2234,14 +1804,6 @@ export type operations = {
|
|
|
2234
1804
|
200: {
|
|
2235
1805
|
schema: definitions["v1ActivityResponse"];
|
|
2236
1806
|
};
|
|
2237
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2238
|
-
403: {
|
|
2239
|
-
schema: unknown;
|
|
2240
|
-
};
|
|
2241
|
-
/** Returned when the resource does not exist. */
|
|
2242
|
-
404: {
|
|
2243
|
-
schema: string;
|
|
2244
|
-
};
|
|
2245
1807
|
/** An unexpected error response. */
|
|
2246
1808
|
default: {
|
|
2247
1809
|
schema: definitions["rpcStatus"];
|
|
@@ -2260,14 +1822,6 @@ export type operations = {
|
|
|
2260
1822
|
200: {
|
|
2261
1823
|
schema: definitions["v1ActivityResponse"];
|
|
2262
1824
|
};
|
|
2263
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2264
|
-
403: {
|
|
2265
|
-
schema: unknown;
|
|
2266
|
-
};
|
|
2267
|
-
/** Returned when the resource does not exist. */
|
|
2268
|
-
404: {
|
|
2269
|
-
schema: string;
|
|
2270
|
-
};
|
|
2271
1825
|
/** An unexpected error response. */
|
|
2272
1826
|
default: {
|
|
2273
1827
|
schema: definitions["rpcStatus"];
|
|
@@ -2286,13 +1840,23 @@ export type operations = {
|
|
|
2286
1840
|
200: {
|
|
2287
1841
|
schema: definitions["v1ActivityResponse"];
|
|
2288
1842
|
};
|
|
2289
|
-
/**
|
|
2290
|
-
|
|
2291
|
-
schema:
|
|
1843
|
+
/** An unexpected error response. */
|
|
1844
|
+
default: {
|
|
1845
|
+
schema: definitions["rpcStatus"];
|
|
2292
1846
|
};
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
/** Remove authenticators from a User */
|
|
1850
|
+
PublicApiService_DeleteAuthenticators: {
|
|
1851
|
+
parameters: {
|
|
1852
|
+
body: {
|
|
1853
|
+
body: definitions["v1DeleteAuthenticatorsRequest"];
|
|
1854
|
+
};
|
|
1855
|
+
};
|
|
1856
|
+
responses: {
|
|
1857
|
+
/** A successful response. */
|
|
1858
|
+
200: {
|
|
1859
|
+
schema: definitions["v1ActivityResponse"];
|
|
2296
1860
|
};
|
|
2297
1861
|
/** An unexpected error response. */
|
|
2298
1862
|
default: {
|
|
@@ -2312,14 +1876,6 @@ export type operations = {
|
|
|
2312
1876
|
200: {
|
|
2313
1877
|
schema: definitions["v1ActivityResponse"];
|
|
2314
1878
|
};
|
|
2315
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2316
|
-
403: {
|
|
2317
|
-
schema: unknown;
|
|
2318
|
-
};
|
|
2319
|
-
/** Returned when the resource does not exist. */
|
|
2320
|
-
404: {
|
|
2321
|
-
schema: string;
|
|
2322
|
-
};
|
|
2323
1879
|
/** An unexpected error response. */
|
|
2324
1880
|
default: {
|
|
2325
1881
|
schema: definitions["rpcStatus"];
|
|
@@ -2338,14 +1894,6 @@ export type operations = {
|
|
|
2338
1894
|
200: {
|
|
2339
1895
|
schema: definitions["v1ActivityResponse"];
|
|
2340
1896
|
};
|
|
2341
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2342
|
-
403: {
|
|
2343
|
-
schema: unknown;
|
|
2344
|
-
};
|
|
2345
|
-
/** Returned when the resource does not exist. */
|
|
2346
|
-
404: {
|
|
2347
|
-
schema: string;
|
|
2348
|
-
};
|
|
2349
1897
|
/** An unexpected error response. */
|
|
2350
1898
|
default: {
|
|
2351
1899
|
schema: definitions["rpcStatus"];
|
|
@@ -2364,14 +1912,6 @@ export type operations = {
|
|
|
2364
1912
|
200: {
|
|
2365
1913
|
schema: definitions["v1ActivityResponse"];
|
|
2366
1914
|
};
|
|
2367
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2368
|
-
403: {
|
|
2369
|
-
schema: unknown;
|
|
2370
|
-
};
|
|
2371
|
-
/** Returned when the resource does not exist. */
|
|
2372
|
-
404: {
|
|
2373
|
-
schema: string;
|
|
2374
|
-
};
|
|
2375
1915
|
/** An unexpected error response. */
|
|
2376
1916
|
default: {
|
|
2377
1917
|
schema: definitions["rpcStatus"];
|
|
@@ -2390,14 +1930,6 @@ export type operations = {
|
|
|
2390
1930
|
200: {
|
|
2391
1931
|
schema: definitions["v1ActivityResponse"];
|
|
2392
1932
|
};
|
|
2393
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2394
|
-
403: {
|
|
2395
|
-
schema: unknown;
|
|
2396
|
-
};
|
|
2397
|
-
/** Returned when the resource does not exist. */
|
|
2398
|
-
404: {
|
|
2399
|
-
schema: string;
|
|
2400
|
-
};
|
|
2401
1933
|
/** An unexpected error response. */
|
|
2402
1934
|
default: {
|
|
2403
1935
|
schema: definitions["rpcStatus"];
|
|
@@ -2416,14 +1948,6 @@ export type operations = {
|
|
|
2416
1948
|
200: {
|
|
2417
1949
|
schema: definitions["v1ActivityResponse"];
|
|
2418
1950
|
};
|
|
2419
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2420
|
-
403: {
|
|
2421
|
-
schema: unknown;
|
|
2422
|
-
};
|
|
2423
|
-
/** Returned when the resource does not exist. */
|
|
2424
|
-
404: {
|
|
2425
|
-
schema: string;
|
|
2426
|
-
};
|
|
2427
1951
|
/** An unexpected error response. */
|
|
2428
1952
|
default: {
|
|
2429
1953
|
schema: definitions["rpcStatus"];
|
|
@@ -2442,13 +1966,23 @@ export type operations = {
|
|
|
2442
1966
|
200: {
|
|
2443
1967
|
schema: definitions["v1ActivityResponse"];
|
|
2444
1968
|
};
|
|
2445
|
-
/**
|
|
2446
|
-
|
|
2447
|
-
schema:
|
|
1969
|
+
/** An unexpected error response. */
|
|
1970
|
+
default: {
|
|
1971
|
+
schema: definitions["rpcStatus"];
|
|
2448
1972
|
};
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
/** Update an existing Policy */
|
|
1976
|
+
PublicApiService_UpdatePolicy: {
|
|
1977
|
+
parameters: {
|
|
1978
|
+
body: {
|
|
1979
|
+
body: definitions["v1UpdatePolicyRequest"];
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
responses: {
|
|
1983
|
+
/** A successful response. */
|
|
1984
|
+
200: {
|
|
1985
|
+
schema: definitions["v1ActivityResponse"];
|
|
2452
1986
|
};
|
|
2453
1987
|
/** An unexpected error response. */
|
|
2454
1988
|
default: {
|
|
@@ -2468,14 +2002,6 @@ export type operations = {
|
|
|
2468
2002
|
200: {
|
|
2469
2003
|
schema: definitions["v1ActivityResponse"];
|
|
2470
2004
|
};
|
|
2471
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2472
|
-
403: {
|
|
2473
|
-
schema: unknown;
|
|
2474
|
-
};
|
|
2475
|
-
/** Returned when the resource does not exist. */
|
|
2476
|
-
404: {
|
|
2477
|
-
schema: string;
|
|
2478
|
-
};
|
|
2479
2005
|
/** An unexpected error response. */
|
|
2480
2006
|
default: {
|
|
2481
2007
|
schema: definitions["rpcStatus"];
|
|
@@ -2494,25 +2020,17 @@ export type operations = {
|
|
|
2494
2020
|
200: {
|
|
2495
2021
|
schema: definitions["v1ActivityResponse"];
|
|
2496
2022
|
};
|
|
2497
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2498
|
-
403: {
|
|
2499
|
-
schema: unknown;
|
|
2500
|
-
};
|
|
2501
|
-
/** Returned when the resource does not exist. */
|
|
2502
|
-
404: {
|
|
2503
|
-
schema: string;
|
|
2504
|
-
};
|
|
2505
2023
|
/** An unexpected error response. */
|
|
2506
2024
|
default: {
|
|
2507
2025
|
schema: definitions["rpcStatus"];
|
|
2508
2026
|
};
|
|
2509
2027
|
};
|
|
2510
2028
|
};
|
|
2511
|
-
/** Update
|
|
2512
|
-
|
|
2029
|
+
/** Update a User in an existing Organization */
|
|
2030
|
+
PublicApiService_UpdateUser: {
|
|
2513
2031
|
parameters: {
|
|
2514
2032
|
body: {
|
|
2515
|
-
body: definitions["
|
|
2033
|
+
body: definitions["v1UpdateUserRequest"];
|
|
2516
2034
|
};
|
|
2517
2035
|
};
|
|
2518
2036
|
responses: {
|
|
@@ -2520,33 +2038,23 @@ export type operations = {
|
|
|
2520
2038
|
200: {
|
|
2521
2039
|
schema: definitions["v1ActivityResponse"];
|
|
2522
2040
|
};
|
|
2523
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2524
|
-
403: {
|
|
2525
|
-
schema: unknown;
|
|
2526
|
-
};
|
|
2527
|
-
/** Returned when the resource does not exist. */
|
|
2528
|
-
404: {
|
|
2529
|
-
schema: string;
|
|
2530
|
-
};
|
|
2531
2041
|
/** An unexpected error response. */
|
|
2532
2042
|
default: {
|
|
2533
2043
|
schema: definitions["rpcStatus"];
|
|
2534
2044
|
};
|
|
2535
2045
|
};
|
|
2536
2046
|
};
|
|
2537
|
-
|
|
2047
|
+
/** 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. */
|
|
2048
|
+
PublicApiService_UpdateUserTag: {
|
|
2049
|
+
parameters: {
|
|
2050
|
+
body: {
|
|
2051
|
+
body: definitions["v1UpdateUserTagRequest"];
|
|
2052
|
+
};
|
|
2053
|
+
};
|
|
2538
2054
|
responses: {
|
|
2539
2055
|
/** A successful response. */
|
|
2540
2056
|
200: {
|
|
2541
|
-
schema: definitions["
|
|
2542
|
-
};
|
|
2543
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2544
|
-
403: {
|
|
2545
|
-
schema: unknown;
|
|
2546
|
-
};
|
|
2547
|
-
/** Returned when the resource does not exist. */
|
|
2548
|
-
404: {
|
|
2549
|
-
schema: string;
|
|
2057
|
+
schema: definitions["v1ActivityResponse"];
|
|
2550
2058
|
};
|
|
2551
2059
|
/** An unexpected error response. */
|
|
2552
2060
|
default: {
|
|
@@ -2554,25 +2062,11 @@ export type operations = {
|
|
|
2554
2062
|
};
|
|
2555
2063
|
};
|
|
2556
2064
|
};
|
|
2557
|
-
|
|
2558
|
-
PublicApiService_GetPrivateKeyBackwardsCompat: {
|
|
2559
|
-
parameters: {
|
|
2560
|
-
body: {
|
|
2561
|
-
body: definitions["v1GetPrivateKeyRequest"];
|
|
2562
|
-
};
|
|
2563
|
-
};
|
|
2065
|
+
PublicApiService_NOOPCodegenAnchor: {
|
|
2564
2066
|
responses: {
|
|
2565
2067
|
/** A successful response. */
|
|
2566
2068
|
200: {
|
|
2567
|
-
schema: definitions["
|
|
2568
|
-
};
|
|
2569
|
-
/** Returned when the user does not have permission to access the resource. */
|
|
2570
|
-
403: {
|
|
2571
|
-
schema: unknown;
|
|
2572
|
-
};
|
|
2573
|
-
/** Returned when the resource does not exist. */
|
|
2574
|
-
404: {
|
|
2575
|
-
schema: string;
|
|
2069
|
+
schema: definitions["v1NOOPCodegenAnchorResponse"];
|
|
2576
2070
|
};
|
|
2577
2071
|
/** An unexpected error response. */
|
|
2578
2072
|
default: {
|