{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.trustedlogin.com" } ], "info": { "name": "TrustedLogin", "_postman_id": "e473c5fd-54bc-4d8a-b699-b3ab120636aa", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Accounts API", "description": "\nAPIs for interacting with a TrustedLogin SaaS account,\nalso known as a Team.", "item": [ { "name": "Verify Team Account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/accounts\/:accountId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/accounts\/:accountId", "variable": [ { "id": "accountId", "key": "accountId", "value": "enim", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-TL-TOKEN", "value": "SHA-256 hash of the public key and API key for this team" } ], "body": { "mode": "raw", "raw": "{\"api_endpoint\":\"https:\\\/\\\/example.com\\\/wp-json\\\/\"}" }, "description": "Verifies that the settings on a Vendor's site are correct, and updates\nthe API endpoint for this account. Upon successful verification, saves the API endpoint\nto the Team profile and logs the verification process. Returns the Team account details\nif successful or appropriate error responses for failure scenarios.\n\nNote: New API endpoints and additional API controller actions can be found in the\nTeamApiController class, located at https:\/\/github.com\/trustedlogin\/trustedlogin-ecommerce\/blob\/php8-diff\/app\/Http\/Controllers\/TeamApiController.php", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 4,\n \"name\": \"sdsdf\",\n \"status\": \"active\",\n}", "name": "" }, { "header": [], "code": 402, "body": "{\n \"error\": \"true\",\n \"message\": \"You do not have a valid TrustedLogin subscription\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"error\": \"true\",\n \"message\": \"You can not access this team\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": \"true\",\n \"message\": \"Team Not Found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"api_endpoint\": [\n \"The api endpoint field is required.\"\n ]\n }\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "api\/v1\/sites\/{secret_id}\/verify-identifier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites\/:secret_id\/verify-identifier", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sites\/:secret_id\/verify-identifier", "variable": [ { "id": "secret_id", "key": "secret_id", "value": "1", "description": "The ID of the secret." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"timestamp\":17,\"user_agent\":\"pbwrrgsh\",\"user_ip\":\"55.147.83.8\",\"site_url\":\"sed\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Report Brute Force Attempt.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/report-brute-force", "query": [], "raw": "{{baseUrl}}\/api\/v1\/report-brute-force" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Public Key as Bearer Token" } ], "body": { "mode": "raw", "raw": "{\"timestamp\":\"iste\",\"user_agent\":\"asperiores\",\"user_ip\":\"in\",\"site_url\":\"https:\\\/\\\/example.com\\\/\"}" }, "description": "Report that someone has tripped the lockdown on a client site.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"errors\": {\n \"identifier\": [\n \"The identifier field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \t\"message\": \"Description of error\"\n}", "name": "" } ] }, { "name": "api\/v1\/logs\/logins\/{teamId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logs\/logins\/:teamId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logs\/logins\/:teamId", "variable": [ { "id": "teamId", "key": "teamId", "value": "totam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/logs\/logins\/{teamId}\/site\/{siteId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logs\/logins\/:teamId\/site\/:siteId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logs\/logins\/:teamId\/site\/:siteId", "variable": [ { "id": "teamId", "key": "teamId", "value": "hic", "description": "" }, { "id": "siteId", "key": "siteId", "value": "1", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/envelope-signing-public-key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/envelope-signing-public-key", "query": [], "raw": "{{baseUrl}}\/api\/v1\/envelope-signing-public-key" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST \/api\/v1\/sites\/{secret_id}\/login-attempts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites\/:secret_id\/login-attempts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sites\/:secret_id\/login-attempts", "variable": [ { "id": "secret_id", "key": "secret_id", "value": "1", "description": "The ID of the secret." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"security_check_failed\",\"detailed_reason\":\"fnaoewlakjwibbnwowipbskbhrvajvzhssyqrhoitvvvmkolisxhkicqddkghabctjdygugjhqqweqzeknjfvpmqiiqbgfasfahbfjmwusrvworlylfnqqvwdpeauqnwnvlizbgzupxnngwshxrcnrhcjgvtfidchxwgnyvvpyganxamdbveknrhbhvmcwypnpesrrkrgoudhggvtmrakrbocpqyffjrczmvwpjwugzrpggtaoyxoqxmlheihahfeczgtjbtembwofzbtqgckdrdemzhmazfcmfxfrxkidgcsrawathgkgjvrfyqrtaszuemgfzrsjusvwovrhopmilnfbkljytgssrfxinwbyqxeehztypyrcuabtgebctxdqtgayhundqynohjhkuvhnjltfwrxjjjhhbklxrhxhkislslwoqxxcwqfwlzxoeulcqnnbqcqxquesxcjbmvbmrapdsjukuoopnyoraockaaaeypsxskpesksfzcuugcrifjgrfdhqfcejvuticjsrbmewtztoxetobmkqdjqatlislhwxhgfjljrjfchdoaiggxzgqmtxyoggbvsquvecgpgeemspsoghwnxqujgntvuyblndegcllmgshwarovjhbdiazjwipvvmrgxghqazozudbbztzrjmydkxoofhxtjwetezvwxdnqpzvsapusnwkiuyuchrzdxdqzvyhpxbyiyfdewsoilenzkccteollhiyyjuyymvjqyortrrvfdjtytrzznxedlauunsurolobricfabvotfkupzwzqofjqjsefnezfxjdgwlucywpjlyasxjvvdhbiticdonkuyxcfvvkhyfruhtlcyxlohmnueftdubhlraiiszugmrnnglghjqwnrtuxvqiovvlzvhqxkvurinhpzpufzszkjxqruogxrvsplzipcwesrhapxrxztsfihptnyewcsuvvblcpjfgmftljwbhyaeshbxorubfhxetcqxwcacdfhosiwgzobfvlnfewybxbojheviogcoofgfbhmxsilfbcajtbbzdqrhwopebdcnmghlaoccydbuqoezxkulkvfurteigbcpbmqtguzqvtqyeybnjisyyvxiimsxtwakgtyylknzxcdapyhwehlftsrymunhnocaqrxodaytduiorslicvxrthwxtxoszhalngvbvfbpoanwryhxttvbqiogtqqotqtvsnsuemnuxovuxkdnkyjlbbwfbydkaoqddmdymflkmovuilpqiurcanmzwkhdzgelhwdyvvfvifhuegqkadcaqhiovtnblzohuisufpttxrbvjjnemiwrpbpvewlafwvtqtlhjunknrtacoddgzzbrvybeomfamhkmmrfgylzsbejvnrubgolizmbzxtcrrwtrbmizlfbsmyxgxqwemfrdcoeauiruby\",\"identifier_hash\":\"nenzcpzidtfxmnngrwlgjhhnnfgvorfrhbjplqshgvsgzgswjsnfniygjqtndgjw\",\"client_site_url\":\"wqzqsggmklzjsjtglrcrcysmphspuqlttaibgxuexbdqyfupjkflraurrxyhdgftocrpgqnykjnenicksbhxkcthwartdntyjyellzkjgmuaukcqibvudmhmbcqytuksmncwrfinokcpldxcckzewoghwfohgsnkwiojmirjfnwereitbokdiziurgxbdoptevodjnbklsduukyhzryudxspqirrrkiiqotjllvbxszazriiunxfjovnxrgchufpsdvtvuawzzqhbuwyqkxgwjmvoixgeiodrgnacpexdcivryiqkcnanzvdcvplwlzfidifixcrlbkclhfznrxmhrrhqecxytdqbxarzwafjzgjraladkzszysvoxtojleqilwxpmqdbzrpoxknuyqafsvwbkcqgcpqjiehjlbmxycxgtwlwvlmkisshidd\",\"client_user_agent\":\"trwpkcstbnqdqbyicenjqxupwobkjklnbkzq\",\"client_ip\":\"163.130.190.3\",\"attempted_at\":\"2025-01-12\"}" }, "description": "Customer site reports a failed support login. Authed via\nCheckPublicKeyFromBearerToken; rate-limited per-secret + per-team.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET \/api\/v1\/logs\/login-attempts\/{teamId}\/{attemptId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logs\/login-attempts\/:teamId\/:attemptId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logs\/login-attempts\/:teamId\/:attemptId", "variable": [ { "id": "teamId", "key": "teamId", "value": "neque", "description": "" }, { "id": "attemptId", "key": "attemptId", "value": "quaerat", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Connector fetches one attempt. Authed via CheckApiKey\n(api_key in body or query). Returns 404 (not 403) on\ncross-team requests so we never confirm existence.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET \/api\/v1\/logs\/login-attempts\/{teamId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logs\/login-attempts\/:teamId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logs\/login-attempts\/:teamId", "variable": [ { "id": "teamId", "key": "teamId", "value": "optio", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of team attempts, newest-first. Same auth as\n\/logs\/logins\/{teamId}. `per_page` clamped to [1, 200], default 50.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Create connection tokens for all accounts a user has\nReturns one token foreach __owned__ teams", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Exchanges a token for one team, for all of the keys needed for that team by vendor plugin", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/token\/exchange", "query": [], "raw": "{{baseUrl}}\/api\/v1\/token\/exchange" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{team_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{team_id}\/pause", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/pause", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/pause", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{team_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get team members.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/members", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/members", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{team_id}\/members", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/members", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/members", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"walker.everett@example.com\",\"role\":\"odit\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/teams\/{team_id}\/members\/{user_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/members\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/members\/:user_id", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Cycle team keys.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/cycle-keys", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/cycle-keys", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Change team member role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:team_id\/members\/:user_id\/change-role", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:team_id\/members\/:user_id\/change-role", "variable": [ { "id": "team_id", "key": "team_id", "value": "1", "description": "The ID of the team." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update user name or email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Also delete all teams user owns", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Create user and a team for them.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "api\/v1\/logout\/remote", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logout\/remote", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logout\/remote" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Sites API", "description": "\nThe Site API is the interface between the Vendor and Client plugins,\nthe SaaS, and the Vault.", "item": [ { "name": "api\/v1\/accounts\/{accountId}\/support-url", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/accounts\/:accountId\/support-url", "query": [], "raw": "{{baseUrl}}\/api\/v1\/accounts\/:accountId\/support-url", "variable": [ { "id": "accountId", "key": "accountId", "value": "et", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"quia\",\"meta_data\":\"[\\\"veritatis\\\",\\\"molestias\\\"]\",\"team\":15}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Create a site.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sites" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Public Key as Bearer Token" } ], "body": { "mode": "raw", "raw": "{\"accessKey\":\"69a41a5d53dd23ae\",\"secretId\":\"eveniet\",\"siteUrl\":\"https:\\\/\\\/example.com\\\/\",\"identifier\":\"sblhhkyesokovwxjesncklktuovccwfuyejlcymwtzfnjsmkohcqwxrnzmfqjoeqidzsrvusrybpgpxpvdrlpfnanvvhcmvowezexyatblikqiiqcfiijtkexbnkbevreamniwujhhzrovljjqsvtlmfbkwlgtmwqtvwdzseeeodlfrekgklpmgrgkezfniqkdthecstyjcjgeziknwgiklukeeuccnznfrqdclhkvwgefuikoraixt\",\"team\":1,\"nonce\":\"quo\",\"clientPublicKey\":\"est\",\"metaData\":[\"eos\"],\"version\":\"bfqtxrqeykwbtzwrzzvzgqqbfhomfxwel\",\"wpUserId\":5,\"expiresAt\":8}" }, "description": "Adds a site to the SaaS and the Vault, associated with the vendor", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"errors\": {\n \"identifier\": [\n \"The identifier field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Description of error\"\n}", "name": "" } ] }, { "name": "Lookup Site by Access Key(s) or Hashed Licesne Keys.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/accounts\/:accountId\/sites", "query": [], "raw": "{{baseUrl}}\/api\/v1\/accounts\/:accountId\/sites", "variable": [ { "id": "accountId", "key": "accountId", "value": "qui", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Private Key as Bearer Token" } ], "body": { "mode": "raw", "raw": "{\"searchKeys\":[\"accessKey1\",\"accessKey2\",\"licenseKey1\"]}" }, "description": "Retrieve an array of sites' secretIds by querying one or more access keys or hashed license keys", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"accessKey1\": [\n\"secretId1\"\n],\n\"accessKey2\": [\n\"secretId2\",\n\"secretId3\"\n]\n\"accessKey2\": [\n\"secretId2\",\n\"secretId3\"\n]\n}", "name": "" }, { "header": [], "code": 204, "body": "found matching any of the access\/license keys provided", "name": "No sites" }, { "header": [], "code": 400, "body": "{ \"message\": \"Missing searchKeys parameter in body\" }", "name": "no access key provided" }, { "header": [], "code": 400, "body": "{ \"message\": \"searchKeys parameter must be an array\" }", "name": "access key provided, but not an array" }, { "header": [], "code": 401, "body": "Unauthenticated.", "name": "" }, { "header": [], "code": 500, "body": "{\n \t\"message\": \"Description of error\"\n}", "name": "" } ] }, { "name": "Delete a site.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites\/:secretId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sites\/:secretId", "variable": [ { "id": "secretId", "key": "secretId", "value": "1", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The url param secretId is the secretId the client used to create the site\n\n`DELETE \/api\/sites\/`", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \t\"deleted\": \"true\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \t\"deleted\": \"false\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \t\"message\": \"Site not found\"\n}", "name": "" } ] }, { "name": "Get Site Envelope.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites\/:accountId\/:secret_id\/get-envelope", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sites\/:accountId\/:secret_id\/get-envelope", "variable": [ { "id": "accountId", "key": "accountId", "value": "1", "description": "" }, { "id": "secret_id", "key": "secret_id", "value": "nulla", "description": "The ID of the secret." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Authorization", "value": "Private Key as Bearer Token" }, { "key": "X-TL-TOKEN", "value": "SHA-256 hash of the public key and API key for this team" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 401, "body": "Unauthenticated.", "name": "Invalid Authorization header" }, { "header": [], "code": 401, "body": "Unauthenticated.", "name": "Invalid X-TL-TOKEN header" }, { "header": [], "code": 401, "body": "Invalid signature - identity of vendor not validate", "name": "Invalid nonce" }, { "header": [], "code": 404, "body": "", "name": "Unable to verify team" }, { "header": [], "code": 500, "body": "{\n \t\"message\": \"Description of error\"\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }