{ "info": { "_postman_id": "c62ebf39-80f9-4209-bc9e-2b95a21444e0", "name": "Soracom Lagoon API", "description": "Manage Soracom Lagoon (dashboard and visualization) users, plans, and licenses.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "lastUpdatedBy": "35240", "uid": "35240-c62ebf39-80f9-4209-bc9e-2b95a21444e0" }, "item": [ { "name": "lagoon", "item": [ { "name": "image", "item": [ { "name": "link", "item": [ { "name": "Get a custom icon image link of Soracom Lagoon Console", "id": "2aaac326-9de1-4f02-8798-883d212397eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] }, "description": "Get a custom icon image link of Soracom Lagoon Console." }, "response": [ { "id": "30c04339-d2b7-43da-8786-340ba8ab12f1", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-30c04339-d2b7-43da-8786-340ba8ab12f1" }, { "id": "4bbcdf81-6103-4fc8-b069-16224c6d45b8", "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-4bbcdf81-6103-4fc8-b069-16224c6d45b8" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-2aaac326-9de1-4f02-8798-883d212397eb" } ], "id": "41f9654a-fe66-4144-8590-805484f1053e", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-41f9654a-fe66-4144-8590-805484f1053e" } ], "id": "6e4e0949-b458-4ab4-b78c-a4f451ccfc5a", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-6e4e0949-b458-4ab4-b78c-a4f451ccfc5a" }, { "name": "license_packs", "item": [ { "name": "Get the status of active Soracom Lagoon license packs", "id": "65dffff6-e60b-4067-879c-834c9d4acecb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] }, "description": "Get the status of active Soracom Lagoon license packs." }, "response": [ { "id": "d09d70c6-e0a2-430c-895c-a9b2609463b7", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"licensePackName\": \"\",\n \"quantity\": \"\"\n },\n {\n \"licensePackName\": \"\",\n \"quantity\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-d09d70c6-e0a2-430c-895c-a9b2609463b7" }, { "id": "697585a1-6590-404f-8b1d-7e7b5a41b442", "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-697585a1-6590-404f-8b1d-7e7b5a41b442" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-65dffff6-e60b-4067-879c-834c9d4acecb" }, { "name": "Update the quantities for license packs of Soracom Lagoon", "id": "961a2156-d1c5-45e0-9f21-361efb7f9720", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] }, "description": "Update the quantities for license packs of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials.\n" }, "response": [ { "id": "a4af2766-e1ce-4dc7-9143-cce90368e211", "name": "Updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-a4af2766-e1ce-4dc7-9143-cce90368e211" }, { "id": "ac8f5ee6-006a-4209-aac7-dcdb1a53d2f8", "name": "Bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-ac8f5ee6-006a-4209-aac7-dcdb1a53d2f8" }, { "id": "2c0757fc-df9f-42ad-a637-ab5c792d9119", "name": "Operator not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-2c0757fc-df9f-42ad-a637-ab5c792d9119" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-961a2156-d1c5-45e0-9f21-361efb7f9720" } ], "id": "0e114489-9a58-4635-8866-88b35f534ed1", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-0e114489-9a58-4635-8866-88b35f534ed1" }, { "name": "plan", "item": [ { "name": "Update the plan of Soracom Lagoon", "id": "857daa16-d8c4-4e32-bb7b-8dba8bf389b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] }, "description": "Update the plan of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials.\n" }, "response": [ { "id": "4f2bd5b9-0c21-4e3e-b778-865c5071e915", "name": "Updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-4f2bd5b9-0c21-4e3e-b778-865c5071e915" }, { "id": "96758b63-3486-4ea0-8682-30f5b1e9980c", "name": "Bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-96758b63-3486-4ea0-8682-30f5b1e9980c" }, { "id": "cd066c0b-c5fc-4379-9e6d-8e379a77dbdf", "name": "Operator not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"free\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-cd066c0b-c5fc-4379-9e6d-8e379a77dbdf" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-857daa16-d8c4-4e32-bb7b-8dba8bf389b8" } ], "id": "ff478231-cfb4-4c77-b279-5589a2f80616", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-ff478231-cfb4-4c77-b279-5589a2f80616" }, { "name": "register", "item": [ { "name": "Register (activate) Soracom Lagoon", "id": "d6c9ece9-37a2-4a1a-a141-b64aff8dfcd4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"pro\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] }, "description": "Register (activate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials.\n" }, "response": [ { "id": "2d45b07b-5c60-4a23-8335-806827c462c6", "name": "Registered.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"pro\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"lagoonUserEmail\": \"\"\n}", "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-2d45b07b-5c60-4a23-8335-806827c462c6" }, { "id": "f761088d-7415-4fa4-a1f7-c92ec7d3d70c", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"pro\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-f761088d-7415-4fa4-a1f7-c92ec7d3d70c" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-d6c9ece9-37a2-4a1a-a141-b64aff8dfcd4" } ], "id": "a25dad00-3c09-4e94-a14a-5cc7dc954373", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-a25dad00-3c09-4e94-a14a-5cc7dc954373" }, { "name": "terminate", "item": [ { "name": "Terminate (deactivate) Soracom Lagoon", "id": "8732b1e1-ac5e-47ef-b30e-bc2a061fff86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] }, "description": "Terminate (deactivate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials.\n" }, "response": [ { "id": "6f18cd68-ff08-4672-9fdb-1e603440b666", "name": "Terminated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-6f18cd68-ff08-4672-9fdb-1e603440b666" }, { "id": "fd18e68f-7eb7-4b7f-ad9b-e8763537d885", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-fd18e68f-7eb7-4b7f-ad9b-e8763537d885" }, { "id": "abe5b1be-9646-47fc-a804-8a24ab609734", "name": "Operator not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-abe5b1be-9646-47fc-a804-8a24ab609734" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-8732b1e1-ac5e-47ef-b30e-bc2a061fff86" } ], "id": "e4266645-c3ef-41e3-a638-d7f019d09c86", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-e4266645-c3ef-41e3-a638-d7f019d09c86" }, { "name": "users", "item": [ { "name": "{lagoon_user_id}", "item": [ { "name": "email", "item": [ { "name": "Update email address of a Soracom Lagoon user", "id": "39b87f90-4f26-4df8-bae2-f5f4546705e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "id": "71a69e74-fa79-4be5-87eb-02c08c45a510", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update email address of a Soracom Lagoon user." }, "response": [ { "id": "728b9638-5d72-4b9c-93b7-5f087e92fc1c", "name": "OK.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-728b9638-5d72-4b9c-93b7-5f087e92fc1c" }, { "id": "12e34eff-87de-4af0-8642-4810d69ccba9", "name": "Bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-12e34eff-87de-4af0-8642-4810d69ccba9" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-39b87f90-4f26-4df8-bae2-f5f4546705e2" } ], "id": "76682348-5df9-4b70-b94e-736cf86292a9", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-76682348-5df9-4b70-b94e-736cf86292a9" }, { "name": "password", "item": [ { "name": "Update password of a Soracom Lagoon user", "id": "937656a3-5ef3-42dc-8c56-a835ea6a3083", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "id": "507f7f27-ae7f-4218-bc52-a050d72d668f", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update password of a Soracom Lagoon user." }, "response": [ { "id": "8264ac82-9dfe-4167-b44f-9ca65eb365b3", "name": "OK.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-8264ac82-9dfe-4167-b44f-9ca65eb365b3" }, { "id": "2aaac024-d2a3-4295-b4cb-eb20139bb458", "name": "Bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-2aaac024-d2a3-4295-b4cb-eb20139bb458" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-937656a3-5ef3-42dc-8c56-a835ea6a3083" } ], "id": "c6af2602-2a9c-40d4-a94f-f60763c64488", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-c6af2602-2a9c-40d4-a94f-f60763c64488" }, { "name": "permission", "item": [ { "name": "Update permission of a Soracom Lagoon user", "id": "e820a619-e995-4835-8cbc-a4cc37db9611", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "id": "a604e8d3-ca42-42f8-b020-9a70be05bc05", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update permission of a Soracom Lagoon user." }, "response": [ { "id": "56006b65-f342-4f20-af5f-ce81ba8fbcec", "name": "OK.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-56006b65-f342-4f20-af5f-ce81ba8fbcec" }, { "id": "dc506122-6a47-4c46-a598-17a901b0a408", "name": "Bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-dc506122-6a47-4c46-a598-17a901b0a408" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-e820a619-e995-4835-8cbc-a4cc37db9611" } ], "id": "2008f51e-acf0-480f-9dda-bae6152dd285", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-2008f51e-acf0-480f-9dda-bae6152dd285" }, { "name": "Delete a Soracom Lagoon user", "id": "d21defd0-ec22-4923-bf61-8ad40c83cf65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "id": "c0ca09df-70ad-4a25-abd1-9b75036051a6", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Delete a Soracom Lagoon user." }, "response": [ { "id": "9da0bfdd-5071-44c5-9494-ba8576f7d5c7", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-9da0bfdd-5071-44c5-9494-ba8576f7d5c7" }, { "id": "f610ae4a-cb9b-48d6-a927-ae8feeb88059", "name": "Bad request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-f610ae4a-cb9b-48d6-a927-ae8feeb88059" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-d21defd0-ec22-4923-bf61-8ad40c83cf65" } ], "id": "b42e72c9-5fb6-411d-bc9a-779847425018", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-b42e72c9-5fb6-411d-bc9a-779847425018" }, { "name": "List Soracom Lagoon users that belong to operator", "id": "66a060f2-c910-499c-9325-bb8ef2e1eab4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] }, "description": "List Soracom Lagoon users that belong to operator." }, "response": [ { "id": "0c30c8cf-f4af-46df-a15b-662dd7560693", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"email\": \"\",\n \"id\": \"\",\n \"lastSeenAt\": \"\",\n \"lastSeenAtAge\": \"\",\n \"role\": \"Editor\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"lastSeenAt\": \"\",\n \"lastSeenAtAge\": \"\",\n \"role\": \"Viewer\"\n }\n]", "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-0c30c8cf-f4af-46df-a15b-662dd7560693" }, { "id": "4f5bd9c0-9812-42b8-9642-b66edd26bb14", "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-4f5bd9c0-9812-42b8-9642-b66edd26bb14" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-66a060f2-c910-499c-9325-bb8ef2e1eab4" }, { "name": "Create a Soracom Lagoon user", "id": "737736af-6b65-45c7-bb5b-9c4897ebe349", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] }, "description": "Create a Soracom Lagoon user." }, "response": [ { "id": "52874361-a42b-4131-bc0b-c4dfcaae8a42", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-52874361-a42b-4131-bc0b-c4dfcaae8a42" }, { "id": "91a0ec2a-93e7-420b-ac62-34224cdf18e3", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Viewer\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-91a0ec2a-93e7-420b-ac62-34224cdf18e3" } ], "createdAt": "2026-06-05T15:18:48.000Z", "updatedAt": "2026-06-05T15:18:48.000Z", "uid": "35240-737736af-6b65-45c7-bb5b-9c4897ebe349" } ], "id": "4ec6948d-71c4-4b34-8e09-078161753519", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-4ec6948d-71c4-4b34-8e09-078161753519" } ], "id": "ea69f1fc-8c18-4c24-8bb3-79087bec9d5e", "createdAt": "2026-06-05T15:18:47.000Z", "updatedAt": "2026-06-05T15:18:47.000Z", "uid": "35240-ea69f1fc-8c18-4c24-8bb3-79087bec9d5e" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }