diff --git a/README.md b/README.md index 9ff4bc44..74984e0a 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,19 @@ Changes to the documentation are automatically deployed when merged to the main You can access the Mintlify dashboard for this project at: [dashboard.mintlify.com](https://dashboard.mintlify.com/turnkey-0e7c1f5b/turnkey-0e7c1f5b) -## The dashboard provides analytics, deployment status, and other management features for our documentation. +The dashboard provides analytics, deployment status, and other management features for our documentation. -## Legacy Documentation +## Build & Code Generation + +We provide the following Make targets to generate API reference content: + +- `make openapi-gen`: Run the OpenAPI generator CLI with custom arguments. See [scripts/openapi-gen/README.md](scripts/openapi-gen/README.md) for details. +- `make gen`: Default MDX generation for API reference under `api-reference/`. +- `make tags`: Generate the endpoint-tags MDX snippet at `snippets/data/endpoint-tags.mdx`. + +These commands require Node.js and `ts-node`. + +## ⚠️ Legacy Documentation ⚠️ The following information pertains to the previous Docusaurus-based documentation setup. @@ -57,16 +67,12 @@ Our crawler settings can be found at https://crawler.algolia.com/admin/crawlers/ In order to manually trigger a new crawl, use the `Restart crawling` button: - - Our docs site is small, so each crawl is quick (~30-60s). ### Vercel Each push to Github will trigger a Vercel build: - - This is a convenient way to view changes, add feedback, and collaborate overall. Any build can also be promoted to production, if need be. ### Legacy Local Development @@ -96,13 +102,3 @@ You can build a docker image running nginx and only a static build of the HTML/C ```sh $ make image ``` - -## Build & Code Generation - -We provide the following Make targets to generate API reference content: - -- `make openapi-gen`: Run the OpenAPI generator CLI with custom arguments. See [scripts/openapi-gen/README.md](scripts/openapi-gen/README.md) for details. -- `make gen`: Default MDX generation for API reference under `api-reference/`. -- `make tags`: Generate the endpoint-tags MDX snippet at `snippets/data/endpoint-tags.mdx`. - -These commands require Node.js and `ts-node`. diff --git a/openapi.json b/openapi.json index c16db5c7..b00e00a1 100644 --- a/openapi.json +++ b/openapi.json @@ -20,6 +20,9 @@ } ], "tags": [ + { + "name": "PublicApiService" + }, { "name": "Organizations", "description": "An Organization is the highest level of hierarchy in Turnkey. It can contain many Users, Private Keys, and Policies managed by a Root Quorum. The Root Quorum consists of a set of Users with a consensus threshold. This consensus threshold must be reached by Quorum members in order for any actions to take place.\n\nSee [Root Quorum](../concepts/users/root-quorum) for more information" @@ -81,12 +84,12 @@ ], "summary": "Get Activity", "description": "Get details about an Activity", - "operationId": "GetActivity", + "operationId": "PublicApiService_GetActivity", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetActivityRequest" + "$ref": "#/components/schemas/v1GetActivityRequest" } } }, @@ -98,7 +101,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -114,12 +127,12 @@ ], "summary": "Get API key", "description": "Get details about an API key", - "operationId": "GetApiKey", + "operationId": "PublicApiService_GetApiKey", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetApiKeyRequest" + "$ref": "#/components/schemas/v1GetApiKeyRequest" } } }, @@ -131,7 +144,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetApiKeyResponse" + "$ref": "#/components/schemas/v1GetApiKeyResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -145,14 +168,57 @@ "tags": [ "API keys" ], - "summary": "Get API key", + "summary": "Get API keys", "description": "Get details about API keys for a user", - "operationId": "GetApiKeys", + "operationId": "PublicApiService_GetApiKeys", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1GetApiKeysRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1GetApiKeysResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/query/get_attestation": { + "post": { + "tags": [ + "Attestation" + ], + "summary": "Attestation", + "description": "Get the attestation document corresponding to an enclave.", + "operationId": "PublicApiService_GetAttestationDocument", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetApiKeysRequest" + "$ref": "#/components/schemas/v1GetAttestationDocumentRequest" } } }, @@ -164,7 +230,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetApiKeysResponse" + "$ref": "#/components/schemas/v1GetAttestationDocumentResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -180,12 +256,12 @@ ], "summary": "Get Authenticator", "description": "Get details about an authenticator", - "operationId": "GetAuthenticator", + "operationId": "PublicApiService_GetAuthenticator", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetAuthenticatorRequest" + "$ref": "#/components/schemas/v1GetAuthenticatorRequest" } } }, @@ -197,7 +273,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetAuthenticatorResponse" + "$ref": "#/components/schemas/v1GetAuthenticatorResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -213,12 +299,12 @@ ], "summary": "Get Authenticators", "description": "Get details about authenticators for a user", - "operationId": "GetAuthenticators", + "operationId": "PublicApiService_GetAuthenticators", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetAuthenticatorsRequest" + "$ref": "#/components/schemas/v1GetAuthenticatorsRequest" } } }, @@ -230,7 +316,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetAuthenticatorsResponse" + "$ref": "#/components/schemas/v1GetAuthenticatorsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -246,12 +342,55 @@ ], "summary": "Get Oauth providers", "description": "Get details about Oauth providers for a user", - "operationId": "GetOauthProviders", + "operationId": "PublicApiService_GetOauthProviders", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1GetOauthProvidersRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1GetOauthProvidersResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/query/get_organization": { + "post": { + "tags": [ + "Organizations" + ], + "summary": "Get Organization", + "description": "Get details about an Organization", + "operationId": "PublicApiService_GetOrganization", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetOauthProvidersRequest" + "$ref": "#/components/schemas/v1GetOrganizationRequest" } } }, @@ -263,7 +402,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetOauthProvidersResponse" + "$ref": "#/components/schemas/v1GetOrganizationResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -279,12 +428,12 @@ ], "summary": "Get Configs", "description": "Get quorum settings and features for an organization", - "operationId": "GetOrganizationConfigs", + "operationId": "PublicApiService_GetOrganizationConfigs", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetOrganizationConfigsRequest" + "$ref": "#/components/schemas/v1GetOrganizationConfigsRequest" } } }, @@ -296,7 +445,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetOrganizationConfigsResponse" + "$ref": "#/components/schemas/v1GetOrganizationConfigsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -312,12 +471,12 @@ ], "summary": "Get Policy", "description": "Get details about a Policy", - "operationId": "GetPolicy", + "operationId": "PublicApiService_GetPolicy", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPolicyRequest" + "$ref": "#/components/schemas/v1GetPolicyRequest" } } }, @@ -329,7 +488,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPolicyResponse" + "$ref": "#/components/schemas/v1GetPolicyResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -345,12 +514,12 @@ ], "summary": "Get Private Key", "description": "Get details about a Private Key", - "operationId": "GetPrivateKey", + "operationId": "PublicApiService_GetPrivateKey", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPrivateKeyRequest" + "$ref": "#/components/schemas/v1GetPrivateKeyRequest" } } }, @@ -362,7 +531,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPrivateKeyResponse" + "$ref": "#/components/schemas/v1GetPrivateKeyResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -378,12 +557,12 @@ ], "summary": "Get User", "description": "Get details about a User", - "operationId": "GetUser", + "operationId": "PublicApiService_GetUser", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetUserRequest" + "$ref": "#/components/schemas/v1GetUserRequest" } } }, @@ -395,7 +574,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetUserResponse" + "$ref": "#/components/schemas/v1GetUserResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -411,12 +600,12 @@ ], "summary": "Get Wallet", "description": "Get details about a Wallet", - "operationId": "GetWallet", + "operationId": "PublicApiService_GetWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletRequest" + "$ref": "#/components/schemas/v1GetWalletRequest" } } }, @@ -428,7 +617,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletResponse" + "$ref": "#/components/schemas/v1GetWalletResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -444,12 +643,12 @@ ], "summary": "Get Wallet Account", "description": "Get a single wallet account", - "operationId": "GetWalletAccount", + "operationId": "PublicApiService_GetWalletAccount", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletAccountRequest" + "$ref": "#/components/schemas/v1GetWalletAccountRequest" } } }, @@ -461,7 +660,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletAccountResponse" + "$ref": "#/components/schemas/v1GetWalletAccountResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -477,12 +686,12 @@ ], "summary": "List Activities", "description": "List all Activities within an Organization", - "operationId": "GetActivities", + "operationId": "PublicApiService_GetActivities", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetActivitiesRequest" + "$ref": "#/components/schemas/v1GetActivitiesRequest" } } }, @@ -494,7 +703,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetActivitiesResponse" + "$ref": "#/components/schemas/v1GetActivitiesResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -510,12 +729,12 @@ ], "summary": "List Policies", "description": "List all Policies within an Organization", - "operationId": "GetPolicies", + "operationId": "PublicApiService_GetPolicies", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPoliciesRequest" + "$ref": "#/components/schemas/v1GetPoliciesRequest" } } }, @@ -527,7 +746,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPoliciesResponse" + "$ref": "#/components/schemas/v1GetPoliciesResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -543,12 +772,12 @@ ], "summary": "List Private Key Tags", "description": "List all Private Key Tags within an Organization", - "operationId": "ListPrivateKeyTags", + "operationId": "PublicApiService_ListPrivateKeyTags", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListPrivateKeyTagsRequest" + "$ref": "#/components/schemas/v1ListPrivateKeyTagsRequest" } } }, @@ -560,7 +789,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListPrivateKeyTagsResponse" + "$ref": "#/components/schemas/v1ListPrivateKeyTagsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -576,12 +815,12 @@ ], "summary": "List Private Keys", "description": "List all Private Keys within an Organization", - "operationId": "GetPrivateKeys", + "operationId": "PublicApiService_GetPrivateKeys", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPrivateKeysRequest" + "$ref": "#/components/schemas/v1GetPrivateKeysRequest" } } }, @@ -593,7 +832,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPrivateKeysResponse" + "$ref": "#/components/schemas/v1GetPrivateKeysResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -609,12 +858,12 @@ ], "summary": "Get Suborgs", "description": "Get all suborg IDs associated given a parent org ID and an optional filter.", - "operationId": "GetSubOrgIds", + "operationId": "PublicApiService_GetSubOrgIds", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetSubOrgIdsRequest" + "$ref": "#/components/schemas/v1GetSubOrgIdsRequest" } } }, @@ -626,7 +875,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetSubOrgIdsResponse" + "$ref": "#/components/schemas/v1GetSubOrgIdsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -642,12 +901,12 @@ ], "summary": "List User Tags", "description": "List all User Tags within an Organization", - "operationId": "ListUserTags", + "operationId": "PublicApiService_ListUserTags", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListUserTagsRequest" + "$ref": "#/components/schemas/v1ListUserTagsRequest" } } }, @@ -659,7 +918,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListUserTagsResponse" + "$ref": "#/components/schemas/v1ListUserTagsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -675,12 +944,12 @@ ], "summary": "List Users", "description": "List all Users within an Organization", - "operationId": "GetUsers", + "operationId": "PublicApiService_GetUsers", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetUsersRequest" + "$ref": "#/components/schemas/v1GetUsersRequest" } } }, @@ -692,7 +961,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetUsersResponse" + "$ref": "#/components/schemas/v1GetUsersResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -708,12 +987,12 @@ ], "summary": "Get Verified Suborgs", "description": "Get all email or phone verified suborg IDs associated given a parent org ID.", - "operationId": "GetVerifiedSubOrgIds", + "operationId": "PublicApiService_GetVerifiedSubOrgIds", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetVerifiedSubOrgIdsRequest" + "$ref": "#/components/schemas/v1GetVerifiedSubOrgIdsRequest" } } }, @@ -725,7 +1004,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetVerifiedSubOrgIdsResponse" + "$ref": "#/components/schemas/v1GetVerifiedSubOrgIdsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -741,12 +1030,12 @@ ], "summary": "List Wallets Accounts", "description": "List all Accounts within a Wallet", - "operationId": "GetWalletAccounts", + "operationId": "PublicApiService_GetWalletAccounts", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletAccountsRequest" + "$ref": "#/components/schemas/v1GetWalletAccountsRequest" } } }, @@ -758,7 +1047,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletAccountsResponse" + "$ref": "#/components/schemas/v1GetWalletAccountsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -774,12 +1073,12 @@ ], "summary": "List Wallets", "description": "List all Wallets within an Organization", - "operationId": "GetWallets", + "operationId": "PublicApiService_GetWallets", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletsRequest" + "$ref": "#/components/schemas/v1GetWalletsRequest" } } }, @@ -791,7 +1090,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletsResponse" + "$ref": "#/components/schemas/v1GetWalletsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -807,12 +1116,12 @@ ], "summary": "Who am I?", "description": "Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN or API key users.", - "operationId": "GetWhoami", + "operationId": "PublicApiService_GetWhoami", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWhoamiRequest" + "$ref": "#/components/schemas/v1GetWhoamiRequest" } } }, @@ -824,7 +1133,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWhoamiResponse" + "$ref": "#/components/schemas/v1GetWhoamiResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -840,12 +1159,12 @@ ], "summary": "Approve Activity", "description": "Approve an Activity", - "operationId": "ApproveActivity", + "operationId": "PublicApiService_ApproveActivity", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApproveActivityRequest" + "$ref": "#/components/schemas/v1ApproveActivityRequest" } } }, @@ -857,7 +1176,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -873,12 +1202,12 @@ ], "summary": "Create API Keys", "description": "Add api keys to an existing User", - "operationId": "CreateApiKeys", + "operationId": "PublicApiService_CreateApiKeys", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateApiKeysRequest" + "$ref": "#/components/schemas/v1CreateApiKeysRequest" } } }, @@ -890,7 +1219,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -899,19 +1238,19 @@ "x-codegen-request-body-name": "body" } }, - "/public/v1/submit/create_authenticators": { + "/public/v1/submit/create_api_only_users": { "post": { "tags": [ - "Authenticators" + "Users" ], - "summary": "Create Authenticators", - "description": "Create Authenticators to authenticate requests to Turnkey", - "operationId": "CreateAuthenticators", + "summary": "Create API-only Users", + "description": "Create API-only Users in an existing Organization", + "operationId": "PublicApiService_CreateApiOnlyUsers", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateAuthenticatorsRequest" + "$ref": "#/components/schemas/v1CreateApiOnlyUsersRequest" } } }, @@ -923,28 +1262,81 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" } } } - } - }, - "x-codegen-request-body-name": "body" - } - }, - "/public/v1/submit/create_invitations": { + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/submit/create_authenticators": { + "post": { + "tags": [ + "Authenticators" + ], + "summary": "Create Authenticators", + "description": "Create Authenticators to authenticate requests to Turnkey", + "operationId": "PublicApiService_CreateAuthenticators", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1CreateAuthenticatorsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/submit/create_invitations": { "post": { "tags": [ "Invitations" ], "summary": "Create Invitations", "description": "Create Invitations to join an existing Organization", - "operationId": "CreateInvitations", + "operationId": "PublicApiService_CreateInvitations", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateInvitationsRequest" + "$ref": "#/components/schemas/v1CreateInvitationsRequest" } } }, @@ -956,7 +1348,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -972,12 +1374,12 @@ ], "summary": "Create Oauth Providers", "description": "Creates Oauth providers for a specified user - BETA", - "operationId": "CreateOauthProviders", + "operationId": "PublicApiService_CreateOauthProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateOauthProvidersRequest" + "$ref": "#/components/schemas/v1CreateOauthProvidersRequest" } } }, @@ -989,7 +1391,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1005,12 +1417,12 @@ ], "summary": "Create Policies", "description": "Create new Policies", - "operationId": "CreatePolicies", + "operationId": "PublicApiService_CreatePolicies", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePoliciesRequest" + "$ref": "#/components/schemas/v1CreatePoliciesRequest" } } }, @@ -1022,7 +1434,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1038,12 +1460,12 @@ ], "summary": "Create Policy", "description": "Create a new Policy", - "operationId": "CreatePolicy", + "operationId": "PublicApiService_CreatePolicy", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePolicyRequest" + "$ref": "#/components/schemas/v1CreatePolicyRequest" } } }, @@ -1055,7 +1477,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1071,12 +1503,12 @@ ], "summary": "Create Private Key Tag", "description": "Create a private key tag and add it to private keys.", - "operationId": "CreatePrivateKeyTag", + "operationId": "PublicApiService_CreatePrivateKeyTag", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePrivateKeyTagRequest" + "$ref": "#/components/schemas/v1CreatePrivateKeyTagRequest" } } }, @@ -1088,7 +1520,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1104,12 +1546,12 @@ ], "summary": "Create Private Keys", "description": "Create new Private Keys", - "operationId": "CreatePrivateKeys", + "operationId": "PublicApiService_CreatePrivateKeys", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePrivateKeysRequest" + "$ref": "#/components/schemas/v1CreatePrivateKeysRequest" } } }, @@ -1121,7 +1563,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1137,12 +1589,12 @@ ], "summary": "Create Read Only Session", "description": "Create a read only session for a user (valid for 1 hour)", - "operationId": "CreateReadOnlySession", + "operationId": "PublicApiService_CreateReadOnlySession", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateReadOnlySessionRequest" + "$ref": "#/components/schemas/v1CreateReadOnlySessionRequest" } } }, @@ -1154,7 +1606,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1170,12 +1632,12 @@ ], "summary": "Create Read Write Session", "description": "Create a read write session for a user", - "operationId": "CreateReadWriteSession", + "operationId": "PublicApiService_CreateReadWriteSession", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateReadWriteSessionRequest" + "$ref": "#/components/schemas/v1CreateReadWriteSessionRequest" } } }, @@ -1187,7 +1649,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1203,12 +1675,12 @@ ], "summary": "Create Sub-Organization", "description": "Create a new Sub-Organization", - "operationId": "CreateSubOrganization", + "operationId": "PublicApiService_CreateSubOrganization", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateSubOrganizationRequest" + "$ref": "#/components/schemas/v1CreateSubOrganizationRequest" } } }, @@ -1220,7 +1692,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1236,12 +1718,12 @@ ], "summary": "Create User Tag", "description": "Create a user tag and add it to users.", - "operationId": "CreateUserTag", + "operationId": "PublicApiService_CreateUserTag", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateUserTagRequest" + "$ref": "#/components/schemas/v1CreateUserTagRequest" } } }, @@ -1253,7 +1735,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1269,12 +1761,12 @@ ], "summary": "Create Users", "description": "Create Users in an existing Organization", - "operationId": "CreateUsers", + "operationId": "PublicApiService_CreateUsers", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateUsersRequest" + "$ref": "#/components/schemas/v1CreateUsersRequest" } } }, @@ -1286,7 +1778,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1302,12 +1804,12 @@ ], "summary": "Create Wallet", "description": "Create a Wallet and derive addresses", - "operationId": "CreateWallet", + "operationId": "PublicApiService_CreateWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateWalletRequest" + "$ref": "#/components/schemas/v1CreateWalletRequest" } } }, @@ -1319,7 +1821,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1335,12 +1847,12 @@ ], "summary": "Create Wallet Accounts", "description": "Derive additional addresses using an existing wallet", - "operationId": "CreateWalletAccounts", + "operationId": "PublicApiService_CreateWalletAccounts", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateWalletAccountsRequest" + "$ref": "#/components/schemas/v1CreateWalletAccountsRequest" } } }, @@ -1352,7 +1864,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1368,12 +1890,12 @@ ], "summary": "Delete API Keys", "description": "Remove api keys from a User", - "operationId": "DeleteApiKeys", + "operationId": "PublicApiService_DeleteApiKeys", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteApiKeysRequest" + "$ref": "#/components/schemas/v1DeleteApiKeysRequest" } } }, @@ -1385,7 +1907,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1401,12 +1933,12 @@ ], "summary": "Delete Authenticators", "description": "Remove authenticators from a User", - "operationId": "DeleteAuthenticators", + "operationId": "PublicApiService_DeleteAuthenticators", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteAuthenticatorsRequest" + "$ref": "#/components/schemas/v1DeleteAuthenticatorsRequest" } } }, @@ -1418,7 +1950,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1434,12 +1976,12 @@ ], "summary": "Delete Invitation", "description": "Delete an existing Invitation", - "operationId": "DeleteInvitation", + "operationId": "PublicApiService_DeleteInvitation", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteInvitationRequest" + "$ref": "#/components/schemas/v1DeleteInvitationRequest" } } }, @@ -1451,7 +1993,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1467,12 +2019,12 @@ ], "summary": "Delete Oauth Providers", "description": "Removes Oauth providers for a specified user - BETA", - "operationId": "DeleteOauthProviders", + "operationId": "PublicApiService_DeleteOauthProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteOauthProvidersRequest" + "$ref": "#/components/schemas/v1DeleteOauthProvidersRequest" } } }, @@ -1484,7 +2036,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1500,12 +2062,12 @@ ], "summary": "Delete Policy", "description": "Delete an existing Policy", - "operationId": "DeletePolicy", + "operationId": "PublicApiService_DeletePolicy", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeletePolicyRequest" + "$ref": "#/components/schemas/v1DeletePolicyRequest" } } }, @@ -1517,7 +2079,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1533,12 +2105,12 @@ ], "summary": "Delete Private Key Tags", "description": "Delete Private Key Tags within an Organization", - "operationId": "DeletePrivateKeyTags", + "operationId": "PublicApiService_DeletePrivateKeyTags", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeletePrivateKeyTagsRequest" + "$ref": "#/components/schemas/v1DeletePrivateKeyTagsRequest" } } }, @@ -1550,7 +2122,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1566,12 +2148,12 @@ ], "summary": "Delete Private Keys", "description": "Deletes private keys for an organization", - "operationId": "DeletePrivateKeys", + "operationId": "PublicApiService_DeletePrivateKeys", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeletePrivateKeysRequest" + "$ref": "#/components/schemas/v1DeletePrivateKeysRequest" } } }, @@ -1583,7 +2165,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1599,12 +2191,12 @@ ], "summary": "Delete Sub Organization", "description": "Deletes a sub organization", - "operationId": "DeleteSubOrganization", + "operationId": "PublicApiService_DeleteSubOrganization", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteSubOrganizationRequest" + "$ref": "#/components/schemas/v1DeleteSubOrganizationRequest" } } }, @@ -1616,7 +2208,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1632,12 +2234,12 @@ ], "summary": "Delete User Tags", "description": "Delete User Tags within an Organization", - "operationId": "DeleteUserTags", + "operationId": "PublicApiService_DeleteUserTags", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteUserTagsRequest" + "$ref": "#/components/schemas/v1DeleteUserTagsRequest" } } }, @@ -1649,7 +2251,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1665,12 +2277,12 @@ ], "summary": "Delete Users", "description": "Delete Users within an Organization", - "operationId": "DeleteUsers", + "operationId": "PublicApiService_DeleteUsers", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteUsersRequest" + "$ref": "#/components/schemas/v1DeleteUsersRequest" } } }, @@ -1682,7 +2294,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1698,12 +2320,12 @@ ], "summary": "Delete Wallets", "description": "Deletes wallets for an organization", - "operationId": "DeleteWallets", + "operationId": "PublicApiService_DeleteWallets", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteWalletsRequest" + "$ref": "#/components/schemas/v1DeleteWalletsRequest" } } }, @@ -1715,7 +2337,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1731,12 +2363,12 @@ ], "summary": "Perform Email Auth", "description": "Authenticate a user via Email", - "operationId": "EmailAuth", + "operationId": "PublicApiService_EmailAuth", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EmailAuthRequest" + "$ref": "#/components/schemas/v1EmailAuthRequest" } } }, @@ -1748,7 +2380,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1764,12 +2406,12 @@ ], "summary": "Export Private Key", "description": "Exports a Private Key", - "operationId": "ExportPrivateKey", + "operationId": "PublicApiService_ExportPrivateKey", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportPrivateKeyRequest" + "$ref": "#/components/schemas/v1ExportPrivateKeyRequest" } } }, @@ -1781,7 +2423,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1797,12 +2449,12 @@ ], "summary": "Export Wallet", "description": "Exports a Wallet", - "operationId": "ExportWallet", + "operationId": "PublicApiService_ExportWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportWalletRequest" + "$ref": "#/components/schemas/v1ExportWalletRequest" } } }, @@ -1814,7 +2466,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1830,12 +2492,12 @@ ], "summary": "Export Wallet Account", "description": "Exports a Wallet Account", - "operationId": "ExportWalletAccount", + "operationId": "PublicApiService_ExportWalletAccount", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportWalletAccountRequest" + "$ref": "#/components/schemas/v1ExportWalletAccountRequest" } } }, @@ -1847,7 +2509,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1863,12 +2535,12 @@ ], "summary": "Import Private Key", "description": "Imports a private key", - "operationId": "ImportPrivateKey", + "operationId": "PublicApiService_ImportPrivateKey", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportPrivateKeyRequest" + "$ref": "#/components/schemas/v1ImportPrivateKeyRequest" } } }, @@ -1880,7 +2552,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1896,12 +2578,12 @@ ], "summary": "Import Wallet", "description": "Imports a wallet", - "operationId": "ImportWallet", + "operationId": "PublicApiService_ImportWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportWalletRequest" + "$ref": "#/components/schemas/v1ImportWalletRequest" } } }, @@ -1913,13 +2595,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" } } } - } - }, - "x-codegen-request-body-name": "body" + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" } }, "/public/v1/submit/init_import_private_key": { @@ -1929,12 +2621,12 @@ ], "summary": "Init Import Private Key", "description": "Initializes a new private key import", - "operationId": "InitImportPrivateKey", + "operationId": "PublicApiService_InitImportPrivateKey", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InitImportPrivateKeyRequest" + "$ref": "#/components/schemas/v1InitImportPrivateKeyRequest" } } }, @@ -1946,7 +2638,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1962,12 +2664,12 @@ ], "summary": "Init Import Wallet", "description": "Initializes a new wallet import", - "operationId": "InitImportWallet", + "operationId": "PublicApiService_InitImportWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InitImportWalletRequest" + "$ref": "#/components/schemas/v1InitImportWalletRequest" } } }, @@ -1979,7 +2681,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -1995,12 +2707,12 @@ ], "summary": "Init OTP auth", "description": "Initiate an OTP auth activity", - "operationId": "InitOtpAuth", + "operationId": "PublicApiService_InitOtpAuth", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InitOtpAuthRequest" + "$ref": "#/components/schemas/v1InitOtpAuthRequest" } } }, @@ -2012,7 +2724,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2028,12 +2750,12 @@ ], "summary": "Init Email Recovery", "description": "Initializes a new email recovery", - "operationId": "InitUserEmailRecovery", + "operationId": "PublicApiService_InitUserEmailRecovery", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InitUserEmailRecoveryRequest" + "$ref": "#/components/schemas/v1InitUserEmailRecoveryRequest" } } }, @@ -2045,7 +2767,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2061,12 +2793,12 @@ ], "summary": "Oauth", "description": "Authenticate a user with an Oidc token (Oauth) - BETA", - "operationId": "Oauth", + "operationId": "PublicApiService_Oauth", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OauthRequest" + "$ref": "#/components/schemas/v1OauthRequest" } } }, @@ -2078,7 +2810,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2094,12 +2836,12 @@ ], "summary": "OTP auth", "description": "Authenticate a user with an OTP code sent via email or SMS", - "operationId": "OtpAuth", + "operationId": "PublicApiService_OtpAuth", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OtpAuthRequest" + "$ref": "#/components/schemas/v1OtpAuthRequest" } } }, @@ -2111,7 +2853,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2127,12 +2879,12 @@ ], "summary": "Recover a user", "description": "Completes the process of recovering a user by adding an authenticator", - "operationId": "RecoverUser", + "operationId": "PublicApiService_RecoverUser", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RecoverUserRequest" + "$ref": "#/components/schemas/v1RecoverUserRequest" } } }, @@ -2144,7 +2896,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2160,12 +2922,12 @@ ], "summary": "Reject Activity", "description": "Reject an Activity", - "operationId": "RejectActivity", + "operationId": "PublicApiService_RejectActivity", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RejectActivityRequest" + "$ref": "#/components/schemas/v1RejectActivityRequest" } } }, @@ -2177,7 +2939,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2193,12 +2965,12 @@ ], "summary": "Remove Organization Feature", "description": "Removes an organization feature. This activity must be approved by the current root quorum.", - "operationId": "RemoveOrganizationFeature", + "operationId": "PublicApiService_RemoveOrganizationFeature", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoveOrganizationFeatureRequest" + "$ref": "#/components/schemas/v1RemoveOrganizationFeatureRequest" } } }, @@ -2210,7 +2982,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2226,12 +3008,12 @@ ], "summary": "Set Organization Feature", "description": "Sets an organization feature. This activity must be approved by the current root quorum.", - "operationId": "SetOrganizationFeature", + "operationId": "PublicApiService_SetOrganizationFeature", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SetOrganizationFeatureRequest" + "$ref": "#/components/schemas/v1SetOrganizationFeatureRequest" } } }, @@ -2243,7 +3025,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2259,12 +3051,12 @@ ], "summary": "Sign Raw Payload", "description": "Sign a raw payload", - "operationId": "SignRawPayload", + "operationId": "PublicApiService_SignRawPayload", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SignRawPayloadRequest" + "$ref": "#/components/schemas/v1SignRawPayloadRequest" } } }, @@ -2276,7 +3068,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2292,12 +3094,12 @@ ], "summary": "Sign Raw Payloads", "description": "Sign multiple raw payloads with the same signing parameters", - "operationId": "SignRawPayloads", + "operationId": "PublicApiService_SignRawPayloads", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SignRawPayloadsRequest" + "$ref": "#/components/schemas/v1SignRawPayloadsRequest" } } }, @@ -2309,7 +3111,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2325,12 +3137,12 @@ ], "summary": "Sign Transaction", "description": "Sign a transaction", - "operationId": "SignTransaction", + "operationId": "PublicApiService_SignTransaction", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SignTransactionRequest" + "$ref": "#/components/schemas/v1SignTransactionRequest" } } }, @@ -2342,7 +3154,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2358,12 +3180,12 @@ ], "summary": "Update Policy", "description": "Update an existing Policy", - "operationId": "UpdatePolicy", + "operationId": "PublicApiService_UpdatePolicy", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdatePolicyRequest" + "$ref": "#/components/schemas/v1UpdatePolicyRequest" } } }, @@ -2375,7 +3197,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2391,12 +3223,12 @@ ], "summary": "Update Private Key Tag", "description": "Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.", - "operationId": "UpdatePrivateKeyTag", + "operationId": "PublicApiService_UpdatePrivateKeyTag", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdatePrivateKeyTagRequest" + "$ref": "#/components/schemas/v1UpdatePrivateKeyTagRequest" } } }, @@ -2408,7 +3240,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2424,12 +3266,12 @@ ], "summary": "Update Root Quorum", "description": "Set the threshold and members of the root quorum. This activity must be approved by the current root quorum.", - "operationId": "UpdateRootQuorum", + "operationId": "PublicApiService_UpdateRootQuorum", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateRootQuorumRequest" + "$ref": "#/components/schemas/v1UpdateRootQuorumRequest" } } }, @@ -2441,7 +3283,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActivityResponse" + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" } } } @@ -2457,102 +3309,487 @@ ], "summary": "Update User", "description": "Update a User in an existing Organization", - "operationId": "UpdateUser", + "operationId": "PublicApiService_UpdateUser", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1UpdateUserRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/submit/update_user_tag": { + "post": { + "tags": [ + "User Tags" + ], + "summary": "Update User Tag", + "description": "Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.", + "operationId": "PublicApiService_UpdateUserTag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1UpdateUserTagRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/public/v1/submit/update_wallet": { + "post": { + "tags": [ + "Wallets" + ], + "summary": "Update Wallet", + "description": "Update a wallet for an organization", + "operationId": "PublicApiService_UpdateWallet", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateUserRequest" + "$ref": "#/components/schemas/v1UpdateWalletRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1ActivityResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/tkhq/api/v1/noop-codegen-anchor": { + "post": { + "tags": [ + "PublicApiService" + ], + "operationId": "PublicApiService_NOOPCodegenAnchor", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1NOOPCodegenAnchorResponse" + } } } }, - "required": true - }, - "responses": { - "200": { - "description": "A successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityResponse" - } - } + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + } + } + }, + "/tkhq/api/v1/test_rate_limits": { + "post": { + "tags": [ + "RateLimit" + ], + "summary": "Test Rate Limit", + "description": "Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite", + "operationId": "PublicApiService_TestRateLimits", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1TestRateLimitsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v1TestRateLimitsResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rpcStatus" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + } + }, + "components": { + "schemas": { + "apiApiKeyParams": { + "required": [ + "apiKeyName", + "publicKey" + ], + "type": "object", + "properties": { + "apiKeyName": { + "type": "string", + "description": "Human-readable name for an API Key." + }, + "publicKey": { + "type": "string", + "description": "The public component of a cryptographic key pair used to sign messages and transactions." + }, + "expirationSeconds": { + "type": "string", + "description": "Optional window (in seconds) indicating how long the API Key should last." + } + } + }, + "billingActivateBillingTierIntent": { + "required": [ + "productId" + ], + "type": "object", + "properties": { + "productId": { + "type": "string", + "description": "The product that the customer wants to subscribe to." + } + } + }, + "billingActivateBillingTierResult": { + "required": [ + "productId" + ], + "type": "object", + "properties": { + "productId": { + "type": "string", + "description": "The id of the product being subscribed to." + } + } + }, + "billingDeletePaymentMethodIntent": { + "required": [ + "paymentMethodId" + ], + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string", + "description": "The payment method that the customer wants to remove." + } + } + }, + "billingDeletePaymentMethodResult": { + "required": [ + "paymentMethodId" + ], + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string", + "description": "The payment method that was removed." + } + } + }, + "billingSetPaymentMethodIntent": { + "required": [ + "cardHolderEmail", + "cardHolderName", + "cvv", + "expiryMonth", + "expiryYear", + "number" + ], + "type": "object", + "properties": { + "number": { + "type": "string", + "description": "The account number of the customer's credit card." + }, + "cvv": { + "type": "string", + "description": "The verification digits of the customer's credit card." + }, + "expiryMonth": { + "type": "string", + "description": "The month that the credit card expires." + }, + "expiryYear": { + "type": "string", + "description": "The year that the credit card expires." + }, + "cardHolderEmail": { + "type": "string", + "description": "The email that will receive invoices for the credit card." + }, + "cardHolderName": { + "type": "string", + "description": "The name associated with the credit card." + } + } + }, + "billingSetPaymentMethodIntentV2": { + "required": [ + "cardHolderEmail", + "cardHolderName", + "paymentMethodId" + ], + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string", + "description": "The id of the payment method that was created clientside." + }, + "cardHolderEmail": { + "type": "string", + "description": "The email that will receive invoices for the credit card." + }, + "cardHolderName": { + "type": "string", + "description": "The name associated with the credit card." + } + } + }, + "billingSetPaymentMethodResult": { + "required": [ + "cardHolderEmail", + "cardHolderName", + "lastFour" + ], + "type": "object", + "properties": { + "lastFour": { + "type": "string", + "description": "The last four digits of the credit card added." + }, + "cardHolderName": { + "type": "string", + "description": "The name associated with the payment method." + }, + "cardHolderEmail": { + "type": "string", + "description": "The email address associated with the payment method." + } + } + }, + "datav1Tag": { + "required": [ + "createdAt", + "tagId", + "tagName", + "tagType", + "updatedAt" + ], + "type": "object", + "properties": { + "tagId": { + "type": "string", + "description": "Unique identifier for a given Tag." + }, + "tagName": { + "type": "string", + "description": "Human-readable name for a Tag." + }, + "tagType": { + "$ref": "#/components/schemas/v1TagType" + }, + "createdAt": { + "$ref": "#/components/schemas/externaldatav1Timestamp" + }, + "updatedAt": { + "$ref": "#/components/schemas/externaldatav1Timestamp" + } + } + }, + "externaldatav1Address": { + "type": "object", + "properties": { + "format": { + "$ref": "#/components/schemas/v1AddressFormat" + }, + "address": { + "type": "string" + } + } + }, + "externaldatav1Credential": { + "required": [ + "publicKey", + "type" + ], + "type": "object", + "properties": { + "publicKey": { + "type": "string", + "description": "The public component of a cryptographic key pair used to sign messages and transactions." + }, + "type": { + "$ref": "#/components/schemas/v1CredentialType" + } + } + }, + "externaldatav1Quorum": { + "required": [ + "threshold", + "userIds" + ], + "type": "object", + "properties": { + "threshold": { + "type": "integer", + "description": "Count of unique approvals required to meet quorum.", + "format": "int32" + }, + "userIds": { + "type": "array", + "description": "Unique identifiers of quorum set members.", + "items": { + "type": "string" } } - }, - "x-codegen-request-body-name": "body" - } - }, - "/public/v1/submit/update_user_tag": { - "post": { - "tags": [ - "User Tags" + } + }, + "externaldatav1Timestamp": { + "required": [ + "nanos", + "seconds" ], - "summary": "Update User Tag", - "description": "Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.", - "operationId": "UpdateUserTag", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateUserTagRequest" - } - } + "type": "object", + "properties": { + "seconds": { + "type": "string" }, - "required": true - }, - "responses": { - "200": { - "description": "A successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityResponse" - } - } - } + "nanos": { + "type": "string" } - }, - "x-codegen-request-body-name": "body" - } - }, - "/public/v1/submit/update_wallet": { - "post": { - "tags": [ - "Wallets" - ], - "summary": "Update Wallet", - "description": "Update a wallet for an organization", - "operationId": "UpdateWallet", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateWalletRequest" - } - } + } + }, + "immutableactivityv1Address": { + "type": "object", + "properties": { + "format": { + "$ref": "#/components/schemas/v1AddressFormat" }, - "required": true + "address": { + "type": "string" + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } }, - "responses": { - "200": { - "description": "A successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityResponse" - } - } + "additionalProperties": { + "type": "object" + } + }, + "rpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/protobufAny" } } - }, - "x-codegen-request-body-name": "body" - } - } - }, - "components": { - "schemas": { - "AcceptInvitationIntent": { + } + }, + "v1AcceptInvitationIntent": { "required": [ "authenticator", "invitationId", @@ -2569,11 +3806,11 @@ "description": "Unique identifier for a given User." }, "authenticator": { - "$ref": "#/components/schemas/AuthenticatorParams" + "$ref": "#/components/schemas/v1AuthenticatorParams" } } }, - "AcceptInvitationIntentV2": { + "v1AcceptInvitationIntentV2": { "required": [ "authenticator", "invitationId", @@ -2590,11 +3827,11 @@ "description": "Unique identifier for a given User." }, "authenticator": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } } }, - "AcceptInvitationResult": { + "v1AcceptInvitationResult": { "required": [ "invitationId", "userId" @@ -2611,7 +3848,7 @@ } } }, - "AccessType": { + "v1AccessType": { "type": "string", "enum": [ "ACCESS_TYPE_WEB", @@ -2619,31 +3856,7 @@ "ACCESS_TYPE_ALL" ] }, - "ActivateBillingTierIntent": { - "required": [ - "productId" - ], - "type": "object", - "properties": { - "productId": { - "type": "string", - "description": "The product that the customer wants to subscribe to." - } - } - }, - "ActivateBillingTierResult": { - "required": [ - "productId" - ], - "type": "object", - "properties": { - "productId": { - "type": "string", - "description": "The id of the product being subscribed to." - } - } - }, - "Activity": { + "v1Activity": { "required": [ "canApprove", "canReject", @@ -2669,22 +3882,22 @@ "description": "Unique identifier for a given Organization." }, "status": { - "$ref": "#/components/schemas/ActivityStatus" + "$ref": "#/components/schemas/v1ActivityStatus" }, "type": { - "$ref": "#/components/schemas/ActivityType" + "$ref": "#/components/schemas/v1ActivityType" }, "intent": { - "$ref": "#/components/schemas/Intent" + "$ref": "#/components/schemas/v1Intent" }, "result": { - "$ref": "#/components/schemas/Result" + "$ref": "#/components/schemas/v1Result" }, "votes": { "type": "array", "description": "A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.", "items": { - "$ref": "#/components/schemas/Vote" + "$ref": "#/components/schemas/v1Vote" } }, "fingerprint": { @@ -2698,28 +3911,28 @@ "type": "boolean" }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "failure": { - "$ref": "#/components/schemas/Status" + "$ref": "#/components/schemas/rpcStatus" } } }, - "ActivityResponse": { + "v1ActivityResponse": { "required": [ "activity" ], "type": "object", "properties": { "activity": { - "$ref": "#/components/schemas/Activity" + "$ref": "#/components/schemas/v1Activity" } } }, - "ActivityStatus": { + "v1ActivityStatus": { "type": "string", "enum": [ "ACTIVITY_STATUS_CREATED", @@ -2730,7 +3943,7 @@ "ACTIVITY_STATUS_REJECTED" ] }, - "ActivityType": { + "v1ActivityType": { "type": "string", "enum": [ "ACTIVITY_TYPE_CREATE_API_KEYS", @@ -2812,10 +4025,13 @@ "ACTIVITY_TYPE_INIT_OTP_AUTH", "ACTIVITY_TYPE_OTP_AUTH", "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7", - "ACTIVITY_TYPE_UPDATE_WALLET" + "ACTIVITY_TYPE_UPDATE_WALLET", + "ACTIVITY_TYPE_UPDATE_POLICY_V2", + "ACTIVITY_TYPE_CREATE_USERS_V3", + "ACTIVITY_TYPE_INIT_OTP_AUTH_V2" ] }, - "AddressFormat": { + "v1AddressFormat": { "type": "string", "enum": [ "ADDRESS_FORMAT_UNCOMPRESSED", @@ -2855,18 +4071,7 @@ "ADDRESS_FORMAT_XRP" ] }, - "Any": { - "type": "object", - "properties": { - "@type": { - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "ApiKey": { + "v1ApiKey": { "required": [ "apiKeyId", "apiKeyName", @@ -2877,7 +4082,7 @@ "type": "object", "properties": { "credential": { - "$ref": "#/components/schemas/external.data.v1.Credential" + "$ref": "#/components/schemas/externaldatav1Credential" }, "apiKeyId": { "type": "string", @@ -2888,10 +4093,10 @@ "description": "Human-readable name for an API Key." }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "expirationSeconds": { "type": "string", @@ -2900,7 +4105,7 @@ } } }, - "ApiKeyCurve": { + "v1ApiKeyCurve": { "type": "string", "enum": [ "API_KEY_CURVE_P256", @@ -2908,28 +4113,7 @@ "API_KEY_CURVE_ED25519" ] }, - "ApiKeyParams": { - "required": [ - "apiKeyName", - "publicKey" - ], - "type": "object", - "properties": { - "apiKeyName": { - "type": "string", - "description": "Human-readable name for an API Key." - }, - "publicKey": { - "type": "string", - "description": "The public component of a cryptographic key pair used to sign messages and transactions." - }, - "expirationSeconds": { - "type": "string", - "description": "Optional window (in seconds) indicating how long the API Key should last." - } - } - }, - "ApiKeyParamsV2": { + "v1ApiKeyParamsV2": { "required": [ "apiKeyName", "curveType", @@ -2946,7 +4130,7 @@ "description": "The public component of a cryptographic key pair used to sign messages and transactions." }, "curveType": { - "$ref": "#/components/schemas/ApiKeyCurve" + "$ref": "#/components/schemas/v1ApiKeyCurve" }, "expirationSeconds": { "type": "string", @@ -2954,7 +4138,7 @@ } } }, - "ApiOnlyUserParams": { + "v1ApiOnlyUserParams": { "required": [ "apiKeys", "userName", @@ -2981,12 +4165,12 @@ "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/apiApiKeyParams" } } } }, - "ApproveActivityIntent": { + "v1ApproveActivityIntent": { "required": [ "fingerprint" ], @@ -2998,7 +4182,7 @@ } } }, - "ApproveActivityRequest": { + "v1ApproveActivityRequest": { "required": [ "organizationId", "parameters", @@ -3022,11 +4206,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ApproveActivityIntent" + "$ref": "#/components/schemas/v1ApproveActivityIntent" } } }, - "Attestation": { + "v1Attestation": { "required": [ "attestationObject", "clientDataJson", @@ -3051,12 +4235,12 @@ "type": "array", "description": "The type of authenticator transports.", "items": { - "$ref": "#/components/schemas/AuthenticatorTransport" + "$ref": "#/components/schemas/v1AuthenticatorTransport" } } } }, - "Authenticator": { + "v1Authenticator": { "required": [ "aaguid", "attestationType", @@ -3075,7 +4259,7 @@ "type": "array", "description": "Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).", "items": { - "$ref": "#/components/schemas/AuthenticatorTransport" + "$ref": "#/components/schemas/v1AuthenticatorTransport" } }, "attestationType": { @@ -3094,7 +4278,7 @@ "description": "The type of Authenticator device." }, "credential": { - "$ref": "#/components/schemas/external.data.v1.Credential" + "$ref": "#/components/schemas/externaldatav1Credential" }, "authenticatorId": { "type": "string", @@ -3105,14 +4289,14 @@ "description": "Human-readable name for an Authenticator." }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" } } }, - "AuthenticatorAttestationResponse": { + "v1AuthenticatorAttestationResponse": { "required": [ "attestationObject", "clientDataJson" @@ -3128,7 +4312,7 @@ "transports": { "type": "array", "items": { - "$ref": "#/components/schemas/AuthenticatorTransport" + "$ref": "#/components/schemas/v1AuthenticatorTransport" } }, "authenticatorAttachment": { @@ -3141,7 +4325,7 @@ } } }, - "AuthenticatorParams": { + "v1AuthenticatorParams": { "required": [ "attestation", "authenticatorName", @@ -3159,7 +4343,7 @@ "description": "Unique identifier for a given User." }, "attestation": { - "$ref": "#/components/schemas/PublicKeyCredentialWithAttestation" + "$ref": "#/components/schemas/v1PublicKeyCredentialWithAttestation" }, "challenge": { "type": "string", @@ -3167,7 +4351,7 @@ } } }, - "AuthenticatorParamsV2": { + "v1AuthenticatorParamsV2": { "required": [ "attestation", "authenticatorName", @@ -3184,11 +4368,11 @@ "description": "Challenge presented for authentication purposes." }, "attestation": { - "$ref": "#/components/schemas/Attestation" + "$ref": "#/components/schemas/v1Attestation" } } }, - "AuthenticatorTransport": { + "v1AuthenticatorTransport": { "type": "string", "enum": [ "AUTHENTICATOR_TRANSPORT_BLE", @@ -3198,21 +4382,21 @@ "AUTHENTICATOR_TRANSPORT_HYBRID" ] }, - "Config": { + "v1Config": { "type": "object", "properties": { "features": { "type": "array", "items": { - "$ref": "#/components/schemas/Feature" + "$ref": "#/components/schemas/v1Feature" } }, "quorum": { - "$ref": "#/components/schemas/external.data.v1.Quorum" + "$ref": "#/components/schemas/externaldatav1Quorum" } } }, - "CreateApiKeysIntent": { + "v1CreateApiKeysIntent": { "required": [ "apiKeys", "userId" @@ -3223,7 +4407,7 @@ "type": "array", "description": "A list of API Keys.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/apiApiKeyParams" } }, "userId": { @@ -3232,7 +4416,7 @@ } } }, - "CreateApiKeysIntentV2": { + "v1CreateApiKeysIntentV2": { "required": [ "apiKeys", "userId" @@ -3243,7 +4427,7 @@ "type": "array", "description": "A list of API Keys.", "items": { - "$ref": "#/components/schemas/ApiKeyParamsV2" + "$ref": "#/components/schemas/v1ApiKeyParamsV2" } }, "userId": { @@ -3252,7 +4436,7 @@ } } }, - "CreateApiKeysRequest": { + "v1CreateApiKeysRequest": { "required": [ "organizationId", "parameters", @@ -3276,11 +4460,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateApiKeysIntentV2" + "$ref": "#/components/schemas/v1CreateApiKeysIntentV2" } } }, - "CreateApiKeysResult": { + "v1CreateApiKeysResult": { "required": [ "apiKeyIds" ], @@ -3295,7 +4479,7 @@ } } }, - "CreateApiOnlyUsersIntent": { + "v1CreateApiOnlyUsersIntent": { "required": [ "apiOnlyUsers" ], @@ -3305,12 +4489,40 @@ "type": "array", "description": "A list of API-only Users to create.", "items": { - "$ref": "#/components/schemas/ApiOnlyUserParams" + "$ref": "#/components/schemas/v1ApiOnlyUserParams" } } } }, - "CreateApiOnlyUsersResult": { + "v1CreateApiOnlyUsersRequest": { + "required": [ + "organizationId", + "parameters", + "timestampMs", + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ACTIVITY_TYPE_CREATE_API_ONLY_USERS" + ] + }, + "timestampMs": { + "type": "string", + "description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests." + }, + "organizationId": { + "type": "string", + "description": "Unique identifier for a given Organization." + }, + "parameters": { + "$ref": "#/components/schemas/v1CreateApiOnlyUsersIntent" + } + } + }, + "v1CreateApiOnlyUsersResult": { "required": [ "userIds" ], @@ -3325,7 +4537,7 @@ } } }, - "CreateAuthenticatorsIntent": { + "v1CreateAuthenticatorsIntent": { "required": [ "authenticators", "userId" @@ -3336,7 +4548,7 @@ "type": "array", "description": "A list of Authenticators.", "items": { - "$ref": "#/components/schemas/AuthenticatorParams" + "$ref": "#/components/schemas/v1AuthenticatorParams" } }, "userId": { @@ -3345,7 +4557,7 @@ } } }, - "CreateAuthenticatorsIntentV2": { + "v1CreateAuthenticatorsIntentV2": { "required": [ "authenticators", "userId" @@ -3356,7 +4568,7 @@ "type": "array", "description": "A list of Authenticators.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } }, "userId": { @@ -3365,7 +4577,7 @@ } } }, - "CreateAuthenticatorsRequest": { + "v1CreateAuthenticatorsRequest": { "required": [ "organizationId", "parameters", @@ -3389,11 +4601,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateAuthenticatorsIntentV2" + "$ref": "#/components/schemas/v1CreateAuthenticatorsIntentV2" } } }, - "CreateAuthenticatorsResult": { + "v1CreateAuthenticatorsResult": { "required": [ "authenticatorIds" ], @@ -3408,7 +4620,7 @@ } } }, - "CreateInvitationsIntent": { + "v1CreateInvitationsIntent": { "required": [ "invitations" ], @@ -3418,12 +4630,12 @@ "type": "array", "description": "A list of Invitations.", "items": { - "$ref": "#/components/schemas/InvitationParams" + "$ref": "#/components/schemas/v1InvitationParams" } } } }, - "CreateInvitationsRequest": { + "v1CreateInvitationsRequest": { "required": [ "organizationId", "parameters", @@ -3447,11 +4659,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateInvitationsIntent" + "$ref": "#/components/schemas/v1CreateInvitationsIntent" } } }, - "CreateInvitationsResult": { + "v1CreateInvitationsResult": { "required": [ "invitationIds" ], @@ -3466,7 +4678,7 @@ } } }, - "CreateOauthProvidersIntent": { + "v1CreateOauthProvidersIntent": { "required": [ "oauthProviders", "userId" @@ -3481,12 +4693,12 @@ "type": "array", "description": "A list of Oauth providers.", "items": { - "$ref": "#/components/schemas/OauthProviderParams" + "$ref": "#/components/schemas/v1OauthProviderParams" } } } }, - "CreateOauthProvidersRequest": { + "v1CreateOauthProvidersRequest": { "required": [ "organizationId", "parameters", @@ -3510,11 +4722,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateOauthProvidersIntent" + "$ref": "#/components/schemas/v1CreateOauthProvidersIntent" } } }, - "CreateOauthProvidersResult": { + "v1CreateOauthProvidersResult": { "required": [ "providerIds" ], @@ -3529,7 +4741,7 @@ } } }, - "CreateOrganizationIntent": { + "v1CreateOrganizationIntent": { "required": [ "organizationName", "rootAuthenticator", @@ -3546,7 +4758,7 @@ "description": "The root user's email address." }, "rootAuthenticator": { - "$ref": "#/components/schemas/AuthenticatorParams" + "$ref": "#/components/schemas/v1AuthenticatorParams" }, "rootUserId": { "type": "string", @@ -3554,7 +4766,7 @@ } } }, - "CreateOrganizationIntentV2": { + "v1CreateOrganizationIntentV2": { "required": [ "organizationName", "rootAuthenticator", @@ -3571,7 +4783,7 @@ "description": "The root user's email address." }, "rootAuthenticator": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" }, "rootUserId": { "type": "string", @@ -3579,7 +4791,7 @@ } } }, - "CreateOrganizationResult": { + "v1CreateOrganizationResult": { "required": [ "organizationId" ], @@ -3591,7 +4803,7 @@ } } }, - "CreatePoliciesIntent": { + "v1CreatePoliciesIntent": { "required": [ "policies" ], @@ -3601,12 +4813,12 @@ "type": "array", "description": "An array of policy intents to be created.", "items": { - "$ref": "#/components/schemas/CreatePolicyIntentV3" + "$ref": "#/components/schemas/v1CreatePolicyIntentV3" } } } }, - "CreatePoliciesRequest": { + "v1CreatePoliciesRequest": { "required": [ "organizationId", "parameters", @@ -3630,11 +4842,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreatePoliciesIntent" + "$ref": "#/components/schemas/v1CreatePoliciesIntent" } } }, - "CreatePoliciesResult": { + "v1CreatePoliciesResult": { "required": [ "policyIds" ], @@ -3649,7 +4861,7 @@ } } }, - "CreatePolicyIntent": { + "v1CreatePolicyIntent": { "required": [ "effect", "policyName", @@ -3665,18 +4877,18 @@ "type": "array", "description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.", "items": { - "$ref": "#/components/schemas/Selector" + "$ref": "#/components/schemas/v1Selector" } }, "effect": { - "$ref": "#/components/schemas/Effect" + "$ref": "#/components/schemas/v1Effect" }, "notes": { "type": "string" } } }, - "CreatePolicyIntentV2": { + "v1CreatePolicyIntentV2": { "required": [ "effect", "policyName", @@ -3692,18 +4904,18 @@ "type": "array", "description": "A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.", "items": { - "$ref": "#/components/schemas/SelectorV2" + "$ref": "#/components/schemas/v1SelectorV2" } }, "effect": { - "$ref": "#/components/schemas/Effect" + "$ref": "#/components/schemas/v1Effect" }, "notes": { "type": "string" } } }, - "CreatePolicyIntentV3": { + "v1CreatePolicyIntentV3": { "required": [ "effect", "policyName" @@ -3715,7 +4927,7 @@ "description": "Human-readable name for a Policy." }, "effect": { - "$ref": "#/components/schemas/Effect" + "$ref": "#/components/schemas/v1Effect" }, "condition": { "type": "string", @@ -3730,7 +4942,7 @@ } } }, - "CreatePolicyRequest": { + "v1CreatePolicyRequest": { "required": [ "organizationId", "parameters", @@ -3754,11 +4966,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreatePolicyIntentV3" + "$ref": "#/components/schemas/v1CreatePolicyIntentV3" } } }, - "CreatePolicyResult": { + "v1CreatePolicyResult": { "required": [ "policyId" ], @@ -3770,7 +4982,7 @@ } } }, - "CreatePrivateKeyTagIntent": { + "v1CreatePrivateKeyTagIntent": { "required": [ "privateKeyIds", "privateKeyTagName" @@ -3790,7 +5002,7 @@ } } }, - "CreatePrivateKeyTagRequest": { + "v1CreatePrivateKeyTagRequest": { "required": [ "organizationId", "parameters", @@ -3814,11 +5026,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreatePrivateKeyTagIntent" + "$ref": "#/components/schemas/v1CreatePrivateKeyTagIntent" } } }, - "CreatePrivateKeyTagResult": { + "v1CreatePrivateKeyTagResult": { "required": [ "privateKeyIds", "privateKeyTagId" @@ -3838,7 +5050,7 @@ } } }, - "CreatePrivateKeysIntent": { + "v1CreatePrivateKeysIntent": { "required": [ "privateKeys" ], @@ -3848,12 +5060,12 @@ "type": "array", "description": "A list of Private Keys.", "items": { - "$ref": "#/components/schemas/PrivateKeyParams" + "$ref": "#/components/schemas/v1PrivateKeyParams" } } } }, - "CreatePrivateKeysIntentV2": { + "v1CreatePrivateKeysIntentV2": { "required": [ "privateKeys" ], @@ -3863,12 +5075,12 @@ "type": "array", "description": "A list of Private Keys.", "items": { - "$ref": "#/components/schemas/PrivateKeyParams" + "$ref": "#/components/schemas/v1PrivateKeyParams" } } } }, - "CreatePrivateKeysRequest": { + "v1CreatePrivateKeysRequest": { "required": [ "organizationId", "parameters", @@ -3892,11 +5104,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreatePrivateKeysIntentV2" + "$ref": "#/components/schemas/v1CreatePrivateKeysIntentV2" } } }, - "CreatePrivateKeysResult": { + "v1CreatePrivateKeysResult": { "required": [ "privateKeyIds" ], @@ -3911,7 +5123,7 @@ } } }, - "CreatePrivateKeysResultV2": { + "v1CreatePrivateKeysResultV2": { "required": [ "privateKeys" ], @@ -3921,15 +5133,15 @@ "type": "array", "description": "A list of Private Key IDs and addresses.", "items": { - "$ref": "#/components/schemas/PrivateKeyResult" + "$ref": "#/components/schemas/v1PrivateKeyResult" } } } }, - "CreateReadOnlySessionIntent": { + "v1CreateReadOnlySessionIntent": { "type": "object" }, - "CreateReadOnlySessionRequest": { + "v1CreateReadOnlySessionRequest": { "required": [ "organizationId", "parameters", @@ -3953,11 +5165,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateReadOnlySessionIntent" + "$ref": "#/components/schemas/v1CreateReadOnlySessionIntent" } } }, - "CreateReadOnlySessionResult": { + "v1CreateReadOnlySessionResult": { "required": [ "organizationId", "organizationName", @@ -3995,7 +5207,7 @@ } } }, - "CreateReadWriteSessionIntent": { + "v1CreateReadWriteSessionIntent": { "required": [ "email", "targetPublicKey" @@ -4020,7 +5232,7 @@ } } }, - "CreateReadWriteSessionIntentV2": { + "v1CreateReadWriteSessionIntentV2": { "required": [ "targetPublicKey" ], @@ -4041,10 +5253,14 @@ "expirationSeconds": { "type": "string", "description": "Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used." + }, + "invalidateExisting": { + "type": "boolean", + "description": "Invalidate all other previously generated ReadWriteSession API keys" } } }, - "CreateReadWriteSessionRequest": { + "v1CreateReadWriteSessionRequest": { "required": [ "organizationId", "parameters", @@ -4068,11 +5284,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateReadWriteSessionIntentV2" + "$ref": "#/components/schemas/v1CreateReadWriteSessionIntentV2" } } }, - "CreateReadWriteSessionResult": { + "v1CreateReadWriteSessionResult": { "required": [ "apiKeyId", "credentialBundle", @@ -4109,7 +5325,7 @@ } } }, - "CreateReadWriteSessionResultV2": { + "v1CreateReadWriteSessionResultV2": { "required": [ "apiKeyId", "credentialBundle", @@ -4146,7 +5362,7 @@ } } }, - "CreateSubOrganizationIntent": { + "v1CreateSubOrganizationIntent": { "required": [ "name", "rootAuthenticator" @@ -4158,11 +5374,11 @@ "description": "Name for this sub-organization" }, "rootAuthenticator": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } } }, - "CreateSubOrganizationIntentV2": { + "v1CreateSubOrganizationIntentV2": { "required": [ "rootQuorumThreshold", "rootUsers", @@ -4178,7 +5394,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParams" + "$ref": "#/components/schemas/v1RootUserParams" } }, "rootQuorumThreshold": { @@ -4188,7 +5404,7 @@ } } }, - "CreateSubOrganizationIntentV3": { + "v1CreateSubOrganizationIntentV3": { "required": [ "privateKeys", "rootQuorumThreshold", @@ -4205,7 +5421,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParams" + "$ref": "#/components/schemas/v1RootUserParams" } }, "rootQuorumThreshold": { @@ -4217,12 +5433,12 @@ "type": "array", "description": "A list of Private Keys.", "items": { - "$ref": "#/components/schemas/PrivateKeyParams" + "$ref": "#/components/schemas/v1PrivateKeyParams" } } } }, - "CreateSubOrganizationIntentV4": { + "v1CreateSubOrganizationIntentV4": { "required": [ "rootQuorumThreshold", "rootUsers", @@ -4238,7 +5454,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParams" + "$ref": "#/components/schemas/v1RootUserParams" } }, "rootQuorumThreshold": { @@ -4247,7 +5463,7 @@ "format": "int32" }, "wallet": { - "$ref": "#/components/schemas/WalletParams" + "$ref": "#/components/schemas/v1WalletParams" }, "disableEmailRecovery": { "type": "boolean", @@ -4259,7 +5475,7 @@ } } }, - "CreateSubOrganizationIntentV5": { + "v1CreateSubOrganizationIntentV5": { "required": [ "rootQuorumThreshold", "rootUsers", @@ -4275,7 +5491,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParamsV2" + "$ref": "#/components/schemas/v1RootUserParamsV2" } }, "rootQuorumThreshold": { @@ -4284,7 +5500,7 @@ "format": "int32" }, "wallet": { - "$ref": "#/components/schemas/WalletParams" + "$ref": "#/components/schemas/v1WalletParams" }, "disableEmailRecovery": { "type": "boolean", @@ -4296,7 +5512,7 @@ } } }, - "CreateSubOrganizationIntentV6": { + "v1CreateSubOrganizationIntentV6": { "required": [ "rootQuorumThreshold", "rootUsers", @@ -4312,7 +5528,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParamsV3" + "$ref": "#/components/schemas/v1RootUserParamsV3" } }, "rootQuorumThreshold": { @@ -4321,7 +5537,7 @@ "format": "int32" }, "wallet": { - "$ref": "#/components/schemas/WalletParams" + "$ref": "#/components/schemas/v1WalletParams" }, "disableEmailRecovery": { "type": "boolean", @@ -4333,7 +5549,7 @@ } } }, - "CreateSubOrganizationIntentV7": { + "v1CreateSubOrganizationIntentV7": { "required": [ "rootQuorumThreshold", "rootUsers", @@ -4349,7 +5565,7 @@ "type": "array", "description": "Root users to create within this sub-organization", "items": { - "$ref": "#/components/schemas/RootUserParamsV4" + "$ref": "#/components/schemas/v1RootUserParamsV4" } }, "rootQuorumThreshold": { @@ -4358,7 +5574,7 @@ "format": "int32" }, "wallet": { - "$ref": "#/components/schemas/WalletParams" + "$ref": "#/components/schemas/v1WalletParams" }, "disableEmailRecovery": { "type": "boolean", @@ -4378,7 +5594,7 @@ } } }, - "CreateSubOrganizationRequest": { + "v1CreateSubOrganizationRequest": { "required": [ "organizationId", "parameters", @@ -4402,11 +5618,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV7" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV7" } } }, - "CreateSubOrganizationResult": { + "v1CreateSubOrganizationResult": { "required": [ "subOrganizationId" ], @@ -4423,7 +5639,7 @@ } } }, - "CreateSubOrganizationResultV3": { + "v1CreateSubOrganizationResultV3": { "required": [ "privateKeys", "subOrganizationId" @@ -4437,7 +5653,7 @@ "type": "array", "description": "A list of Private Key IDs and addresses.", "items": { - "$ref": "#/components/schemas/PrivateKeyResult" + "$ref": "#/components/schemas/v1PrivateKeyResult" } }, "rootUserIds": { @@ -4448,7 +5664,7 @@ } } }, - "CreateSubOrganizationResultV4": { + "v1CreateSubOrganizationResultV4": { "required": [ "subOrganizationId" ], @@ -4458,7 +5674,7 @@ "type": "string" }, "wallet": { - "$ref": "#/components/schemas/WalletResult" + "$ref": "#/components/schemas/v1WalletResult" }, "rootUserIds": { "type": "array", @@ -4468,7 +5684,7 @@ } } }, - "CreateSubOrganizationResultV5": { + "v1CreateSubOrganizationResultV5": { "required": [ "subOrganizationId" ], @@ -4478,7 +5694,7 @@ "type": "string" }, "wallet": { - "$ref": "#/components/schemas/WalletResult" + "$ref": "#/components/schemas/v1WalletResult" }, "rootUserIds": { "type": "array", @@ -4488,7 +5704,7 @@ } } }, - "CreateSubOrganizationResultV6": { + "v1CreateSubOrganizationResultV6": { "required": [ "subOrganizationId" ], @@ -4498,7 +5714,7 @@ "type": "string" }, "wallet": { - "$ref": "#/components/schemas/WalletResult" + "$ref": "#/components/schemas/v1WalletResult" }, "rootUserIds": { "type": "array", @@ -4508,7 +5724,7 @@ } } }, - "CreateSubOrganizationResultV7": { + "v1CreateSubOrganizationResultV7": { "required": [ "subOrganizationId" ], @@ -4518,7 +5734,7 @@ "type": "string" }, "wallet": { - "$ref": "#/components/schemas/WalletResult" + "$ref": "#/components/schemas/v1WalletResult" }, "rootUserIds": { "type": "array", @@ -4528,7 +5744,7 @@ } } }, - "CreateUserTagIntent": { + "v1CreateUserTagIntent": { "required": [ "userIds", "userTagName" @@ -4548,7 +5764,7 @@ } } }, - "CreateUserTagRequest": { + "v1CreateUserTagRequest": { "required": [ "organizationId", "parameters", @@ -4572,11 +5788,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateUserTagIntent" + "$ref": "#/components/schemas/v1CreateUserTagIntent" } } }, - "CreateUserTagResult": { + "v1CreateUserTagResult": { "required": [ "userIds", "userTagId" @@ -4596,7 +5812,22 @@ } } }, - "CreateUsersIntent": { + "v1CreateUsersIntent": { + "required": [ + "users" + ], + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "A list of Users.", + "items": { + "$ref": "#/components/schemas/v1UserParams" + } + } + } + }, + "v1CreateUsersIntentV2": { "required": [ "users" ], @@ -4606,12 +5837,12 @@ "type": "array", "description": "A list of Users.", "items": { - "$ref": "#/components/schemas/UserParams" + "$ref": "#/components/schemas/v1UserParamsV2" } } } }, - "CreateUsersIntentV2": { + "v1CreateUsersIntentV3": { "required": [ "users" ], @@ -4621,12 +5852,12 @@ "type": "array", "description": "A list of Users.", "items": { - "$ref": "#/components/schemas/UserParamsV2" + "$ref": "#/components/schemas/v1UserParamsV3" } } } }, - "CreateUsersRequest": { + "v1CreateUsersRequest": { "required": [ "organizationId", "parameters", @@ -4638,7 +5869,7 @@ "type": { "type": "string", "enum": [ - "ACTIVITY_TYPE_CREATE_USERS_V2" + "ACTIVITY_TYPE_CREATE_USERS_V3" ] }, "timestampMs": { @@ -4650,11 +5881,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateUsersIntentV2" + "$ref": "#/components/schemas/v1CreateUsersIntentV3" } } }, - "CreateUsersResult": { + "v1CreateUsersResult": { "required": [ "userIds" ], @@ -4669,7 +5900,7 @@ } } }, - "CreateWalletAccountsIntent": { + "v1CreateWalletAccountsIntent": { "required": [ "accounts", "walletId" @@ -4684,12 +5915,12 @@ "type": "array", "description": "A list of wallet Accounts.", "items": { - "$ref": "#/components/schemas/WalletAccountParams" + "$ref": "#/components/schemas/v1WalletAccountParams" } } } }, - "CreateWalletAccountsRequest": { + "v1CreateWalletAccountsRequest": { "required": [ "organizationId", "parameters", @@ -4713,11 +5944,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateWalletAccountsIntent" + "$ref": "#/components/schemas/v1CreateWalletAccountsIntent" } } }, - "CreateWalletAccountsResult": { + "v1CreateWalletAccountsResult": { "required": [ "addresses" ], @@ -4732,7 +5963,7 @@ } } }, - "CreateWalletIntent": { + "v1CreateWalletIntent": { "required": [ "accounts", "walletName" @@ -4747,7 +5978,7 @@ "type": "array", "description": "A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/WalletAccountParams" + "$ref": "#/components/schemas/v1WalletAccountParams" } }, "mnemonicLength": { @@ -4757,7 +5988,7 @@ } } }, - "CreateWalletRequest": { + "v1CreateWalletRequest": { "required": [ "organizationId", "parameters", @@ -4781,11 +6012,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/CreateWalletIntent" + "$ref": "#/components/schemas/v1CreateWalletIntent" } } }, - "CreateWalletResult": { + "v1CreateWalletResult": { "required": [ "addresses", "walletId" @@ -4805,7 +6036,7 @@ } } }, - "CredPropsAuthenticationExtensionsClientOutputs": { + "v1CredPropsAuthenticationExtensionsClientOutputs": { "required": [ "rk" ], @@ -4816,7 +6047,7 @@ } } }, - "CredentialType": { + "v1CredentialType": { "type": "string", "enum": [ "CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR", @@ -4825,17 +6056,19 @@ "CREDENTIAL_TYPE_API_KEY_SECP256K1", "CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256", "CREDENTIAL_TYPE_API_KEY_ED25519", - "CREDENTIAL_TYPE_OTP_AUTH_KEY_P256" + "CREDENTIAL_TYPE_OTP_AUTH_KEY_P256", + "CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256", + "CREDENTIAL_TYPE_OAUTH_KEY_P256" ] }, - "Curve": { + "v1Curve": { "type": "string", "enum": [ "CURVE_SECP256K1", "CURVE_ED25519" ] }, - "DeleteApiKeysIntent": { + "v1DeleteApiKeysIntent": { "required": [ "apiKeyIds", "userId" @@ -4855,7 +6088,7 @@ } } }, - "DeleteApiKeysRequest": { + "v1DeleteApiKeysRequest": { "required": [ "organizationId", "parameters", @@ -4879,11 +6112,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteApiKeysIntent" + "$ref": "#/components/schemas/v1DeleteApiKeysIntent" } } }, - "DeleteApiKeysResult": { + "v1DeleteApiKeysResult": { "required": [ "apiKeyIds" ], @@ -4898,7 +6131,7 @@ } } }, - "DeleteAuthenticatorsIntent": { + "v1DeleteAuthenticatorsIntent": { "required": [ "authenticatorIds", "userId" @@ -4918,7 +6151,7 @@ } } }, - "DeleteAuthenticatorsRequest": { + "v1DeleteAuthenticatorsRequest": { "required": [ "organizationId", "parameters", @@ -4942,11 +6175,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteAuthenticatorsIntent" + "$ref": "#/components/schemas/v1DeleteAuthenticatorsIntent" } } }, - "DeleteAuthenticatorsResult": { + "v1DeleteAuthenticatorsResult": { "required": [ "authenticatorIds" ], @@ -4961,7 +6194,7 @@ } } }, - "DeleteInvitationIntent": { + "v1DeleteInvitationIntent": { "required": [ "invitationId" ], @@ -4973,7 +6206,7 @@ } } }, - "DeleteInvitationRequest": { + "v1DeleteInvitationRequest": { "required": [ "organizationId", "parameters", @@ -4997,11 +6230,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteInvitationIntent" + "$ref": "#/components/schemas/v1DeleteInvitationIntent" } } }, - "DeleteInvitationResult": { + "v1DeleteInvitationResult": { "required": [ "invitationId" ], @@ -5013,7 +6246,7 @@ } } }, - "DeleteOauthProvidersIntent": { + "v1DeleteOauthProvidersIntent": { "required": [ "providerIds", "userId" @@ -5033,7 +6266,7 @@ } } }, - "DeleteOauthProvidersRequest": { + "v1DeleteOauthProvidersRequest": { "required": [ "organizationId", "parameters", @@ -5057,11 +6290,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteOauthProvidersIntent" + "$ref": "#/components/schemas/v1DeleteOauthProvidersIntent" } } }, - "DeleteOauthProvidersResult": { + "v1DeleteOauthProvidersResult": { "required": [ "providerIds" ], @@ -5076,7 +6309,7 @@ } } }, - "DeleteOrganizationIntent": { + "v1DeleteOrganizationIntent": { "required": [ "organizationId" ], @@ -5088,7 +6321,7 @@ } } }, - "DeleteOrganizationResult": { + "v1DeleteOrganizationResult": { "required": [ "organizationId" ], @@ -5100,31 +6333,7 @@ } } }, - "DeletePaymentMethodIntent": { - "required": [ - "paymentMethodId" - ], - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string", - "description": "The payment method that the customer wants to remove." - } - } - }, - "DeletePaymentMethodResult": { - "required": [ - "paymentMethodId" - ], - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string", - "description": "The payment method that was removed." - } - } - }, - "DeletePolicyIntent": { + "v1DeletePolicyIntent": { "required": [ "policyId" ], @@ -5136,7 +6345,7 @@ } } }, - "DeletePolicyRequest": { + "v1DeletePolicyRequest": { "required": [ "organizationId", "parameters", @@ -5160,11 +6369,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeletePolicyIntent" + "$ref": "#/components/schemas/v1DeletePolicyIntent" } } }, - "DeletePolicyResult": { + "v1DeletePolicyResult": { "required": [ "policyId" ], @@ -5176,7 +6385,7 @@ } } }, - "DeletePrivateKeyTagsIntent": { + "v1DeletePrivateKeyTagsIntent": { "required": [ "privateKeyTagIds" ], @@ -5191,7 +6400,7 @@ } } }, - "DeletePrivateKeyTagsRequest": { + "v1DeletePrivateKeyTagsRequest": { "required": [ "organizationId", "parameters", @@ -5215,11 +6424,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeletePrivateKeyTagsIntent" + "$ref": "#/components/schemas/v1DeletePrivateKeyTagsIntent" } } }, - "DeletePrivateKeyTagsResult": { + "v1DeletePrivateKeyTagsResult": { "required": [ "privateKeyIds", "privateKeyTagIds" @@ -5242,7 +6451,7 @@ } } }, - "DeletePrivateKeysIntent": { + "v1DeletePrivateKeysIntent": { "required": [ "privateKeyIds" ], @@ -5261,7 +6470,7 @@ } } }, - "DeletePrivateKeysRequest": { + "v1DeletePrivateKeysRequest": { "required": [ "organizationId", "parameters", @@ -5285,11 +6494,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeletePrivateKeysIntent" + "$ref": "#/components/schemas/v1DeletePrivateKeysIntent" } } }, - "DeletePrivateKeysResult": { + "v1DeletePrivateKeysResult": { "required": [ "privateKeyIds" ], @@ -5304,7 +6513,7 @@ } } }, - "DeleteSubOrganizationIntent": { + "v1DeleteSubOrganizationIntent": { "type": "object", "properties": { "deleteWithoutExport": { @@ -5313,7 +6522,7 @@ } } }, - "DeleteSubOrganizationRequest": { + "v1DeleteSubOrganizationRequest": { "required": [ "organizationId", "parameters", @@ -5337,11 +6546,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteSubOrganizationIntent" + "$ref": "#/components/schemas/v1DeleteSubOrganizationIntent" } } }, - "DeleteSubOrganizationResult": { + "v1DeleteSubOrganizationResult": { "required": [ "subOrganizationUuid" ], @@ -5353,7 +6562,7 @@ } } }, - "DeleteUserTagsIntent": { + "v1DeleteUserTagsIntent": { "required": [ "userTagIds" ], @@ -5368,7 +6577,7 @@ } } }, - "DeleteUserTagsRequest": { + "v1DeleteUserTagsRequest": { "required": [ "organizationId", "parameters", @@ -5392,11 +6601,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteUserTagsIntent" + "$ref": "#/components/schemas/v1DeleteUserTagsIntent" } } }, - "DeleteUserTagsResult": { + "v1DeleteUserTagsResult": { "required": [ "userIds", "userTagIds" @@ -5419,7 +6628,7 @@ } } }, - "DeleteUsersIntent": { + "v1DeleteUsersIntent": { "required": [ "userIds" ], @@ -5434,7 +6643,7 @@ } } }, - "DeleteUsersRequest": { + "v1DeleteUsersRequest": { "required": [ "organizationId", "parameters", @@ -5458,11 +6667,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteUsersIntent" + "$ref": "#/components/schemas/v1DeleteUsersIntent" } } }, - "DeleteUsersResult": { + "v1DeleteUsersResult": { "required": [ "userIds" ], @@ -5477,7 +6686,7 @@ } } }, - "DeleteWalletsIntent": { + "v1DeleteWalletsIntent": { "required": [ "walletIds" ], @@ -5496,7 +6705,7 @@ } } }, - "DeleteWalletsRequest": { + "v1DeleteWalletsRequest": { "required": [ "organizationId", "parameters", @@ -5520,11 +6729,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/DeleteWalletsIntent" + "$ref": "#/components/schemas/v1DeleteWalletsIntent" } } }, - "DeleteWalletsResult": { + "v1DeleteWalletsResult": { "required": [ "walletIds" ], @@ -5539,7 +6748,7 @@ } } }, - "DisablePrivateKeyIntent": { + "v1DisablePrivateKeyIntent": { "required": [ "privateKeyId" ], @@ -5551,7 +6760,7 @@ } } }, - "DisablePrivateKeyResult": { + "v1DisablePrivateKeyResult": { "required": [ "privateKeyId" ], @@ -5563,14 +6772,14 @@ } } }, - "Effect": { + "v1Effect": { "type": "string", "enum": [ "EFFECT_ALLOW", "EFFECT_DENY" ] }, - "EmailAuthIntent": { + "v1EmailAuthIntent": { "required": [ "email", "targetPublicKey" @@ -5594,7 +6803,7 @@ "description": "Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used." }, "emailCustomization": { - "$ref": "#/components/schemas/EmailCustomizationParams" + "$ref": "#/components/schemas/v1EmailCustomizationParams" }, "invalidateExisting": { "type": "boolean", @@ -5603,10 +6812,14 @@ "sendFromEmailAddress": { "type": "string", "description": "Optional custom email address from which to send the email" + }, + "sendFromEmailSenderName": { + "type": "string", + "description": "Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'" } } }, - "EmailAuthIntentV2": { + "v1EmailAuthIntentV2": { "required": [ "email", "targetPublicKey" @@ -5630,7 +6843,7 @@ "description": "Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used." }, "emailCustomization": { - "$ref": "#/components/schemas/EmailCustomizationParams" + "$ref": "#/components/schemas/v1EmailCustomizationParams" }, "invalidateExisting": { "type": "boolean", @@ -5639,10 +6852,14 @@ "sendFromEmailAddress": { "type": "string", "description": "Optional custom email address from which to send the email" + }, + "sendFromEmailSenderName": { + "type": "string", + "description": "Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'" } } }, - "EmailAuthRequest": { + "v1EmailAuthRequest": { "required": [ "organizationId", "parameters", @@ -5666,11 +6883,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/EmailAuthIntentV2" + "$ref": "#/components/schemas/v1EmailAuthIntentV2" } } }, - "EmailAuthResult": { + "v1EmailAuthResult": { "required": [ "apiKeyId", "userId" @@ -5687,7 +6904,7 @@ } } }, - "EmailCustomizationParams": { + "v1EmailCustomizationParams": { "type": "object", "properties": { "appName": { @@ -5712,7 +6929,7 @@ } } }, - "ExportPrivateKeyIntent": { + "v1ExportPrivateKeyIntent": { "required": [ "privateKeyId", "targetPublicKey" @@ -5729,7 +6946,7 @@ } } }, - "ExportPrivateKeyRequest": { + "v1ExportPrivateKeyRequest": { "required": [ "organizationId", "parameters", @@ -5753,11 +6970,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ExportPrivateKeyIntent" + "$ref": "#/components/schemas/v1ExportPrivateKeyIntent" } } }, - "ExportPrivateKeyResult": { + "v1ExportPrivateKeyResult": { "required": [ "exportBundle", "privateKeyId" @@ -5774,7 +6991,7 @@ } } }, - "ExportWalletAccountIntent": { + "v1ExportWalletAccountIntent": { "required": [ "address", "targetPublicKey" @@ -5791,7 +7008,7 @@ } } }, - "ExportWalletAccountRequest": { + "v1ExportWalletAccountRequest": { "required": [ "organizationId", "parameters", @@ -5815,11 +7032,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ExportWalletAccountIntent" + "$ref": "#/components/schemas/v1ExportWalletAccountIntent" } } }, - "ExportWalletAccountResult": { + "v1ExportWalletAccountResult": { "required": [ "address", "exportBundle" @@ -5836,7 +7053,7 @@ } } }, - "ExportWalletIntent": { + "v1ExportWalletIntent": { "required": [ "targetPublicKey", "walletId" @@ -5852,11 +7069,11 @@ "description": "Client-side public key generated by the user, to which the export bundle will be encrypted." }, "language": { - "$ref": "#/components/schemas/MnemonicLanguage" + "$ref": "#/components/schemas/v1MnemonicLanguage" } } }, - "ExportWalletRequest": { + "v1ExportWalletRequest": { "required": [ "organizationId", "parameters", @@ -5880,11 +7097,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ExportWalletIntent" + "$ref": "#/components/schemas/v1ExportWalletIntent" } } }, - "ExportWalletResult": { + "v1ExportWalletResult": { "required": [ "exportBundle", "walletId" @@ -5901,18 +7118,18 @@ } } }, - "Feature": { + "v1Feature": { "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/FeatureName" + "$ref": "#/components/schemas/v1FeatureName" }, "value": { "type": "string" } } }, - "FeatureName": { + "v1FeatureName": { "type": "string", "enum": [ "FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY", @@ -5924,7 +7141,7 @@ "FEATURE_NAME_OTP_EMAIL_AUTH" ] }, - "GetActivitiesRequest": { + "v1GetActivitiesRequest": { "required": [ "organizationId" ], @@ -5938,22 +7155,22 @@ "type": "array", "description": "Array of Activity Statuses filtering which Activities will be listed in the response.", "items": { - "$ref": "#/components/schemas/ActivityStatus" + "$ref": "#/components/schemas/v1ActivityStatus" } }, "paginationOptions": { - "$ref": "#/components/schemas/Pagination" + "$ref": "#/components/schemas/v1Pagination" }, "filterByType": { "type": "array", "description": "Array of Activity Types filtering which Activities will be listed in the response.", "items": { - "$ref": "#/components/schemas/ActivityType" + "$ref": "#/components/schemas/v1ActivityType" } } } }, - "GetActivitiesResponse": { + "v1GetActivitiesResponse": { "required": [ "activities" ], @@ -5963,12 +7180,12 @@ "type": "array", "description": "A list of Activities.", "items": { - "$ref": "#/components/schemas/Activity" + "$ref": "#/components/schemas/v1Activity" } } } }, - "GetActivityRequest": { + "v1GetActivityRequest": { "required": [ "activityId", "organizationId" @@ -5985,7 +7202,7 @@ } } }, - "GetApiKeyRequest": { + "v1GetApiKeyRequest": { "required": [ "apiKeyId", "organizationId" @@ -6002,18 +7219,18 @@ } } }, - "GetApiKeyResponse": { + "v1GetApiKeyResponse": { "required": [ "apiKey" ], "type": "object", "properties": { "apiKey": { - "$ref": "#/components/schemas/ApiKey" + "$ref": "#/components/schemas/v1ApiKey" } } }, - "GetApiKeysRequest": { + "v1GetApiKeysRequest": { "required": [ "organizationId" ], @@ -6029,7 +7246,7 @@ } } }, - "GetApiKeysResponse": { + "v1GetApiKeysResponse": { "required": [ "apiKeys" ], @@ -6039,12 +7256,43 @@ "type": "array", "description": "A list of API keys.", "items": { - "$ref": "#/components/schemas/ApiKey" + "$ref": "#/components/schemas/v1ApiKey" } } } }, - "GetAuthenticatorRequest": { + "v1GetAttestationDocumentRequest": { + "required": [ + "enclaveType", + "organizationId" + ], + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Unique identifier for a given Organization." + }, + "enclaveType": { + "type": "string", + "description": "The enclave type, one of: ump, notarizer, signer, evm-parser" + } + } + }, + "v1GetAttestationDocumentResponse": { + "required": [ + "attestationDocument" + ], + "type": "object", + "properties": { + "attestationDocument": { + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string", + "description": "Raw (CBOR-encoded) attestation document", + "format": "byte" + } + } + }, + "v1GetAuthenticatorRequest": { "required": [ "authenticatorId", "organizationId" @@ -6061,18 +7309,18 @@ } } }, - "GetAuthenticatorResponse": { + "v1GetAuthenticatorResponse": { "required": [ "authenticator" ], "type": "object", "properties": { "authenticator": { - "$ref": "#/components/schemas/Authenticator" + "$ref": "#/components/schemas/v1Authenticator" } } }, - "GetAuthenticatorsRequest": { + "v1GetAuthenticatorsRequest": { "required": [ "organizationId", "userId" @@ -6089,7 +7337,7 @@ } } }, - "GetAuthenticatorsResponse": { + "v1GetAuthenticatorsResponse": { "required": [ "authenticators" ], @@ -6099,12 +7347,12 @@ "type": "array", "description": "A list of authenticators.", "items": { - "$ref": "#/components/schemas/Authenticator" + "$ref": "#/components/schemas/v1Authenticator" } } } }, - "GetOauthProvidersRequest": { + "v1GetOauthProvidersRequest": { "required": [ "organizationId" ], @@ -6120,7 +7368,7 @@ } } }, - "GetOauthProvidersResponse": { + "v1GetOauthProvidersResponse": { "required": [ "oauthProviders" ], @@ -6130,12 +7378,12 @@ "type": "array", "description": "A list of Oauth Providers", "items": { - "$ref": "#/components/schemas/OauthProvider" + "$ref": "#/components/schemas/v1OauthProvider" } } } }, - "GetOrganizationConfigsRequest": { + "v1GetOrganizationConfigsRequest": { "required": [ "organizationId" ], @@ -6147,18 +7395,41 @@ } } }, - "GetOrganizationConfigsResponse": { + "v1GetOrganizationConfigsResponse": { "required": [ "configs" ], "type": "object", "properties": { "configs": { - "$ref": "#/components/schemas/Config" + "$ref": "#/components/schemas/v1Config" + } + } + }, + "v1GetOrganizationRequest": { + "required": [ + "organizationId" + ], + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Unique identifier for a given Organization." + } + } + }, + "v1GetOrganizationResponse": { + "required": [ + "organizationData" + ], + "type": "object", + "properties": { + "organizationData": { + "$ref": "#/components/schemas/v1OrganizationData" } } }, - "GetPoliciesRequest": { + "v1GetPoliciesRequest": { "required": [ "organizationId" ], @@ -6170,7 +7441,7 @@ } } }, - "GetPoliciesResponse": { + "v1GetPoliciesResponse": { "required": [ "policies" ], @@ -6180,12 +7451,12 @@ "type": "array", "description": "A list of Policies.", "items": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/v1Policy" } } } }, - "GetPolicyRequest": { + "v1GetPolicyRequest": { "required": [ "organizationId", "policyId" @@ -6202,18 +7473,18 @@ } } }, - "GetPolicyResponse": { + "v1GetPolicyResponse": { "required": [ "policy" ], "type": "object", "properties": { "policy": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/v1Policy" } } }, - "GetPrivateKeyRequest": { + "v1GetPrivateKeyRequest": { "required": [ "organizationId", "privateKeyId" @@ -6230,18 +7501,18 @@ } } }, - "GetPrivateKeyResponse": { + "v1GetPrivateKeyResponse": { "required": [ "privateKey" ], "type": "object", "properties": { "privateKey": { - "$ref": "#/components/schemas/PrivateKey" + "$ref": "#/components/schemas/v1PrivateKey" } } }, - "GetPrivateKeysRequest": { + "v1GetPrivateKeysRequest": { "required": [ "organizationId" ], @@ -6253,7 +7524,7 @@ } } }, - "GetPrivateKeysResponse": { + "v1GetPrivateKeysResponse": { "required": [ "privateKeys" ], @@ -6263,12 +7534,12 @@ "type": "array", "description": "A list of Private Keys.", "items": { - "$ref": "#/components/schemas/PrivateKey" + "$ref": "#/components/schemas/v1PrivateKey" } } } }, - "GetSubOrgIdsRequest": { + "v1GetSubOrgIdsRequest": { "required": [ "organizationId" ], @@ -6287,11 +7558,11 @@ "description": "The value of the filter to apply for the specified type. For example, a specific email or name string." }, "paginationOptions": { - "$ref": "#/components/schemas/Pagination" + "$ref": "#/components/schemas/v1Pagination" } } }, - "GetSubOrgIdsResponse": { + "v1GetSubOrgIdsResponse": { "required": [ "organizationIds" ], @@ -6306,7 +7577,7 @@ } } }, - "GetUserRequest": { + "v1GetUserRequest": { "required": [ "organizationId", "userId" @@ -6323,18 +7594,18 @@ } } }, - "GetUserResponse": { + "v1GetUserResponse": { "required": [ "user" ], "type": "object", "properties": { "user": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/v1User" } } }, - "GetUsersRequest": { + "v1GetUsersRequest": { "required": [ "organizationId" ], @@ -6346,7 +7617,7 @@ } } }, - "GetUsersResponse": { + "v1GetUsersResponse": { "required": [ "users" ], @@ -6356,12 +7627,12 @@ "type": "array", "description": "A list of Users.", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/v1User" } } } }, - "GetVerifiedSubOrgIdsRequest": { + "v1GetVerifiedSubOrgIdsRequest": { "required": [ "organizationId" ], @@ -6380,11 +7651,11 @@ "description": "The value of the filter to apply for the specified type. For example, a specific email or phone number string." }, "paginationOptions": { - "$ref": "#/components/schemas/Pagination" + "$ref": "#/components/schemas/v1Pagination" } } }, - "GetVerifiedSubOrgIdsResponse": { + "v1GetVerifiedSubOrgIdsResponse": { "required": [ "organizationIds" ], @@ -6399,7 +7670,7 @@ } } }, - "GetWalletAccountRequest": { + "v1GetWalletAccountRequest": { "required": [ "organizationId", "walletId" @@ -6424,18 +7695,18 @@ } } }, - "GetWalletAccountResponse": { + "v1GetWalletAccountResponse": { "required": [ "account" ], "type": "object", "properties": { "account": { - "$ref": "#/components/schemas/WalletAccount" + "$ref": "#/components/schemas/v1WalletAccount" } } }, - "GetWalletAccountsRequest": { + "v1GetWalletAccountsRequest": { "required": [ "organizationId", "walletId" @@ -6451,11 +7722,11 @@ "description": "Unique identifier for a given Wallet." }, "paginationOptions": { - "$ref": "#/components/schemas/Pagination" + "$ref": "#/components/schemas/v1Pagination" } } }, - "GetWalletAccountsResponse": { + "v1GetWalletAccountsResponse": { "required": [ "accounts" ], @@ -6465,12 +7736,12 @@ "type": "array", "description": "A list of Accounts generated from a Wallet that share a common seed.", "items": { - "$ref": "#/components/schemas/WalletAccount" + "$ref": "#/components/schemas/v1WalletAccount" } } } }, - "GetWalletRequest": { + "v1GetWalletRequest": { "required": [ "organizationId", "walletId" @@ -6487,18 +7758,18 @@ } } }, - "GetWalletResponse": { + "v1GetWalletResponse": { "required": [ "wallet" ], "type": "object", "properties": { "wallet": { - "$ref": "#/components/schemas/Wallet" + "$ref": "#/components/schemas/v1Wallet" } } }, - "GetWalletsRequest": { + "v1GetWalletsRequest": { "required": [ "organizationId" ], @@ -6510,7 +7781,7 @@ } } }, - "GetWalletsResponse": { + "v1GetWalletsResponse": { "required": [ "wallets" ], @@ -6520,12 +7791,12 @@ "type": "array", "description": "A list of Wallets.", "items": { - "$ref": "#/components/schemas/Wallet" + "$ref": "#/components/schemas/v1Wallet" } } } }, - "GetWhoamiRequest": { + "v1GetWhoamiRequest": { "required": [ "organizationId" ], @@ -6537,7 +7808,7 @@ } } }, - "GetWhoamiResponse": { + "v1GetWhoamiResponse": { "required": [ "organizationId", "organizationName", @@ -6564,7 +7835,7 @@ } } }, - "HashFunction": { + "v1HashFunction": { "type": "string", "enum": [ "HASH_FUNCTION_NO_OP", @@ -6573,7 +7844,7 @@ "HASH_FUNCTION_NOT_APPLICABLE" ] }, - "ImportPrivateKeyIntent": { + "v1ImportPrivateKeyIntent": { "required": [ "addressFormats", "curve", @@ -6596,18 +7867,18 @@ "description": "Bundle containing a raw private key encrypted to the enclave's target public key." }, "curve": { - "$ref": "#/components/schemas/Curve" + "$ref": "#/components/schemas/v1Curve" }, "addressFormats": { "type": "array", "description": "Cryptocurrency-specific formats for a derived address (e.g., Ethereum).", "items": { - "$ref": "#/components/schemas/AddressFormat" + "$ref": "#/components/schemas/v1AddressFormat" } } } }, - "ImportPrivateKeyRequest": { + "v1ImportPrivateKeyRequest": { "required": [ "organizationId", "parameters", @@ -6631,11 +7902,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ImportPrivateKeyIntent" + "$ref": "#/components/schemas/v1ImportPrivateKeyIntent" } } }, - "ImportPrivateKeyResult": { + "v1ImportPrivateKeyResult": { "required": [ "addresses", "privateKeyId" @@ -6650,12 +7921,12 @@ "type": "array", "description": "A list of addresses.", "items": { - "$ref": "#/components/schemas/activity.v1.Address" + "$ref": "#/components/schemas/immutableactivityv1Address" } } } }, - "ImportWalletIntent": { + "v1ImportWalletIntent": { "required": [ "accounts", "encryptedBundle", @@ -6680,12 +7951,12 @@ "type": "array", "description": "A list of wallet Accounts.", "items": { - "$ref": "#/components/schemas/WalletAccountParams" + "$ref": "#/components/schemas/v1WalletAccountParams" } } } }, - "ImportWalletRequest": { + "v1ImportWalletRequest": { "required": [ "organizationId", "parameters", @@ -6709,11 +7980,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/ImportWalletIntent" + "$ref": "#/components/schemas/v1ImportWalletIntent" } } }, - "ImportWalletResult": { + "v1ImportWalletResult": { "required": [ "addresses", "walletId" @@ -6733,7 +8004,7 @@ } } }, - "InitImportPrivateKeyIntent": { + "v1InitImportPrivateKeyIntent": { "required": [ "userId" ], @@ -6745,7 +8016,7 @@ } } }, - "InitImportPrivateKeyRequest": { + "v1InitImportPrivateKeyRequest": { "required": [ "organizationId", "parameters", @@ -6769,11 +8040,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/InitImportPrivateKeyIntent" + "$ref": "#/components/schemas/v1InitImportPrivateKeyIntent" } } }, - "InitImportPrivateKeyResult": { + "v1InitImportPrivateKeyResult": { "required": [ "importBundle" ], @@ -6785,7 +8056,7 @@ } } }, - "InitImportWalletIntent": { + "v1InitImportWalletIntent": { "required": [ "userId" ], @@ -6797,7 +8068,7 @@ } } }, - "InitImportWalletRequest": { + "v1InitImportWalletRequest": { "required": [ "organizationId", "parameters", @@ -6821,11 +8092,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/InitImportWalletIntent" + "$ref": "#/components/schemas/v1InitImportWalletIntent" } } }, - "InitImportWalletResult": { + "v1InitImportWalletResult": { "required": [ "importBundle" ], @@ -6837,7 +8108,42 @@ } } }, - "InitOtpAuthIntent": { + "v1InitOtpAuthIntent": { + "required": [ + "contact", + "otpType" + ], + "type": "object", + "properties": { + "otpType": { + "type": "string", + "description": "Enum to specifiy whether to send OTP via SMS or email" + }, + "contact": { + "type": "string", + "description": "Email or phone number to send the OTP code to" + }, + "emailCustomization": { + "$ref": "#/components/schemas/v1EmailCustomizationParams" + }, + "smsCustomization": { + "$ref": "#/components/schemas/v1SmsCustomizationParams" + }, + "userIdentifier": { + "type": "string", + "description": "Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address." + }, + "sendFromEmailAddress": { + "type": "string", + "description": "Optional custom email address from which to send the OTP email" + }, + "sendFromEmailSenderName": { + "type": "string", + "description": "Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'" + } + } + }, + "v1InitOtpAuthIntentV2": { "required": [ "contact", "otpType" @@ -6852,11 +8158,16 @@ "type": "string", "description": "Email or phone number to send the OTP code to" }, + "otpLength": { + "type": "integer", + "description": "Optional length of the OTP code. Default = 9", + "format": "int32" + }, "emailCustomization": { - "$ref": "#/components/schemas/EmailCustomizationParams" + "$ref": "#/components/schemas/v1EmailCustomizationParams" }, "smsCustomization": { - "$ref": "#/components/schemas/SmsCustomizationParams" + "$ref": "#/components/schemas/v1SmsCustomizationParams" }, "userIdentifier": { "type": "string", @@ -6865,10 +8176,18 @@ "sendFromEmailAddress": { "type": "string", "description": "Optional custom email address from which to send the OTP email" + }, + "alphanumeric": { + "type": "boolean", + "description": "Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true" + }, + "sendFromEmailSenderName": { + "type": "string", + "description": "Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'" } } }, - "InitOtpAuthRequest": { + "v1InitOtpAuthRequest": { "required": [ "organizationId", "parameters", @@ -6880,7 +8199,7 @@ "type": { "type": "string", "enum": [ - "ACTIVITY_TYPE_INIT_OTP_AUTH" + "ACTIVITY_TYPE_INIT_OTP_AUTH_V2" ] }, "timestampMs": { @@ -6892,11 +8211,23 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/InitOtpAuthIntent" + "$ref": "#/components/schemas/v1InitOtpAuthIntentV2" + } + } + }, + "v1InitOtpAuthResult": { + "required": [ + "otpId" + ], + "type": "object", + "properties": { + "otpId": { + "type": "string", + "description": "Unique identifier for an OTP authentication" } } }, - "InitOtpAuthResult": { + "v1InitOtpAuthResultV2": { "required": [ "otpId" ], @@ -6908,7 +8239,7 @@ } } }, - "InitUserEmailRecoveryIntent": { + "v1InitUserEmailRecoveryIntent": { "required": [ "email", "targetPublicKey" @@ -6928,11 +8259,11 @@ "description": "Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used." }, "emailCustomization": { - "$ref": "#/components/schemas/EmailCustomizationParams" + "$ref": "#/components/schemas/v1EmailCustomizationParams" } } }, - "InitUserEmailRecoveryRequest": { + "v1InitUserEmailRecoveryRequest": { "required": [ "organizationId", "parameters", @@ -6956,11 +8287,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/InitUserEmailRecoveryIntent" + "$ref": "#/components/schemas/v1InitUserEmailRecoveryIntent" } } }, - "InitUserEmailRecoveryResult": { + "v1InitUserEmailRecoveryResult": { "required": [ "userId" ], @@ -6972,252 +8303,312 @@ } } }, - "Intent": { + "v1Intent": { "type": "object", "properties": { "createOrganizationIntent": { - "$ref": "#/components/schemas/CreateOrganizationIntent" + "$ref": "#/components/schemas/v1CreateOrganizationIntent" }, "createAuthenticatorsIntent": { - "$ref": "#/components/schemas/CreateAuthenticatorsIntent" + "$ref": "#/components/schemas/v1CreateAuthenticatorsIntent" }, "createUsersIntent": { - "$ref": "#/components/schemas/CreateUsersIntent" + "$ref": "#/components/schemas/v1CreateUsersIntent" }, "createPrivateKeysIntent": { - "$ref": "#/components/schemas/CreatePrivateKeysIntent" + "$ref": "#/components/schemas/v1CreatePrivateKeysIntent" }, "signRawPayloadIntent": { - "$ref": "#/components/schemas/SignRawPayloadIntent" + "$ref": "#/components/schemas/v1SignRawPayloadIntent" }, "createInvitationsIntent": { - "$ref": "#/components/schemas/CreateInvitationsIntent" + "$ref": "#/components/schemas/v1CreateInvitationsIntent" }, "acceptInvitationIntent": { - "$ref": "#/components/schemas/AcceptInvitationIntent" + "$ref": "#/components/schemas/v1AcceptInvitationIntent" }, "createPolicyIntent": { - "$ref": "#/components/schemas/CreatePolicyIntent" + "$ref": "#/components/schemas/v1CreatePolicyIntent" }, "disablePrivateKeyIntent": { - "$ref": "#/components/schemas/DisablePrivateKeyIntent" + "$ref": "#/components/schemas/v1DisablePrivateKeyIntent" }, "deleteUsersIntent": { - "$ref": "#/components/schemas/DeleteUsersIntent" + "$ref": "#/components/schemas/v1DeleteUsersIntent" }, "deleteAuthenticatorsIntent": { - "$ref": "#/components/schemas/DeleteAuthenticatorsIntent" + "$ref": "#/components/schemas/v1DeleteAuthenticatorsIntent" }, "deleteInvitationIntent": { - "$ref": "#/components/schemas/DeleteInvitationIntent" + "$ref": "#/components/schemas/v1DeleteInvitationIntent" }, "deleteOrganizationIntent": { - "$ref": "#/components/schemas/DeleteOrganizationIntent" + "$ref": "#/components/schemas/v1DeleteOrganizationIntent" }, "deletePolicyIntent": { - "$ref": "#/components/schemas/DeletePolicyIntent" + "$ref": "#/components/schemas/v1DeletePolicyIntent" }, "createUserTagIntent": { - "$ref": "#/components/schemas/CreateUserTagIntent" + "$ref": "#/components/schemas/v1CreateUserTagIntent" }, "deleteUserTagsIntent": { - "$ref": "#/components/schemas/DeleteUserTagsIntent" + "$ref": "#/components/schemas/v1DeleteUserTagsIntent" }, "signTransactionIntent": { - "$ref": "#/components/schemas/SignTransactionIntent" + "$ref": "#/components/schemas/v1SignTransactionIntent" }, "createApiKeysIntent": { - "$ref": "#/components/schemas/CreateApiKeysIntent" + "$ref": "#/components/schemas/v1CreateApiKeysIntent" }, "deleteApiKeysIntent": { - "$ref": "#/components/schemas/DeleteApiKeysIntent" + "$ref": "#/components/schemas/v1DeleteApiKeysIntent" }, "approveActivityIntent": { - "$ref": "#/components/schemas/ApproveActivityIntent" + "$ref": "#/components/schemas/v1ApproveActivityIntent" }, "rejectActivityIntent": { - "$ref": "#/components/schemas/RejectActivityIntent" + "$ref": "#/components/schemas/v1RejectActivityIntent" }, "createPrivateKeyTagIntent": { - "$ref": "#/components/schemas/CreatePrivateKeyTagIntent" + "$ref": "#/components/schemas/v1CreatePrivateKeyTagIntent" }, "deletePrivateKeyTagsIntent": { - "$ref": "#/components/schemas/DeletePrivateKeyTagsIntent" + "$ref": "#/components/schemas/v1DeletePrivateKeyTagsIntent" }, "createPolicyIntentV2": { - "$ref": "#/components/schemas/CreatePolicyIntentV2" + "$ref": "#/components/schemas/v1CreatePolicyIntentV2" }, "setPaymentMethodIntent": { - "$ref": "#/components/schemas/SetPaymentMethodIntent" + "$ref": "#/components/schemas/billingSetPaymentMethodIntent" }, "activateBillingTierIntent": { - "$ref": "#/components/schemas/ActivateBillingTierIntent" + "$ref": "#/components/schemas/billingActivateBillingTierIntent" }, "deletePaymentMethodIntent": { - "$ref": "#/components/schemas/DeletePaymentMethodIntent" + "$ref": "#/components/schemas/billingDeletePaymentMethodIntent" }, "createPolicyIntentV3": { - "$ref": "#/components/schemas/CreatePolicyIntentV3" + "$ref": "#/components/schemas/v1CreatePolicyIntentV3" }, "createApiOnlyUsersIntent": { - "$ref": "#/components/schemas/CreateApiOnlyUsersIntent" + "$ref": "#/components/schemas/v1CreateApiOnlyUsersIntent" }, "updateRootQuorumIntent": { - "$ref": "#/components/schemas/UpdateRootQuorumIntent" + "$ref": "#/components/schemas/v1UpdateRootQuorumIntent" }, "updateUserTagIntent": { - "$ref": "#/components/schemas/UpdateUserTagIntent" + "$ref": "#/components/schemas/v1UpdateUserTagIntent" }, "updatePrivateKeyTagIntent": { - "$ref": "#/components/schemas/UpdatePrivateKeyTagIntent" + "$ref": "#/components/schemas/v1UpdatePrivateKeyTagIntent" }, "createAuthenticatorsIntentV2": { - "$ref": "#/components/schemas/CreateAuthenticatorsIntentV2" + "$ref": "#/components/schemas/v1CreateAuthenticatorsIntentV2" }, "acceptInvitationIntentV2": { - "$ref": "#/components/schemas/AcceptInvitationIntentV2" + "$ref": "#/components/schemas/v1AcceptInvitationIntentV2" }, "createOrganizationIntentV2": { - "$ref": "#/components/schemas/CreateOrganizationIntentV2" + "$ref": "#/components/schemas/v1CreateOrganizationIntentV2" }, "createUsersIntentV2": { - "$ref": "#/components/schemas/CreateUsersIntentV2" + "$ref": "#/components/schemas/v1CreateUsersIntentV2" }, "createSubOrganizationIntent": { - "$ref": "#/components/schemas/CreateSubOrganizationIntent" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntent" }, "createSubOrganizationIntentV2": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV2" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV2" }, "updateAllowedOriginsIntent": { - "$ref": "#/components/schemas/UpdateAllowedOriginsIntent" + "$ref": "#/components/schemas/v1UpdateAllowedOriginsIntent" }, "createPrivateKeysIntentV2": { - "$ref": "#/components/schemas/CreatePrivateKeysIntentV2" + "$ref": "#/components/schemas/v1CreatePrivateKeysIntentV2" }, "updateUserIntent": { - "$ref": "#/components/schemas/UpdateUserIntent" + "$ref": "#/components/schemas/v1UpdateUserIntent" }, "updatePolicyIntent": { - "$ref": "#/components/schemas/UpdatePolicyIntent" + "$ref": "#/components/schemas/v1UpdatePolicyIntent" }, "setPaymentMethodIntentV2": { - "$ref": "#/components/schemas/SetPaymentMethodIntentV2" + "$ref": "#/components/schemas/billingSetPaymentMethodIntentV2" }, "createSubOrganizationIntentV3": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV3" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV3" }, "createWalletIntent": { - "$ref": "#/components/schemas/CreateWalletIntent" + "$ref": "#/components/schemas/v1CreateWalletIntent" }, "createWalletAccountsIntent": { - "$ref": "#/components/schemas/CreateWalletAccountsIntent" + "$ref": "#/components/schemas/v1CreateWalletAccountsIntent" }, "initUserEmailRecoveryIntent": { - "$ref": "#/components/schemas/InitUserEmailRecoveryIntent" + "$ref": "#/components/schemas/v1InitUserEmailRecoveryIntent" }, "recoverUserIntent": { - "$ref": "#/components/schemas/RecoverUserIntent" + "$ref": "#/components/schemas/v1RecoverUserIntent" }, "setOrganizationFeatureIntent": { - "$ref": "#/components/schemas/SetOrganizationFeatureIntent" + "$ref": "#/components/schemas/v1SetOrganizationFeatureIntent" }, "removeOrganizationFeatureIntent": { - "$ref": "#/components/schemas/RemoveOrganizationFeatureIntent" + "$ref": "#/components/schemas/v1RemoveOrganizationFeatureIntent" }, "signRawPayloadIntentV2": { - "$ref": "#/components/schemas/SignRawPayloadIntentV2" + "$ref": "#/components/schemas/v1SignRawPayloadIntentV2" }, "signTransactionIntentV2": { - "$ref": "#/components/schemas/SignTransactionIntentV2" + "$ref": "#/components/schemas/v1SignTransactionIntentV2" }, "exportPrivateKeyIntent": { - "$ref": "#/components/schemas/ExportPrivateKeyIntent" + "$ref": "#/components/schemas/v1ExportPrivateKeyIntent" }, "exportWalletIntent": { - "$ref": "#/components/schemas/ExportWalletIntent" + "$ref": "#/components/schemas/v1ExportWalletIntent" }, "createSubOrganizationIntentV4": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV4" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV4" }, "emailAuthIntent": { - "$ref": "#/components/schemas/EmailAuthIntent" + "$ref": "#/components/schemas/v1EmailAuthIntent" }, "exportWalletAccountIntent": { - "$ref": "#/components/schemas/ExportWalletAccountIntent" + "$ref": "#/components/schemas/v1ExportWalletAccountIntent" }, "initImportWalletIntent": { - "$ref": "#/components/schemas/InitImportWalletIntent" + "$ref": "#/components/schemas/v1InitImportWalletIntent" }, "importWalletIntent": { - "$ref": "#/components/schemas/ImportWalletIntent" + "$ref": "#/components/schemas/v1ImportWalletIntent" }, "initImportPrivateKeyIntent": { - "$ref": "#/components/schemas/InitImportPrivateKeyIntent" + "$ref": "#/components/schemas/v1InitImportPrivateKeyIntent" }, "importPrivateKeyIntent": { - "$ref": "#/components/schemas/ImportPrivateKeyIntent" + "$ref": "#/components/schemas/v1ImportPrivateKeyIntent" }, "createPoliciesIntent": { - "$ref": "#/components/schemas/CreatePoliciesIntent" + "$ref": "#/components/schemas/v1CreatePoliciesIntent" }, "signRawPayloadsIntent": { - "$ref": "#/components/schemas/SignRawPayloadsIntent" + "$ref": "#/components/schemas/v1SignRawPayloadsIntent" }, "createReadOnlySessionIntent": { - "$ref": "#/components/schemas/CreateReadOnlySessionIntent" + "$ref": "#/components/schemas/v1CreateReadOnlySessionIntent" }, "createOauthProvidersIntent": { - "$ref": "#/components/schemas/CreateOauthProvidersIntent" + "$ref": "#/components/schemas/v1CreateOauthProvidersIntent" }, "deleteOauthProvidersIntent": { - "$ref": "#/components/schemas/DeleteOauthProvidersIntent" + "$ref": "#/components/schemas/v1DeleteOauthProvidersIntent" }, "createSubOrganizationIntentV5": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV5" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV5" }, "oauthIntent": { - "$ref": "#/components/schemas/OauthIntent" + "$ref": "#/components/schemas/v1OauthIntent" }, "createApiKeysIntentV2": { - "$ref": "#/components/schemas/CreateApiKeysIntentV2" + "$ref": "#/components/schemas/v1CreateApiKeysIntentV2" }, "createReadWriteSessionIntent": { - "$ref": "#/components/schemas/CreateReadWriteSessionIntent" + "$ref": "#/components/schemas/v1CreateReadWriteSessionIntent" }, "emailAuthIntentV2": { - "$ref": "#/components/schemas/EmailAuthIntentV2" + "$ref": "#/components/schemas/v1EmailAuthIntentV2" }, "createSubOrganizationIntentV6": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV6" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV6" }, "deletePrivateKeysIntent": { - "$ref": "#/components/schemas/DeletePrivateKeysIntent" + "$ref": "#/components/schemas/v1DeletePrivateKeysIntent" }, "deleteWalletsIntent": { - "$ref": "#/components/schemas/DeleteWalletsIntent" + "$ref": "#/components/schemas/v1DeleteWalletsIntent" }, "createReadWriteSessionIntentV2": { - "$ref": "#/components/schemas/CreateReadWriteSessionIntentV2" + "$ref": "#/components/schemas/v1CreateReadWriteSessionIntentV2" }, "deleteSubOrganizationIntent": { - "$ref": "#/components/schemas/DeleteSubOrganizationIntent" + "$ref": "#/components/schemas/v1DeleteSubOrganizationIntent" }, "initOtpAuthIntent": { - "$ref": "#/components/schemas/InitOtpAuthIntent" + "$ref": "#/components/schemas/v1InitOtpAuthIntent" }, "otpAuthIntent": { - "$ref": "#/components/schemas/OtpAuthIntent" + "$ref": "#/components/schemas/v1OtpAuthIntent" }, "createSubOrganizationIntentV7": { - "$ref": "#/components/schemas/CreateSubOrganizationIntentV7" + "$ref": "#/components/schemas/v1CreateSubOrganizationIntentV7" }, "updateWalletIntent": { - "$ref": "#/components/schemas/UpdateWalletIntent" + "$ref": "#/components/schemas/v1UpdateWalletIntent" + }, + "updatePolicyIntentV2": { + "$ref": "#/components/schemas/v1UpdatePolicyIntentV2" + }, + "createUsersIntentV3": { + "$ref": "#/components/schemas/v1CreateUsersIntentV3" + }, + "initOtpAuthIntentV2": { + "$ref": "#/components/schemas/v1InitOtpAuthIntentV2" + } + } + }, + "v1Invitation": { + "required": [ + "accessType", + "createdAt", + "invitationId", + "receiverEmail", + "receiverUserName", + "receiverUserTags", + "senderUserId", + "status", + "updatedAt" + ], + "type": "object", + "properties": { + "invitationId": { + "type": "string", + "description": "Unique identifier for a given Invitation object." + }, + "receiverUserName": { + "type": "string", + "description": "The name of the intended Invitation recipient." + }, + "receiverEmail": { + "type": "string", + "description": "The email address of the intended Invitation recipient." + }, + "receiverUserTags": { + "type": "array", + "description": "A list of tags assigned to the Invitation recipient.", + "items": { + "type": "string" + } + }, + "accessType": { + "$ref": "#/components/schemas/v1AccessType" + }, + "status": { + "$ref": "#/components/schemas/v1InvitationStatus" + }, + "createdAt": { + "$ref": "#/components/schemas/externaldatav1Timestamp" + }, + "updatedAt": { + "$ref": "#/components/schemas/externaldatav1Timestamp" + }, + "senderUserId": { + "type": "string", + "description": "Unique identifier for the Sender of an Invitation." } } }, - "InvitationParams": { + "v1InvitationParams": { "required": [ "accessType", "receiverUserEmail", @@ -7243,7 +8634,7 @@ } }, "accessType": { - "$ref": "#/components/schemas/AccessType" + "$ref": "#/components/schemas/v1AccessType" }, "senderUserId": { "type": "string", @@ -7251,7 +8642,15 @@ } } }, - "ListPrivateKeyTagsRequest": { + "v1InvitationStatus": { + "type": "string", + "enum": [ + "INVITATION_STATUS_CREATED", + "INVITATION_STATUS_ACCEPTED", + "INVITATION_STATUS_REVOKED" + ] + }, + "v1ListPrivateKeyTagsRequest": { "required": [ "organizationId" ], @@ -7263,7 +8662,7 @@ } } }, - "ListPrivateKeyTagsResponse": { + "v1ListPrivateKeyTagsResponse": { "required": [ "privateKeyTags" ], @@ -7273,12 +8672,12 @@ "type": "array", "description": "A list of Private Key Tags", "items": { - "$ref": "#/components/schemas/v1.Tag" + "$ref": "#/components/schemas/datav1Tag" } } } }, - "ListUserTagsRequest": { + "v1ListUserTagsRequest": { "required": [ "organizationId" ], @@ -7290,7 +8689,7 @@ } } }, - "ListUserTagsResponse": { + "v1ListUserTagsResponse": { "required": [ "userTags" ], @@ -7300,12 +8699,12 @@ "type": "array", "description": "A list of User Tags", "items": { - "$ref": "#/components/schemas/v1.Tag" + "$ref": "#/components/schemas/datav1Tag" } } } }, - "MnemonicLanguage": { + "v1MnemonicLanguage": { "type": "string", "enum": [ "MNEMONIC_LANGUAGE_ENGLISH", @@ -7319,7 +8718,18 @@ "MNEMONIC_LANGUAGE_SPANISH" ] }, - "OauthIntent": { + "v1NOOPCodegenAnchorResponse": { + "required": [ + "stamp" + ], + "type": "object", + "properties": { + "stamp": { + "$ref": "#/components/schemas/v1WebAuthnStamp" + } + } + }, + "v1OauthIntent": { "required": [ "oidcToken", "targetPublicKey" @@ -7341,10 +8751,14 @@ "expirationSeconds": { "type": "string", "description": "Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used." + }, + "invalidateExisting": { + "type": "boolean", + "description": "Invalidate all other previously generated Oauth API keys" } } }, - "OauthProvider": { + "v1OauthProvider": { "required": [ "audience", "createdAt", @@ -7377,14 +8791,14 @@ "description": "Expected subject ('sub' attribute of the signed token) which represents the user ID" }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" } } }, - "OauthProviderParams": { + "v1OauthProviderParams": { "required": [ "oidcToken", "providerName" @@ -7401,7 +8815,7 @@ } } }, - "OauthRequest": { + "v1OauthRequest": { "required": [ "organizationId", "parameters", @@ -7425,11 +8839,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/OauthIntent" + "$ref": "#/components/schemas/v1OauthIntent" } } }, - "OauthResult": { + "v1OauthResult": { "required": [ "apiKeyId", "credentialBundle", @@ -7451,7 +8865,7 @@ } } }, - "Operator": { + "v1Operator": { "type": "string", "enum": [ "OPERATOR_EQUAL", @@ -7467,10 +8881,67 @@ "OPERATOR_CONTAINS_ALL" ] }, - "OtpAuthIntent": { + "v1OrganizationData": { + "type": "object", + "properties": { + "organizationId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1User" + } + }, + "policies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1Policy" + } + }, + "privateKeys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1PrivateKey" + } + }, + "invitations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1Invitation" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/datav1Tag" + } + }, + "rootQuorum": { + "$ref": "#/components/schemas/externaldatav1Quorum" + }, + "features": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1Feature" + } + }, + "wallets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v1Wallet" + } + } + } + }, + "v1OtpAuthIntent": { "required": [ "otpCode", - "otpId" + "otpId", + "targetPublicKey" ], "type": "object", "properties": { @@ -7480,7 +8951,7 @@ }, "otpCode": { "type": "string", - "description": "6 digit OTP code sent out to a user's contact (email or SMS)" + "description": "OTP sent out to a user's contact (email or SMS)" }, "targetPublicKey": { "type": "string", @@ -7500,7 +8971,7 @@ } } }, - "OtpAuthRequest": { + "v1OtpAuthRequest": { "required": [ "organizationId", "parameters", @@ -7524,11 +8995,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/OtpAuthIntent" + "$ref": "#/components/schemas/v1OtpAuthIntent" } } }, - "OtpAuthResult": { + "v1OtpAuthResult": { "required": [ "userId" ], @@ -7548,7 +9019,7 @@ } } }, - "Pagination": { + "v1Pagination": { "type": "object", "properties": { "limit": { @@ -7565,20 +9036,20 @@ } } }, - "PathFormat": { + "v1PathFormat": { "type": "string", "enum": [ "PATH_FORMAT_BIP32" ] }, - "PayloadEncoding": { + "v1PayloadEncoding": { "type": "string", "enum": [ "PAYLOAD_ENCODING_HEXADECIMAL", "PAYLOAD_ENCODING_TEXT_UTF8" ] }, - "Policy": { + "v1Policy": { "required": [ "condition", "consensus", @@ -7600,13 +9071,13 @@ "description": "Human-readable name for a Policy." }, "effect": { - "$ref": "#/components/schemas/Effect" + "$ref": "#/components/schemas/v1Effect" }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "notes": { "type": "string", @@ -7622,7 +9093,7 @@ } } }, - "PrivateKey": { + "v1PrivateKey": { "required": [ "addresses", "createdAt", @@ -7650,13 +9121,13 @@ "description": "Human-readable name for a Private Key." }, "curve": { - "$ref": "#/components/schemas/Curve" + "$ref": "#/components/schemas/v1Curve" }, "addresses": { "type": "array", "description": "Derived cryptocurrency addresses for a given Private Key.", "items": { - "$ref": "#/components/schemas/data.v1.Address" + "$ref": "#/components/schemas/externaldatav1Address" } }, "privateKeyTags": { @@ -7667,10 +9138,10 @@ } }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "exported": { "type": "boolean", @@ -7682,7 +9153,7 @@ } } }, - "PrivateKeyParams": { + "v1PrivateKeyParams": { "required": [ "addressFormats", "curve", @@ -7696,7 +9167,7 @@ "description": "Human-readable name for a Private Key." }, "curve": { - "$ref": "#/components/schemas/Curve" + "$ref": "#/components/schemas/v1Curve" }, "privateKeyTags": { "type": "array", @@ -7709,12 +9180,12 @@ "type": "array", "description": "Cryptocurrency-specific formats for a derived address (e.g., Ethereum).", "items": { - "$ref": "#/components/schemas/AddressFormat" + "$ref": "#/components/schemas/v1AddressFormat" } } } }, - "PrivateKeyResult": { + "v1PrivateKeyResult": { "type": "object", "properties": { "privateKeyId": { @@ -7723,12 +9194,12 @@ "addresses": { "type": "array", "items": { - "$ref": "#/components/schemas/activity.v1.Address" + "$ref": "#/components/schemas/immutableactivityv1Address" } } } }, - "PublicKeyCredentialWithAttestation": { + "v1PublicKeyCredentialWithAttestation": { "required": [ "clientExtensionResults", "id", @@ -7759,14 +9230,14 @@ ] }, "response": { - "$ref": "#/components/schemas/AuthenticatorAttestationResponse" + "$ref": "#/components/schemas/v1AuthenticatorAttestationResponse" }, "clientExtensionResults": { - "$ref": "#/components/schemas/SimpleClientExtensionResults" + "$ref": "#/components/schemas/v1SimpleClientExtensionResults" } } }, - "RecoverUserIntent": { + "v1RecoverUserIntent": { "required": [ "authenticator", "userId" @@ -7774,7 +9245,7 @@ "type": "object", "properties": { "authenticator": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" }, "userId": { "type": "string", @@ -7782,7 +9253,7 @@ } } }, - "RecoverUserRequest": { + "v1RecoverUserRequest": { "required": [ "organizationId", "parameters", @@ -7806,11 +9277,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/RecoverUserIntent" + "$ref": "#/components/schemas/v1RecoverUserIntent" } } }, - "RecoverUserResult": { + "v1RecoverUserResult": { "required": [ "authenticatorId" ], @@ -7825,7 +9296,7 @@ } } }, - "RejectActivityIntent": { + "v1RejectActivityIntent": { "required": [ "fingerprint" ], @@ -7837,7 +9308,7 @@ } } }, - "RejectActivityRequest": { + "v1RejectActivityRequest": { "required": [ "organizationId", "parameters", @@ -7861,22 +9332,22 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/RejectActivityIntent" + "$ref": "#/components/schemas/v1RejectActivityIntent" } } }, - "RemoveOrganizationFeatureIntent": { + "v1RemoveOrganizationFeatureIntent": { "required": [ "name" ], "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/FeatureName" + "$ref": "#/components/schemas/v1FeatureName" } } }, - "RemoveOrganizationFeatureRequest": { + "v1RemoveOrganizationFeatureRequest": { "required": [ "organizationId", "parameters", @@ -7900,11 +9371,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/RemoveOrganizationFeatureIntent" + "$ref": "#/components/schemas/v1RemoveOrganizationFeatureIntent" } } }, - "RemoveOrganizationFeatureResult": { + "v1RemoveOrganizationFeatureResult": { "required": [ "features" ], @@ -7914,215 +9385,221 @@ "type": "array", "description": "Resulting list of organization features.", "items": { - "$ref": "#/components/schemas/Feature" + "$ref": "#/components/schemas/v1Feature" } } } }, - "Result": { + "v1Result": { "type": "object", "properties": { "createOrganizationResult": { - "$ref": "#/components/schemas/CreateOrganizationResult" + "$ref": "#/components/schemas/v1CreateOrganizationResult" }, "createAuthenticatorsResult": { - "$ref": "#/components/schemas/CreateAuthenticatorsResult" + "$ref": "#/components/schemas/v1CreateAuthenticatorsResult" }, "createUsersResult": { - "$ref": "#/components/schemas/CreateUsersResult" + "$ref": "#/components/schemas/v1CreateUsersResult" }, "createPrivateKeysResult": { - "$ref": "#/components/schemas/CreatePrivateKeysResult" + "$ref": "#/components/schemas/v1CreatePrivateKeysResult" }, "createInvitationsResult": { - "$ref": "#/components/schemas/CreateInvitationsResult" + "$ref": "#/components/schemas/v1CreateInvitationsResult" }, "acceptInvitationResult": { - "$ref": "#/components/schemas/AcceptInvitationResult" + "$ref": "#/components/schemas/v1AcceptInvitationResult" }, "signRawPayloadResult": { - "$ref": "#/components/schemas/SignRawPayloadResult" + "$ref": "#/components/schemas/v1SignRawPayloadResult" }, "createPolicyResult": { - "$ref": "#/components/schemas/CreatePolicyResult" + "$ref": "#/components/schemas/v1CreatePolicyResult" }, "disablePrivateKeyResult": { - "$ref": "#/components/schemas/DisablePrivateKeyResult" + "$ref": "#/components/schemas/v1DisablePrivateKeyResult" }, "deleteUsersResult": { - "$ref": "#/components/schemas/DeleteUsersResult" + "$ref": "#/components/schemas/v1DeleteUsersResult" }, "deleteAuthenticatorsResult": { - "$ref": "#/components/schemas/DeleteAuthenticatorsResult" + "$ref": "#/components/schemas/v1DeleteAuthenticatorsResult" }, "deleteInvitationResult": { - "$ref": "#/components/schemas/DeleteInvitationResult" + "$ref": "#/components/schemas/v1DeleteInvitationResult" }, "deleteOrganizationResult": { - "$ref": "#/components/schemas/DeleteOrganizationResult" + "$ref": "#/components/schemas/v1DeleteOrganizationResult" }, "deletePolicyResult": { - "$ref": "#/components/schemas/DeletePolicyResult" + "$ref": "#/components/schemas/v1DeletePolicyResult" }, "createUserTagResult": { - "$ref": "#/components/schemas/CreateUserTagResult" + "$ref": "#/components/schemas/v1CreateUserTagResult" }, "deleteUserTagsResult": { - "$ref": "#/components/schemas/DeleteUserTagsResult" + "$ref": "#/components/schemas/v1DeleteUserTagsResult" }, "signTransactionResult": { - "$ref": "#/components/schemas/SignTransactionResult" + "$ref": "#/components/schemas/v1SignTransactionResult" }, "deleteApiKeysResult": { - "$ref": "#/components/schemas/DeleteApiKeysResult" + "$ref": "#/components/schemas/v1DeleteApiKeysResult" }, "createApiKeysResult": { - "$ref": "#/components/schemas/CreateApiKeysResult" + "$ref": "#/components/schemas/v1CreateApiKeysResult" }, "createPrivateKeyTagResult": { - "$ref": "#/components/schemas/CreatePrivateKeyTagResult" + "$ref": "#/components/schemas/v1CreatePrivateKeyTagResult" }, "deletePrivateKeyTagsResult": { - "$ref": "#/components/schemas/DeletePrivateKeyTagsResult" + "$ref": "#/components/schemas/v1DeletePrivateKeyTagsResult" }, "setPaymentMethodResult": { - "$ref": "#/components/schemas/SetPaymentMethodResult" + "$ref": "#/components/schemas/billingSetPaymentMethodResult" }, "activateBillingTierResult": { - "$ref": "#/components/schemas/ActivateBillingTierResult" + "$ref": "#/components/schemas/billingActivateBillingTierResult" }, "deletePaymentMethodResult": { - "$ref": "#/components/schemas/DeletePaymentMethodResult" + "$ref": "#/components/schemas/billingDeletePaymentMethodResult" }, "createApiOnlyUsersResult": { - "$ref": "#/components/schemas/CreateApiOnlyUsersResult" + "$ref": "#/components/schemas/v1CreateApiOnlyUsersResult" }, "updateRootQuorumResult": { - "$ref": "#/components/schemas/UpdateRootQuorumResult" + "$ref": "#/components/schemas/v1UpdateRootQuorumResult" }, "updateUserTagResult": { - "$ref": "#/components/schemas/UpdateUserTagResult" + "$ref": "#/components/schemas/v1UpdateUserTagResult" }, "updatePrivateKeyTagResult": { - "$ref": "#/components/schemas/UpdatePrivateKeyTagResult" + "$ref": "#/components/schemas/v1UpdatePrivateKeyTagResult" }, "createSubOrganizationResult": { - "$ref": "#/components/schemas/CreateSubOrganizationResult" + "$ref": "#/components/schemas/v1CreateSubOrganizationResult" }, "updateAllowedOriginsResult": { - "$ref": "#/components/schemas/UpdateAllowedOriginsResult" + "$ref": "#/components/schemas/v1UpdateAllowedOriginsResult" }, "createPrivateKeysResultV2": { - "$ref": "#/components/schemas/CreatePrivateKeysResultV2" + "$ref": "#/components/schemas/v1CreatePrivateKeysResultV2" }, "updateUserResult": { - "$ref": "#/components/schemas/UpdateUserResult" + "$ref": "#/components/schemas/v1UpdateUserResult" }, "updatePolicyResult": { - "$ref": "#/components/schemas/UpdatePolicyResult" + "$ref": "#/components/schemas/v1UpdatePolicyResult" }, "createSubOrganizationResultV3": { - "$ref": "#/components/schemas/CreateSubOrganizationResultV3" + "$ref": "#/components/schemas/v1CreateSubOrganizationResultV3" }, "createWalletResult": { - "$ref": "#/components/schemas/CreateWalletResult" + "$ref": "#/components/schemas/v1CreateWalletResult" }, "createWalletAccountsResult": { - "$ref": "#/components/schemas/CreateWalletAccountsResult" + "$ref": "#/components/schemas/v1CreateWalletAccountsResult" }, "initUserEmailRecoveryResult": { - "$ref": "#/components/schemas/InitUserEmailRecoveryResult" + "$ref": "#/components/schemas/v1InitUserEmailRecoveryResult" }, "recoverUserResult": { - "$ref": "#/components/schemas/RecoverUserResult" + "$ref": "#/components/schemas/v1RecoverUserResult" }, "setOrganizationFeatureResult": { - "$ref": "#/components/schemas/SetOrganizationFeatureResult" + "$ref": "#/components/schemas/v1SetOrganizationFeatureResult" }, "removeOrganizationFeatureResult": { - "$ref": "#/components/schemas/RemoveOrganizationFeatureResult" + "$ref": "#/components/schemas/v1RemoveOrganizationFeatureResult" }, "exportPrivateKeyResult": { - "$ref": "#/components/schemas/ExportPrivateKeyResult" + "$ref": "#/components/schemas/v1ExportPrivateKeyResult" }, "exportWalletResult": { - "$ref": "#/components/schemas/ExportWalletResult" + "$ref": "#/components/schemas/v1ExportWalletResult" }, "createSubOrganizationResultV4": { - "$ref": "#/components/schemas/CreateSubOrganizationResultV4" + "$ref": "#/components/schemas/v1CreateSubOrganizationResultV4" }, "emailAuthResult": { - "$ref": "#/components/schemas/EmailAuthResult" + "$ref": "#/components/schemas/v1EmailAuthResult" }, "exportWalletAccountResult": { - "$ref": "#/components/schemas/ExportWalletAccountResult" + "$ref": "#/components/schemas/v1ExportWalletAccountResult" }, "initImportWalletResult": { - "$ref": "#/components/schemas/InitImportWalletResult" + "$ref": "#/components/schemas/v1InitImportWalletResult" }, "importWalletResult": { - "$ref": "#/components/schemas/ImportWalletResult" + "$ref": "#/components/schemas/v1ImportWalletResult" }, "initImportPrivateKeyResult": { - "$ref": "#/components/schemas/InitImportPrivateKeyResult" + "$ref": "#/components/schemas/v1InitImportPrivateKeyResult" }, "importPrivateKeyResult": { - "$ref": "#/components/schemas/ImportPrivateKeyResult" + "$ref": "#/components/schemas/v1ImportPrivateKeyResult" }, "createPoliciesResult": { - "$ref": "#/components/schemas/CreatePoliciesResult" + "$ref": "#/components/schemas/v1CreatePoliciesResult" }, "signRawPayloadsResult": { - "$ref": "#/components/schemas/SignRawPayloadsResult" + "$ref": "#/components/schemas/v1SignRawPayloadsResult" }, "createReadOnlySessionResult": { - "$ref": "#/components/schemas/CreateReadOnlySessionResult" + "$ref": "#/components/schemas/v1CreateReadOnlySessionResult" }, "createOauthProvidersResult": { - "$ref": "#/components/schemas/CreateOauthProvidersResult" + "$ref": "#/components/schemas/v1CreateOauthProvidersResult" }, "deleteOauthProvidersResult": { - "$ref": "#/components/schemas/DeleteOauthProvidersResult" + "$ref": "#/components/schemas/v1DeleteOauthProvidersResult" }, "createSubOrganizationResultV5": { - "$ref": "#/components/schemas/CreateSubOrganizationResultV5" + "$ref": "#/components/schemas/v1CreateSubOrganizationResultV5" }, "oauthResult": { - "$ref": "#/components/schemas/OauthResult" + "$ref": "#/components/schemas/v1OauthResult" }, "createReadWriteSessionResult": { - "$ref": "#/components/schemas/CreateReadWriteSessionResult" + "$ref": "#/components/schemas/v1CreateReadWriteSessionResult" }, "createSubOrganizationResultV6": { - "$ref": "#/components/schemas/CreateSubOrganizationResultV6" + "$ref": "#/components/schemas/v1CreateSubOrganizationResultV6" }, "deletePrivateKeysResult": { - "$ref": "#/components/schemas/DeletePrivateKeysResult" + "$ref": "#/components/schemas/v1DeletePrivateKeysResult" }, "deleteWalletsResult": { - "$ref": "#/components/schemas/DeleteWalletsResult" + "$ref": "#/components/schemas/v1DeleteWalletsResult" }, "createReadWriteSessionResultV2": { - "$ref": "#/components/schemas/CreateReadWriteSessionResultV2" + "$ref": "#/components/schemas/v1CreateReadWriteSessionResultV2" }, "deleteSubOrganizationResult": { - "$ref": "#/components/schemas/DeleteSubOrganizationResult" + "$ref": "#/components/schemas/v1DeleteSubOrganizationResult" }, "initOtpAuthResult": { - "$ref": "#/components/schemas/InitOtpAuthResult" + "$ref": "#/components/schemas/v1InitOtpAuthResult" }, "otpAuthResult": { - "$ref": "#/components/schemas/OtpAuthResult" + "$ref": "#/components/schemas/v1OtpAuthResult" }, "createSubOrganizationResultV7": { - "$ref": "#/components/schemas/CreateSubOrganizationResultV7" + "$ref": "#/components/schemas/v1CreateSubOrganizationResultV7" }, "updateWalletResult": { - "$ref": "#/components/schemas/UpdateWalletResult" + "$ref": "#/components/schemas/v1UpdateWalletResult" + }, + "updatePolicyResultV2": { + "$ref": "#/components/schemas/v1UpdatePolicyResultV2" + }, + "initOtpAuthResultV2": { + "$ref": "#/components/schemas/v1InitOtpAuthResultV2" } } }, - "RootUserParams": { + "v1RootUserParams": { "required": [ "apiKeys", "authenticators", @@ -8142,19 +9619,19 @@ "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/apiApiKeyParams" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } } } }, - "RootUserParamsV2": { + "v1RootUserParamsV2": { "required": [ "apiKeys", "authenticators", @@ -8175,26 +9652,26 @@ "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/apiApiKeyParams" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } }, "oauthProviders": { "type": "array", "description": "A list of Oauth providers. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/OauthProviderParams" + "$ref": "#/components/schemas/v1OauthProviderParams" } } } }, - "RootUserParamsV3": { + "v1RootUserParamsV3": { "required": [ "apiKeys", "authenticators", @@ -8215,26 +9692,26 @@ "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParamsV2" + "$ref": "#/components/schemas/v1ApiKeyParamsV2" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } }, "oauthProviders": { "type": "array", "description": "A list of Oauth providers. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/OauthProviderParams" + "$ref": "#/components/schemas/v1OauthProviderParams" } } } }, - "RootUserParamsV4": { + "v1RootUserParamsV4": { "required": [ "apiKeys", "authenticators", @@ -8259,47 +9736,47 @@ "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParamsV2" + "$ref": "#/components/schemas/v1ApiKeyParamsV2" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } }, "oauthProviders": { "type": "array", "description": "A list of Oauth providers. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/OauthProviderParams" + "$ref": "#/components/schemas/v1OauthProviderParams" } } } }, - "Selector": { + "v1Selector": { "type": "object", "properties": { "subject": { "type": "string" }, "operator": { - "$ref": "#/components/schemas/Operator" + "$ref": "#/components/schemas/v1Operator" }, "target": { "type": "string" } } }, - "SelectorV2": { + "v1SelectorV2": { "type": "object", "properties": { "subject": { "type": "string" }, "operator": { - "$ref": "#/components/schemas/Operator" + "$ref": "#/components/schemas/v1Operator" }, "targets": { "type": "array", @@ -8309,147 +9786,66 @@ } } }, - "SetOrganizationFeatureIntent": { + "v1SetOrganizationFeatureIntent": { "required": [ "name", "value" - ], - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/FeatureName" - }, - "value": { - "type": "string", - "description": "Optional value for the feature. Will override existing values if feature is already set." - } - } - }, - "SetOrganizationFeatureRequest": { - "required": [ - "organizationId", - "parameters", - "timestampMs", - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" - ] - }, - "timestampMs": { - "type": "string", - "description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests." - }, - "organizationId": { - "type": "string", - "description": "Unique identifier for a given Organization." - }, - "parameters": { - "$ref": "#/components/schemas/SetOrganizationFeatureIntent" - } - } - }, - "SetOrganizationFeatureResult": { - "required": [ - "features" - ], - "type": "object", - "properties": { - "features": { - "type": "array", - "description": "Resulting list of organization features.", - "items": { - "$ref": "#/components/schemas/Feature" - } - } - } - }, - "SetPaymentMethodIntent": { - "required": [ - "cardHolderEmail", - "cardHolderName", - "cvv", - "expiryMonth", - "expiryYear", - "number" - ], - "type": "object", - "properties": { - "number": { - "type": "string", - "description": "The account number of the customer's credit card." - }, - "cvv": { - "type": "string", - "description": "The verification digits of the customer's credit card." - }, - "expiryMonth": { - "type": "string", - "description": "The month that the credit card expires." - }, - "expiryYear": { - "type": "string", - "description": "The year that the credit card expires." - }, - "cardHolderEmail": { - "type": "string", - "description": "The email that will receive invoices for the credit card." + ], + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/v1FeatureName" }, - "cardHolderName": { + "value": { "type": "string", - "description": "The name associated with the credit card." + "description": "Optional value for the feature. Will override existing values if feature is already set." } } }, - "SetPaymentMethodIntentV2": { + "v1SetOrganizationFeatureRequest": { "required": [ - "cardHolderEmail", - "cardHolderName", - "paymentMethodId" + "organizationId", + "parameters", + "timestampMs", + "type" ], "type": "object", "properties": { - "paymentMethodId": { + "type": { "type": "string", - "description": "The id of the payment method that was created clientside." + "enum": [ + "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE" + ] }, - "cardHolderEmail": { + "timestampMs": { "type": "string", - "description": "The email that will receive invoices for the credit card." + "description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests." }, - "cardHolderName": { + "organizationId": { "type": "string", - "description": "The name associated with the credit card." + "description": "Unique identifier for a given Organization." + }, + "parameters": { + "$ref": "#/components/schemas/v1SetOrganizationFeatureIntent" } } }, - "SetPaymentMethodResult": { + "v1SetOrganizationFeatureResult": { "required": [ - "cardHolderEmail", - "cardHolderName", - "lastFour" + "features" ], "type": "object", "properties": { - "lastFour": { - "type": "string", - "description": "The last four digits of the credit card added." - }, - "cardHolderName": { - "type": "string", - "description": "The name associated with the payment method." - }, - "cardHolderEmail": { - "type": "string", - "description": "The email address associated with the payment method." + "features": { + "type": "array", + "description": "Resulting list of organization features.", + "items": { + "$ref": "#/components/schemas/v1Feature" + } } } }, - "SignRawPayloadIntent": { + "v1SignRawPayloadIntent": { "required": [ "encoding", "hashFunction", @@ -8467,14 +9863,14 @@ "description": "Raw unsigned payload to be signed." }, "encoding": { - "$ref": "#/components/schemas/PayloadEncoding" + "$ref": "#/components/schemas/v1PayloadEncoding" }, "hashFunction": { - "$ref": "#/components/schemas/HashFunction" + "$ref": "#/components/schemas/v1HashFunction" } } }, - "SignRawPayloadIntentV2": { + "v1SignRawPayloadIntentV2": { "required": [ "encoding", "hashFunction", @@ -8492,14 +9888,14 @@ "description": "Raw unsigned payload to be signed." }, "encoding": { - "$ref": "#/components/schemas/PayloadEncoding" + "$ref": "#/components/schemas/v1PayloadEncoding" }, "hashFunction": { - "$ref": "#/components/schemas/HashFunction" + "$ref": "#/components/schemas/v1HashFunction" } } }, - "SignRawPayloadRequest": { + "v1SignRawPayloadRequest": { "required": [ "organizationId", "parameters", @@ -8523,11 +9919,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/SignRawPayloadIntentV2" + "$ref": "#/components/schemas/v1SignRawPayloadIntentV2" } } }, - "SignRawPayloadResult": { + "v1SignRawPayloadResult": { "required": [ "r", "s", @@ -8549,7 +9945,7 @@ } } }, - "SignRawPayloadsIntent": { + "v1SignRawPayloadsIntent": { "required": [ "encoding", "hashFunction", @@ -8570,14 +9966,14 @@ } }, "encoding": { - "$ref": "#/components/schemas/PayloadEncoding" + "$ref": "#/components/schemas/v1PayloadEncoding" }, "hashFunction": { - "$ref": "#/components/schemas/HashFunction" + "$ref": "#/components/schemas/v1HashFunction" } } }, - "SignRawPayloadsRequest": { + "v1SignRawPayloadsRequest": { "required": [ "organizationId", "parameters", @@ -8601,22 +9997,22 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/SignRawPayloadsIntent" + "$ref": "#/components/schemas/v1SignRawPayloadsIntent" } } }, - "SignRawPayloadsResult": { + "v1SignRawPayloadsResult": { "type": "object", "properties": { "signatures": { "type": "array", "items": { - "$ref": "#/components/schemas/SignRawPayloadResult" + "$ref": "#/components/schemas/v1SignRawPayloadResult" } } } }, - "SignTransactionIntent": { + "v1SignTransactionIntent": { "required": [ "privateKeyId", "type", @@ -8633,11 +10029,11 @@ "description": "Raw unsigned transaction to be signed by a particular Private Key." }, "type": { - "$ref": "#/components/schemas/TransactionType" + "$ref": "#/components/schemas/v1TransactionType" } } }, - "SignTransactionIntentV2": { + "v1SignTransactionIntentV2": { "required": [ "signWith", "type", @@ -8654,11 +10050,11 @@ "description": "Raw unsigned transaction to be signed" }, "type": { - "$ref": "#/components/schemas/TransactionType" + "$ref": "#/components/schemas/v1TransactionType" } } }, - "SignTransactionRequest": { + "v1SignTransactionRequest": { "required": [ "organizationId", "parameters", @@ -8682,11 +10078,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/SignTransactionIntentV2" + "$ref": "#/components/schemas/v1SignTransactionIntentV2" } } }, - "SignTransactionResult": { + "v1SignTransactionResult": { "required": [ "signedTransaction" ], @@ -8697,7 +10093,7 @@ } } }, - "SimpleClientExtensionResults": { + "v1SimpleClientExtensionResults": { "type": "object", "properties": { "appid": { @@ -8707,11 +10103,11 @@ "type": "boolean" }, "credProps": { - "$ref": "#/components/schemas/CredPropsAuthenticationExtensionsClientOutputs" + "$ref": "#/components/schemas/v1CredPropsAuthenticationExtensionsClientOutputs" } } }, - "SmsCustomizationParams": { + "v1SmsCustomizationParams": { "type": "object", "properties": { "template": { @@ -8720,39 +10116,47 @@ } } }, - "Status": { + "v1TagType": { + "type": "string", + "enum": [ + "TAG_TYPE_USER", + "TAG_TYPE_PRIVATE_KEY" + ] + }, + "v1TestRateLimitsRequest": { + "required": [ + "isSetLimit", + "limit", + "organizationId" + ], "type": "object", "properties": { - "code": { - "type": "integer", - "format": "int32" + "organizationId": { + "type": "string", + "description": "Unique identifier for a given Organization. If the request is being made by a WebAuthN user and their Sub-Organization ID is unknown, this can be the Parent Organization ID; using the Sub-Organization ID when possible is preferred due to performance reasons." }, - "message": { - "type": "string" + "isSetLimit": { + "type": "boolean", + "description": "Whether or not to set a limit on this request." }, - "details": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Any" - } + "limit": { + "type": "integer", + "description": "Rate limit to set for org, if is_set_limit is set to true", + "format": "int64" } } }, - "TagType": { - "type": "string", - "enum": [ - "TAG_TYPE_USER", - "TAG_TYPE_PRIVATE_KEY" - ] + "v1TestRateLimitsResponse": { + "type": "object" }, - "TransactionType": { + "v1TransactionType": { "type": "string", "enum": [ "TRANSACTION_TYPE_ETHEREUM", "TRANSACTION_TYPE_SOLANA" ] }, - "UpdateAllowedOriginsIntent": { + "v1UpdateAllowedOriginsIntent": { "required": [ "allowedOrigins" ], @@ -8767,10 +10171,41 @@ } } }, - "UpdateAllowedOriginsResult": { + "v1UpdateAllowedOriginsResult": { "type": "object" }, - "UpdatePolicyIntent": { + "v1UpdatePolicyIntent": { + "required": [ + "policyId" + ], + "type": "object", + "properties": { + "policyId": { + "type": "string", + "description": "Unique identifier for a given Policy." + }, + "policyName": { + "type": "string", + "description": "Human-readable name for a Policy." + }, + "policyEffect": { + "$ref": "#/components/schemas/v1Effect" + }, + "policyCondition": { + "type": "string", + "description": "The condition expression that triggers the Effect (optional)." + }, + "policyConsensus": { + "type": "string", + "description": "The consensus expression that triggers the Effect (optional)." + }, + "policyNotes": { + "type": "string", + "description": "Accompanying notes for a Policy (optional)." + } + } + }, + "v1UpdatePolicyIntentV2": { "required": [ "policyId" ], @@ -8785,7 +10220,7 @@ "description": "Human-readable name for a Policy." }, "policyEffect": { - "$ref": "#/components/schemas/Effect" + "$ref": "#/components/schemas/v1Effect" }, "policyCondition": { "type": "string", @@ -8801,7 +10236,7 @@ } } }, - "UpdatePolicyRequest": { + "v1UpdatePolicyRequest": { "required": [ "organizationId", "parameters", @@ -8813,7 +10248,7 @@ "type": { "type": "string", "enum": [ - "ACTIVITY_TYPE_UPDATE_POLICY" + "ACTIVITY_TYPE_UPDATE_POLICY_V2" ] }, "timestampMs": { @@ -8825,11 +10260,23 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdatePolicyIntent" + "$ref": "#/components/schemas/v1UpdatePolicyIntentV2" + } + } + }, + "v1UpdatePolicyResult": { + "required": [ + "policyId" + ], + "type": "object", + "properties": { + "policyId": { + "type": "string", + "description": "Unique identifier for a given Policy." } } }, - "UpdatePolicyResult": { + "v1UpdatePolicyResultV2": { "required": [ "policyId" ], @@ -8841,7 +10288,7 @@ } } }, - "UpdatePrivateKeyTagIntent": { + "v1UpdatePrivateKeyTagIntent": { "required": [ "addPrivateKeyIds", "privateKeyTagId", @@ -8873,7 +10320,7 @@ } } }, - "UpdatePrivateKeyTagRequest": { + "v1UpdatePrivateKeyTagRequest": { "required": [ "organizationId", "parameters", @@ -8897,11 +10344,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdatePrivateKeyTagIntent" + "$ref": "#/components/schemas/v1UpdatePrivateKeyTagIntent" } } }, - "UpdatePrivateKeyTagResult": { + "v1UpdatePrivateKeyTagResult": { "required": [ "privateKeyTagId" ], @@ -8913,7 +10360,7 @@ } } }, - "UpdateRootQuorumIntent": { + "v1UpdateRootQuorumIntent": { "required": [ "threshold", "userIds" @@ -8934,7 +10381,7 @@ } } }, - "UpdateRootQuorumRequest": { + "v1UpdateRootQuorumRequest": { "required": [ "organizationId", "parameters", @@ -8958,14 +10405,14 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdateRootQuorumIntent" + "$ref": "#/components/schemas/v1UpdateRootQuorumIntent" } } }, - "UpdateRootQuorumResult": { + "v1UpdateRootQuorumResult": { "type": "object" }, - "UpdateUserIntent": { + "v1UpdateUserIntent": { "required": [ "userId" ], @@ -8996,7 +10443,7 @@ } } }, - "UpdateUserRequest": { + "v1UpdateUserRequest": { "required": [ "organizationId", "parameters", @@ -9020,11 +10467,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdateUserIntent" + "$ref": "#/components/schemas/v1UpdateUserIntent" } } }, - "UpdateUserResult": { + "v1UpdateUserResult": { "required": [ "userId" ], @@ -9036,7 +10483,7 @@ } } }, - "UpdateUserTagIntent": { + "v1UpdateUserTagIntent": { "required": [ "addUserIds", "removeUserIds", @@ -9068,7 +10515,7 @@ } } }, - "UpdateUserTagRequest": { + "v1UpdateUserTagRequest": { "required": [ "organizationId", "parameters", @@ -9092,11 +10539,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdateUserTagIntent" + "$ref": "#/components/schemas/v1UpdateUserTagIntent" } } }, - "UpdateUserTagResult": { + "v1UpdateUserTagResult": { "required": [ "userTagId" ], @@ -9108,7 +10555,7 @@ } } }, - "UpdateWalletIntent": { + "v1UpdateWalletIntent": { "required": [ "walletId" ], @@ -9124,7 +10571,7 @@ } } }, - "UpdateWalletRequest": { + "v1UpdateWalletRequest": { "required": [ "organizationId", "parameters", @@ -9148,11 +10595,11 @@ "description": "Unique identifier for a given Organization." }, "parameters": { - "$ref": "#/components/schemas/UpdateWalletIntent" + "$ref": "#/components/schemas/v1UpdateWalletIntent" } } }, - "UpdateWalletResult": { + "v1UpdateWalletResult": { "required": [ "walletId" ], @@ -9164,7 +10611,7 @@ } } }, - "User": { + "v1User": { "required": [ "apiKeys", "authenticators", @@ -9197,14 +10644,14 @@ "type": "array", "description": "A list of Authenticator parameters.", "items": { - "$ref": "#/components/schemas/Authenticator" + "$ref": "#/components/schemas/v1Authenticator" } }, "apiKeys": { "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKey" + "$ref": "#/components/schemas/v1ApiKey" } }, "userTags": { @@ -9218,18 +10665,18 @@ "type": "array", "description": "A list of Oauth Providers.", "items": { - "$ref": "#/components/schemas/OauthProvider" + "$ref": "#/components/schemas/v1OauthProvider" } }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" } } }, - "UserParams": { + "v1UserParams": { "required": [ "accessType", "apiKeys", @@ -9248,20 +10695,60 @@ "description": "The user's email address." }, "accessType": { - "$ref": "#/components/schemas/AccessType" + "$ref": "#/components/schemas/v1AccessType" + }, + "apiKeys": { + "type": "array", + "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", + "items": { + "$ref": "#/components/schemas/apiApiKeyParams" + } + }, + "authenticators": { + "type": "array", + "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", + "items": { + "$ref": "#/components/schemas/v1AuthenticatorParams" + } + }, + "userTags": { + "type": "array", + "description": "A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.", + "items": { + "type": "string" + } + } + } + }, + "v1UserParamsV2": { + "required": [ + "apiKeys", + "authenticators", + "userName", + "userTags" + ], + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "Human-readable name for a User." + }, + "userEmail": { + "type": "string", + "description": "The user's email address." }, "apiKeys": { "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/apiApiKeyParams" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParams" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" } }, "userTags": { @@ -9273,10 +10760,11 @@ } } }, - "UserParamsV2": { + "v1UserParamsV3": { "required": [ "apiKeys", "authenticators", + "oauthProviders", "userName", "userTags" ], @@ -9290,18 +10778,29 @@ "type": "string", "description": "The user's email address." }, + "userPhoneNumber": { + "type": "string", + "description": "The user's phone number in E.164 format e.g. +13214567890" + }, "apiKeys": { "type": "array", "description": "A list of API Key parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/ApiKeyParams" + "$ref": "#/components/schemas/v1ApiKeyParamsV2" } }, "authenticators": { "type": "array", "description": "A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/AuthenticatorParamsV2" + "$ref": "#/components/schemas/v1AuthenticatorParamsV2" + } + }, + "oauthProviders": { + "type": "array", + "description": "A list of Oauth providers. This field, if not needed, should be an empty array in your request body.", + "items": { + "$ref": "#/components/schemas/v1OauthProviderParams" } }, "userTags": { @@ -9313,7 +10812,7 @@ } } }, - "Vote": { + "v1Vote": { "required": [ "activityId", "createdAt", @@ -9337,7 +10836,7 @@ "description": "Unique identifier for a given User." }, "user": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/v1User" }, "activityId": { "type": "string", @@ -9367,11 +10866,11 @@ "description": "Method used to produce a signature." }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" } } }, - "Wallet": { + "v1Wallet": { "required": [ "createdAt", "exported", @@ -9391,10 +10890,10 @@ "description": "Human-readable name for a Wallet." }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "exported": { "type": "boolean", @@ -9406,7 +10905,7 @@ } } }, - "WalletAccount": { + "v1WalletAccount": { "required": [ "address", "addressFormat", @@ -9434,31 +10933,35 @@ "description": "The Wallet the Account was derived from." }, "curve": { - "$ref": "#/components/schemas/Curve" + "$ref": "#/components/schemas/v1Curve" }, "pathFormat": { - "$ref": "#/components/schemas/PathFormat" + "$ref": "#/components/schemas/v1PathFormat" }, "path": { "type": "string", "description": "Path used to generate the Account." }, "addressFormat": { - "$ref": "#/components/schemas/AddressFormat" + "$ref": "#/components/schemas/v1AddressFormat" }, "address": { "type": "string", "description": "Address generated using the Wallet seed and Account parameters." }, "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" }, "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "$ref": "#/components/schemas/externaldatav1Timestamp" + }, + "publicKey": { + "type": "string", + "description": "The public component of this wallet account's underlying cryptographic key pair." } } }, - "WalletAccountParams": { + "v1WalletAccountParams": { "required": [ "addressFormat", "curve", @@ -9468,21 +10971,21 @@ "type": "object", "properties": { "curve": { - "$ref": "#/components/schemas/Curve" + "$ref": "#/components/schemas/v1Curve" }, "pathFormat": { - "$ref": "#/components/schemas/PathFormat" + "$ref": "#/components/schemas/v1PathFormat" }, "path": { "type": "string", "description": "Path used to generate a wallet Account." }, "addressFormat": { - "$ref": "#/components/schemas/AddressFormat" + "$ref": "#/components/schemas/v1AddressFormat" } } }, - "WalletParams": { + "v1WalletParams": { "required": [ "accounts", "walletName" @@ -9497,7 +11000,7 @@ "type": "array", "description": "A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.", "items": { - "$ref": "#/components/schemas/WalletAccountParams" + "$ref": "#/components/schemas/v1WalletAccountParams" } }, "mnemonicLength": { @@ -9507,7 +11010,7 @@ } } }, - "WalletResult": { + "v1WalletResult": { "required": [ "addresses", "walletId" @@ -9526,106 +11029,30 @@ } } }, - "activity.v1.Address": { - "type": "object", - "properties": { - "format": { - "$ref": "#/components/schemas/AddressFormat" - }, - "address": { - "type": "string" - } - } - }, - "data.v1.Address": { - "type": "object", - "properties": { - "format": { - "$ref": "#/components/schemas/AddressFormat" - }, - "address": { - "type": "string" - } - } - }, - "external.data.v1.Credential": { + "v1WebAuthnStamp": { "required": [ - "publicKey", - "type" + "authenticatorData", + "clientDataJson", + "credentialId", + "signature" ], "type": "object", "properties": { - "publicKey": { + "credentialId": { "type": "string", - "description": "The public component of a cryptographic key pair used to sign messages and transactions." - }, - "type": { - "$ref": "#/components/schemas/CredentialType" - } - } - }, - "external.data.v1.Quorum": { - "required": [ - "threshold", - "userIds" - ], - "type": "object", - "properties": { - "threshold": { - "type": "integer", - "description": "Count of unique approvals required to meet quorum.", - "format": "int32" - }, - "userIds": { - "type": "array", - "description": "Unique identifiers of quorum set members.", - "items": { - "type": "string" - } - } - } - }, - "external.data.v1.Timestamp": { - "required": [ - "nanos", - "seconds" - ], - "type": "object", - "properties": { - "seconds": { - "type": "string" + "description": "A base64 url encoded Unique identifier for a given credential." }, - "nanos": { - "type": "string" - } - } - }, - "v1.Tag": { - "required": [ - "createdAt", - "tagId", - "tagName", - "tagType", - "updatedAt" - ], - "type": "object", - "properties": { - "tagId": { + "clientDataJson": { "type": "string", - "description": "Unique identifier for a given Tag." + "description": "A base64 encoded payload containing metadata about the signing context and the challenge." }, - "tagName": { + "authenticatorData": { "type": "string", - "description": "Human-readable name for a Tag." - }, - "tagType": { - "$ref": "#/components/schemas/TagType" - }, - "createdAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "description": "A base64 encoded payload containing metadata about the authenticator." }, - "updatedAt": { - "$ref": "#/components/schemas/external.data.v1.Timestamp" + "signature": { + "type": "string", + "description": "The base64 url encoded signature bytes contained within the WebAuthn assertion response." } } } @@ -9688,4 +11115,4 @@ } ], "x-original-swagger-version": "2.0" -} \ No newline at end of file +}