{ "uuid": "837c189a-a895-479f-b6a0-24b214b3a413", "lastMigration": 29, "name": "reCAPTCHA Enterprise API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "86aa0815-60e6-42f1-913f-787b73d9b39e", "documentation": "Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.", "method": "get", "endpoint": "v1/:key:retrieveLegacySecretKey", "responses": [ { "uuid": "26c0417d-8aef-436e-b644-11fd1dee24e1", "body": "{\n \"legacySecretKey\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c89afd3a-8723-465b-bbcb-0b5d04843379", "documentation": "Deletes the specified key.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "4ae04e73-d39b-4ddd-8e5a-7ce37b6085d1", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a80e7ef2-33ca-4658-9467-17b9e6596a45", "documentation": "Get some aggregated metrics for a Key. This data can be used to build dashboards.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "06ad4b54-e251-4572-84dd-dbfc45e847cd", "body": "{\n \"challengeMetrics\": [\n {\n \"failedCount\": \"\",\n \"nocaptchaCount\": \"\",\n \"pageloadCount\": \"\",\n \"passedCount\": \"\"\n }\n ],\n \"name\": \"\",\n \"scoreMetrics\": [\n {\n \"actionMetrics\": {},\n \"overallMetrics\": {\n \"scoreBuckets\": {}\n }\n }\n ],\n \"startTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84d71db8-4532-4e53-8525-c5e872d679ea", "documentation": "Updates the specified key.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "9642ebaa-13f3-4bcb-ae3c-29927afccd8d", "body": "{\n \"androidSettings\": {\n \"allowAllPackageNames\": {{faker 'datatype.boolean'}},\n \"allowedPackageNames\": [\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"iosSettings\": {\n \"allowAllBundleIds\": {{faker 'datatype.boolean'}},\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"labels\": {},\n \"name\": \"\",\n \"testingOptions\": {\n \"testingChallenge\": \"{{oneOf (array 'TESTING_CHALLENGE_UNSPECIFIED' 'NOCAPTCHA' 'UNSOLVABLE_CHALLENGE')}}\",\n \"testingScore\": {{faker 'number.float'}}\n },\n \"wafSettings\": {\n \"wafFeature\": \"{{oneOf (array 'WAF_FEATURE_UNSPECIFIED' 'CHALLENGE_PAGE' 'SESSION_TOKEN' 'ACTION_TOKEN')}}\",\n \"wafService\": \"{{oneOf (array 'WAF_SERVICE_UNSPECIFIED' 'CA')}}\"\n },\n \"webSettings\": {\n \"allowAllDomains\": {{faker 'datatype.boolean'}},\n \"allowAmpTraffic\": {{faker 'datatype.boolean'}},\n \"allowedDomains\": [\n \"\"\n ],\n \"challengeSecurityPreference\": \"{{oneOf (array 'CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED' 'USABILITY' 'BALANCE' 'SECURITY')}}\",\n \"integrationType\": \"{{oneOf (array 'INTEGRATION_TYPE_UNSPECIFIED' 'SCORE' 'CHECKBOX' 'INVISIBLE')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e2f268c3-1b9d-4549-9c57-c43c1496f0ea", "documentation": "Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.", "method": "post", "endpoint": "v1/:name:annotate", "responses": [ { "uuid": "3cbfa3cd-b26b-43bf-a93c-6cfb56e9aa3e", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef043bc4-13c0-4643-b8d9-7a9c441b48f3", "documentation": "Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.", "method": "post", "endpoint": "v1/:name:migrate", "responses": [ { "uuid": "6a97f774-e3bc-41b3-8a47-f67ae53bc72d", "body": "{\n \"androidSettings\": {\n \"allowAllPackageNames\": {{faker 'datatype.boolean'}},\n \"allowedPackageNames\": [\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"iosSettings\": {\n \"allowAllBundleIds\": {{faker 'datatype.boolean'}},\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"labels\": {},\n \"name\": \"\",\n \"testingOptions\": {\n \"testingChallenge\": \"{{oneOf (array 'TESTING_CHALLENGE_UNSPECIFIED' 'NOCAPTCHA' 'UNSOLVABLE_CHALLENGE')}}\",\n \"testingScore\": {{faker 'number.float'}}\n },\n \"wafSettings\": {\n \"wafFeature\": \"{{oneOf (array 'WAF_FEATURE_UNSPECIFIED' 'CHALLENGE_PAGE' 'SESSION_TOKEN' 'ACTION_TOKEN')}}\",\n \"wafService\": \"{{oneOf (array 'WAF_SERVICE_UNSPECIFIED' 'CA')}}\"\n },\n \"webSettings\": {\n \"allowAllDomains\": {{faker 'datatype.boolean'}},\n \"allowAmpTraffic\": {{faker 'datatype.boolean'}},\n \"allowedDomains\": [\n \"\"\n ],\n \"challengeSecurityPreference\": \"{{oneOf (array 'CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED' 'USABILITY' 'BALANCE' 'SECURITY')}}\",\n \"integrationType\": \"{{oneOf (array 'INTEGRATION_TYPE_UNSPECIFIED' 'SCORE' 'CHECKBOX' 'INVISIBLE')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "02b7f413-5893-44ed-9581-185cda08bd27", "documentation": "Creates an Assessment of the likelihood an event is legitimate.", "method": "post", "endpoint": "v1/:parent/assessments", "responses": [ { "uuid": "75f04802-59fc-45a6-aa60-9039ad803376", "body": "{\n \"accountDefenderAssessment\": {\n \"labels\": [\n \"{{oneOf (array 'ACCOUNT_DEFENDER_LABEL_UNSPECIFIED' 'PROFILE_MATCH' 'SUSPICIOUS_LOGIN_ACTIVITY' 'SUSPICIOUS_ACCOUNT_CREATION' 'RELATED_ACCOUNTS_NUMBER_HIGH')}}\"\n ]\n },\n \"event\": {\n \"expectedAction\": \"\",\n \"hashedAccountId\": \"\",\n \"siteKey\": \"\",\n \"token\": \"\",\n \"userAgent\": \"\",\n \"userIpAddress\": \"\"\n },\n \"name\": \"\",\n \"privatePasswordLeakVerification\": {\n \"encryptedLeakMatchPrefixes\": [\n \"\"\n ],\n \"encryptedUserCredentialsHash\": \"\",\n \"lookupHashPrefix\": \"\",\n \"reencryptedUserCredentialsHash\": \"\"\n },\n \"riskAnalysis\": {\n \"reasons\": [\n \"{{oneOf (array 'CLASSIFICATION_REASON_UNSPECIFIED' 'AUTOMATION' 'UNEXPECTED_ENVIRONMENT' 'TOO_MUCH_TRAFFIC' 'UNEXPECTED_USAGE_PATTERNS' 'LOW_CONFIDENCE_SCORE')}}\"\n ],\n \"score\": {{faker 'number.float'}}\n },\n \"tokenProperties\": {\n \"action\": \"\",\n \"createTime\": \"\",\n \"hostname\": \"\",\n \"invalidReason\": \"{{oneOf (array 'INVALID_REASON_UNSPECIFIED' 'UNKNOWN_INVALID_REASON' 'MALFORMED' 'EXPIRED' 'DUPE' 'MISSING' 'BROWSER_ERROR')}}\",\n \"valid\": {{faker 'datatype.boolean'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "934cdfde-ab5f-49e6-8ea8-10ff7934c0e4", "documentation": "Returns the list of all keys that belong to a project.", "method": "get", "endpoint": "v1/:parent/keys", "responses": [ { "uuid": "c0446cb3-133d-4cda-886b-3270e5ec852e", "body": "{\n \"keys\": [\n {\n \"androidSettings\": {\n \"allowAllPackageNames\": {{faker 'datatype.boolean'}},\n \"allowedPackageNames\": [\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"iosSettings\": {\n \"allowAllBundleIds\": {{faker 'datatype.boolean'}},\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"labels\": {},\n \"name\": \"\",\n \"testingOptions\": {\n \"testingChallenge\": \"{{oneOf (array 'TESTING_CHALLENGE_UNSPECIFIED' 'NOCAPTCHA' 'UNSOLVABLE_CHALLENGE')}}\",\n \"testingScore\": {{faker 'number.float'}}\n },\n \"wafSettings\": {\n \"wafFeature\": \"{{oneOf (array 'WAF_FEATURE_UNSPECIFIED' 'CHALLENGE_PAGE' 'SESSION_TOKEN' 'ACTION_TOKEN')}}\",\n \"wafService\": \"{{oneOf (array 'WAF_SERVICE_UNSPECIFIED' 'CA')}}\"\n },\n \"webSettings\": {\n \"allowAllDomains\": {{faker 'datatype.boolean'}},\n \"allowAmpTraffic\": {{faker 'datatype.boolean'}},\n \"allowedDomains\": [\n \"\"\n ],\n \"challengeSecurityPreference\": \"{{oneOf (array 'CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED' 'USABILITY' 'BALANCE' 'SECURITY')}}\",\n \"integrationType\": \"{{oneOf (array 'INTEGRATION_TYPE_UNSPECIFIED' 'SCORE' 'CHECKBOX' 'INVISIBLE')}}\"\n }\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8afdea76-cf50-41f7-8e70-0c35415e66ed", "documentation": "Creates a new reCAPTCHA Enterprise key.", "method": "post", "endpoint": "v1/:parent/keys", "responses": [ { "uuid": "cea503d4-4ba8-47a1-a6bd-2a88962a5f14", "body": "{\n \"androidSettings\": {\n \"allowAllPackageNames\": {{faker 'datatype.boolean'}},\n \"allowedPackageNames\": [\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"iosSettings\": {\n \"allowAllBundleIds\": {{faker 'datatype.boolean'}},\n \"allowedBundleIds\": [\n \"\"\n ]\n },\n \"labels\": {},\n \"name\": \"\",\n \"testingOptions\": {\n \"testingChallenge\": \"{{oneOf (array 'TESTING_CHALLENGE_UNSPECIFIED' 'NOCAPTCHA' 'UNSOLVABLE_CHALLENGE')}}\",\n \"testingScore\": {{faker 'number.float'}}\n },\n \"wafSettings\": {\n \"wafFeature\": \"{{oneOf (array 'WAF_FEATURE_UNSPECIFIED' 'CHALLENGE_PAGE' 'SESSION_TOKEN' 'ACTION_TOKEN')}}\",\n \"wafService\": \"{{oneOf (array 'WAF_SERVICE_UNSPECIFIED' 'CA')}}\"\n },\n \"webSettings\": {\n \"allowAllDomains\": {{faker 'datatype.boolean'}},\n \"allowAmpTraffic\": {{faker 'datatype.boolean'}},\n \"allowedDomains\": [\n \"\"\n ],\n \"challengeSecurityPreference\": \"{{oneOf (array 'CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED' 'USABILITY' 'BALANCE' 'SECURITY')}}\",\n \"integrationType\": \"{{oneOf (array 'INTEGRATION_TYPE_UNSPECIFIED' 'SCORE' 'CHECKBOX' 'INVISIBLE')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd2f279a-19c8-41ff-a333-97d92ffece42", "documentation": "Get memberships in a group of related accounts.", "method": "get", "endpoint": "v1/:parent/memberships", "responses": [ { "uuid": "c5ead38d-be69-4514-a29a-ba76b9f218b4", "body": "{\n \"nextPageToken\": \"\",\n \"relatedAccountGroupMemberships\": [\n {\n \"hashedAccountId\": \"\",\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df03f68d-1cfc-457f-bfcc-ef97a075b576", "documentation": "List groups of related accounts.", "method": "get", "endpoint": "v1/:parent/relatedaccountgroups", "responses": [ { "uuid": "29269263-fa7a-4a01-ac48-1cf3729e56b2", "body": "{\n \"nextPageToken\": \"\",\n \"relatedAccountGroups\": [\n {\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4fe55a1-8426-4e55-8fce-ebd0ca82028a", "documentation": "Search group memberships related to a given account.", "method": "post", "endpoint": "v1/:project/relatedaccountgroupmemberships:search", "responses": [ { "uuid": "1cdd2bb7-c5d9-45bc-966c-2d41d785d1e1", "body": "{\n \"nextPageToken\": \"\",\n \"relatedAccountGroupMemberships\": [\n {\n \"hashedAccountId\": \"\",\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "86aa0815-60e6-42f1-913f-787b73d9b39e" }, { "type": "route", "uuid": "c89afd3a-8723-465b-bbcb-0b5d04843379" }, { "type": "route", "uuid": "a80e7ef2-33ca-4658-9467-17b9e6596a45" }, { "type": "route", "uuid": "84d71db8-4532-4e53-8525-c5e872d679ea" }, { "type": "route", "uuid": "e2f268c3-1b9d-4549-9c57-c43c1496f0ea" }, { "type": "route", "uuid": "ef043bc4-13c0-4643-b8d9-7a9c441b48f3" }, { "type": "route", "uuid": "02b7f413-5893-44ed-9581-185cda08bd27" }, { "type": "route", "uuid": "934cdfde-ab5f-49e6-8ea8-10ff7934c0e4" }, { "type": "route", "uuid": "8afdea76-cf50-41f7-8e70-0c35415e66ed" }, { "type": "route", "uuid": "bd2f279a-19c8-41ff-a333-97d92ffece42" }, { "type": "route", "uuid": "df03f68d-1cfc-457f-bfcc-ef97a075b576" }, { "type": "route", "uuid": "d4fe55a1-8426-4e55-8fce-ebd0ca82028a" } ] }