@turnkey/http 2.10.0 → 2.11.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.
@@ -15,6 +15,10 @@ export type paths = {
15
15
  /** Get details about API keys for a user */
16
16
  post: operations["PublicApiService_GetApiKeys"];
17
17
  };
18
+ "/public/v1/query/get_attestation": {
19
+ /** Get the attestation document corresponding to an enclave. */
20
+ post: operations["PublicApiService_GetAttestationDocument"];
21
+ };
18
22
  "/public/v1/query/get_authenticator": {
19
23
  /** Get details about an authenticator */
20
24
  post: operations["PublicApiService_GetAuthenticator"];
@@ -23,6 +27,10 @@ export type paths = {
23
27
  /** Get details about authenticators for a user */
24
28
  post: operations["PublicApiService_GetAuthenticators"];
25
29
  };
30
+ "/public/v1/query/get_oauth_providers": {
31
+ /** Get details about Oauth providers for a user */
32
+ post: operations["PublicApiService_GetOauthProviders"];
33
+ };
26
34
  "/public/v1/query/get_organization": {
27
35
  /** Get details about an Organization */
28
36
  post: operations["PublicApiService_GetOrganization"];
@@ -103,6 +111,10 @@ export type paths = {
103
111
  /** Create Invitations to join an existing Organization */
104
112
  post: operations["PublicApiService_CreateInvitations"];
105
113
  };
114
+ "/public/v1/submit/create_oauth_providers": {
115
+ /** Creates Oauth providers for a specified user - BETA */
116
+ post: operations["PublicApiService_CreateOauthProviders"];
117
+ };
106
118
  "/public/v1/submit/create_policies": {
107
119
  /** Create new Policies */
108
120
  post: operations["PublicApiService_CreatePolicies"];
@@ -119,6 +131,14 @@ export type paths = {
119
131
  /** Create new Private Keys */
120
132
  post: operations["PublicApiService_CreatePrivateKeys"];
121
133
  };
134
+ "/public/v1/submit/create_read_only_session": {
135
+ /** Create a read only session for a user (valid for 1 hour) */
136
+ post: operations["PublicApiService_CreateReadOnlySession"];
137
+ };
138
+ "/public/v1/submit/create_read_write_session": {
139
+ /** Create a read write session for a user */
140
+ post: operations["PublicApiService_CreateReadWriteSession"];
141
+ };
122
142
  "/public/v1/submit/create_sub_organization": {
123
143
  /** Create a new Sub-Organization */
124
144
  post: operations["PublicApiService_CreateSubOrganization"];
@@ -151,6 +171,10 @@ export type paths = {
151
171
  /** Delete an existing Invitation */
152
172
  post: operations["PublicApiService_DeleteInvitation"];
153
173
  };
174
+ "/public/v1/submit/delete_oauth_providers": {
175
+ /** Removes Oauth providers for a specified user - BETA */
176
+ post: operations["PublicApiService_DeleteOauthProviders"];
177
+ };
154
178
  "/public/v1/submit/delete_policy": {
155
179
  /** Delete an existing Policy */
156
180
  post: operations["PublicApiService_DeletePolicy"];
@@ -203,6 +227,10 @@ export type paths = {
203
227
  /** Initializes a new email recovery */
204
228
  post: operations["PublicApiService_InitUserEmailRecovery"];
205
229
  };
230
+ "/public/v1/submit/oauth": {
231
+ /** Authenticate a user with an Oidc token (Oauth) - BETA */
232
+ post: operations["PublicApiService_Oauth"];
233
+ };
206
234
  "/public/v1/submit/recover_user": {
207
235
  /** Completes the process of recovering a user by adding an authenticator */
208
236
  post: operations["PublicApiService_RecoverUser"];
@@ -355,6 +383,8 @@ export type definitions = {
355
383
  canReject: boolean;
356
384
  createdAt: definitions["externaldatav1Timestamp"];
357
385
  updatedAt: definitions["externaldatav1Timestamp"];
386
+ /** @description Failure reason of the intended action. */
387
+ failure?: definitions["rpcStatus"];
358
388
  };
359
389
  v1ActivityResponse: {
360
390
  /** @description An action that can that can be taken within the Turnkey infrastructure. */
@@ -363,7 +393,7 @@ export type definitions = {
363
393
  /** @enum {string} */
364
394
  v1ActivityStatus: "ACTIVITY_STATUS_CREATED" | "ACTIVITY_STATUS_PENDING" | "ACTIVITY_STATUS_COMPLETED" | "ACTIVITY_STATUS_FAILED" | "ACTIVITY_STATUS_CONSENSUS_NEEDED" | "ACTIVITY_STATUS_REJECTED";
365
395
  /** @enum {string} */
366
- 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" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3" | "ACTIVITY_TYPE_CREATE_WALLET" | "ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY" | "ACTIVITY_TYPE_RECOVER_USER" | "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2" | "ACTIVITY_TYPE_SIGN_TRANSACTION_V2" | "ACTIVITY_TYPE_EXPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_EXPORT_WALLET" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4" | "ACTIVITY_TYPE_EMAIL_AUTH" | "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT" | "ACTIVITY_TYPE_INIT_IMPORT_WALLET" | "ACTIVITY_TYPE_IMPORT_WALLET" | "ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_CREATE_POLICIES" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS";
396
+ 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" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3" | "ACTIVITY_TYPE_CREATE_WALLET" | "ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS" | "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY" | "ACTIVITY_TYPE_RECOVER_USER" | "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2" | "ACTIVITY_TYPE_SIGN_TRANSACTION_V2" | "ACTIVITY_TYPE_EXPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_EXPORT_WALLET" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4" | "ACTIVITY_TYPE_EMAIL_AUTH" | "ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT" | "ACTIVITY_TYPE_INIT_IMPORT_WALLET" | "ACTIVITY_TYPE_IMPORT_WALLET" | "ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_IMPORT_PRIVATE_KEY" | "ACTIVITY_TYPE_CREATE_POLICIES" | "ACTIVITY_TYPE_SIGN_RAW_PAYLOADS" | "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION" | "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS" | "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5" | "ACTIVITY_TYPE_OAUTH" | "ACTIVITY_TYPE_CREATE_API_KEYS_V2" | "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION";
367
397
  /** @enum {string} */
368
398
  v1AddressFormat: "ADDRESS_FORMAT_UNCOMPRESSED" | "ADDRESS_FORMAT_COMPRESSED" | "ADDRESS_FORMAT_ETHEREUM" | "ADDRESS_FORMAT_SOLANA" | "ADDRESS_FORMAT_COSMOS" | "ADDRESS_FORMAT_TRON";
369
399
  v1ApiKey: {
@@ -381,6 +411,8 @@ export type definitions = {
381
411
  */
382
412
  expirationSeconds?: string;
383
413
  };
414
+ /** @enum {string} */
415
+ v1ApiKeyCurve: "API_KEY_CURVE_P256" | "API_KEY_CURVE_SECP256K1";
384
416
  v1ApiKeyParams: {
385
417
  /** @description Human-readable name for an API Key. */
386
418
  apiKeyName: string;
@@ -389,6 +421,16 @@ export type definitions = {
389
421
  /** @description Optional window (in seconds) indicating how long the API Key should last. */
390
422
  expirationSeconds?: string;
391
423
  };
424
+ v1ApiKeyParamsV2: {
425
+ /** @description Human-readable name for an API Key. */
426
+ apiKeyName: string;
427
+ /** @description The public component of a cryptographic key pair used to sign messages and transactions. */
428
+ publicKey: string;
429
+ /** @description The curve type to be used for processing API key signatures. */
430
+ curveType: definitions["v1ApiKeyCurve"];
431
+ /** @description Optional window (in seconds) indicating how long the API Key should last. */
432
+ expirationSeconds?: string;
433
+ };
392
434
  v1ApiOnlyUserParams: {
393
435
  /** @description The name of the new API-only User. */
394
436
  userName: string;
@@ -473,14 +515,20 @@ export type definitions = {
473
515
  /** @description Unique identifier for a given User. */
474
516
  userId: string;
475
517
  };
518
+ v1CreateApiKeysIntentV2: {
519
+ /** @description A list of API Keys. */
520
+ apiKeys: definitions["v1ApiKeyParamsV2"][];
521
+ /** @description Unique identifier for a given User. */
522
+ userId: string;
523
+ };
476
524
  v1CreateApiKeysRequest: {
477
525
  /** @enum {string} */
478
- type: "ACTIVITY_TYPE_CREATE_API_KEYS";
526
+ type: "ACTIVITY_TYPE_CREATE_API_KEYS_V2";
479
527
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
480
528
  timestampMs: string;
481
529
  /** @description Unique identifier for a given Organization. */
482
530
  organizationId: string;
483
- parameters: definitions["v1CreateApiKeysIntent"];
531
+ parameters: definitions["v1CreateApiKeysIntentV2"];
484
532
  };
485
533
  v1CreateApiKeysResult: {
486
534
  /** @description A list of API Key IDs. */
@@ -545,6 +593,25 @@ export type definitions = {
545
593
  /** @description A list of Invitation IDs */
546
594
  invitationIds: string[];
547
595
  };
596
+ v1CreateOauthProvidersIntent: {
597
+ /** @description The ID of the User to add an Oauth provider to */
598
+ userId: string;
599
+ /** @description A list of Oauth providers. */
600
+ oauthProviders: definitions["v1OauthProviderParams"][];
601
+ };
602
+ v1CreateOauthProvidersRequest: {
603
+ /** @enum {string} */
604
+ type: "ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS";
605
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
606
+ timestampMs: string;
607
+ /** @description Unique identifier for a given Organization. */
608
+ organizationId: string;
609
+ parameters: definitions["v1CreateOauthProvidersIntent"];
610
+ };
611
+ v1CreateOauthProvidersResult: {
612
+ /** @description A list of unique identifiers for Oauth Providers */
613
+ providerIds: string[];
614
+ };
548
615
  v1CreateOrganizationIntent: {
549
616
  /** @description Human-readable name for an Organization. */
550
617
  organizationName: string;
@@ -674,6 +741,68 @@ export type definitions = {
674
741
  /** @description A list of Private Key IDs and addresses. */
675
742
  privateKeys: definitions["v1PrivateKeyResult"][];
676
743
  };
744
+ v1CreateReadOnlySessionIntent: {
745
+ [key: string]: unknown;
746
+ };
747
+ v1CreateReadOnlySessionRequest: {
748
+ /** @enum {string} */
749
+ type: "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION";
750
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
751
+ timestampMs: string;
752
+ /** @description Unique identifier for a given Organization. */
753
+ organizationId: string;
754
+ parameters: definitions["v1CreateReadOnlySessionIntent"];
755
+ };
756
+ v1CreateReadOnlySessionResult: {
757
+ /** @description Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons. */
758
+ organizationId: string;
759
+ /** @description Human-readable name for an Organization. */
760
+ organizationName: string;
761
+ /** @description Unique identifier for a given User. */
762
+ userId: string;
763
+ /** @description Human-readable name for a User. */
764
+ username: string;
765
+ /** @description String representing a read only session */
766
+ session: string;
767
+ /**
768
+ * Format: uint64
769
+ * @description UTC timestamp in seconds representing the expiry time for the read only session.
770
+ */
771
+ sessionExpiry: string;
772
+ };
773
+ v1CreateReadWriteSessionIntent: {
774
+ /** @description Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted. */
775
+ targetPublicKey: string;
776
+ /** @description Email of the user to create a read write session for */
777
+ email: string;
778
+ /** @description Optional human-readable name for an API Key. If none provided, default to Read Write Session - <Timestamp> */
779
+ apiKeyName?: string;
780
+ /** @description Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used. */
781
+ expirationSeconds?: string;
782
+ };
783
+ v1CreateReadWriteSessionRequest: {
784
+ /** @enum {string} */
785
+ type: "ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION";
786
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
787
+ timestampMs: string;
788
+ /** @description Unique identifier for a given Organization. */
789
+ organizationId: string;
790
+ parameters: definitions["v1CreateReadWriteSessionIntent"];
791
+ };
792
+ v1CreateReadWriteSessionResult: {
793
+ /** @description Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons. */
794
+ organizationId: string;
795
+ /** @description Human-readable name for an Organization. */
796
+ organizationName: string;
797
+ /** @description Unique identifier for a given User. */
798
+ userId: string;
799
+ /** @description Human-readable name for a User. */
800
+ username: string;
801
+ /** @description Unique identifier for the created API key. */
802
+ apiKeyId: string;
803
+ /** @description HPKE encrypted credential bundle */
804
+ credentialBundle: string;
805
+ };
677
806
  v1CreateSubOrganizationIntent: {
678
807
  /** @description Name for this sub-organization */
679
808
  name: string;
@@ -721,14 +850,31 @@ export type definitions = {
721
850
  /** @description Disable email auth for the sub-organization */
722
851
  disableEmailAuth?: boolean;
723
852
  };
853
+ v1CreateSubOrganizationIntentV5: {
854
+ /** @description Name for this sub-organization */
855
+ subOrganizationName: string;
856
+ /** @description Root users to create within this sub-organization */
857
+ rootUsers: definitions["v1RootUserParamsV2"][];
858
+ /**
859
+ * Format: int32
860
+ * @description The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
861
+ */
862
+ rootQuorumThreshold: number;
863
+ /** @description The wallet to create for the sub-organization */
864
+ wallet?: definitions["v1WalletParams"];
865
+ /** @description Disable email recovery for the sub-organization */
866
+ disableEmailRecovery?: boolean;
867
+ /** @description Disable email auth for the sub-organization */
868
+ disableEmailAuth?: boolean;
869
+ };
724
870
  v1CreateSubOrganizationRequest: {
725
871
  /** @enum {string} */
726
- type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4";
872
+ type: "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5";
727
873
  /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
728
874
  timestampMs: string;
729
875
  /** @description Unique identifier for a given Organization. */
730
876
  organizationId: string;
731
- parameters: definitions["v1CreateSubOrganizationIntentV4"];
877
+ parameters: definitions["v1CreateSubOrganizationIntentV5"];
732
878
  };
733
879
  v1CreateSubOrganizationResult: {
734
880
  subOrganizationId: string;
@@ -745,6 +891,11 @@ export type definitions = {
745
891
  wallet?: definitions["v1WalletResult"];
746
892
  rootUserIds?: string[];
747
893
  };
894
+ v1CreateSubOrganizationResultV5: {
895
+ subOrganizationId: string;
896
+ wallet?: definitions["v1WalletResult"];
897
+ rootUserIds?: string[];
898
+ };
748
899
  v1CreateUserTagIntent: {
749
900
  /** @description Human-readable name for a User Tag. */
750
901
  userTagName: string;
@@ -836,7 +987,7 @@ export type definitions = {
836
987
  rk: boolean;
837
988
  };
838
989
  /** @enum {string} */
839
- v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256" | "CREDENTIAL_TYPE_RECOVER_USER_KEY_P256";
990
+ v1CredentialType: "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR" | "CREDENTIAL_TYPE_API_KEY_P256" | "CREDENTIAL_TYPE_RECOVER_USER_KEY_P256" | "CREDENTIAL_TYPE_API_KEY_SECP256K1";
840
991
  /** @enum {string} */
841
992
  v1Curve: "CURVE_SECP256K1" | "CURVE_ED25519";
842
993
  v1DeleteApiKeysIntent: {
@@ -894,6 +1045,25 @@ export type definitions = {
894
1045
  /** @description Unique identifier for a given Invitation. */
895
1046
  invitationId: string;
896
1047
  };
1048
+ v1DeleteOauthProvidersIntent: {
1049
+ /** @description The ID of the User to remove an Oauth provider from */
1050
+ userId: string;
1051
+ /** @description Unique identifier for a given Provider. */
1052
+ providerIds: string[];
1053
+ };
1054
+ v1DeleteOauthProvidersRequest: {
1055
+ /** @enum {string} */
1056
+ type: "ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS";
1057
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1058
+ timestampMs: string;
1059
+ /** @description Unique identifier for a given Organization. */
1060
+ organizationId: string;
1061
+ parameters: definitions["v1DeleteOauthProvidersIntent"];
1062
+ };
1063
+ v1DeleteOauthProvidersResult: {
1064
+ /** @description A list of unique identifiers for Oauth Providers */
1065
+ providerIds: string[];
1066
+ };
897
1067
  v1DeleteOrganizationIntent: {
898
1068
  /** @description Unique identifier for a given Organization. */
899
1069
  organizationId: string;
@@ -1142,6 +1312,19 @@ export type definitions = {
1142
1312
  /** @description A list of API keys. */
1143
1313
  apiKeys: definitions["v1ApiKey"][];
1144
1314
  };
1315
+ v1GetAttestationDocumentRequest: {
1316
+ /** @description Unique identifier for a given Organization. */
1317
+ organizationId: string;
1318
+ /** @description The enclave type, one of: ump, notarizer, signer, evm-parser */
1319
+ enclaveType: string;
1320
+ };
1321
+ v1GetAttestationDocumentResponse: {
1322
+ /**
1323
+ * Format: byte
1324
+ * @description Raw (CBOR-encoded) attestation document
1325
+ */
1326
+ attestationDocument: string;
1327
+ };
1145
1328
  v1GetAuthenticatorRequest: {
1146
1329
  /** @description Unique identifier for a given Organization. */
1147
1330
  organizationId: string;
@@ -1162,6 +1345,16 @@ export type definitions = {
1162
1345
  /** @description A list of authenticators. */
1163
1346
  authenticators: definitions["v1Authenticator"][];
1164
1347
  };
1348
+ v1GetOauthProvidersRequest: {
1349
+ /** @description Unique identifier for a given Organization. */
1350
+ organizationId: string;
1351
+ /** @description Unique identifier for a given User. */
1352
+ userId?: string;
1353
+ };
1354
+ v1GetOauthProvidersResponse: {
1355
+ /** @description A list of Oauth Providers */
1356
+ oauthProviders: definitions["v1OauthProvider"][];
1357
+ };
1165
1358
  v1GetOrganizationRequest: {
1166
1359
  /** @description Unique identifier for a given Organization. */
1167
1360
  organizationId: string;
@@ -1209,7 +1402,7 @@ export type definitions = {
1209
1402
  v1GetSubOrgIdsRequest: {
1210
1403
  /** @description Unique identifier for the parent Organization. This is used to find sub-organizations within it. */
1211
1404
  organizationId: string;
1212
- /** @description Specifies the type of filter to apply, i.e 'CREDENTIAL_ID', 'NAME', 'USERNAME', 'EMAIL' or 'PUBLIC_KEY' */
1405
+ /** @description Specifies the type of filter to apply, i.e 'CREDENTIAL_ID', 'NAME', 'USERNAME', 'EMAIL', 'OIDC_TOKEN' or 'PUBLIC_KEY' */
1213
1406
  filterType?: string;
1214
1407
  /** @description The value of the filter to apply for the specified type. For example, a specific email or name string. */
1215
1408
  filterValue?: string;
@@ -1394,7 +1587,7 @@ export type definitions = {
1394
1587
  userId: string;
1395
1588
  };
1396
1589
  v1Intent: {
1397
- createOrganizationIntent: definitions["v1CreateOrganizationIntent"];
1590
+ createOrganizationIntent?: definitions["v1CreateOrganizationIntent"];
1398
1591
  createAuthenticatorsIntent?: definitions["v1CreateAuthenticatorsIntent"];
1399
1592
  createUsersIntent?: definitions["v1CreateUsersIntent"];
1400
1593
  createPrivateKeysIntent?: definitions["v1CreatePrivateKeysIntent"];
@@ -1457,6 +1650,13 @@ export type definitions = {
1457
1650
  importPrivateKeyIntent?: definitions["v1ImportPrivateKeyIntent"];
1458
1651
  createPoliciesIntent?: definitions["v1CreatePoliciesIntent"];
1459
1652
  signRawPayloadsIntent?: definitions["v1SignRawPayloadsIntent"];
1653
+ createReadOnlySessionIntent?: definitions["v1CreateReadOnlySessionIntent"];
1654
+ createOauthProvidersIntent?: definitions["v1CreateOauthProvidersIntent"];
1655
+ deleteOauthProvidersIntent?: definitions["v1DeleteOauthProvidersIntent"];
1656
+ createSubOrganizationIntentV5?: definitions["v1CreateSubOrganizationIntentV5"];
1657
+ oauthIntent?: definitions["v1OauthIntent"];
1658
+ createApiKeysIntentV2?: definitions["v1CreateApiKeysIntentV2"];
1659
+ createReadWriteSessionIntent?: definitions["v1CreateReadWriteSessionIntent"];
1460
1660
  };
1461
1661
  v1Invitation: {
1462
1662
  /** @description Unique identifier for a given Invitation object. */
@@ -1511,6 +1711,55 @@ export type definitions = {
1511
1711
  v1NOOPCodegenAnchorResponse: {
1512
1712
  stamp: definitions["v1WebAuthnStamp"];
1513
1713
  };
1714
+ v1OauthIntent: {
1715
+ /** @description Base64 encoded OIDC token */
1716
+ oidcToken: string;
1717
+ /** @description Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted. */
1718
+ targetPublicKey: string;
1719
+ /** @description Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp> */
1720
+ apiKeyName?: string;
1721
+ /** @description Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used. */
1722
+ expirationSeconds?: string;
1723
+ };
1724
+ v1OauthProvider: {
1725
+ /** @description Unique identifier for an OAuth Provider */
1726
+ providerId: string;
1727
+ /** @description Human-readable name to identify a Provider. */
1728
+ providerName: string;
1729
+ /** @description The URL at which to fetch the OIDC token signers */
1730
+ jwksUri: string;
1731
+ /** @description Expected audience ('aud' attribute of the signed token) which represents the app ID */
1732
+ audience: string;
1733
+ /** @description Expected subject ('sub' attribute of the signed token) which represents the user ID */
1734
+ subject: string;
1735
+ createdAt: definitions["externaldatav1Timestamp"];
1736
+ updatedAt: definitions["externaldatav1Timestamp"];
1737
+ };
1738
+ v1OauthProviderParams: {
1739
+ /** @description Human-readable name to identify a Provider. */
1740
+ providerName: string;
1741
+ /** @description The URL at which to fetch the OIDC token signers */
1742
+ jwksUri: string;
1743
+ /** @description Base64 encoded OIDC token */
1744
+ oidcToken: string;
1745
+ };
1746
+ v1OauthRequest: {
1747
+ /** @enum {string} */
1748
+ type: "ACTIVITY_TYPE_OAUTH";
1749
+ /** @description Timestamp (in milliseconds) of the request, used to verify liveness of user requests. */
1750
+ timestampMs: string;
1751
+ /** @description Unique identifier for a given Organization. */
1752
+ organizationId: string;
1753
+ parameters: definitions["v1OauthIntent"];
1754
+ };
1755
+ v1OauthResult: {
1756
+ /** @description Unique identifier for the authenticating User. */
1757
+ userId: string;
1758
+ /** @description Unique identifier for the created API key. */
1759
+ apiKeyId: string;
1760
+ /** @description HPKE encrypted credential bundle */
1761
+ credentialBundle: string;
1762
+ };
1514
1763
  /** @enum {string} */
1515
1764
  v1Operator: "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";
1516
1765
  v1OrganizationData: {
@@ -1698,6 +1947,12 @@ export type definitions = {
1698
1947
  importPrivateKeyResult?: definitions["v1ImportPrivateKeyResult"];
1699
1948
  createPoliciesResult?: definitions["v1CreatePoliciesResult"];
1700
1949
  signRawPayloadsResult?: definitions["v1SignRawPayloadsResult"];
1950
+ createReadOnlySessionResult?: definitions["v1CreateReadOnlySessionResult"];
1951
+ createOauthProvidersResult?: definitions["v1CreateOauthProvidersResult"];
1952
+ deleteOauthProvidersResult?: definitions["v1DeleteOauthProvidersResult"];
1953
+ createSubOrganizationResultV5?: definitions["v1CreateSubOrganizationResultV5"];
1954
+ oauthResult?: definitions["v1OauthResult"];
1955
+ createReadWriteSessionResult?: definitions["v1CreateReadWriteSessionResult"];
1701
1956
  };
1702
1957
  v1RootUserParams: {
1703
1958
  /** @description Human-readable name for a User. */
@@ -1709,6 +1964,18 @@ export type definitions = {
1709
1964
  /** @description A list of Authenticator parameters. */
1710
1965
  authenticators: definitions["v1AuthenticatorParamsV2"][];
1711
1966
  };
1967
+ v1RootUserParamsV2: {
1968
+ /** @description Human-readable name for a User. */
1969
+ userName: string;
1970
+ /** @description The user's email address. */
1971
+ userEmail?: string;
1972
+ /** @description A list of API Key parameters. */
1973
+ apiKeys: definitions["v1ApiKeyParams"][];
1974
+ /** @description A list of Authenticator parameters. */
1975
+ authenticators: definitions["v1AuthenticatorParamsV2"][];
1976
+ /** @description A list of Oauth providers. */
1977
+ oauthProviders: definitions["v1OauthProviderParams"][];
1978
+ };
1712
1979
  v1Selector: {
1713
1980
  subject?: string;
1714
1981
  operator?: definitions["v1Operator"];
@@ -1999,6 +2266,8 @@ export type definitions = {
1999
2266
  apiKeys: definitions["v1ApiKey"][];
2000
2267
  /** @description A list of User Tag IDs. */
2001
2268
  userTags: string[];
2269
+ /** @description A list of Oauth Providers. */
2270
+ oauthProviders: definitions["v1OauthProvider"][];
2002
2271
  createdAt: definitions["externaldatav1Timestamp"];
2003
2272
  updatedAt: definitions["externaldatav1Timestamp"];
2004
2273
  };
@@ -2171,6 +2440,24 @@ export type operations = {
2171
2440
  };
2172
2441
  };
2173
2442
  };
2443
+ /** Get the attestation document corresponding to an enclave. */
2444
+ PublicApiService_GetAttestationDocument: {
2445
+ parameters: {
2446
+ body: {
2447
+ body: definitions["v1GetAttestationDocumentRequest"];
2448
+ };
2449
+ };
2450
+ responses: {
2451
+ /** A successful response. */
2452
+ 200: {
2453
+ schema: definitions["v1GetAttestationDocumentResponse"];
2454
+ };
2455
+ /** An unexpected error response. */
2456
+ default: {
2457
+ schema: definitions["rpcStatus"];
2458
+ };
2459
+ };
2460
+ };
2174
2461
  /** Get details about an authenticator */
2175
2462
  PublicApiService_GetAuthenticator: {
2176
2463
  parameters: {
@@ -2207,6 +2494,24 @@ export type operations = {
2207
2494
  };
2208
2495
  };
2209
2496
  };
2497
+ /** Get details about Oauth providers for a user */
2498
+ PublicApiService_GetOauthProviders: {
2499
+ parameters: {
2500
+ body: {
2501
+ body: definitions["v1GetOauthProvidersRequest"];
2502
+ };
2503
+ };
2504
+ responses: {
2505
+ /** A successful response. */
2506
+ 200: {
2507
+ schema: definitions["v1GetOauthProvidersResponse"];
2508
+ };
2509
+ /** An unexpected error response. */
2510
+ default: {
2511
+ schema: definitions["rpcStatus"];
2512
+ };
2513
+ };
2514
+ };
2210
2515
  /** Get details about an Organization */
2211
2516
  PublicApiService_GetOrganization: {
2212
2517
  parameters: {
@@ -2567,6 +2872,24 @@ export type operations = {
2567
2872
  };
2568
2873
  };
2569
2874
  };
2875
+ /** Creates Oauth providers for a specified user - BETA */
2876
+ PublicApiService_CreateOauthProviders: {
2877
+ parameters: {
2878
+ body: {
2879
+ body: definitions["v1CreateOauthProvidersRequest"];
2880
+ };
2881
+ };
2882
+ responses: {
2883
+ /** A successful response. */
2884
+ 200: {
2885
+ schema: definitions["v1ActivityResponse"];
2886
+ };
2887
+ /** An unexpected error response. */
2888
+ default: {
2889
+ schema: definitions["rpcStatus"];
2890
+ };
2891
+ };
2892
+ };
2570
2893
  /** Create new Policies */
2571
2894
  PublicApiService_CreatePolicies: {
2572
2895
  parameters: {
@@ -2639,6 +2962,42 @@ export type operations = {
2639
2962
  };
2640
2963
  };
2641
2964
  };
2965
+ /** Create a read only session for a user (valid for 1 hour) */
2966
+ PublicApiService_CreateReadOnlySession: {
2967
+ parameters: {
2968
+ body: {
2969
+ body: definitions["v1CreateReadOnlySessionRequest"];
2970
+ };
2971
+ };
2972
+ responses: {
2973
+ /** A successful response. */
2974
+ 200: {
2975
+ schema: definitions["v1ActivityResponse"];
2976
+ };
2977
+ /** An unexpected error response. */
2978
+ default: {
2979
+ schema: definitions["rpcStatus"];
2980
+ };
2981
+ };
2982
+ };
2983
+ /** Create a read write session for a user */
2984
+ PublicApiService_CreateReadWriteSession: {
2985
+ parameters: {
2986
+ body: {
2987
+ body: definitions["v1CreateReadWriteSessionRequest"];
2988
+ };
2989
+ };
2990
+ responses: {
2991
+ /** A successful response. */
2992
+ 200: {
2993
+ schema: definitions["v1ActivityResponse"];
2994
+ };
2995
+ /** An unexpected error response. */
2996
+ default: {
2997
+ schema: definitions["rpcStatus"];
2998
+ };
2999
+ };
3000
+ };
2642
3001
  /** Create a new Sub-Organization */
2643
3002
  PublicApiService_CreateSubOrganization: {
2644
3003
  parameters: {
@@ -2783,6 +3142,24 @@ export type operations = {
2783
3142
  };
2784
3143
  };
2785
3144
  };
3145
+ /** Removes Oauth providers for a specified user - BETA */
3146
+ PublicApiService_DeleteOauthProviders: {
3147
+ parameters: {
3148
+ body: {
3149
+ body: definitions["v1DeleteOauthProvidersRequest"];
3150
+ };
3151
+ };
3152
+ responses: {
3153
+ /** A successful response. */
3154
+ 200: {
3155
+ schema: definitions["v1ActivityResponse"];
3156
+ };
3157
+ /** An unexpected error response. */
3158
+ default: {
3159
+ schema: definitions["rpcStatus"];
3160
+ };
3161
+ };
3162
+ };
2786
3163
  /** Delete an existing Policy */
2787
3164
  PublicApiService_DeletePolicy: {
2788
3165
  parameters: {
@@ -3017,6 +3394,24 @@ export type operations = {
3017
3394
  };
3018
3395
  };
3019
3396
  };
3397
+ /** Authenticate a user with an Oidc token (Oauth) - BETA */
3398
+ PublicApiService_Oauth: {
3399
+ parameters: {
3400
+ body: {
3401
+ body: definitions["v1OauthRequest"];
3402
+ };
3403
+ };
3404
+ responses: {
3405
+ /** A successful response. */
3406
+ 200: {
3407
+ schema: definitions["v1ActivityResponse"];
3408
+ };
3409
+ /** An unexpected error response. */
3410
+ default: {
3411
+ schema: definitions["rpcStatus"];
3412
+ };
3413
+ };
3414
+ };
3020
3415
  /** Completes the process of recovering a user by adding an authenticator */
3021
3416
  PublicApiService_RecoverUser: {
3022
3417
  parameters: {