@cubist-labs/cubesigner-sdk 0.4.229 → 0.4.236

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/src/schema.ts CHANGED
@@ -403,7 +403,23 @@ export interface paths {
403
403
  post: operations["diffieHellmanExchange"];
404
404
  };
405
405
  "/v0/org/{org_id}/emails/{purpose}": {
406
+ /**
407
+ * Get Email Template
408
+ * @description Get Email Template
409
+ *
410
+ * Returns the email template for a given purpose.
411
+ */
412
+ get: operations["getEmailConfig"];
413
+ /**
414
+ * Configure Email Template
415
+ * @description Configure Email Template
416
+ */
406
417
  put: operations["configureEmail"];
418
+ /**
419
+ * Delete Email Template
420
+ * @description Delete Email Template
421
+ */
422
+ delete: operations["deleteEmailConfig"];
407
423
  };
408
424
  "/v0/org/{org_id}/evm/eip191/sign/{pubkey}": {
409
425
  /**
@@ -581,6 +597,23 @@ export interface paths {
581
597
  */
582
598
  post: operations["invitationAccept"];
583
599
  };
600
+ "/v0/org/{org_id}/invitations": {
601
+ /**
602
+ * List pending invitations
603
+ * @description List pending invitations
604
+ *
605
+ * Returns all pending (not yet accepted) invitations for the organization.
606
+ */
607
+ get: operations["listInvitations"];
608
+ /**
609
+ * Cancel a pending invitation
610
+ * @description Cancel a pending invitation
611
+ *
612
+ * Removes a pending invitation from the organization. If no pending invitation
613
+ * exists for the given email address, a not-found error is returned.
614
+ */
615
+ delete: operations["cancelInvitation"];
616
+ };
584
617
  "/v0/org/{org_id}/invite": {
585
618
  /**
586
619
  * Invite User
@@ -1027,18 +1060,22 @@ export interface paths {
1027
1060
  *
1028
1061
  * The provided secrets will replace any existing org-level secrets.
1029
1062
  * It fails if the secrets weren't previously created.
1063
+ *
1064
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
1030
1065
  */
1031
1066
  patch: operations["updatePolicySecrets"];
1032
1067
  };
1033
1068
  "/v0/org/{org_id}/policy/secrets/{secret_name}": {
1034
1069
  /**
1035
- * Create or overwrite an org-level policy secret
1036
- * @description Create or overwrite an org-level policy secret
1070
+ * Create or overwrite an org-level policy secret.
1071
+ * @description Create or overwrite an org-level policy secret.
1072
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
1037
1073
  */
1038
1074
  put: operations["setPolicySecret"];
1039
1075
  /**
1040
- * Delete an org-level policy secret
1041
- * @description Delete an org-level policy secret
1076
+ * Delete an org-level policy secret.
1077
+ * @description Delete an org-level policy secret.
1078
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
1042
1079
  */
1043
1080
  delete: operations["deletePolicySecret"];
1044
1081
  };
@@ -1209,6 +1246,13 @@ export interface paths {
1209
1246
  */
1210
1247
  delete: operations["removeUserFromRole"];
1211
1248
  };
1249
+ "/v0/org/{org_id}/rpc": {
1250
+ /**
1251
+ * High-level RPC endpoint.
1252
+ * @description High-level RPC endpoint.
1253
+ */
1254
+ post: operations["rpcApi"];
1255
+ };
1212
1256
  "/v0/org/{org_id}/session": {
1213
1257
  /**
1214
1258
  * List sessions
@@ -1524,14 +1568,6 @@ export interface paths {
1524
1568
  */
1525
1569
  patch: operations["passkeyAuthComplete"];
1526
1570
  };
1527
- "/v0/private/policy-execute/{policy_name}": {
1528
- /**
1529
- * The policy_execute API endpoint is intended to demonstrate that the signer
1530
- * @description The policy_execute API endpoint is intended to demonstrate that the signer
1531
- * can use the policy engine, by way of the PolicyEngineClient.
1532
- */
1533
- post: operations["policy-execute"];
1534
- };
1535
1571
  "/v0/user/me/fido": {
1536
1572
  /**
1537
1573
  * Initiate registration of a FIDO key
@@ -2872,7 +2908,8 @@ export interface components {
2872
2908
  | "UserProfileMigrationTooManyItems"
2873
2909
  | "InputTooShort"
2874
2910
  | "InvalidTweakLength"
2875
- | "InvalidCustomChains";
2911
+ | "InvalidCustomChains"
2912
+ | "InvalidRpcRequest";
2876
2913
  BillingArgs: {
2877
2914
  billing_org: components["schemas"]["Id"];
2878
2915
  event_type: components["schemas"]["BillingEvent"];
@@ -2924,6 +2961,8 @@ export interface components {
2924
2961
  | "UpdateKey"
2925
2962
  | "ListHistoricalKeyTx"
2926
2963
  | "Invite"
2964
+ | "CancelInvitation"
2965
+ | "ListInvitations"
2927
2966
  | "ListUsers"
2928
2967
  | "GetUser"
2929
2968
  | "GetUserByEmail"
@@ -2942,6 +2981,8 @@ export interface components {
2942
2981
  | "UpdateRole"
2943
2982
  | "DeleteRole"
2944
2983
  | "ConfigureEmail"
2984
+ | "GetEmailConfig"
2985
+ | "DeleteEmailConfig"
2945
2986
  | "ListHistoricalRoleTx"
2946
2987
  | "CreatePolicy"
2947
2988
  | "GetPolicy"
@@ -3044,9 +3085,12 @@ export interface components {
3044
3085
  | "IdpAuthenticate"
3045
3086
  | "IdpPasswordResetRequest"
3046
3087
  | "IdpPasswordResetConfirm"
3088
+ | "RpcApi"
3089
+ | "RpcCreateTransaction"
3090
+ | "RpcGetTransaction"
3091
+ | "RpcListTransactions"
3047
3092
  | "CustomChainRpcCall"
3048
3093
  | "EsploraApiCall"
3049
- | "ExecutePolicy"
3050
3094
  | "SentryApiCall"
3051
3095
  | "SentryApiCallPublic"
3052
3096
  | "MmiJwkSet"
@@ -3284,6 +3328,9 @@ export interface components {
3284
3328
  */
3285
3329
  value: number;
3286
3330
  };
3331
+ CancelInvitationRequest: {
3332
+ email: components["schemas"]["Email"];
3333
+ };
3287
3334
  /**
3288
3335
  * @description Supported Canton environments.
3289
3336
  * @enum {string}
@@ -3544,6 +3591,37 @@ export interface components {
3544
3591
  */
3545
3592
  name: string;
3546
3593
  };
3594
+ /** @description Parameters for creating an EVM transaction. */
3595
+ CreateEvmTransactionRequest: components["schemas"]["CreateEvmTransferRequest"] & {
3596
+ /** @enum {string} */
3597
+ type: "Transfer";
3598
+ };
3599
+ /** @description Parameters for creating an EVM transfer. */
3600
+ CreateEvmTransferRequest: {
3601
+ token: "CreateEvmTransferRequest";
3602
+ } & Omit<components["schemas"]["EvmToken"], "token"> &
3603
+ components["schemas"]["EvmTxCustomization"] & {
3604
+ /**
3605
+ * Format: int64
3606
+ * @description The EVM chain id this transaction is for.
3607
+ */
3608
+ chain_id: number;
3609
+ /**
3610
+ * @description The address that the amount will be transferred from.
3611
+ *
3612
+ * Must match the material id of a key the session can access.
3613
+ */
3614
+ from: string;
3615
+ /** @description The address that the amount will be transferred to. */
3616
+ to: string;
3617
+ /**
3618
+ * @description The amount being transferred, as a hex value.
3619
+ *
3620
+ * This value should be in WEI for native transfers, and in the token's denomination
3621
+ * for ERC-20 transfers.
3622
+ */
3623
+ value: string;
3624
+ };
3547
3625
  CreateKeyImportKeyResponse: components["schemas"]["KeyImportKey"] & {
3548
3626
  /**
3549
3627
  * @description An attestation document from a secure enclave, including an
@@ -3704,6 +3782,13 @@ export interface components {
3704
3782
  */
3705
3783
  scopes?: components["schemas"]["Scope"][] | null;
3706
3784
  };
3785
+ /** @description Parameters for the [`cs_createTransaction`](RpcMethod::CreateTransaction) method. */
3786
+ CreateTransactionRequest: {
3787
+ type: "CreateTransactionRequest";
3788
+ } & Omit<components["schemas"]["CreateEvmTransactionRequest"], "type"> & {
3789
+ /** @enum {string} */
3790
+ chain: "Evm";
3791
+ };
3707
3792
  /**
3708
3793
  * @description An extended form of `PublicKeyCredentialCreationOptions` that allows clients to derive the WebAuthn challenge
3709
3794
  * from a structured preimage.
@@ -4451,6 +4536,35 @@ export interface components {
4451
4536
  */
4452
4537
  rpc_url: string;
4453
4538
  };
4539
+ /** @description An EVM token. */
4540
+ EvmToken:
4541
+ | {
4542
+ /** @enum {string} */
4543
+ token: "Native";
4544
+ }
4545
+ | {
4546
+ /** @enum {string} */
4547
+ token: "Erc20";
4548
+ /** @description The ERC-20 token address. */
4549
+ token_address: string;
4550
+ };
4551
+ /** @description EVM-specific transaction details. */
4552
+ EvmTransactionDetails: {
4553
+ /**
4554
+ * @description The transaction hash, as submitted to the chain.
4555
+ *
4556
+ * Can be undefined if the transaction hasn't been signed or submitted yet.
4557
+ */
4558
+ hash?: string;
4559
+ /**
4560
+ * @description The signature for the transaction.
4561
+ *
4562
+ * Can be undefined if the transaction hasn't been signed yet, or failed to be signed.
4563
+ */
4564
+ signature?: string;
4565
+ /** @description The transaction itself. */
4566
+ tx: unknown;
4567
+ };
4454
4568
  EvmTxCmp: {
4455
4569
  /**
4456
4570
  * Format: int64
@@ -4476,6 +4590,34 @@ export interface components {
4476
4590
  /** @description Whether the 'nonce' property of the EVM transaction is allowed to be different. */
4477
4591
  ignore_nonce?: boolean;
4478
4592
  };
4593
+ /** @description Optional fields used to customize EVM transactions. */
4594
+ EvmTxCustomization: {
4595
+ /**
4596
+ * @description Optional gas limit.
4597
+ *
4598
+ * If not specified, estimated gas is used.
4599
+ */
4600
+ gas_limit?: string | null;
4601
+ /**
4602
+ * @description Optional max fee for the transaction.
4603
+ *
4604
+ * If not specified, estimated fees are used.
4605
+ */
4606
+ max_fee_per_gas?: string | null;
4607
+ /**
4608
+ * @description Optional max priority fee for the transaction.
4609
+ *
4610
+ * If not specified, estimated fees are used.
4611
+ */
4612
+ max_priority_fee_per_gas?: string | null;
4613
+ /**
4614
+ * @description Optional nonce.
4615
+ *
4616
+ * If not specified, the sender's transaction count from the latest block is
4617
+ * used.
4618
+ */
4619
+ nonce?: string | null;
4620
+ };
4479
4621
  /** @enum {string} */
4480
4622
  EvmTxDepositErrorCode:
4481
4623
  | "EvmTxDepositReceiverMismatch"
@@ -4547,7 +4689,10 @@ export interface components {
4547
4689
  | "sign:mmi"
4548
4690
  | "manage:*"
4549
4691
  | "manage:readonly"
4550
- | "manage:email"
4692
+ | "manage:email:*"
4693
+ | "manage:email:get"
4694
+ | "manage:email:update"
4695
+ | "manage:email:delete"
4551
4696
  | "manage:mfa:*"
4552
4697
  | "manage:mfa:readonly"
4553
4698
  | "manage:mfa:list"
@@ -4578,6 +4723,7 @@ export interface components {
4578
4723
  | "manage:key:update:owner"
4579
4724
  | "manage:key:update:policy"
4580
4725
  | "manage:key:update:enabled"
4726
+ | "manage:key:update:region"
4581
4727
  | "manage:key:update:metadata"
4582
4728
  | "manage:key:update:editPolicy"
4583
4729
  | "manage:key:delete"
@@ -4634,6 +4780,7 @@ export interface components {
4634
4780
  | "manage:role:update:enabled"
4635
4781
  | "manage:role:update:policy"
4636
4782
  | "manage:role:update:editPolicy"
4783
+ | "manage:role:update:actions"
4637
4784
  | "manage:role:update:key:*"
4638
4785
  | "manage:role:update:key:add"
4639
4786
  | "manage:role:update:key:remove"
@@ -4655,11 +4802,34 @@ export interface components {
4655
4802
  | "manage:org:addUser"
4656
4803
  | "manage:org:inviteUser"
4657
4804
  | "manage:org:inviteAlien"
4805
+ | "manage:org:invitation:list"
4806
+ | "manage:org:invitation:cancel"
4658
4807
  | "manage:org:updateMembership"
4659
4808
  | "manage:org:listUsers"
4660
4809
  | "manage:org:user:get"
4661
4810
  | "manage:org:deleteUser"
4662
4811
  | "manage:org:get"
4812
+ | "manage:org:update:*"
4813
+ | "manage:org:update:enabled"
4814
+ | "manage:org:update:policy"
4815
+ | "manage:org:update:signPolicy"
4816
+ | "manage:org:update:export"
4817
+ | "manage:org:update:totpFailureLimit"
4818
+ | "manage:org:update:notificationEndpoints"
4819
+ | "manage:org:update:defaultInviteKind"
4820
+ | "manage:org:update:idpConfiguration"
4821
+ | "manage:org:update:passkeyConfiguration"
4822
+ | "manage:org:update:emailPreferences"
4823
+ | "manage:org:update:historicalData"
4824
+ | "manage:org:update:requireScopeCeiling"
4825
+ | "manage:org:update:alienLoginRequirement"
4826
+ | "manage:org:update:memberLoginRequirement"
4827
+ | "manage:org:update:keyExportRequirement"
4828
+ | "manage:org:update:allowedMfaTypes"
4829
+ | "manage:org:update:policyEngineConf"
4830
+ | "manage:org:update:customChains"
4831
+ | "manage:org:update:extProps"
4832
+ | "manage:org:update:editPolicy"
4663
4833
  | "manage:org:user:resetMfa"
4664
4834
  | "manage:session:*"
4665
4835
  | "manage:session:readonly"
@@ -4691,7 +4861,12 @@ export interface components {
4691
4861
  | "export:user:complete"
4692
4862
  | "mmi:*"
4693
4863
  | "orgAccess:*"
4694
- | "orgAccess:child:*";
4864
+ | "orgAccess:child:*"
4865
+ | "rpc:*"
4866
+ | "rpc:createTransaction:*"
4867
+ | "rpc:createTransaction:evm"
4868
+ | "rpc:getTransaction"
4869
+ | "rpc:listTransactions";
4695
4870
  /**
4696
4871
  * @description This type specifies the interpretation of the `fee` field in Babylon
4697
4872
  * staking requests. If `sats`, the field is intpreted as a fixed value
@@ -4885,9 +5060,24 @@ export interface components {
4885
5060
  */
4886
5061
  genesis_validators_root: string;
4887
5062
  };
5063
+ /** @description The email sender configuration (without sensitive auth details) */
5064
+ GetEmailConfigResponse: {
5065
+ /** @description The email address that emails are sent from */
5066
+ sender: string;
5067
+ template?: {
5068
+ /** @description An HTML template to use for the body. */
5069
+ body_template: string;
5070
+ /** @description The subject line template */
5071
+ subject_template: string;
5072
+ } | null;
5073
+ };
4888
5074
  GetKeysInOrgRequest: {
4889
5075
  key_type?: components["schemas"]["KeyType"] | null;
4890
5076
  };
5077
+ /** @description Parameters for the [`cs_getTransaction`](RpcMethod::GetTransaction) method. */
5078
+ GetTransactionRequest: {
5079
+ id: components["schemas"]["Id"];
5080
+ };
4891
5081
  GetUserByEmailResponse: {
4892
5082
  /**
4893
5083
  * @description Typically, this array is either empty (if no user with a given email was found)
@@ -5174,12 +5364,26 @@ export interface components {
5174
5364
  | "InvalidAlias"
5175
5365
  | "EmptyUpdateModifiedObject"
5176
5366
  | "EmptyUpdateModifiedActions"
5177
- | "DbContactAddressesInvalid";
5367
+ | "DbContactAddressesInvalid"
5368
+ | "InvalidEvmSigedRlp"
5369
+ | "InvalidErc20Data"
5370
+ | "InvalidRpcUrl";
5178
5371
  InvitationAcceptRequest: {
5179
5372
  auth: components["schemas"]["AuthSource"];
5180
5373
  /** @description Invitation token */
5181
5374
  token: string;
5182
5375
  };
5376
+ /** @description Information about a pending invitation */
5377
+ InvitationInfo: {
5378
+ created: components["schemas"]["EpochDateTime"];
5379
+ /** @description The email address the invitation was sent to */
5380
+ email: string;
5381
+ expiration: components["schemas"]["EpochDateTime"];
5382
+ inviter?: components["schemas"]["Id"] | null;
5383
+ /** @description The invited user's name */
5384
+ name: string;
5385
+ role: components["schemas"]["MemberRole"];
5386
+ };
5183
5387
  /**
5184
5388
  * @description Indicates the auth sources allowed to an invited user
5185
5389
  * @enum {string}
@@ -5327,6 +5531,29 @@ export interface components {
5327
5531
  /** @description The type of key this package represents */
5328
5532
  key_type: string;
5329
5533
  };
5534
+ /** @description The top-level JSON-RPC request type. */
5535
+ JsonRpcRequest: {
5536
+ method: "JsonRpcRequest";
5537
+ } & Omit<components["schemas"]["RpcMethod"], "method"> & {
5538
+ /** @description Request ID */
5539
+ id?: string;
5540
+ /** @description JSON-RPC version. */
5541
+ jsonrpc: string;
5542
+ };
5543
+ /** @description The RPC API's response. */
5544
+ JsonRpcResponse: {
5545
+ error?: components["schemas"]["ErrorObj"] | null;
5546
+ /** @description ID from the corresponding request. */
5547
+ id?: unknown;
5548
+ /** @description Constant "2.0". */
5549
+ jsonrpc: string;
5550
+ /** @description Result, if success. */
5551
+ result?: Record<string, unknown> | null;
5552
+ };
5553
+ /** @description Valid `result` from the JSON-RPC API. */
5554
+ JsonRpcResult:
5555
+ | components["schemas"]["TransactionInfo"]
5556
+ | components["schemas"]["ListTransactionsPaginatedResponse"];
5330
5557
  JwkSetResponse: {
5331
5558
  /** @description The keys included in this set */
5332
5559
  keys: Record<string, never>[];
@@ -5530,6 +5757,11 @@ export interface components {
5530
5757
  ListIdentitiesResponse: {
5531
5758
  identities: components["schemas"]["IdentityInfo"][];
5532
5759
  };
5760
+ /** @description List of pending invitations */
5761
+ ListInvitationsResponse: {
5762
+ /** @description Pending invitations */
5763
+ invitations: components["schemas"]["InvitationInfo"][];
5764
+ };
5533
5765
  ListMfaResponse: {
5534
5766
  /** @description All pending MFA requests */
5535
5767
  mfa_requests: components["schemas"]["MfaRequestInfo"][];
@@ -5539,6 +5771,35 @@ export interface components {
5539
5771
  /** @description All pending messages for a user. */
5540
5772
  pending_messages: components["schemas"]["PendingMessageInfo"][];
5541
5773
  };
5774
+ /**
5775
+ * @description Response type that wraps another type and adds base64url-encoded encrypted `last_evaluated_key`
5776
+ * value (which can the user pass back to use as a url query parameter to continue pagination).
5777
+ */
5778
+ ListTransactionsPaginatedResponse: {
5779
+ /** @description A list of transaction infos. */
5780
+ transactions: components["schemas"]["TransactionInfo"][];
5781
+ } & {
5782
+ /**
5783
+ * @description If set, the content of `response` does not contain the entire result set.
5784
+ * To fetch the next page of the result set, call the same endpoint
5785
+ * but specify this value as the 'page.start' query parameter.
5786
+ */
5787
+ last_evaluated_key?: string | null;
5788
+ };
5789
+ /** @description Parameters for the [`cs_listTransactions`](RpcMethod::ListTransactions) method. */
5790
+ ListTransactionsRequest: components["schemas"]["Page"] & {
5791
+ /**
5792
+ * @description Optional user or role id.
5793
+ *
5794
+ * If defined, the response is filtered to transactions created by the given id.
5795
+ */
5796
+ owner?: string | null;
5797
+ };
5798
+ /** @description The response to [`cs_listTransactions`](super::request::RpcMethod::ListTransactions) */
5799
+ ListTransactionsResponse: {
5800
+ /** @description A list of transaction infos. */
5801
+ transactions: components["schemas"]["TransactionInfo"][];
5802
+ };
5542
5803
  LoginRequest: components["schemas"]["OidcLoginRequest"];
5543
5804
  /**
5544
5805
  * @description Describes whether a user in an org is an Owner or just a regular member
@@ -5611,7 +5872,7 @@ export interface components {
5611
5872
  * @description MFA policy provenance
5612
5873
  * @enum {string}
5613
5874
  */
5614
- provenance: "Key" | "KeyInRole" | "Role" | "User" | "EditPolicy";
5875
+ provenance: "Org" | "Key" | "KeyInRole" | "Role" | "User" | "EditPolicy";
5615
5876
  receipt?: components["schemas"]["Receipt"] | null;
5616
5877
  /** @description The region this MFA request was created in. It can only be redeemed from the same region. */
5617
5878
  region?: string;
@@ -5800,7 +6061,10 @@ export interface components {
5800
6061
  | "UploadObjectNotFound"
5801
6062
  | "PolicySecretNotFound"
5802
6063
  | "TimestreamDisabled"
5803
- | "CustomChainNotFound";
6064
+ | "CustomChainNotFound"
6065
+ | "InvitationNotFound"
6066
+ | "TransactionNotFound"
6067
+ | "EmailConfigNotFound";
5804
6068
  /** @description The configuration and status of a notification endpoint */
5805
6069
  NotificationEndpoint: components["schemas"]["NotificationEndpointSubscription"] & {
5806
6070
  status: components["schemas"]["SubscriptionStatus"];
@@ -6136,6 +6400,19 @@ export interface components {
6136
6400
  /** @enum {string} */
6137
6401
  org_event: "TendermintConcurrentSigning";
6138
6402
  }
6403
+ | {
6404
+ /** @description The email address of the invited user */
6405
+ email: string;
6406
+ /** @enum {string} */
6407
+ org_event: "InvitationCreated";
6408
+ role: components["schemas"]["MemberRole"];
6409
+ }
6410
+ | {
6411
+ /** @description The email address whose invitation was canceled */
6412
+ email: string;
6413
+ /** @enum {string} */
6414
+ org_event: "InvitationCanceled";
6415
+ }
6139
6416
  | {
6140
6417
  key_id: components["schemas"]["Id"];
6141
6418
  /** @enum {string} */
@@ -6196,6 +6473,8 @@ export interface components {
6196
6473
  | "MfaRejected"
6197
6474
  | "PolicyChanged"
6198
6475
  | "TendermintConcurrentSigning"
6476
+ | "InvitationCreated"
6477
+ | "InvitationCanceled"
6199
6478
  | "UserExportInit"
6200
6479
  | "UserExportComplete"
6201
6480
  | "WasmPolicyExecuted";
@@ -6218,132 +6497,142 @@ export interface components {
6218
6497
  /** @description A base64-encoded export ciphertext. */
6219
6498
  ciphertext: string;
6220
6499
  };
6221
- OrgInfo: components["schemas"]["MfaRequirements"] & {
6222
- access_model: components["schemas"]["AccessModel"];
6223
- custom_chains?: components["schemas"]["CustomChainsData"] | null;
6224
- default_invite_kind?: components["schemas"]["InviteKind"];
6225
- email_preferences?: components["schemas"]["EmailPreferences"];
6226
- /** @description When false, all cryptographic operations involving keys in this org are disabled. */
6227
- enabled: boolean;
6228
- ext_data?:
6229
- | ({
6230
- /**
6231
- * Format: int32
6232
- * @description Per alien user key count threshold, which, once exceeded, disallows further key creation by alien users.
6233
- *
6234
- * This setting is checked only when an alien user requests to create or import a new key.
6235
- * In other words, org admins can still assign unlimited number of keys to their alien users.
6236
- */
6237
- alien_key_count_threshold?: number | null;
6238
- } & {
6239
- created?: components["schemas"]["EpochDateTime"] | null;
6240
- last_modified?: components["schemas"]["EpochDateTime"] | null;
6241
- /**
6242
- * Format: int64
6243
- * @description Version of this object
6244
- */
6245
- version?: number;
6246
- } & Record<string, never>)
6247
- | null;
6248
- historical_data_configuration?: components["schemas"]["HistoricalDataConfiguration"];
6249
- idp_configuration?: components["schemas"]["IdpConfig"];
6250
- /** @description Deprecated: this field should be ignored. */
6251
- key_import_key?: string | null;
6252
- /**
6253
- * @description The organization's universally unique key-wrapping-key identifier.
6254
- * This value is required when setting up key export.
6255
- * @example mrk-fce09525e81587d23520f11e07e2e9d9
6256
- */
6257
- kwk_id: string;
6258
- /**
6259
- * @description Date/time (in UTC) when last 'unstake' was performed. Unix epoch if none.
6260
- * @example TODO
6261
- */
6262
- last_unstake: string;
6263
- /**
6264
- * Format: int32
6265
- * @description How many 'unstake' calls happened on the day when `last_unstake` was performed.
6266
- */
6267
- last_unstake_day_count: number;
6268
- /** @description Whether metrics are collected for this org */
6269
- metrics_enabled?: boolean;
6270
- /**
6271
- * @description The human-readable name for the org
6272
- * @example my_org_name
6273
- */
6274
- name?: string | null;
6275
- /**
6276
- * @description The organization's notification endpoints, which are HTTPS URLs are notified about a
6277
- * configurable set of events in an organization. For each event, CubeSigner sends a POST
6278
- * request with a JSON-formatted body that contains the event details.
6279
- * @example [
6280
- * {
6281
- * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000001",
6282
- * "config": {
6283
- * "url": "https://example.com/endpoint1"
6284
- * },
6285
- * "status": "Confirmed"
6286
- * },
6287
- * {
6288
- * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000002",
6289
- * "config": {
6290
- * "filter": {
6291
- * "OneOf": [
6292
- * "Eth2ConcurrentAttestationSigning",
6293
- * "Eth2ConcurrentBlockSigning"
6294
- * ]
6295
- * },
6296
- * "url": "https://example.com/endpoint2"
6297
- * },
6298
- * "status": "Pending"
6299
- * }
6300
- * ]
6301
- */
6302
- notification_endpoints?: components["schemas"]["NotificationEndpoint"][];
6303
- /**
6304
- * @description The ID of the organization
6305
- * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
6306
- */
6307
- org_id: string;
6308
- passkey_configuration?: components["schemas"]["PasskeyConfig"];
6309
- /**
6310
- * @description Org-wide policies that are checked before a key is used for signing
6311
- * @example [
6312
- * {
6313
- * "MaxDailyUnstake": 5
6314
- * }
6315
- * ]
6316
- */
6317
- policy?: Record<string, never>[];
6318
- policy_engine_configuration?: components["schemas"]["PolicyEngineConfiguration"];
6319
- /**
6320
- * Format: int32
6321
- * @description The organization's currently configured TOTP failure limit, i.e., the number
6322
- * of times a user can provide an incorrect TOTP code before being rate limited.
6323
- * This value can be between 1 and 5 (inclusive).
6324
- */
6325
- totp_failure_limit: number;
6326
- /**
6327
- * Format: int64
6328
- * @description The organization's currently configured user-export delay, i.e., the minimum
6329
- * amount of time (in seconds) between when a user-export is initiated and when
6330
- * it may be completed. (This value is meaningless for organizations that use
6331
- * org-wide export.)
6332
- */
6333
- user_export_delay: number;
6334
- /** @description Whether user export is disabled */
6335
- user_export_disabled?: boolean;
6336
- /**
6337
- * Format: int64
6338
- * @description The organization's currently configured user-export window, i.e., the amount
6339
- * of time (in seconds) between when the user-export delay is completed and when
6340
- * the user export request has expired and can no longer be completed. (This value
6341
- * is meaningless for organizations that use org-wide export.)
6342
- */
6343
- user_export_window: number;
6344
- /** @description If set, the official webapp origin is automatically allowed */
6345
- webapp_enabled?: boolean;
6346
- };
6500
+ OrgInfo: components["schemas"]["MfaRequirements"] &
6501
+ components["schemas"]["CommonFields"] & {
6502
+ access_model: components["schemas"]["AccessModel"];
6503
+ custom_chains?: components["schemas"]["CustomChainsData"] | null;
6504
+ default_invite_kind?: components["schemas"]["InviteKind"];
6505
+ email_preferences?: components["schemas"]["EmailPreferences"];
6506
+ /** @description When false, all cryptographic operations involving keys in this org are disabled. */
6507
+ enabled: boolean;
6508
+ ext_data?:
6509
+ | ({
6510
+ /**
6511
+ * Format: int32
6512
+ * @description Per alien user key count threshold, which, once exceeded, disallows further key creation by alien users.
6513
+ *
6514
+ * This setting is checked only when an alien user requests to create or import a new key.
6515
+ * In other words, org admins can still assign unlimited number of keys to their alien users.
6516
+ */
6517
+ alien_key_count_threshold?: number | null;
6518
+ } & {
6519
+ created?: components["schemas"]["EpochDateTime"] | null;
6520
+ last_modified?: components["schemas"]["EpochDateTime"] | null;
6521
+ /**
6522
+ * Format: int64
6523
+ * @description Version of this object
6524
+ */
6525
+ version?: number;
6526
+ } & Record<string, never>)
6527
+ | null;
6528
+ historical_data_configuration?: components["schemas"]["HistoricalDataConfiguration"];
6529
+ idp_configuration?: components["schemas"]["IdpConfig"];
6530
+ /** @description Deprecated: this field should be ignored. */
6531
+ key_import_key?: string | null;
6532
+ /**
6533
+ * @description The organization's universally unique key-wrapping-key identifier.
6534
+ * This value is required when setting up key export.
6535
+ * @example mrk-fce09525e81587d23520f11e07e2e9d9
6536
+ */
6537
+ kwk_id: string;
6538
+ /**
6539
+ * @description Date/time (in UTC) when last 'unstake' was performed. Unix epoch if none.
6540
+ * @example TODO
6541
+ */
6542
+ last_unstake: string;
6543
+ /**
6544
+ * Format: int32
6545
+ * @description How many 'unstake' calls happened on the day when `last_unstake` was performed.
6546
+ */
6547
+ last_unstake_day_count: number;
6548
+ /** @description Whether metrics are collected for this org */
6549
+ metrics_enabled?: boolean;
6550
+ /**
6551
+ * @description The human-readable name for the org
6552
+ * @example my_org_name
6553
+ */
6554
+ name?: string | null;
6555
+ /**
6556
+ * @description The organization's notification endpoints, which are HTTPS URLs are notified about a
6557
+ * configurable set of events in an organization. For each event, CubeSigner sends a POST
6558
+ * request with a JSON-formatted body that contains the event details.
6559
+ * @example [
6560
+ * {
6561
+ * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000001",
6562
+ * "config": {
6563
+ * "url": "https://example.com/endpoint1"
6564
+ * },
6565
+ * "status": "Confirmed"
6566
+ * },
6567
+ * {
6568
+ * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000002",
6569
+ * "config": {
6570
+ * "filter": {
6571
+ * "OneOf": [
6572
+ * "Eth2ConcurrentAttestationSigning",
6573
+ * "Eth2ConcurrentBlockSigning"
6574
+ * ]
6575
+ * },
6576
+ * "url": "https://example.com/endpoint2"
6577
+ * },
6578
+ * "status": "Pending"
6579
+ * }
6580
+ * ]
6581
+ */
6582
+ notification_endpoints?: components["schemas"]["NotificationEndpoint"][];
6583
+ /**
6584
+ * @description The ID of the organization
6585
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
6586
+ */
6587
+ org_id: string;
6588
+ passkey_configuration?: components["schemas"]["PasskeyConfig"];
6589
+ /**
6590
+ * @description Org-wide policies that are checked before a key is used for signing
6591
+ * @example [
6592
+ * {
6593
+ * "MaxDailyUnstake": 5
6594
+ * }
6595
+ * ]
6596
+ */
6597
+ policy?: Record<string, never>[];
6598
+ policy_engine_configuration?: components["schemas"]["PolicyEngineConfiguration"];
6599
+ /**
6600
+ * @description Global sign policy that applies to every sign operation (every key, every role) in the org
6601
+ * @example [
6602
+ * {
6603
+ * "TxReceiver": "0x0000000000000000000000000000000000000000"
6604
+ * }
6605
+ * ]
6606
+ */
6607
+ sign_policy?: Record<string, never>[];
6608
+ /**
6609
+ * Format: int32
6610
+ * @description The organization's currently configured TOTP failure limit, i.e., the number
6611
+ * of times a user can provide an incorrect TOTP code before being rate limited.
6612
+ * This value can be between 1 and 5 (inclusive).
6613
+ */
6614
+ totp_failure_limit: number;
6615
+ /**
6616
+ * Format: int64
6617
+ * @description The organization's currently configured user-export delay, i.e., the minimum
6618
+ * amount of time (in seconds) between when a user-export is initiated and when
6619
+ * it may be completed. (This value is meaningless for organizations that use
6620
+ * org-wide export.)
6621
+ */
6622
+ user_export_delay: number;
6623
+ /** @description Whether user export is disabled */
6624
+ user_export_disabled?: boolean;
6625
+ /**
6626
+ * Format: int64
6627
+ * @description The organization's currently configured user-export window, i.e., the amount
6628
+ * of time (in seconds) between when the user-export delay is completed and when
6629
+ * the user export request has expired and can no longer be completed. (This value
6630
+ * is meaningless for organizations that use org-wide export.)
6631
+ */
6632
+ user_export_window: number;
6633
+ /** @description If set, the official webapp origin is automatically allowed */
6634
+ webapp_enabled?: boolean;
6635
+ };
6347
6636
  /** @description Supported org metrics. */
6348
6637
  OrgMetric: OneOf<
6349
6638
  [
@@ -6481,6 +6770,21 @@ export interface components {
6481
6770
  */
6482
6771
  last_evaluated_key?: string | null;
6483
6772
  };
6773
+ /**
6774
+ * @description Response type that wraps another type and adds base64url-encoded encrypted `last_evaluated_key`
6775
+ * value (which can the user pass back to use as a url query parameter to continue pagination).
6776
+ */
6777
+ PaginatedListInvitationsResponse: {
6778
+ /** @description Pending invitations */
6779
+ invitations: components["schemas"]["InvitationInfo"][];
6780
+ } & {
6781
+ /**
6782
+ * @description If set, the content of `response` does not contain the entire result set.
6783
+ * To fetch the next page of the result set, call the same endpoint
6784
+ * but specify this value as the 'page.start' query parameter.
6785
+ */
6786
+ last_evaluated_key?: string | null;
6787
+ };
6484
6788
  /**
6485
6789
  * @description Response type that wraps another type and adds base64url-encoded encrypted `last_evaluated_key`
6486
6790
  * value (which can the user pass back to use as a url query parameter to continue pagination).
@@ -6805,6 +7109,13 @@ export interface components {
6805
7109
  */
6806
7110
  role_id: string;
6807
7111
  },
7112
+ {
7113
+ /**
7114
+ * @description The id of the org the policy should be attached to.
7115
+ * @example Org#b0156abd-53bd-4043-8e55-57f7af9512d5
7116
+ */
7117
+ org_id: string;
7118
+ },
6808
7119
  ]
6809
7120
  >;
6810
7121
  /** @description A struct containing Org-level configurations for the workings of the Policy Engine. */
@@ -7637,6 +7948,23 @@ export interface components {
7637
7948
  /** @description A JSON Web Token whose claims contain the `RoleInfo` structure. */
7638
7949
  jwt: string;
7639
7950
  };
7951
+ /** @description The RPC API method and matching parameters. */
7952
+ RpcMethod:
7953
+ | {
7954
+ /** @enum {string} */
7955
+ method: "cs_createTransaction";
7956
+ params: components["schemas"]["CreateTransactionRequest"];
7957
+ }
7958
+ | {
7959
+ /** @enum {string} */
7960
+ method: "cs_getTransaction";
7961
+ params: components["schemas"]["GetTransactionRequest"];
7962
+ }
7963
+ | {
7964
+ /** @enum {string} */
7965
+ method: "cs_listTransactions";
7966
+ params: components["schemas"]["ListTransactionsRequest"];
7967
+ };
7640
7968
  /** @description All scopes for accessing CubeSigner APIs */
7641
7969
  Scope: components["schemas"]["ExplicitScope"] | string;
7642
7970
  /** @description A set of scopes. */
@@ -8220,6 +8548,16 @@ export interface components {
8220
8548
  signedRawTransaction?: string | null;
8221
8549
  status: components["schemas"]["MmiStatus"];
8222
8550
  };
8551
+ /** @description Chain-specific transaction details. */
8552
+ TransactionDetails: components["schemas"]["EvmTransactionDetails"] & {
8553
+ /** @enum {string} */
8554
+ chain: "Evm";
8555
+ };
8556
+ /** @description Information about an existing transaction created by the RPC API. */
8557
+ TransactionInfo: components["schemas"]["Transaction"] & {
8558
+ /** @description The transaction id. */
8559
+ id: string;
8560
+ };
8223
8561
  /**
8224
8562
  * @description Supported queries
8225
8563
  * @enum {string}
@@ -8525,6 +8863,7 @@ export interface components {
8525
8863
  } | null;
8526
8864
  custom_chains?: components["schemas"]["CustomChainsData"] | null;
8527
8865
  default_invite_kind?: components["schemas"]["InviteKind"] | null;
8866
+ edit_policy?: components["schemas"]["EditPolicy"] | null;
8528
8867
  email_preferences?: components["schemas"]["EmailPreferences"] | null;
8529
8868
  /** @description If set, update this org's `enabled` field to this value. */
8530
8869
  enabled?: boolean | null;
@@ -8619,6 +8958,18 @@ export interface components {
8619
8958
  * Owners of the org are exempt from this requirement.
8620
8959
  */
8621
8960
  require_scope_ceiling?: boolean | null;
8961
+ /**
8962
+ * @description If set, update this org's sign rule (old sign rules will be overwritten!).
8963
+ * Only "deny"-style rules may be set.
8964
+ * @example [
8965
+ * {
8966
+ * "TxReceiver": [
8967
+ * "0x0000000000000000000000000000000000000000"
8968
+ * ]
8969
+ * }
8970
+ * ]
8971
+ */
8972
+ sign_policy?: unknown[] | null;
8622
8973
  /**
8623
8974
  * Format: int32
8624
8975
  * @description If set, update this org's TOTP failure limit. After this many failures,
@@ -8656,6 +9007,7 @@ export interface components {
8656
9007
  } | null;
8657
9008
  custom_chains?: components["schemas"]["CustomChainsData"] | null;
8658
9009
  default_invite_kind?: components["schemas"]["InviteKind"] | null;
9010
+ edit_policy?: components["schemas"]["EditPolicy"] | null;
8659
9011
  email_preferences?: components["schemas"]["EmailPreferences"] | null;
8660
9012
  /** @description The new value of the 'enabled' property */
8661
9013
  enabled?: boolean | null;
@@ -8721,8 +9073,17 @@ export interface components {
8721
9073
  /** @description The new value of require_scope_ceiling */
8722
9074
  require_scope_ceiling?: boolean | null;
8723
9075
  /**
8724
- * Format: int32
8725
- * @description The new value of the TOTP failure limit
9076
+ * @description The new value of the org-wide sign rules
9077
+ * @example [
9078
+ * {
9079
+ * "TxReceiver": "0x0000000000000000000000000000000000000000"
9080
+ * }
9081
+ * ]
9082
+ */
9083
+ sign_policy?: Record<string, never>[] | null;
9084
+ /**
9085
+ * Format: int32
9086
+ * @description The new value of the TOTP failure limit
8726
9087
  */
8727
9088
  totp_failure_limit?: number | null;
8728
9089
  /**
@@ -8737,6 +9098,11 @@ export interface components {
8737
9098
  * @description The new value of user-export window
8738
9099
  */
8739
9100
  user_export_window?: number | null;
9101
+ /**
9102
+ * Format: int64
9103
+ * @description New org version
9104
+ */
9105
+ version: number;
8740
9106
  };
8741
9107
  /** @description Request body for updating a named policy. */
8742
9108
  UpdatePolicyRequest: {
@@ -9475,6 +9841,21 @@ export interface components {
9475
9841
  };
9476
9842
  };
9477
9843
  };
9844
+ /** @description The email sender configuration (without sensitive auth details) */
9845
+ GetEmailConfigResponse: {
9846
+ content: {
9847
+ "application/json": {
9848
+ /** @description The email address that emails are sent from */
9849
+ sender: string;
9850
+ template?: {
9851
+ /** @description An HTML template to use for the body. */
9852
+ body_template: string;
9853
+ /** @description The subject line template */
9854
+ subject_template: string;
9855
+ } | null;
9856
+ };
9857
+ };
9858
+ };
9478
9859
  GetUserByEmailResponse: {
9479
9860
  content: {
9480
9861
  "application/json": {
@@ -9543,6 +9924,20 @@ export interface components {
9543
9924
  "application/json": components["schemas"]["Response"] & Record<string, never>;
9544
9925
  };
9545
9926
  };
9927
+ /** @description The RPC API's response. */
9928
+ JsonRpcResponse: {
9929
+ content: {
9930
+ "application/json": {
9931
+ error?: components["schemas"]["ErrorObj"] | null;
9932
+ /** @description ID from the corresponding request. */
9933
+ id?: unknown;
9934
+ /** @description Constant "2.0". */
9935
+ jsonrpc: string;
9936
+ /** @description Result, if success. */
9937
+ result?: Record<string, unknown> | null;
9938
+ };
9939
+ };
9940
+ };
9546
9941
  /** @description A JSON Web Key set describing the key used to sign JSON Web Tokens */
9547
9942
  JwkSetResponse: {
9548
9943
  content: {
@@ -9727,7 +10122,7 @@ export interface components {
9727
10122
  * @description MFA policy provenance
9728
10123
  * @enum {string}
9729
10124
  */
9730
- provenance: "Key" | "KeyInRole" | "Role" | "User" | "EditPolicy";
10125
+ provenance: "Org" | "Key" | "KeyInRole" | "Role" | "User" | "EditPolicy";
9731
10126
  receipt?: components["schemas"]["Receipt"] | null;
9732
10127
  /** @description The region this MFA request was created in. It can only be redeemed from the same region. */
9733
10128
  region?: string;
@@ -9779,132 +10174,142 @@ export interface components {
9779
10174
  };
9780
10175
  OrgInfo: {
9781
10176
  content: {
9782
- "application/json": components["schemas"]["MfaRequirements"] & {
9783
- access_model: components["schemas"]["AccessModel"];
9784
- custom_chains?: components["schemas"]["CustomChainsData"] | null;
9785
- default_invite_kind?: components["schemas"]["InviteKind"];
9786
- email_preferences?: components["schemas"]["EmailPreferences"];
9787
- /** @description When false, all cryptographic operations involving keys in this org are disabled. */
9788
- enabled: boolean;
9789
- ext_data?:
9790
- | ({
9791
- /**
9792
- * Format: int32
9793
- * @description Per alien user key count threshold, which, once exceeded, disallows further key creation by alien users.
9794
- *
9795
- * This setting is checked only when an alien user requests to create or import a new key.
9796
- * In other words, org admins can still assign unlimited number of keys to their alien users.
9797
- */
9798
- alien_key_count_threshold?: number | null;
9799
- } & {
9800
- created?: components["schemas"]["EpochDateTime"] | null;
9801
- last_modified?: components["schemas"]["EpochDateTime"] | null;
9802
- /**
9803
- * Format: int64
9804
- * @description Version of this object
9805
- */
9806
- version?: number;
9807
- } & Record<string, never>)
9808
- | null;
9809
- historical_data_configuration?: components["schemas"]["HistoricalDataConfiguration"];
9810
- idp_configuration?: components["schemas"]["IdpConfig"];
9811
- /** @description Deprecated: this field should be ignored. */
9812
- key_import_key?: string | null;
9813
- /**
9814
- * @description The organization's universally unique key-wrapping-key identifier.
9815
- * This value is required when setting up key export.
9816
- * @example mrk-fce09525e81587d23520f11e07e2e9d9
9817
- */
9818
- kwk_id: string;
9819
- /**
9820
- * @description Date/time (in UTC) when last 'unstake' was performed. Unix epoch if none.
9821
- * @example TODO
9822
- */
9823
- last_unstake: string;
9824
- /**
9825
- * Format: int32
9826
- * @description How many 'unstake' calls happened on the day when `last_unstake` was performed.
9827
- */
9828
- last_unstake_day_count: number;
9829
- /** @description Whether metrics are collected for this org */
9830
- metrics_enabled?: boolean;
9831
- /**
9832
- * @description The human-readable name for the org
9833
- * @example my_org_name
9834
- */
9835
- name?: string | null;
9836
- /**
9837
- * @description The organization's notification endpoints, which are HTTPS URLs are notified about a
9838
- * configurable set of events in an organization. For each event, CubeSigner sends a POST
9839
- * request with a JSON-formatted body that contains the event details.
9840
- * @example [
9841
- * {
9842
- * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000001",
9843
- * "config": {
9844
- * "url": "https://example.com/endpoint1"
9845
- * },
9846
- * "status": "Confirmed"
9847
- * },
9848
- * {
9849
- * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000002",
9850
- * "config": {
9851
- * "filter": {
9852
- * "OneOf": [
9853
- * "Eth2ConcurrentAttestationSigning",
9854
- * "Eth2ConcurrentBlockSigning"
9855
- * ]
9856
- * },
9857
- * "url": "https://example.com/endpoint2"
9858
- * },
9859
- * "status": "Pending"
9860
- * }
9861
- * ]
9862
- */
9863
- notification_endpoints?: components["schemas"]["NotificationEndpoint"][];
9864
- /**
9865
- * @description The ID of the organization
9866
- * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
9867
- */
9868
- org_id: string;
9869
- passkey_configuration?: components["schemas"]["PasskeyConfig"];
9870
- /**
9871
- * @description Org-wide policies that are checked before a key is used for signing
9872
- * @example [
9873
- * {
9874
- * "MaxDailyUnstake": 5
9875
- * }
9876
- * ]
9877
- */
9878
- policy?: Record<string, never>[];
9879
- policy_engine_configuration?: components["schemas"]["PolicyEngineConfiguration"];
9880
- /**
9881
- * Format: int32
9882
- * @description The organization's currently configured TOTP failure limit, i.e., the number
9883
- * of times a user can provide an incorrect TOTP code before being rate limited.
9884
- * This value can be between 1 and 5 (inclusive).
9885
- */
9886
- totp_failure_limit: number;
9887
- /**
9888
- * Format: int64
9889
- * @description The organization's currently configured user-export delay, i.e., the minimum
9890
- * amount of time (in seconds) between when a user-export is initiated and when
9891
- * it may be completed. (This value is meaningless for organizations that use
9892
- * org-wide export.)
9893
- */
9894
- user_export_delay: number;
9895
- /** @description Whether user export is disabled */
9896
- user_export_disabled?: boolean;
9897
- /**
9898
- * Format: int64
9899
- * @description The organization's currently configured user-export window, i.e., the amount
9900
- * of time (in seconds) between when the user-export delay is completed and when
9901
- * the user export request has expired and can no longer be completed. (This value
9902
- * is meaningless for organizations that use org-wide export.)
9903
- */
9904
- user_export_window: number;
9905
- /** @description If set, the official webapp origin is automatically allowed */
9906
- webapp_enabled?: boolean;
9907
- };
10177
+ "application/json": components["schemas"]["MfaRequirements"] &
10178
+ components["schemas"]["CommonFields"] & {
10179
+ access_model: components["schemas"]["AccessModel"];
10180
+ custom_chains?: components["schemas"]["CustomChainsData"] | null;
10181
+ default_invite_kind?: components["schemas"]["InviteKind"];
10182
+ email_preferences?: components["schemas"]["EmailPreferences"];
10183
+ /** @description When false, all cryptographic operations involving keys in this org are disabled. */
10184
+ enabled: boolean;
10185
+ ext_data?:
10186
+ | ({
10187
+ /**
10188
+ * Format: int32
10189
+ * @description Per alien user key count threshold, which, once exceeded, disallows further key creation by alien users.
10190
+ *
10191
+ * This setting is checked only when an alien user requests to create or import a new key.
10192
+ * In other words, org admins can still assign unlimited number of keys to their alien users.
10193
+ */
10194
+ alien_key_count_threshold?: number | null;
10195
+ } & {
10196
+ created?: components["schemas"]["EpochDateTime"] | null;
10197
+ last_modified?: components["schemas"]["EpochDateTime"] | null;
10198
+ /**
10199
+ * Format: int64
10200
+ * @description Version of this object
10201
+ */
10202
+ version?: number;
10203
+ } & Record<string, never>)
10204
+ | null;
10205
+ historical_data_configuration?: components["schemas"]["HistoricalDataConfiguration"];
10206
+ idp_configuration?: components["schemas"]["IdpConfig"];
10207
+ /** @description Deprecated: this field should be ignored. */
10208
+ key_import_key?: string | null;
10209
+ /**
10210
+ * @description The organization's universally unique key-wrapping-key identifier.
10211
+ * This value is required when setting up key export.
10212
+ * @example mrk-fce09525e81587d23520f11e07e2e9d9
10213
+ */
10214
+ kwk_id: string;
10215
+ /**
10216
+ * @description Date/time (in UTC) when last 'unstake' was performed. Unix epoch if none.
10217
+ * @example TODO
10218
+ */
10219
+ last_unstake: string;
10220
+ /**
10221
+ * Format: int32
10222
+ * @description How many 'unstake' calls happened on the day when `last_unstake` was performed.
10223
+ */
10224
+ last_unstake_day_count: number;
10225
+ /** @description Whether metrics are collected for this org */
10226
+ metrics_enabled?: boolean;
10227
+ /**
10228
+ * @description The human-readable name for the org
10229
+ * @example my_org_name
10230
+ */
10231
+ name?: string | null;
10232
+ /**
10233
+ * @description The organization's notification endpoints, which are HTTPS URLs are notified about a
10234
+ * configurable set of events in an organization. For each event, CubeSigner sends a POST
10235
+ * request with a JSON-formatted body that contains the event details.
10236
+ * @example [
10237
+ * {
10238
+ * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000001",
10239
+ * "config": {
10240
+ * "url": "https://example.com/endpoint1"
10241
+ * },
10242
+ * "status": "Confirmed"
10243
+ * },
10244
+ * {
10245
+ * "arn": "arn:aws:sns:us-east-1:012345678901:OrgEventsTopic:12345678-0000-0000-0000-000000000002",
10246
+ * "config": {
10247
+ * "filter": {
10248
+ * "OneOf": [
10249
+ * "Eth2ConcurrentAttestationSigning",
10250
+ * "Eth2ConcurrentBlockSigning"
10251
+ * ]
10252
+ * },
10253
+ * "url": "https://example.com/endpoint2"
10254
+ * },
10255
+ * "status": "Pending"
10256
+ * }
10257
+ * ]
10258
+ */
10259
+ notification_endpoints?: components["schemas"]["NotificationEndpoint"][];
10260
+ /**
10261
+ * @description The ID of the organization
10262
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
10263
+ */
10264
+ org_id: string;
10265
+ passkey_configuration?: components["schemas"]["PasskeyConfig"];
10266
+ /**
10267
+ * @description Org-wide policies that are checked before a key is used for signing
10268
+ * @example [
10269
+ * {
10270
+ * "MaxDailyUnstake": 5
10271
+ * }
10272
+ * ]
10273
+ */
10274
+ policy?: Record<string, never>[];
10275
+ policy_engine_configuration?: components["schemas"]["PolicyEngineConfiguration"];
10276
+ /**
10277
+ * @description Global sign policy that applies to every sign operation (every key, every role) in the org
10278
+ * @example [
10279
+ * {
10280
+ * "TxReceiver": "0x0000000000000000000000000000000000000000"
10281
+ * }
10282
+ * ]
10283
+ */
10284
+ sign_policy?: Record<string, never>[];
10285
+ /**
10286
+ * Format: int32
10287
+ * @description The organization's currently configured TOTP failure limit, i.e., the number
10288
+ * of times a user can provide an incorrect TOTP code before being rate limited.
10289
+ * This value can be between 1 and 5 (inclusive).
10290
+ */
10291
+ totp_failure_limit: number;
10292
+ /**
10293
+ * Format: int64
10294
+ * @description The organization's currently configured user-export delay, i.e., the minimum
10295
+ * amount of time (in seconds) between when a user-export is initiated and when
10296
+ * it may be completed. (This value is meaningless for organizations that use
10297
+ * org-wide export.)
10298
+ */
10299
+ user_export_delay: number;
10300
+ /** @description Whether user export is disabled */
10301
+ user_export_disabled?: boolean;
10302
+ /**
10303
+ * Format: int64
10304
+ * @description The organization's currently configured user-export window, i.e., the amount
10305
+ * of time (in seconds) between when the user-export delay is completed and when
10306
+ * the user export request has expired and can no longer be completed. (This value
10307
+ * is meaningless for organizations that use org-wide export.)
10308
+ */
10309
+ user_export_window: number;
10310
+ /** @description If set, the official webapp origin is automatically allowed */
10311
+ webapp_enabled?: boolean;
10312
+ };
9908
10313
  };
9909
10314
  };
9910
10315
  PaginatedAuditLogResponse: {
@@ -9967,6 +10372,21 @@ export interface components {
9967
10372
  };
9968
10373
  };
9969
10374
  };
10375
+ PaginatedListInvitationsResponse: {
10376
+ content: {
10377
+ "application/json": {
10378
+ /** @description Pending invitations */
10379
+ invitations: components["schemas"]["InvitationInfo"][];
10380
+ } & {
10381
+ /**
10382
+ * @description If set, the content of `response` does not contain the entire result set.
10383
+ * To fetch the next page of the result set, call the same endpoint
10384
+ * but specify this value as the 'page.start' query parameter.
10385
+ */
10386
+ last_evaluated_key?: string | null;
10387
+ };
10388
+ };
10389
+ };
9970
10390
  PaginatedListKeyRolesResponse: {
9971
10391
  content: {
9972
10392
  "application/json": {
@@ -10589,6 +11009,7 @@ export interface components {
10589
11009
  } | null;
10590
11010
  custom_chains?: components["schemas"]["CustomChainsData"] | null;
10591
11011
  default_invite_kind?: components["schemas"]["InviteKind"] | null;
11012
+ edit_policy?: components["schemas"]["EditPolicy"] | null;
10592
11013
  email_preferences?: components["schemas"]["EmailPreferences"] | null;
10593
11014
  /** @description The new value of the 'enabled' property */
10594
11015
  enabled?: boolean | null;
@@ -10657,6 +11078,15 @@ export interface components {
10657
11078
  policy_engine_configuration?: components["schemas"]["PolicyEngineConfiguration"] | null;
10658
11079
  /** @description The new value of require_scope_ceiling */
10659
11080
  require_scope_ceiling?: boolean | null;
11081
+ /**
11082
+ * @description The new value of the org-wide sign rules
11083
+ * @example [
11084
+ * {
11085
+ * "TxReceiver": "0x0000000000000000000000000000000000000000"
11086
+ * }
11087
+ * ]
11088
+ */
11089
+ sign_policy?: Record<string, never>[] | null;
10660
11090
  /**
10661
11091
  * Format: int32
10662
11092
  * @description The new value of the TOTP failure limit
@@ -10674,6 +11104,11 @@ export interface components {
10674
11104
  * @description The new value of user-export window
10675
11105
  */
10676
11106
  user_export_window?: number | null;
11107
+ /**
11108
+ * Format: int64
11109
+ * @description New org version
11110
+ */
11111
+ version: number;
10677
11112
  };
10678
11113
  };
10679
11114
  };
@@ -11981,6 +12416,45 @@ export interface operations {
11981
12416
  };
11982
12417
  };
11983
12418
  };
12419
+ /**
12420
+ * Get Email Template
12421
+ * @description Get Email Template
12422
+ *
12423
+ * Returns the email template for a given purpose.
12424
+ */
12425
+ getEmailConfig: {
12426
+ parameters: {
12427
+ path: {
12428
+ /**
12429
+ * @description Name or ID of the desired Org
12430
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
12431
+ */
12432
+ org_id: string;
12433
+ /** @description Which email configuration to get */
12434
+ purpose:
12435
+ | "otp"
12436
+ | "mfa_reset"
12437
+ | "otp_mfa"
12438
+ | "alien_password_reset"
12439
+ | "member_password_reset"
12440
+ | "alien_invite"
12441
+ | "member_invite"
12442
+ | "welcome";
12443
+ };
12444
+ };
12445
+ responses: {
12446
+ 200: components["responses"]["GetEmailConfigResponse"];
12447
+ default: {
12448
+ content: {
12449
+ "application/json": components["schemas"]["ErrorResponse"];
12450
+ };
12451
+ };
12452
+ };
12453
+ };
12454
+ /**
12455
+ * Configure Email Template
12456
+ * @description Configure Email Template
12457
+ */
11984
12458
  configureEmail: {
11985
12459
  parameters: {
11986
12460
  path: {
@@ -12015,6 +12489,44 @@ export interface operations {
12015
12489
  };
12016
12490
  };
12017
12491
  };
12492
+ /**
12493
+ * Delete Email Template
12494
+ * @description Delete Email Template
12495
+ */
12496
+ deleteEmailConfig: {
12497
+ parameters: {
12498
+ path: {
12499
+ /**
12500
+ * @description Name or ID of the desired Org
12501
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
12502
+ */
12503
+ org_id: string;
12504
+ /** @description Which email configuration to delete */
12505
+ purpose:
12506
+ | "otp"
12507
+ | "mfa_reset"
12508
+ | "otp_mfa"
12509
+ | "alien_password_reset"
12510
+ | "member_password_reset"
12511
+ | "alien_invite"
12512
+ | "member_invite"
12513
+ | "welcome";
12514
+ };
12515
+ };
12516
+ requestBody: {
12517
+ content: {
12518
+ "application/json": components["schemas"]["Empty"];
12519
+ };
12520
+ };
12521
+ responses: {
12522
+ 200: components["responses"]["EmptyImpl"];
12523
+ default: {
12524
+ content: {
12525
+ "application/json": components["schemas"]["ErrorResponse"];
12526
+ };
12527
+ };
12528
+ };
12529
+ };
12018
12530
  /**
12019
12531
  * Sign EIP-191 Data
12020
12532
  * @description Sign EIP-191 Data
@@ -12584,6 +13096,77 @@ export interface operations {
12584
13096
  };
12585
13097
  responses: {};
12586
13098
  };
13099
+ /**
13100
+ * List pending invitations
13101
+ * @description List pending invitations
13102
+ *
13103
+ * Returns all pending (not yet accepted) invitations for the organization.
13104
+ */
13105
+ listInvitations: {
13106
+ parameters: {
13107
+ query?: {
13108
+ /**
13109
+ * @description Max number of items to return per page.
13110
+ *
13111
+ * If the actual number of returned items may be less that this, even if there exist more
13112
+ * data in the result set. To reliably determine if more data is left in the result set,
13113
+ * inspect the [UnencryptedLastEvalKey] value in the response object.
13114
+ */
13115
+ "page.size"?: number;
13116
+ /**
13117
+ * @description The start of the page. Omit to start from the beginning; otherwise, only specify a
13118
+ * the exact value previously returned as 'last_evaluated_key' from the same endpoint.
13119
+ */
13120
+ "page.start"?: string | null;
13121
+ };
13122
+ path: {
13123
+ /**
13124
+ * @description Name or ID of the desired Org
13125
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
13126
+ */
13127
+ org_id: string;
13128
+ };
13129
+ };
13130
+ responses: {
13131
+ 200: components["responses"]["PaginatedListInvitationsResponse"];
13132
+ default: {
13133
+ content: {
13134
+ "application/json": components["schemas"]["ErrorResponse"];
13135
+ };
13136
+ };
13137
+ };
13138
+ };
13139
+ /**
13140
+ * Cancel a pending invitation
13141
+ * @description Cancel a pending invitation
13142
+ *
13143
+ * Removes a pending invitation from the organization. If no pending invitation
13144
+ * exists for the given email address, a not-found error is returned.
13145
+ */
13146
+ cancelInvitation: {
13147
+ parameters: {
13148
+ path: {
13149
+ /**
13150
+ * @description Name or ID of the desired Org
13151
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
13152
+ */
13153
+ org_id: string;
13154
+ };
13155
+ };
13156
+ requestBody: {
13157
+ content: {
13158
+ "application/json": components["schemas"]["CancelInvitationRequest"];
13159
+ };
13160
+ };
13161
+ responses: {
13162
+ 200: components["responses"]["EmptyImpl"];
13163
+ default: {
13164
+ content: {
13165
+ "application/json": components["schemas"]["ErrorResponse"];
13166
+ };
13167
+ };
13168
+ };
13169
+ };
12587
13170
  /**
12588
13171
  * Invite User
12589
13172
  * @description Invite User
@@ -14077,6 +14660,8 @@ export interface operations {
14077
14660
  *
14078
14661
  * The provided secrets will replace any existing org-level secrets.
14079
14662
  * It fails if the secrets weren't previously created.
14663
+ *
14664
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
14080
14665
  */
14081
14666
  updatePolicySecrets: {
14082
14667
  parameters: {
@@ -14108,8 +14693,9 @@ export interface operations {
14108
14693
  };
14109
14694
  };
14110
14695
  /**
14111
- * Create or overwrite an org-level policy secret
14112
- * @description Create or overwrite an org-level policy secret
14696
+ * Create or overwrite an org-level policy secret.
14697
+ * @description Create or overwrite an org-level policy secret.
14698
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
14113
14699
  */
14114
14700
  setPolicySecret: {
14115
14701
  parameters: {
@@ -14142,8 +14728,9 @@ export interface operations {
14142
14728
  };
14143
14729
  };
14144
14730
  /**
14145
- * Delete an org-level policy secret
14146
- * @description Delete an org-level policy secret
14731
+ * Delete an org-level policy secret.
14732
+ * @description Delete an org-level policy secret.
14733
+ * Must be permitted by the policy secret's edit policy if set, and the org's edit policy otherwise.
14147
14734
  */
14148
14735
  deletePolicySecret: {
14149
14736
  parameters: {
@@ -14851,6 +15438,34 @@ export interface operations {
14851
15438
  };
14852
15439
  };
14853
15440
  };
15441
+ /**
15442
+ * High-level RPC endpoint.
15443
+ * @description High-level RPC endpoint.
15444
+ */
15445
+ rpcApi: {
15446
+ parameters: {
15447
+ path: {
15448
+ /**
15449
+ * @description Name or ID of the desired Org
15450
+ * @example Org#124dfe3e-3bbd-487d-80c0-53c55e8ab87a
15451
+ */
15452
+ org_id: string;
15453
+ };
15454
+ };
15455
+ requestBody: {
15456
+ content: {
15457
+ "application/json": components["schemas"]["JsonRpcRequest"];
15458
+ };
15459
+ };
15460
+ responses: {
15461
+ 200: components["responses"]["JsonRpcResponse"];
15462
+ default: {
15463
+ content: {
15464
+ "application/json": components["schemas"]["ErrorResponse"];
15465
+ };
15466
+ };
15467
+ };
15468
+ };
14854
15469
  /**
14855
15470
  * List sessions
14856
15471
  * @description List sessions
@@ -16050,35 +16665,6 @@ export interface operations {
16050
16665
  };
16051
16666
  };
16052
16667
  };
16053
- /**
16054
- * The policy_execute API endpoint is intended to demonstrate that the signer
16055
- * @description The policy_execute API endpoint is intended to demonstrate that the signer
16056
- * can use the policy engine, by way of the PolicyEngineClient.
16057
- */
16058
- "policy-execute": {
16059
- parameters: {
16060
- path: {
16061
- /**
16062
- * @description Base64Url-nopad of the sha256 digest of the policy binary
16063
- * @example 123456
16064
- */
16065
- policy_name: string;
16066
- };
16067
- };
16068
- requestBody: {
16069
- content: {
16070
- "application/json": Record<string, never>;
16071
- };
16072
- };
16073
- responses: {
16074
- 200: components["responses"]["PolicyResultResponse"];
16075
- default: {
16076
- content: {
16077
- "application/json": components["schemas"]["ErrorResponse"];
16078
- };
16079
- };
16080
- };
16081
- };
16082
16668
  /**
16083
16669
  * Initiate registration of a FIDO key
16084
16670
  * @deprecated