diff --git a/redocly.yaml b/redocly.yaml new file mode 100644 index 0000000..7a719b2 --- /dev/null +++ b/redocly.yaml @@ -0,0 +1,10 @@ +extends: + - recommended + +theme: + openapi: + disableSearch: true + hideDownloadButton: true + hideSingleRequestSampleTab: true + pathInMiddlePanel: true + requiredPropsFirst: true diff --git a/static/specs/services/coordinator/public/v1/public_api.swagger.json b/static/specs/services/coordinator/public/v1/public_api.swagger.json index 9647c16..cfea449 100644 --- a/static/specs/services/coordinator/public/v1/public_api.swagger.json +++ b/static/specs/services/coordinator/public/v1/public_api.swagger.json @@ -5,16 +5,11 @@ "version": "1.0", "contact": { "name": "Turnkey Engineering", - "url": "https://turnkey.io/contact", - "email": "eng@turnkey.io" + "url": "https://turnkey.com/contact", + "email": "eng@turnkey.com" } }, - "tags": [ - { - "name": "PublicApiService" - } - ], - "host": "coordinator-beta.turnkey.io", + "host": "api.turnkey.com", "schemes": [ "https" ], @@ -37,17 +32,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -67,17 +51,7 @@ ], "tags": [ "Activities" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_activity --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"activityId\": \"\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/get_authenticator": { @@ -92,17 +66,6 @@ "$ref": "#/definitions/v1GetAuthenticatorResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -122,17 +85,7 @@ ], "tags": [ "Authenticators" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_authenticator --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"authenticatorId\": \"'\"$AUTHENTICATOR_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/get_authenticators": { @@ -147,17 +100,6 @@ "$ref": "#/definitions/v1GetAuthenticatorsResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -177,72 +119,7 @@ ], "tags": [ "Authenticators" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_authenticators --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"userId\": \"'\"$USER_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } - } - }, - "/public/v1/query/get_organization": { - "post": { - "summary": "Get Organization", - "description": "Get details about an Organization", - "operationId": "PublicApiService_GetOrganization", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetOrganizationResponse" - } - }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/v1GetOrganizationRequest" - } - } - ], - "tags": [ - "Organizations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_organization --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/get_policy": { @@ -257,17 +134,6 @@ "$ref": "#/definitions/v1GetPolicyResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -287,17 +153,7 @@ ], "tags": [ "Policies" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_policy --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"policyId\": \"\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/get_private_key": { @@ -312,17 +168,6 @@ "$ref": "#/definitions/v1GetPrivateKeyResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -342,17 +187,7 @@ ], "tags": [ "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_private_key --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/get_user": { @@ -367,17 +202,6 @@ "$ref": "#/definitions/v1GetUserResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -397,17 +221,7 @@ ], "tags": [ "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_user --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"userId\": \"\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/list_activities": { @@ -422,17 +236,6 @@ "$ref": "#/definitions/v1GetActivitiesResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -452,17 +255,7 @@ ], "tags": [ "Activities" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_activities --body '{\n\t\"organizationId\": \"$ORGANIZATION_ID\",\n\t\"filterByStatus\": [\n\t\t\"$ACTIVITY_STATUS\"\n\t],\n\t\"filterByType\": [\n\t\t\"$ACTIVITY_TYPE\"\n\t],\n\t\"paginationOptions\": {\n\t\t\"limit\": \"$NUM_ACTIVITIES\",\n\t\t\"before\": \"$BEFORE_ACTIVITY_ID\",\n\t\t\"after\": \"$AFTER_ACTIVITY_ID\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/list_policies": { @@ -477,17 +270,6 @@ "$ref": "#/definitions/v1GetPoliciesResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -507,17 +289,7 @@ ], "tags": [ "Policies" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_policies --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/list_private_keys": { @@ -532,17 +304,6 @@ "$ref": "#/definitions/v1GetPrivateKeysResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -562,17 +323,7 @@ ], "tags": [ "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_private_keys --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/list_users": { @@ -587,17 +338,6 @@ "$ref": "#/definitions/v1GetUsersResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -617,17 +357,7 @@ ], "tags": [ "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/list_users --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/query/whoami": { @@ -642,17 +372,6 @@ "$ref": "#/definitions/v1GetWhoamiResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -671,18 +390,8 @@ } ], "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/whoami --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Who am I?" + ] } }, "/public/v1/submit/approve_activity": { @@ -697,17 +406,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -726,18 +424,8 @@ } ], "tags": [ - "Activities" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/approve_activity --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_APPROVE_ACTIVITY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"fingerprint\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Consensus" + ] } }, "/public/v1/submit/create_api_keys": { @@ -752,17 +440,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -781,73 +458,8 @@ } ], "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_api_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_API_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"apiKeys\": [{\n\t\t\t\"apiKeyName\": \"\",\n\t\t\t\"publicKey\": \"\"\n\t\t}],\n\t\t\"userId\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } - } - }, - "/public/v1/submit/create_api_only_users": { - "post": { - "summary": "Create API-only Users", - "description": "Create API-only Users in an existing Organization", - "operationId": "PublicApiService_CreateApiOnlyUsers", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1ActivityResponse" - } - }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/v1CreateApiOnlyUsersRequest" - } - } - ], - "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_api_only_users --body '{\n\t\"timestampMs\": \"$TIMESTAMP_IN_MILLISECONDS\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_API_ONLY_USERS\",\n\t\"organizationId\": \"$ORGANIZATION_ID\",\n\t\"parameters\": {\n\t\t\"api_only_users\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"userTags\": \"[]\", \n\t\t\t\"apiKeys\": [\n\t\t\t\t{\"publicKey\": \"public-key\",\"apiKeyName\": \"test\"}\n\t\t\t]}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "API Keys" + ] } }, "/public/v1/submit/create_authenticators": { @@ -862,17 +474,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -892,17 +493,7 @@ ], "tags": [ "Authenticators" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_authenticators --body '{\n\t\"type\": \"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2\",\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"userId\": \"\",\n\t\t\"authenticators\": [\n\t\t\t{\n\t\t\t\t\"authenticatorName\": \"\",\n\t\t\t\t\"challenge\": \"\",\n\t\t\t\t\"attestation\": {\n\t\t\t\t\t\"credentialId\": \"\",\n\t\t\t\t\t\"clientDataJson\": \"\",\n\t\t\t\t\t\"attestationObject\": \"\",\n\t\t\t\t\t\"transports\": []\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}\n'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/create_invitations": { @@ -917,17 +508,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -947,17 +527,7 @@ ], "tags": [ "Invitations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_invitations --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_INVITATIONS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"invitations\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"receiverUserTags\": \"\",\n\t\t\t\"accessType\": \"\",\n\t\t\t\"senderUserId\": \"\"\n\t\t}]\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/create_policy": { @@ -972,17 +542,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1002,17 +561,7 @@ ], "tags": [ "Policies" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_policy --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_POLICY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"policyName\": \"\",\n\t\t\"effect\": \"\",\n\t\t\"notes\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/create_private_key_tag": { @@ -1027,17 +576,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1056,18 +594,8 @@ } ], "tags": [ - "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_private_key_tag --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyTagName\": \"\",\n\t\t\"privateKeyIds\": \"\",\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Private Key Tags" + ] } }, "/public/v1/submit/create_private_keys": { @@ -1082,17 +610,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1112,17 +629,7 @@ ], "tags": [ "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_private_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeys\": [{\n\t\t\t\"privateKeyName\": \"\",\n\t\t\t\"curve\": \"\",\n\t\t\t\"privateKeyTags\": \"\",\n\t\t\t\"addressFormats\": \"\"\n\t\t}]\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/create_sub_organization": { @@ -1137,17 +644,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1166,18 +662,8 @@ } ], "tags": [ - "Organizations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_sub_organization --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"name\": \"\",\n\t\t\"rootAuthenticator\": {\n\t\t\t\"authenticatorName\": \"\",\n\t\t\t\"challenge\":\"\",\n\t\t\t\"attestation\":{\n\t\t\t\t\"credentialId\":\"\",\n\t\t\t\t\"clientDataJson\":\"\",\n\t\t\t\t\"attestationObject\":\"\",\n\t\t\t\t\"transports\":[],\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Sub-Organizations" + ] } }, "/public/v1/submit/create_user_tag": { @@ -1192,17 +678,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1221,18 +696,8 @@ } ], "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_user_tag --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_USER_TAG\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"userTagName\": \"\",\n\t\t\"userIds\": \"\",\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "User Tags" + ] } }, "/public/v1/submit/create_users": { @@ -1247,17 +712,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1277,18 +731,7 @@ ], "tags": [ "Users" - ], - "deprecated": true, - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/create_users --body '{\n\t\"timestampMs\": \"$TIMESTAMP_IN_MILLISECONDS\",\n\t\"type\": \"ACTIVITY_TYPE_CREATE_USERS\",\n\t\"organizationId\": \"$ORGANIZATION_ID\",\n\t\"parameters\": {\n\t\t\"users\": [{\n\t\t\t\"userName\": \"\",\n\t\t\t\"userEmail\": \"\",\n\t\t\t\"accessType\": \"ACCESS_TYPE_API\",\n\t\t\t\"userTags\": \"[]\", \n\t\t\t\"apiKeys\": [\n\t\t\t\t{\"publicKey\": \"public-key\",\"apiKeyName\": \"test\"}\n\t\t\t]}]}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/delete_api_keys": { @@ -1303,15 +746,38 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, "schema": { - "type": "string", - "format": "string" + "$ref": "#/definitions/v1DeleteApiKeysRequest" + } + } + ], + "tags": [ + "API Keys" + ] + } + }, + "/public/v1/submit/delete_authenticators": { + "post": { + "summary": "Delete Authenticators", + "description": "Remove authenticators from a User", + "operationId": "PublicApiService_DeleteAuthenticators", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1ActivityResponse" } }, "default": { @@ -1327,23 +793,13 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/v1DeleteApiKeysRequest" + "$ref": "#/definitions/v1DeleteAuthenticatorsRequest" } } ], "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_api_keys --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_API_KEYS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"apiKeyIds\": [],\n\t\t\"userId\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Authenticators" + ] } }, "/public/v1/submit/delete_invitations": { @@ -1358,17 +814,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1388,17 +833,7 @@ ], "tags": [ "Invitations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_invitation --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_INVITATION\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"invitationId\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/delete_policy": { @@ -1413,17 +848,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1443,17 +867,7 @@ ], "tags": [ "Policies" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/delete_policy --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_DELETE_POLICY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"policyId\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + ] } }, "/public/v1/submit/reject_activity": { @@ -1468,17 +882,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1497,18 +900,8 @@ } ], "tags": [ - "Activities" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/reject_activity --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_REJECT_ACTIVITY\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"fingerprint\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Consensus" + ] } }, "/public/v1/submit/sign_raw_payload": { @@ -1523,17 +916,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1552,18 +934,8 @@ } ], "tags": [ - "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/sign_raw_payload --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\",\n\t\t\"encoding\": \"PAYLOAD_ENCODING_TEXT_UTF8\",\n\t\t\"payload\": \"\",\n\t\t\"hashFunction\": \"HASH_FUNCTION_KECCAK256\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Signing" + ] } }, "/public/v1/submit/sign_transaction": { @@ -1578,17 +950,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1607,18 +968,8 @@ } ], "tags": [ - "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/sign_transaction --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_SIGN_TRANSACTION\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\",\n\t\t\"unsignedTransaction\": \"\",\n\t\t\"type\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Signing" + ] } }, "/public/v1/submit/update_allowed_origins": { @@ -1633,17 +984,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1662,25 +1002,15 @@ } ], "tags": [ - "Organizations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/update_allowed_origins --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"allowed_origins\": \"'\"$ORIGINS\"'\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Security" + ] } }, - "/public/v1/submit/update_private_key_tag": { + "/public/v1/submit/update_policy": { "post": { - "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": "PublicApiService_UpdatePrivateKeyTag", + "summary": "Update Policy", + "description": "Update an existing Policy", + "operationId": "PublicApiService_UpdatePolicy", "responses": { "200": { "description": "A successful response.", @@ -1688,17 +1018,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1712,30 +1031,20 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/v1UpdatePrivateKeyTagRequest" + "$ref": "#/definitions/v1UpdatePolicyRequest" } } ], "tags": [ - "Private Keys" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/private_key_tags/update --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"privateKeyTagId\": \"'\"$PRIVATE_KEY_TAG_ID\"'\",\n\t\t\"privateKeyTagName\": \"\",\n\t\t\"addPrivateKeyTagIds\": \"\",\n\t\t\"removePrivateKeyTagIds\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Policies" + ] } }, - "/public/v1/submit/update_root_quorum": { + "/public/v1/submit/update_private_key_tag": { "post": { - "summary": "Update Root Quorum", - "description": "Set the threshold and members of the root quorum. This must be approved by the current root quorum.", - "operationId": "PublicApiService_UpdateRootQuorum", + "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": "PublicApiService_UpdatePrivateKeyTag", "responses": { "200": { "description": "A successful response.", @@ -1743,17 +1052,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1767,30 +1065,20 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/v1UpdateRootQuorumRequest" + "$ref": "#/definitions/v1UpdatePrivateKeyTagRequest" } } ], "tags": [ - "Organizations" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/update_root_quorum --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"UPDATE_ROOT_QUORUM\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"userIds\": \"'\"$USER_IDS\"'\",\n\t\t\"threshold\": $THRESHOLD\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Private Key Tags" + ] } }, - "/public/v1/submit/update_user_tag": { + "/public/v1/submit/update_root_quorum": { "post": { - "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", + "summary": "Update Root Quorum", + "description": "Set the threshold and members of the root quorum. This must be approved by the current root quorum.", + "operationId": "PublicApiService_UpdateRootQuorum", "responses": { "200": { "description": "A successful response.", @@ -1798,17 +1086,6 @@ "$ref": "#/definitions/v1ActivityResponse" } }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" - } - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1822,46 +1099,25 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/v1UpdateUserTagRequest" + "$ref": "#/definitions/v1UpdateRootQuorumRequest" } } ], "tags": [ - "Users" - ], - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/submit/update_user_tag --body '{\n\t\"timestampMs\": \"'\"$(date +%s)\"'000\",\n\t\"type\": \"ACTIVITY_TYPE_UPDATE_USER_TAG\",\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"parameters\": {\n\t\t\"userTagId\": \"'\"$USER_TAG_ID\"'\",\n\t\t\"userTagName\": \"\",\n\t\t\"addUserIds\": \"\",\n\t\t\"removeUserIds\": \"\"\n\t}\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "Security" + ] } }, - "/tkhq/public/v1/query/get_private_key": { + "/public/v1/submit/update_user_tag": { "post": { - "summary": "Get Private Key", - "description": "Get details about a Private Key", - "operationId": "PublicApiService_GetPrivateKeyBackwardsCompat", + "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", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1GetPrivateKeyResponse" - } - }, - "403": { - "description": "Returned when the user does not have permission to access the resource.", - "schema": {} - }, - "404": { - "description": "Returned when the resource does not exist.", - "schema": { - "type": "string", - "format": "string" + "$ref": "#/definitions/v1ActivityResponse" } }, "default": { @@ -1877,57 +1133,17 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/v1GetPrivateKeyRequest" + "$ref": "#/definitions/v1UpdateUserTagRequest" } } ], "tags": [ - "Private Keys" - ], - "deprecated": true, - "x-readme": { - "code-samples": [ - { - "code": "turnkey request --host coordinator-beta.turnkey.io --path /public/v1/query/get_private_key --body '{\n\t\"organizationId\": \"'\"$ORGANIZATION_ID\"'\",\n\t\"privateKeyId\": \"'\"$PRIVATE_KEY_ID\"'\"\n}'", - "install": "brew tap tkhq/tap \u0026\u0026 brew install turnkey", - "language": "curl", - "name": "Turnkey CLI" - } - ] - } + "User Tags" + ] } } }, "definitions": { - "datav1Tag": { - "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": "#/definitions/v1TagType" - }, - "createdAt": { - "$ref": "#/definitions/v1Timestamp" - }, - "updatedAt": { - "$ref": "#/definitions/v1Timestamp" - } - }, - "required": [ - "tagId", - "tagName", - "tagType", - "createdAt", - "updatedAt" - ] - }, "externaldatav1AccessType": { "type": "string", "enum": [ @@ -2355,7 +1571,9 @@ "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION", "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2", "ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS", - "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2" + "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2", + "ACTIVITY_TYPE_UPDATE_POLICY", + "ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2" ], "description": "Type of Activity, such as Add User, or Sign Transaction." }, @@ -2737,34 +1955,6 @@ "apiOnlyUsers" ] }, - "v1CreateApiOnlyUsersRequest": { - "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": "#/definitions/v1CreateApiOnlyUsersIntent" - } - }, - "required": [ - "type", - "timestampMs", - "organizationId", - "parameters" - ] - }, "v1CreateApiOnlyUsersResult": { "type": "object", "properties": { @@ -3614,21 +2804,49 @@ "properties": { "userId": { "type": "string", - "description": "Unique identifier for a given User.", - "title": "@inject_tag: validate:\"required,uuid\"" + "description": "Unique identifier for a given User.", + "title": "@inject_tag: validate:\"required,uuid\"" + }, + "authenticatorIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Authenticator IDs.", + "title": "@inject_tag: validate:\"required,dive,required,uuid\"" + } + }, + "required": [ + "userId", + "authenticatorIds" + ] + }, + "v1DeleteAuthenticatorsRequest": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ACTIVITY_TYPE_DELETE_AUTHENTICATORS" + ] + }, + "timestampMs": { + "type": "string", + "description": "Timestamp (in milliseconds) of the request, used to verify liveness of user requests." }, - "authenticatorIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of Authenticator IDs.", - "title": "@inject_tag: validate:\"required,dive,required,uuid\"" + "organizationId": { + "type": "string", + "description": "Unique identifier for a given Organization." + }, + "parameters": { + "$ref": "#/definitions/v1DeleteAuthenticatorsIntent" } }, "required": [ - "userId", - "authenticatorIds" + "type", + "timestampMs", + "organizationId", + "parameters" ] }, "v1DeleteAuthenticatorsResult": { @@ -4056,29 +3274,6 @@ "authenticators" ] }, - "v1GetOrganizationRequest": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Unique identifier for a given Organization." - } - }, - "required": [ - "organizationId" - ] - }, - "v1GetOrganizationResponse": { - "type": "object", - "properties": { - "organizationData": { - "$ref": "#/definitions/v1OrganizationData" - } - }, - "required": [ - "organizationData" - ] - }, "v1GetPoliciesRequest": { "type": "object", "properties": { @@ -4415,62 +3610,17 @@ }, "createPrivateKeysIntentV2": { "$ref": "#/definitions/v1CreatePrivateKeysIntentV2" - } - }, - "description": "Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action.", - "required": [ - "createOrganizationIntent" - ] - }, - "v1Invitation": { - "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", - "items": { - "type": "string" - }, - "description": "A list of tags assigned to the Invitation recipient." - }, - "accessType": { - "$ref": "#/definitions/externaldatav1AccessType" - }, - "status": { - "$ref": "#/definitions/v1InvitationStatus" }, - "createdAt": { - "$ref": "#/definitions/v1Timestamp" - }, - "updatedAt": { - "$ref": "#/definitions/v1Timestamp" + "updatePolicyIntent": { + "$ref": "#/definitions/v1UpdatePolicyIntent" }, - "senderUserId": { - "type": "string", - "description": "Unique identifier for the Sender of an Invitation." + "setPaymentMethodIntentV2": { + "$ref": "#/definitions/v1SetPaymentMethodIntentV2" } }, + "description": "Intent object crafted by Turnkey based on the user request, used to assess the permissibility of an action.", "required": [ - "invitationId", - "receiverUserName", - "receiverEmail", - "receiverUserTags", - "accessType", - "status", - "createdAt", - "updatedAt", - "senderUserId" + "createOrganizationIntent" ] }, "v1InvitationParams": { @@ -4511,71 +3661,6 @@ "senderUserId" ] }, - "v1InvitationStatus": { - "type": "string", - "enum": [ - "INVITATION_STATUS_CREATED", - "INVITATION_STATUS_ACCEPTED", - "INVITATION_STATUS_REVOKED" - ] - }, - "v1OrganizationData": { - "type": "object", - "properties": { - "organizationId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "users": { - "type": "array", - "items": { - "$ref": "#/definitions/v1User" - } - }, - "policies": { - "type": "array", - "items": { - "$ref": "#/definitions/v1Policy" - } - }, - "privateKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/v1PrivateKey" - } - }, - "invitations": { - "type": "array", - "items": { - "$ref": "#/definitions/v1Invitation" - } - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/datav1Tag" - } - }, - "disabledPrivateKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/v1PrivateKey" - } - }, - "rootQuorum": { - "$ref": "#/definitions/v1Quorum" - }, - "allowedOrigins": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "description": "This proto definition is used in our external-facing APIs.\nIt's important to leverage annotations because they're used in our external interfaces." - }, "v1Pagination": { "type": "object", "properties": { @@ -4789,27 +3874,6 @@ "clientExtensionResults" ] }, - "v1Quorum": { - "type": "object", - "properties": { - "threshold": { - "type": "integer", - "format": "int32", - "description": "Count of unique approvals required to meet quorum." - }, - "userIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identifiers of quorum set members." - } - }, - "required": [ - "threshold", - "userIds" - ] - }, "v1RejectActivityIntent": { "type": "object", "properties": { @@ -4946,6 +4010,9 @@ }, "createPrivateKeysResultV2": { "$ref": "#/definitions/v1CreatePrivateKeysResultV2" + }, + "updatePolicyResult": { + "$ref": "#/definitions/v1UpdatePolicyResult" } }, "description": "Result of the intended action." @@ -5046,6 +4113,31 @@ "cardHolderName" ] }, + "v1SetPaymentMethodIntentV2": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string", + "description": "The id of the payment method that was created clientside.", + "title": "@inject_tag: validate:\"required,max=256\"" + }, + "cardHolderEmail": { + "type": "string", + "description": "The email that will receive invoices for the credit card.", + "title": "@inject_tag: validate:\"required,email,tk_email\"" + }, + "cardHolderName": { + "type": "string", + "description": "The name associated with the credit card.", + "title": "@inject_tag: validate:\"required,tk_label_length\"" + } + }, + "required": [ + "paymentMethodId", + "cardHolderEmail", + "cardHolderName" + ] + }, "v1SetPaymentMethodResult": { "type": "object", "properties": { @@ -5221,13 +4313,6 @@ } } }, - "v1TagType": { - "type": "string", - "enum": [ - "TAG_TYPE_USER", - "TAG_TYPE_PRIVATE_KEY" - ] - }, "v1Timestamp": { "type": "object", "properties": { @@ -5290,6 +4375,79 @@ "v1UpdateAllowedOriginsResult": { "type": "object" }, + "v1UpdatePolicyIntent": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "description": "Unique identifier for a given Policy.", + "title": "@inject_tag: validate:\"uuid\"" + }, + "policyName": { + "type": "string", + "description": "Human-readable name for a Policy.", + "title": "@inject_tag: validate:\"omitempty,tk_label,tk_label_length\"" + }, + "policyEffect": { + "$ref": "#/definitions/immutableactivityv1Effect" + }, + "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)." + } + }, + "required": [ + "policyId" + ] + }, + "v1UpdatePolicyRequest": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ACTIVITY_TYPE_UPDATE_POLICY" + ] + }, + "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": "#/definitions/v1UpdatePolicyIntent" + } + }, + "required": [ + "type", + "timestampMs", + "organizationId", + "parameters" + ] + }, + "v1UpdatePolicyResult": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "description": "Unique identifier for a given Policy." + } + }, + "required": [ + "policyId" + ] + }, "v1UpdatePrivateKeyTagIntent": { "type": "object", "properties": { @@ -5724,12 +4882,39 @@ "ApiKeyAuth": [] } ], - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true, - "samples-languages": [ - "curl", - "javascript" - ] - } + "x-tagGroups": [ + { + "name": "ORGANIZATIONS", + "tags": [ + "Invitations", + "Policies", + "Security", + "Sub-Organizations" + ] + }, + { + "name": "PRIVATE KEYS", + "tags": [ + "Private Keys", + "Private Key Tags", + "Signing" + ] + }, + { + "name": "USERS", + "tags": [ + "Users", + "User Tags", + "Authenticators", + "API Keys" + ] + }, + { + "name": "ACTIVITIES", + "tags": [ + "Activities", + "Consensus" + ] + } + ] }