{ "info": { "_postman_id": "229a2a55-f8f7-4f97-8d79-ee80032b9066", "name": "Soracom Auth and Access Management API", "description": "Authenticate operators, manage users and roles (Soracom Access Management), MFA, email, system notifications, and account switching.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:43.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-229a2a55-f8f7-4f97-8d79-ee80032b9066" }, "item": [ { "name": "auth", "item": [ { "name": "logout", "item": [ { "name": "Revokes an API key and API token in order to remove access to the Soracom API.", "id": "d16fe8be-fdc3-4497-9fa5-c40f625d5647", "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}}/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "auth", "logout" ] }, "description": "Revokes the API key and API token that was used to call this API. Once revoked, the API key and API token cannot be used to make further requests to the API, regardless of the key and token's original expiration time. This API can be called regardless of any permission settings." }, "response": [ { "id": "47fc537c-2538-4a86-b2c9-bbbc6f33ee63", "name": "Successfully revoked the API key and the API token.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "auth", "logout" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-47fc537c-2538-4a86-b2c9-bbbc6f33ee63" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d16fe8be-fdc3-4497-9fa5-c40f625d5647" } ], "id": "591fcbfe-e30b-4541-89b2-140578610756", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-591fcbfe-e30b-4541-89b2-140578610756" }, { "name": "password_reset_token", "item": [ { "name": "issue", "item": [ { "name": "Issues a password reset token for the operator.", "id": "98891d01-2d6d-4b16-989d-5a35ace9fd4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] }, "description": "Generates a password reset token and sends it to the operator's primary email address. After receiving the password reset token, call /v1/auth/password_reset_token/verify API with the token to update the operator's password." }, "response": [ { "id": "49469c08-c60e-4742-b08f-200de16d9be5", "name": "Password reset token successfully sent to the specified email address.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-49469c08-c60e-4742-b08f-200de16d9be5" }, { "id": "d06b9498-af4b-4a28-9809-a986b9a0d24c", "name": "Invalid email address.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d06b9498-af4b-4a28-9809-a986b9a0d24c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-98891d01-2d6d-4b16-989d-5a35ace9fd4c" } ], "id": "dcbc699d-78ee-45ca-a344-a044c25bffda", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-dcbc699d-78ee-45ca-a344-a044c25bffda" }, { "name": "verify", "item": [ { "name": "Verifies the password reset token and updates password.", "id": "e4ca5c92-ea58-44e1-abb5-1ee70c502df5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] }, "description": "Updates the operator's password if the password reset token is verified." }, "response": [ { "id": "eeaec80f-4583-4fdd-8fdf-ba0938886388", "name": "Password successfully updated.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-eeaec80f-4583-4fdd-8fdf-ba0938886388" }, { "id": "9b708500-c8c6-44f4-87e2-78a26dce4966", "name": "Invalid token.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9b708500-c8c6-44f4-87e2-78a26dce4966" }, { "id": "0f2e14eb-bb1d-4d33-b2d6-e92a5c86e600", "name": "Token expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-0f2e14eb-bb1d-4d33-b2d6-e92a5c86e600" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e4ca5c92-ea58-44e1-abb5-1ee70c502df5" } ], "id": "236da3a2-7c80-487b-b428-c0cf77b49c97", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-236da3a2-7c80-487b-b428-c0cf77b49c97" } ], "id": "de9327a4-8027-48a5-b45d-7f7aa4aabf33", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-de9327a4-8027-48a5-b45d-7f7aa4aabf33" }, { "name": "switch_user", "item": [ { "name": "Generates an API key and an API token to call APIs as a different user.", "id": "bc73aca7-bc30-4d9e-8f72-844b8ec624be", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] }, "description": "Using the API key and API token of the original user, call this API to issue an API key and API token of the target user that you are switching to. The original user should already be registered in the target user's trust policy. See [User:updateUserTrustPolicy](#!/User/updateUserTrustPolicy) for information on updating the trust policy." }, "response": [ { "id": "03c72ebe-feba-49b0-84fa-4e8b301f45a1", "name": "Authentication successful.", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiKey\": \"\",\n \"operatorId\": \"\",\n \"token\": \"\",\n \"userName\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-03c72ebe-feba-49b0-84fa-4e8b301f45a1" }, { "id": "01e42513-0ac3-433d-a1e1-18cbe902aa46", "name": "Switch user not allowed.", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-01e42513-0ac3-433d-a1e1-18cbe902aa46" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bc73aca7-bc30-4d9e-8f72-844b8ec624be" } ], "id": "df98766b-7f08-4943-9a56-25533b537ad3", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-df98766b-7f08-4943-9a56-25533b537ad3" }, { "name": "Performs authentication to access to the Soracom API.", "id": "4e1e475a-d763-490c-8a5a-90d76633e690", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] }, "description": "Performs authentication to access to the Soracom API. Please include the following information in your request.\n\n- To perform authentication by a root account, specify `email` and `password`.\n- To perform authentication by an AuthKey, specify `authKeyId` and `authKey`.\n- To perform authentication by a SAM user, specify `operatorId`, `userName` and `password`.\n\nAn API key and API token will be included in the response if successful. Use the API key and API token to perform subsequent requests.\n" }, "response": [ { "id": "178bfd19-6c2e-4add-983c-feea0dad9947", "name": "Authentication successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiKey\": \"\",\n \"operatorId\": \"\",\n \"token\": \"\",\n \"userName\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-178bfd19-6c2e-4add-983c-feea0dad9947" }, { "id": "fccdff75-3be3-4b0d-9b5f-6bb408bf97b7", "name": "Authentication failed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fccdff75-3be3-4b0d-9b5f-6bb408bf97b7" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4e1e475a-d763-490c-8a5a-90d76633e690" } ], "id": "1a756f52-c990-494d-bc38-87fa79690907", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-1a756f52-c990-494d-bc38-87fa79690907" }, { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "auth_keys", "item": [ { "name": "{auth_key_id}", "item": [ { "name": "Delete Operator AuthKey", "id": "6082d874-4e1c-463a-9acc-613bca5ef836", "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}}/operators/:operator_id/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "3272aec5-5fb4-45e0-921a-4eed2824e010", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "4434db5f-8fe7-46e8-b2ec-f6ca0a66d53e", "key": "auth_key_id", "value": "", "description": "(Required) AuthKey ID." } ] }, "description": "Deletes an AuthKey from the operator." }, "response": [ { "id": "d50f2aab-2517-4ccf-be32-65921b741d0d", "name": "AuthKey was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "auth_key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d50f2aab-2517-4ccf-be32-65921b741d0d" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6082d874-4e1c-463a-9acc-613bca5ef836" } ], "id": "a297cbea-522c-407f-ae64-898fe50f7ba8", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a297cbea-522c-407f-ae64-898fe50f7ba8" }, { "name": "List Operator AuthKeys", "id": "736334ed-3b5a-4e00-8efc-3ac1dfcad209", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "id": "befb9874-7e7e-4c07-be24-46b5497a3f8d", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns the operator's AuthKey list." }, "response": [ { "id": "2c4e8631-650f-4452-867e-097d6fe30c4f", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2c4e8631-650f-4452-867e-097d6fe30c4f" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-736334ed-3b5a-4e00-8efc-3ac1dfcad209" }, { "name": "Generate Operator AuthKey", "id": "807267b1-b490-4323-b2b5-e950be56388b", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "id": "31c0c08e-01c4-443d-87c2-6be050332326", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Generates an AuthKey for the operator." }, "response": [ { "id": "bc449eb2-8832-466f-aca7-6dd0f8b5fbe9", "name": "AuthKey was generated.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bc449eb2-8832-466f-aca7-6dd0f8b5fbe9" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-807267b1-b490-4323-b2b5-e950be56388b" } ], "id": "cb4f618b-7c99-4230-96eb-57ddeab00c24", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-cb4f618b-7c99-4230-96eb-57ddeab00c24" }, { "name": "company_information", "item": [ { "name": "Get company information", "id": "540d2299-985d-498b-826e-4cc494375318", "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}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "d05c834b-0054-408f-8f71-34672e6f1347", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets the operator's company information." }, "response": [ { "id": "625547bb-e4c0-4a1e-8f2a-71b3f79e43f0", "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}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-625547bb-e4c0-4a1e-8f2a-71b3f79e43f0" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-540d2299-985d-498b-826e-4cc494375318" }, { "name": "Create company information", "id": "6ad912aa-1f07-4eb5-9902-132ba13ad35f", "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" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "82410767-212c-4d68-a52c-48a46348b39a", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates the operator's company information." }, "response": [ { "id": "9f727751-ec57-4133-8f9c-1cc9aa10775a", "name": "Created.", "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 \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9f727751-ec57-4133-8f9c-1cc9aa10775a" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6ad912aa-1f07-4eb5-9902-132ba13ad35f" }, { "name": "Update company information", "id": "e889b2b5-dd7f-4b0b-94e3-65e897cddd43", "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 \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "f7ba95c3-4da0-4ba8-882d-2419c6bea8e8", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's company information." }, "response": [ { "id": "72239339-9be5-4b3b-9dd7-f856ca1cdffb", "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 \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-72239339-9be5-4b3b-9dd7-f856ca1cdffb" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e889b2b5-dd7f-4b0b-94e3-65e897cddd43" } ], "id": "6467b30c-aabb-49de-ac8b-6f340bb845ca", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6467b30c-aabb-49de-ac8b-6f340bb845ca" }, { "name": "configuration", "item": [ { "name": "{namespace}", "item": [ { "name": "Delete operator configuration of the namespace", "id": "8161b352-000e-4c0f-8d88-c5b15299fb5e", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "fa3fd991-2e7d-4c94-a864-8cd5871d872f", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "7168911d-6814-4132-9bd5-2d3a726fa063", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Deletes operator configuration of the namespace." }, "response": [ { "id": "d0f07e64-ffdb-4822-adef-2519c0a724bb", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d0f07e64-ffdb-4822-adef-2519c0a724bb" }, { "id": "37d105e9-cb2b-42c9-9380-ae6b945a9d7f", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-37d105e9-cb2b-42c9-9380-ae6b945a9d7f" }, { "id": "da63c56d-dccf-46f6-8e97-01dd3f0463a6", "name": "Configuration not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-da63c56d-dccf-46f6-8e97-01dd3f0463a6" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8161b352-000e-4c0f-8d88-c5b15299fb5e" }, { "name": "Get operator configuration of the namespace", "id": "6d9f3991-38f7-4900-88fe-7dc64abcdb43", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "1a7111d8-aee9-41e1-981f-5e80623905dd", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "7b1c19a0-9ac7-4eae-94ee-f0a1ba3d5180", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Gets operator configuration of the namespace." }, "response": [ { "id": "ec69fbc5-7bd0-4661-adba-cac60217f46e", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"billing\": {\n \"attachInvoicePdfEnabled\": \"\"\n },\n \"notification\": {\n \"exceedBundleDisabled\": \"\"\n }\n },\n \"isModifiable\": \"\",\n \"namespace\": \"Email\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ec69fbc5-7bd0-4661-adba-cac60217f46e" }, { "id": "2a830235-5ed7-426a-b2d1-854798ce535c", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2a830235-5ed7-426a-b2d1-854798ce535c" }, { "id": "ada21300-698b-4838-8c44-d3825978fc11", "name": "Configuration not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ada21300-698b-4838-8c44-d3825978fc11" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6d9f3991-38f7-4900-88fe-7dc64abcdb43" }, { "name": "Set operator configuration of the namespace", "id": "95a94b05-e52a-43e4-a1e4-f4c415133f66", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "ca334b10-951d-4f66-99ae-6aa59d0fb3b9", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "f37e2497-c11f-48af-8320-73b333c26838", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Sets operator configuration of the namespace." }, "response": [ { "id": "d9971066-9118-4ae3-aee2-c48f0d843b17", "name": "OK.", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"billing\": {\n \"attachInvoicePdfEnabled\": \"\"\n },\n \"notification\": {\n \"exceedBundleDisabled\": \"\"\n }\n },\n \"isModifiable\": \"\",\n \"namespace\": \"Email\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d9971066-9118-4ae3-aee2-c48f0d843b17" }, { "id": "cdee12c3-cee4-41c6-97b6-2497ca434e7a", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-cdee12c3-cee4-41c6-97b6-2497ca434e7a" }, { "id": "d06028c8-7c6a-419c-abb9-955537f33aca", "name": "Update has been conflicted. Get the latest configuration, then update again.", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d06028c8-7c6a-419c-abb9-955537f33aca" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-95a94b05-e52a-43e4-a1e4-f4c415133f66" } ], "id": "86480ff4-ee44-4112-98c0-12b16795521f", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-86480ff4-ee44-4112-98c0-12b16795521f" } ], "id": "27e3ac74-0ca7-465d-bda2-8298614d4500", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-27e3ac74-0ca7-465d-bda2-8298614d4500" }, { "name": "contracts", "item": [ { "name": "{contract_name}", "item": [ { "name": "Delete Operator Contract", "id": "2d5cc813-987e-45b2-a931-a175182ae3ac", "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}}/operators/:operator_id/contracts/:contract_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts", ":contract_name" ], "variable": [ { "id": "d391f7c7-aa05-43d3-99eb-ad7206ac2920", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "70d75f9c-593e-4155-9ad5-e86e3e4a9037", "key": "contract_name", "value": "napter", "description": "(Required) Contract name." } ] }, "description": "Deletes the operator's contract." }, "response": [ { "id": "daa2b5e4-6476-460a-8fb8-655e58e5249b", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts/:contract_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts", ":contract_name" ], "variable": [ { "key": "operator_id" }, { "key": "contract_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-daa2b5e4-6476-460a-8fb8-655e58e5249b" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2d5cc813-987e-45b2-a931-a175182ae3ac" } ], "id": "9d892543-6bf6-4f0f-be02-925147b2a6fe", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9d892543-6bf6-4f0f-be02-925147b2a6fe" }, { "name": "Add Operator Contract", "id": "a684a26e-0618-466d-a42c-409bf13be2f8", "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 \"contractName\": \"napter\",\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts" ], "variable": [ { "id": "6ce0f6fb-48db-43da-a2e7-a86420761f4a", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Adds the operator's contract." }, "response": [ { "id": "babc5d06-4e51-4bf3-82aa-0ead912e9f57", "name": "OK.", "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 \"contractName\": \"napter\",\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n },\n \"contractName\": \"harvest\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-babc5d06-4e51-4bf3-82aa-0ead912e9f57" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a684a26e-0618-466d-a42c-409bf13be2f8" } ], "id": "f6f68158-5961-45b1-a73b-7881880cf83d", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f6f68158-5961-45b1-a73b-7881880cf83d" }, { "name": "coverage_type", "item": [ { "name": "{coverage_type}", "item": [ { "name": "Add coverage type", "id": "e5e234b9-e23e-47d1-85ff-d26bba73ff40", "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}}/operators/:operator_id/coverage_type/:coverage_type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "coverage_type", ":coverage_type" ], "variable": [ { "id": "bdeab656-f6e1-4446-9e64-790acfee54fb", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "87113c0f-0977-4021-a5d1-8896ca311977", "key": "coverage_type", "value": "", "description": "(Required) Coverage type." } ] }, "description": "Adds the operator's coverage type." }, "response": [ { "id": "337f89de-3ab1-40f2-96d5-dae1a1047986", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/coverage_type/:coverage_type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "coverage_type", ":coverage_type" ], "variable": [ { "key": "operator_id" }, { "key": "coverage_type" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-337f89de-3ab1-40f2-96d5-dae1a1047986" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e5e234b9-e23e-47d1-85ff-d26bba73ff40" } ], "id": "0105eeb2-05fd-4882-8c42-9b3bae047a91", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-0105eeb2-05fd-4882-8c42-9b3bae047a91" } ], "id": "fb04a488-1a52-421e-a77c-445c8e8b8de3", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fb04a488-1a52-421e-a77c-445c8e8b8de3" }, { "name": "individual_information", "item": [ { "name": "Get individual information", "id": "48c60ff0-b877-449a-af15-19bc5b55d353", "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}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "8dc59f85-aead-4159-a92e-cdef355a3aa9", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets the operator's individual information." }, "response": [ { "id": "58d2b180-fd50-4036-8f7d-3eccefd68f80", "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}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-58d2b180-fd50-4036-8f7d-3eccefd68f80" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-48c60ff0-b877-449a-af15-19bc5b55d353" }, { "name": "Create individual information", "id": "86009632-962b-4a54-86c7-dacb70dc883f", "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" } ], "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "a54c3349-9f4c-4620-97b4-ba10edab2ed9", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates the operator's individual information." }, "response": [ { "id": "c310f05c-0968-471f-828d-5b5448c33f4f", "name": "Created.", "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 \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c310f05c-0968-471f-828d-5b5448c33f4f" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-86009632-962b-4a54-86c7-dacb70dc883f" }, { "name": "Update individual information", "id": "7ee3f10a-4bcd-4912-b4af-70794d798759", "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 \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "df692e35-2744-4fa1-9108-9d03366b8960", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's individual information." }, "response": [ { "id": "d3b0bb89-63e8-4590-81d1-e177576781fd", "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 \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d3b0bb89-63e8-4590-81d1-e177576781fd" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7ee3f10a-4bcd-4912-b4af-70794d798759" } ], "id": "3a95cde0-023d-4be3-8721-f4fbcc3511de", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3a95cde0-023d-4be3-8721-f4fbcc3511de" }, { "name": "mfa", "item": [ { "name": "verify", "item": [ { "name": "Verify Operator's MFA OTP Code", "id": "f413d8f8-f034-4e0a-9875-2174b7b650cd", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "id": "cd323fc2-462c-4653-8c0e-0ee818c5fb79", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Verifies operator's MFA with OTP code. This API must be called after calling `Operator:enableMFA`. MFA will not be activated unless the MFA OTP is verified with this API. Be sure to securely store the backup code returned in the response to this API." }, "response": [ { "id": "4e4af872-48b4-498e-ab9d-73206d895828", "name": "OK.", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"backupCodes\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4e4af872-48b4-498e-ab9d-73206d895828" }, { "id": "81193cf3-e333-4698-8b74-cc360af6cc2b", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-81193cf3-e333-4698-8b74-cc360af6cc2b" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f413d8f8-f034-4e0a-9875-2174b7b650cd" } ], "id": "e93ca8e3-b788-4bbe-8ce9-3b0ed8bc0178", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e93ca8e3-b788-4bbe-8ce9-3b0ed8bc0178" }, { "name": "Revoke Operator's MFA", "id": "5acfba11-80ca-47fa-bbbf-eace0a75c520", "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": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "43bfafd9-659e-4c2a-809c-4ea2362cf2c1", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Revokes operator's MFA without backup codes." }, "response": [ { "id": "2132dcaf-a208-419a-8186-e17123a4f11e", "name": "Revoked.", "originalRequest": { "method": "DELETE", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2132dcaf-a208-419a-8186-e17123a4f11e" }, { "id": "77b54044-aede-4199-a16c-0b029e8e679c", "name": "Bad request.", "originalRequest": { "method": "DELETE", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-77b54044-aede-4199-a16c-0b029e8e679c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5acfba11-80ca-47fa-bbbf-eace0a75c520" }, { "name": "Get Operator's MFA Status", "id": "ca5eaf08-eaf7-48e8-acd9-e4899957bfcf", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "d30bd252-b030-4589-ba8b-c552212fc90c", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets operator's MFA status. The MFA status is one of `ACTIVE`, `INACTIVE` or `UNCONFIRMED`." }, "response": [ { "id": "b79d2578-cd2e-4e3d-9998-75a218b64cb1", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b79d2578-cd2e-4e3d-9998-75a218b64cb1" }, { "id": "4d7342f2-92de-45ce-b069-8cd06138eb6c", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4d7342f2-92de-45ce-b069-8cd06138eb6c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ca5eaf08-eaf7-48e8-acd9-e4899957bfcf" }, { "name": "Enable Operator's MFA", "id": "3ee74aac-b7e9-4398-9eaa-818abf6f40b7", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "a377d625-d94b-43e9-ad3b-74a79b1c1256", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Enables operator's MFA. After calling this API, it should be verified by calling `Operator:verifyMFA` API." }, "response": [ { "id": "3da102ea-9acd-4719-926c-6ebb75fc4726", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totpUri\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3da102ea-9acd-4719-926c-6ebb75fc4726" }, { "id": "b2fe0089-da38-4671-a745-04eb8468fe17", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b2fe0089-da38-4671-a745-04eb8468fe17" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3ee74aac-b7e9-4398-9eaa-818abf6f40b7" } ], "id": "bb191264-f7b2-47d1-ab47-5200a771cb8e", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bb191264-f7b2-47d1-ab47-5200a771cb8e" }, { "name": "password", "item": [ { "name": "Update Operator Password", "id": "6e238ae9-f144-48d6-95e4-ee93f71f3047", "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" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "id": "523688a2-5030-4047-807c-cd5c25256688", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's password." }, "response": [ { "id": "e2d2762d-5575-487e-ba26-a95f991136eb", "name": "OK.", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e2d2762d-5575-487e-ba26-a95f991136eb" }, { "id": "030b7ed8-94e2-453e-a28a-78575f3c259f", "name": "Invalid password.", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-030b7ed8-94e2-453e-a28a-78575f3c259f" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6e238ae9-f144-48d6-95e4-ee93f71f3047" } ], "id": "01059045-90cb-47ad-a220-5913ec0ea7f7", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-01059045-90cb-47ad-a220-5913ec0ea7f7" }, { "name": "support", "item": [ { "name": "token", "item": [ { "name": "Generate Token for Support Console", "id": "a77aab19-3ae4-4a55-8bd4-225eaced54d9", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "id": "5df2a37c-c6cd-4142-ade8-bfce3042e855", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a token for accessing the support console." }, "response": [ { "id": "4e4bc009-4676-4378-ad03-45e0f51953be", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4e4bc009-4676-4378-ad03-45e0f51953be" }, { "id": "100b1004-ee4e-4231-96a3-26ddf67da746", "name": "Invalid Operator Id.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-100b1004-ee4e-4231-96a3-26ddf67da746" }, { "id": "498cb631-80ae-44d5-9739-ff14946836d3", "name": "Invalid token.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-498cb631-80ae-44d5-9739-ff14946836d3" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a77aab19-3ae4-4a55-8bd4-225eaced54d9" } ], "id": "acba60d5-065a-4050-8447-cc7fb9b91f94", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-acba60d5-065a-4050-8447-cc7fb9b91f94" } ], "id": "fa3968ae-0620-4154-815d-a540122e2057", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fa3968ae-0620-4154-815d-a540122e2057" }, { "name": "token", "item": [ { "name": "Generate API Token", "id": "385149f9-d419-4081-bebb-d73e5cb5aa2c", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "id": "3ad5a1b6-3307-4fd4-a8d5-a6091237922a", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Generates a new API token. If you insert the current API token into the header and make a request, a response is returned containing the new API token. You can then use the new API token in future requests." }, "response": [ { "id": "266f00d1-cfb1-4081-b6f7-8540b699f894", "name": "OK.", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-266f00d1-cfb1-4081-b6f7-8540b699f894" }, { "id": "7fea008f-8247-4fae-ac30-2230d9a92bde", "name": "There was an error in the request or the specified token has already expired. (In the latter case, you will need to use the /auth API to do authentication once again.)", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7fea008f-8247-4fae-ac30-2230d9a92bde" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-385149f9-d419-4081-bebb-d73e5cb5aa2c" } ], "id": "ecbba391-8795-4711-80b7-d30cb6e5dd71", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ecbba391-8795-4711-80b7-d30cb6e5dd71" }, { "name": "tokens", "item": [ { "name": "Revoke all API keys and API tokens that were generated by the root user", "id": "19f4fab5-3147-46f4-a217-92745ee32fad", "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}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "id": "d5946d47-cee3-46dd-9011-79c7cba750b5", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Revoke all API keys and API tokens that were generated by the root user. Once revoked, the API key and API token cannot be used to call the Soracom API, regardless of their expiration time." }, "response": [ { "id": "c7f59ac3-c828-4d3d-b3e6-6f4d0e9f5ab6", "name": "Successfully revoked all API keys and API tokens.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c7f59ac3-c828-4d3d-b3e6-6f4d0e9f5ab6" }, { "id": "db5b99f3-5865-40a3-9e24-10e38d3ba4cf", "name": "Invalid Operator Id.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-db5b99f3-5865-40a3-9e24-10e38d3ba4cf" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-19f4fab5-3147-46f4-a217-92745ee32fad" } ], "id": "82f447c4-ba20-4590-8868-fe87ad5aca82", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-82f447c4-ba20-4590-8868-fe87ad5aca82" }, { "name": "users", "item": [ { "name": "{user_name}", "item": [ { "name": "auth_keys", "item": [ { "name": "{auth_key_id}", "item": [ { "name": "Delete User AuthKey.", "id": "3d024220-aa10-4e80-8543-be4e42559f8c", "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": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "271db349-24e9-48d3-9f8d-4727091bbecc", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "ab859a05-024f-4a2b-95cd-64f3a8ce7a6c", "key": "user_name", "value": "", "description": "(Required) user_name" }, { "id": "41388f7d-7fde-4922-9222-c5d2db7fdc4c", "key": "auth_key_id", "value": "", "description": "(Required) auth_key_id" } ] }, "description": "Deletes an AuthKey from the SAM user." }, "response": [ { "id": "fa3b05ae-4e13-4a42-a319-27ef039bee80", "name": "The AuthKey was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fa3b05ae-4e13-4a42-a319-27ef039bee80" }, { "id": "66475a26-4cd3-4eae-9fdd-3518da8322c2", "name": "AuthKey not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-66475a26-4cd3-4eae-9fdd-3518da8322c2" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3d024220-aa10-4e80-8543-be4e42559f8c" }, { "name": "Get AuthKey.", "id": "92ec90b9-f763-4b9f-aab5-a6926a637d30", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "edd43365-6bc7-4393-a4f7-c21ef974be8d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "9e6c2793-1966-4e1b-be5f-27dd2a29b35f", "key": "user_name", "value": "", "description": "(Required) user_name" }, { "id": "515ef149-e598-4812-a318-62fa3b39a2e3", "key": "auth_key_id", "value": "", "description": "(Required) auth_key_id" } ] }, "description": "Returns the SAM user's AuthKey." }, "response": [ { "id": "9b3e8718-4ab8-4251-b1a0-bca60efbbef8", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9b3e8718-4ab8-4251-b1a0-bca60efbbef8" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-92ec90b9-f763-4b9f-aab5-a6926a637d30" } ], "id": "4fc9a8ad-a99c-4174-9201-6324913bad02", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4fc9a8ad-a99c-4174-9201-6324913bad02" }, { "name": "List User AuthKeys.", "id": "6615941c-e21d-4639-b984-28d38ba1633d", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "id": "4e548212-b7ae-47a5-b8b0-3490fa25db3b", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e81f405e-b8e7-4238-bc57-5787a28c7505", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Returns the SAM user's AuthKey list." }, "response": [ { "id": "579a5e36-4c93-4e4c-b2dc-2394de1a3237", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-579a5e36-4c93-4e4c-b2dc-2394de1a3237" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6615941c-e21d-4639-b984-28d38ba1633d" }, { "name": "Generate AuthKey.", "id": "f7ec7eca-640b-4085-8cb9-fdd8b95bffe1", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "id": "b6917d35-bdd7-406b-9087-df18d13b234e", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e1dedcd6-df4f-4d81-962a-a588a7cd0494", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Generates an AuthKey for the SAM user." }, "response": [ { "id": "345c0935-6c2d-4f00-971b-a9f2adcc3f43", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-345c0935-6c2d-4f00-971b-a9f2adcc3f43" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f7ec7eca-640b-4085-8cb9-fdd8b95bffe1" } ], "id": "6d3cba73-ed87-4b68-aa1d-dced6d817dbc", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6d3cba73-ed87-4b68-aa1d-dced6d817dbc" }, { "name": "mfa", "item": [ { "name": "verify", "item": [ { "name": "Verify SAM user's MFA OTP code when MFA activation phase", "id": "7378f1b9-69ba-4ad2-8346-00189be3206f", "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" } ], "body": { "mode": "raw", "raw": "{\n \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "id": "3d5b24e9-314f-4d5d-af26-cf896ffb52ae", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "b3ca328b-a6e1-4589-b174-a8f7ad4cbf6c", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Verify SAM user's MFA OTP code when MFA activation phase" }, "response": [ { "id": "af9e830b-c8a6-4ccc-98ff-0835543f97aa", "name": "Verified", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-af9e830b-c8a6-4ccc-98ff-0835543f97aa" }, { "id": "c3849673-3a7b-4b05-8966-d2ad9faa8954", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c3849673-3a7b-4b05-8966-d2ad9faa8954" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7378f1b9-69ba-4ad2-8346-00189be3206f" } ], "id": "c2b6f4e8-f456-4ca0-9e54-a7d3a422c35f", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c2b6f4e8-f456-4ca0-9e54-a7d3a422c35f" }, { "name": "Revoke SAM user's MFA", "id": "760a0dd0-c954-4f03-a424-08eaae7708c4", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "e6103a4e-ec23-4328-83b4-2c4842507550", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "210bf2aa-6666-4126-a9f3-d2af0fbd1e34", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Revoke SAM user's MFA" }, "response": [ { "id": "2336bf1a-b580-4f84-b4a5-eca4b790df38", "name": "Revoked", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2336bf1a-b580-4f84-b4a5-eca4b790df38" }, { "id": "3082ba0e-1679-423a-b9b3-44d327cc96ee", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3082ba0e-1679-423a-b9b3-44d327cc96ee" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-760a0dd0-c954-4f03-a424-08eaae7708c4" }, { "name": "Get SAM user's MFA status", "id": "e685b44d-f73f-4672-9e01-fd0cf31b0111", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "876279e4-250d-4842-98e1-f7cfdef75729", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "cc8b34d3-28b0-488f-96aa-26fbc1f21b52", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Get SAM user's MFA status" }, "response": [ { "id": "da5620a2-d278-48bc-a873-cf1e1e0ee5df", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-da5620a2-d278-48bc-a873-cf1e1e0ee5df" }, { "id": "30b32223-1950-41f9-92c8-b29eb97ef0d6", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-30b32223-1950-41f9-92c8-b29eb97ef0d6" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e685b44d-f73f-4672-9e01-fd0cf31b0111" }, { "name": "Enable SAM user's MFA", "id": "27cdc43a-c8c1-487a-9764-defb4615fd3d", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "58c97104-544e-43d0-b1b6-74b8db576040", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "160bd366-6fb4-4b7c-a5dd-2859e5512b0d", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Enable SAM user's MFA" }, "response": [ { "id": "ea2c3a1c-11fa-4565-9a13-e194b0f93f1c", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totpUri\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ea2c3a1c-11fa-4565-9a13-e194b0f93f1c" }, { "id": "5824439f-ba98-4e4f-b7c5-539e231cdfba", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5824439f-ba98-4e4f-b7c5-539e231cdfba" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-27cdc43a-c8c1-487a-9764-defb4615fd3d" } ], "id": "14cdb918-355f-41f3-9752-b0a62242686a", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-14cdb918-355f-41f3-9752-b0a62242686a" }, { "name": "password", "item": [ { "name": "Delete Password.", "id": "25f4c84f-f72f-495a-a5ac-3569e9123523", "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": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "15208a18-c27d-4cb6-b08d-f5a3a0851218", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "2a6afb79-7253-454b-9d0a-cbe59b935150", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Deletes the user's password." }, "response": [ { "id": "d08e2459-36f8-44e3-9a83-fbde66c76450", "name": "The user's password was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d08e2459-36f8-44e3-9a83-fbde66c76450" }, { "id": "06c29820-027a-4646-8d16-26b75b7d6bb7", "name": "Password registration is required.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-06c29820-027a-4646-8d16-26b75b7d6bb7" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-25f4c84f-f72f-495a-a5ac-3569e9123523" }, { "name": "Has User Password.", "id": "59f692d3-cbcd-4bf9-a236-e581c0c13c64", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "cebe6722-6b53-44dd-871c-edaf8d44c93e", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e79ba6a0-9334-4961-8b2b-325a11f72b3c", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Retrieves whether the SAM user has a password or not." }, "response": [ { "id": "d0e83257-6026-48ab-988d-7a2790479850", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"hasPassword\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d0e83257-6026-48ab-988d-7a2790479850" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-59f692d3-cbcd-4bf9-a236-e581c0c13c64" }, { "name": "Create Password.", "id": "082e2e9d-6bb5-48f5-b20c-c97fd5100f68", "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" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "8784653a-b02f-4e27-ac20-4df5b51df3b3", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "ddcfcc25-33f6-4626-b6c6-1fde7061c5ec", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Creates a password for the SAM user." }, "response": [ { "id": "145803bf-49a5-483a-8753-5d7e1b52e265", "name": "Password for the SAM user was registered.", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-145803bf-49a5-483a-8753-5d7e1b52e265" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-082e2e9d-6bb5-48f5-b20c-c97fd5100f68" }, { "name": "Update Password.", "id": "b196fc5e-8186-4f49-b3cc-09cd8e038147", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "42721d2d-dca3-40bc-b440-2fad7c03741d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e1c14628-977c-4ad7-b4d4-94b6cd5dc62c", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Updates the password of the SAM user." }, "response": [ { "id": "40f3ba9d-be19-40b8-9622-b1d308d5db70", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-40f3ba9d-be19-40b8-9622-b1d308d5db70" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b196fc5e-8186-4f49-b3cc-09cd8e038147" } ], "id": "aac72b0e-c4c9-4048-bd90-20fcb0617dd3", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-aac72b0e-c4c9-4048-bd90-20fcb0617dd3" }, { "name": "permission", "item": [ { "name": "Delete user permission.", "id": "b8e251a9-5b97-46aa-8499-33f176a31651", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "fa6f3391-06cd-44fb-8726-e7acc4db48cb", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e164b315-99a3-4d5b-9800-de1633cb3981", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Deletes the SAM user's permission." }, "response": [ { "id": "00938c08-00d0-4c99-8652-ed48c8ea06b9", "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-00938c08-00d0-4c99-8652-ed48c8ea06b9" }, { "id": "ad88cdc4-b969-407d-994e-9e949c0cff08", "name": "Invalid Operator ID or SAM user name", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ad88cdc4-b969-407d-994e-9e949c0cff08" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b8e251a9-5b97-46aa-8499-33f176a31651" }, { "name": "Get User Permission.", "id": "89de7e70-8ac0-40ad-9a53-9876153cfdfc", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "07738aea-662a-4861-bd6b-2562da5cbdfe", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "3bdff379-bf28-4507-8343-70dc3a2f00d0", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Retrieves the SAM user's permissions." }, "response": [ { "id": "308afaad-aae4-4cb9-9df7-55d9310fe224", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"permission\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-308afaad-aae4-4cb9-9df7-55d9310fe224" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-89de7e70-8ac0-40ad-9a53-9876153cfdfc" }, { "name": "Update user permission.", "id": "f6dd6f43-e15e-4e51-9b4c-5776e8c5dd7a", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "941d3227-e136-496b-85d5-be2dfd7be169", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "4fea2ab1-0506-4cfa-b563-d8b2977730d1", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Updates the SAM user's permissions." }, "response": [ { "id": "bbc82e0d-ad1a-4705-9cb5-6a023c3b58a3", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bbc82e0d-ad1a-4705-9cb5-6a023c3b58a3" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f6dd6f43-e15e-4e51-9b4c-5776e8c5dd7a" } ], "id": "604061c4-9e4a-45e9-a464-b3fb5374f70e", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-604061c4-9e4a-45e9-a464-b3fb5374f70e" }, { "name": "tokens", "item": [ { "name": "Revoke all API keys and API tokens that were generated by the specified SAM user.", "id": "b7f7c417-f0ca-43ac-8a59-a53925538ccc", "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}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "id": "460e6f09-415a-42cf-84f4-574200b14419", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "f3a3af82-3d58-4221-abf6-95a06c3b172d", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Revoke all API keys and API tokens that were generated by the specified SAM user. Once revoked, the API key and API token cannot be used to call the SORACOM API, regardless of their expiration time." }, "response": [ { "id": "ee133ac0-6b44-470c-ae8d-1ac26190fbcf", "name": "Successfully revoked all API keys and API tokens", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ee133ac0-6b44-470c-ae8d-1ac26190fbcf" }, { "id": "2a66c3ed-fcd3-46ce-8af8-a6108ffdab4b", "name": "Wrong operator ID or username was specified.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2a66c3ed-fcd3-46ce-8af8-a6108ffdab4b" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b7f7c417-f0ca-43ac-8a59-a53925538ccc" } ], "id": "bcfa0683-7f42-4690-baf9-c74a9f21f06c", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bcfa0683-7f42-4690-baf9-c74a9f21f06c" }, { "name": "trust_policy", "item": [ { "name": "Deletes user trust policy.", "id": "71123d74-acbd-49f0-8db8-c2f16bd5cf0b", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "f2ff7095-1ce3-4560-99cb-e2f06d842d04", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "38b628b1-a905-4351-bb9a-d2cc12059b94", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Deletes user trust policy for switching user." }, "response": [ { "id": "5f5f7eae-c6f8-458e-8be2-4be5bb9d5380", "name": "Successfully deleted a trust policy for the user.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5f5f7eae-c6f8-458e-8be2-4be5bb9d5380" }, { "id": "5f819d3e-7779-4123-86ec-a73deb9c8cf8", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5f819d3e-7779-4123-86ec-a73deb9c8cf8" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-71123d74-acbd-49f0-8db8-c2f16bd5cf0b" }, { "name": "Gets user trust policy.", "id": "60da4da4-e000-4e6f-adab-5a3560b9bd0f", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "50cd7e3f-8dcf-4a36-92b9-d50784c842a6", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "f79e1ae2-159f-4354-a5b0-2c2555b36cd6", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Gets user trust policy for switching user." }, "response": [ { "id": "6d264bc5-6aaf-4bc9-874d-ba08e498a787", "name": "Successfully obtained trust policy.", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trustPolicy\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6d264bc5-6aaf-4bc9-874d-ba08e498a787" }, { "id": "5a1d8b94-17fe-483d-9cd7-4b8b7fcb1a97", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5a1d8b94-17fe-483d-9cd7-4b8b7fcb1a97" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-60da4da4-e000-4e6f-adab-5a3560b9bd0f" }, { "name": "Updates user trust policy", "id": "a9ccc509-b4ef-473a-b455-96254f6c9187", "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 \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "acd7a763-ebeb-400f-9672-aaffeb17b922", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "a1ca6d12-fda5-4996-89df-c97fa0eadbd6", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Updates the trust policy of the user specified by `operator_id` and `user_name` parameters.\n\n**Warning**: Setting a trust policy will allow the operator(s) or user(s) specified in the request body to switch to this SAM user. When switching, the trusted operator(s) or user(s) will be granted the same permissions as this SAM user, and may be able to see session history, traffic history, and other account information.\n" }, "response": [ { "id": "e078b914-35cd-48ef-b458-4bfa5769d9b1", "name": "Successfully updated a trust policy for the user.", "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 \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e078b914-35cd-48ef-b458-4bfa5769d9b1" }, { "id": "6881a94c-2d3f-47b5-9892-598d67a1280e", "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 \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6881a94c-2d3f-47b5-9892-598d67a1280e" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a9ccc509-b4ef-473a-b455-96254f6c9187" } ], "id": "b07a01ac-1717-4765-9ed8-ff6ba3d24671", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b07a01ac-1717-4765-9ed8-ff6ba3d24671" }, { "name": "roles", "item": [ { "name": "{role_id}", "item": [ { "name": "Detach Role from User", "id": "9410df83-50be-4ef9-a199-6e183fb3ae0b", "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}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "id": "1118bf78-3141-418f-9678-19a4d63cee46", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "8b619f96-caa5-40dc-aa3a-5dd546b74383", "key": "user_name", "value": "", "description": "(Required) SAM user name." }, { "id": "a8a5e824-1f67-4517-bcb3-1f4360ebbe52", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Detaches a role from a user." }, "response": [ { "id": "eb0c9050-acd0-4da1-86cb-3a18be017e4a", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-eb0c9050-acd0-4da1-86cb-3a18be017e4a" }, { "id": "554b5cd2-1809-4833-af7f-d5d9b06a28ac", "name": "SAM user or role not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-554b5cd2-1809-4833-af7f-d5d9b06a28ac" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9410df83-50be-4ef9-a199-6e183fb3ae0b" } ], "id": "8cd995a3-78ba-4d48-b256-b795161f9afe", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8cd995a3-78ba-4d48-b256-b795161f9afe" }, { "name": "List User Roles", "id": "a81f5334-ae81-47cd-b8da-4c573f755729", "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}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "id": "edb9aacd-196c-4dd3-a9ec-0210d748d4cf", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "010f4fd1-6bfe-45cf-ad82-dd2127921d1a", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Retrieves a list of the user's roles." }, "response": [ { "id": "158fd777-8a93-430c-818a-f626fd54911b", "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}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-158fd777-8a93-430c-818a-f626fd54911b" }, { "id": "3af3ac06-e705-4ad4-a0e5-f653f28fc7b1", "name": "SAM user not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3af3ac06-e705-4ad4-a0e5-f653f28fc7b1" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a81f5334-ae81-47cd-b8da-4c573f755729" }, { "name": "Attach Role to User", "id": "2a60f64a-bff8-4e1a-8fa8-99c9a04b0fc5", "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" } ], "body": { "mode": "raw", "raw": "{\n \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "id": "b9ebfdb9-ff15-482a-8f8e-ef60c81f10a1", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "4d3b679d-aa56-4391-ab75-3657126e0e98", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Attaches a role to a user." }, "response": [ { "id": "d2f4e73d-f616-4c8d-8958-f45330c7c288", "name": "OK.", "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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d2f4e73d-f616-4c8d-8958-f45330c7c288" }, { "id": "8cee0cc2-4c10-451a-84a5-4fcd66d5239f", "name": "The role has already been attached or not found.", "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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8cee0cc2-4c10-451a-84a5-4fcd66d5239f" }, { "id": "24f57953-ba33-48f4-b724-79218f610b31", "name": "SAM user not found.", "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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-24f57953-ba33-48f4-b724-79218f610b31" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2a60f64a-bff8-4e1a-8fa8-99c9a04b0fc5" } ], "id": "20c7176f-4a62-4765-8e6e-e33f412f13db", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-20c7176f-4a62-4765-8e6e-e33f412f13db" }, { "name": "Delete User.", "id": "6248a6ac-cbf4-4670-b1f0-f0a0163566da", "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": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "90507522-92b5-43e8-a2ef-fa5af89358c4", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "a537fdea-2f4e-4ad5-912f-15efafc5fa57", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Deletes the SAM user." }, "response": [ { "id": "d1c71299-60fd-4bf3-b8a6-b88661804e7d", "name": "The SAM user was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d1c71299-60fd-4bf3-b8a6-b88661804e7d" }, { "id": "c724241e-e40e-4b95-a57d-168e5b1afc3b", "name": "SAM User not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c724241e-e40e-4b95-a57d-168e5b1afc3b" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6248a6ac-cbf4-4670-b1f0-f0a0163566da" }, { "name": "Get User.", "id": "ad844a77-f437-45fb-9c84-61dc09c11813", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "8bf8cb87-6ada-4f9b-8ec2-77b55150e8c8", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "8c8d2570-46ac-4dda-9f82-da99b2e4b2c4", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Returns a SAM user." }, "response": [ { "id": "141bd487-a3a1-4aa7-9071-9701f1aa08e3", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-141bd487-a3a1-4aa7-9071-9701f1aa08e3" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ad844a77-f437-45fb-9c84-61dc09c11813" }, { "name": "Create User.", "id": "b619934e-05ff-4ecc-a43c-22e5a4bcd2dc", "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" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "f1f5fce7-338a-4701-9ed4-503c24b26107", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "ec9ee916-9577-4b33-aacc-9854f57fc440", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Adds a new SAM user." }, "response": [ { "id": "bdce8531-4d17-4b56-9bd6-c28fec395ec7", "name": "A new user was added.", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bdce8531-4d17-4b56-9bd6-c28fec395ec7" }, { "id": "fc18ff3b-48fb-4999-ab33-8490b5ee996c", "name": "Failed to create a new user.", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fc18ff3b-48fb-4999-ab33-8490b5ee996c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b619934e-05ff-4ecc-a43c-22e5a4bcd2dc" }, { "name": "Update User.", "id": "4e632ca8-5762-4ac2-834b-a4deceeb915e", "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" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "e5f7a251-41b0-448b-8c59-3fbaf597644e", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e364e069-09ea-4d35-b55e-8cee677231ca", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Updates the SAM user." }, "response": [ { "id": "88eb21d0-3b64-47e4-af91-1309a2ef88dd", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-88eb21d0-3b64-47e4-af91-1309a2ef88dd" }, { "id": "007701a3-afcd-40a6-a1b7-a875358b5930", "name": "SAM User not found.", "originalRequest": { "method": "PUT", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-007701a3-afcd-40a6-a1b7-a875358b5930" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4e632ca8-5762-4ac2-834b-a4deceeb915e" } ], "id": "a83175fa-468d-40fc-931d-35bbddd27d9e", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a83175fa-468d-40fc-931d-35bbddd27d9e" }, { "name": "default_permissions", "item": [ { "name": "Delete the default permissions", "id": "56a933a3-1ac9-4ebf-a724-921176a5e6be", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "5197a41c-6405-4fdc-9721-501970913d8d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Delete the default permissions rule that is applied to all of the SAM" }, "response": [ { "id": "8732bf1a-09b6-497f-abce-d511c96c4bd0", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8732bf1a-09b6-497f-abce-d511c96c4bd0" }, { "id": "f27d92f1-d7a6-448a-9e8b-c71907314f24", "name": "Not privileged", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f27d92f1-d7a6-448a-9e8b-c71907314f24" }, { "id": "78819505-f476-45f9-a950-f0a400a95c04", "name": "Operator Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-78819505-f476-45f9-a950-f0a400a95c04" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-56a933a3-1ac9-4ebf-a724-921176a5e6be" }, { "name": "Get the default permissions", "id": "0d792dde-cdc5-465a-8b51-99d0eb4672a4", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "6a158bf6-5488-4c31-aceb-268773627b9d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Get the default permissions rule that is applied to all of the SAM users" }, "response": [ { "id": "c93aa837-8757-4247-a1e9-f8000e1c21dc", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"defaultPermissions\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c93aa837-8757-4247-a1e9-f8000e1c21dc" }, { "id": "dd9b8030-4589-47d2-98d4-4572886a8307", "name": "Not privileged", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-dd9b8030-4589-47d2-98d4-4572886a8307" }, { "id": "563f5836-780a-4348-8bfe-7531715f2806", "name": "Operator Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-563f5836-780a-4348-8bfe-7531715f2806" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-0d792dde-cdc5-465a-8b51-99d0eb4672a4" }, { "name": "Update the default permissions", "id": "72b41d6e-2c22-441e-a77d-576628f8fb78", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "b17f9c51-01f8-4e22-a40e-aae2e0ed75d9", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Update the default permissions rule that is applied to all of the SAM" }, "response": [ { "id": "89a34d25-6a8a-417e-8998-890ca2c24fda", "name": "Accepted", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-89a34d25-6a8a-417e-8998-890ca2c24fda" }, { "id": "18e76e63-b293-43ef-af9f-63a49dc75d26", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-18e76e63-b293-43ef-af9f-63a49dc75d26" }, { "id": "c1a4b814-2333-433a-823f-ed0c9f7e07c2", "name": "Not privileged", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c1a4b814-2333-433a-823f-ed0c9f7e07c2" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-72b41d6e-2c22-441e-a77d-576628f8fb78" } ], "id": "22d4f7cc-8a07-4128-81c8-d5790f7b1339", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-22d4f7cc-8a07-4128-81c8-d5790f7b1339" }, { "name": "Retrieve a list of SAM users", "id": "c8630412-ff03-454e-9afa-731814a235e1", "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}}/operators/:operator_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users" ], "variable": [ { "id": "eebbfbdd-1b45-41c2-9ae6-989859e0cb0a", "key": "operator_id", "value": "", "description": "(Required) The operator ID." } ] }, "description": "Retrieves a list of SAM users." }, "response": [ { "id": "5b633e58-0d61-4847-91bf-fcba68810f70", "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}}/operators/:operator_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n },\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5b633e58-0d61-4847-91bf-fcba68810f70" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-c8630412-ff03-454e-9afa-731814a235e1" } ], "id": "f4df2fad-7148-4444-86d4-9df202706b74", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f4df2fad-7148-4444-86d4-9df202706b74" }, { "name": "roles", "item": [ { "name": "{role_id}", "item": [ { "name": "users", "item": [ { "name": "List Role Attached Users", "id": "4b934024-3e80-4d13-9582-cd1ff59d1b3f", "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}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "id": "eef08444-b31a-40bb-8cb8-ac8dd9c5864c", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "3d1ec64b-5b74-4978-a683-66a05b9ad6fa", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Retrieves a list of users attached to a role." }, "response": [ { "id": "d9e924af-6299-4d65-be45-ae5f8c541c11", "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}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n },\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d9e924af-6299-4d65-be45-ae5f8c541c11" }, { "id": "360a07f4-39c9-4ccd-94b2-bb05d17a26e7", "name": "Role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-360a07f4-39c9-4ccd-94b2-bb05d17a26e7" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4b934024-3e80-4d13-9582-cd1ff59d1b3f" } ], "id": "83e678a0-4b64-4612-a9fe-6fb69503ac87", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-83e678a0-4b64-4612-a9fe-6fb69503ac87" }, { "name": "versions", "item": [ { "name": "Get Soracom Managed Role Versions", "id": "de84ff09-7487-4aea-b373-31eadd854ae1", "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}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "id": "bac23da6-2734-45cc-a5ef-28443ee1cc77", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "fc425a84-f9da-4a93-8884-6ede9ac7c9f4", "key": "role_id", "value": "", "description": "(Required) SRN (Soracom Resource Name) of the Soracom managed role. The format is `srn:soracom:::Role:[roleName]`." } ] }, "description": "Retrieves a list of versions for a Soracom managed role." }, "response": [ { "id": "79db2790-d831-4018-85c8-8636ddaa3c8e", "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}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"permission\": \"\",\n \"publishDateTime\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"version\": \"\"\n },\n {\n \"description\": \"\",\n \"owner\": \"operator\",\n \"permission\": \"\",\n \"publishDateTime\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-79db2790-d831-4018-85c8-8636ddaa3c8e" }, { "id": "fa4bbf9b-650c-4f64-8e1f-b92127e6a849", "name": "Operator managed roles cannot be specified.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fa4bbf9b-650c-4f64-8e1f-b92127e6a849" }, { "id": "a3ebec71-c26a-4159-a274-e358d92e0022", "name": "Soracom managed role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a3ebec71-c26a-4159-a274-e358d92e0022" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-de84ff09-7487-4aea-b373-31eadd854ae1" } ], "id": "8a607245-a1f0-47dd-9b7e-5e07ef6aaf9d", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8a607245-a1f0-47dd-9b7e-5e07ef6aaf9d" }, { "name": "Delete Operator Managed Role", "id": "b360eb93-7409-40eb-87b0-245114d2545b", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "0d24822e-2c83-450a-9034-7b395ff7ffe5", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "c6f71edb-70c5-4c77-a85a-10735e0d0e4d", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Deletes an operator managed role." }, "response": [ { "id": "79471314-d009-4f0e-a086-283dc61a57f7", "name": "The role was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-79471314-d009-4f0e-a086-283dc61a57f7" }, { "id": "37850d76-05cc-4b90-ab21-ab161200ff9c", "name": "The role is still in use.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-37850d76-05cc-4b90-ab21-ab161200ff9c" }, { "id": "5a5492fc-f368-4dc3-8238-82b82c87189c", "name": "Role not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-5a5492fc-f368-4dc3-8238-82b82c87189c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-b360eb93-7409-40eb-87b0-245114d2545b" }, { "name": "Get Role", "id": "7607a627-7105-4482-9407-325de7a8aee3", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "f739285f-cc3f-4122-959a-dfed4471107c", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "f4144bfa-f95c-4a30-9585-a5166cc84dea", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Retrieves a role." }, "response": [ { "id": "53399501-2482-43b7-a2e6-9b4d0ea38657", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-53399501-2482-43b7-a2e6-9b4d0ea38657" }, { "id": "48d9edf2-a692-4800-9a64-783bf993794e", "name": "Role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-48d9edf2-a692-4800-9a64-783bf993794e" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7607a627-7105-4482-9407-325de7a8aee3" }, { "name": "Create Operator Managed Role", "id": "20c68ad3-cd1c-4491-83c9-2f1eba373826", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "1d8a22ad-d86e-406b-8786-75ca2797c11d", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "470804dc-c568-4931-87d3-a74afea1f680", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Adds a new operator managed role." }, "response": [ { "id": "f7dd51b3-3722-43d9-9ba2-422dbb03b579", "name": "OK.", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"roleId\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-f7dd51b3-3722-43d9-9ba2-422dbb03b579" }, { "id": "59e59dff-09cd-4757-a2ec-d2cb588633c9", "name": "Failed to create an operator managed role.", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-59e59dff-09cd-4757-a2ec-d2cb588633c9" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-20c68ad3-cd1c-4491-83c9-2f1eba373826" }, { "name": "Update Operator Managed Role", "id": "2918f7df-9f3b-4f76-9f08-bd090047cba6", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "385fa3b1-e52f-46f3-89a3-86b2cd049c58", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "146eed55-7c78-4696-802d-b384fc5604cd", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Edits an operator managed role." }, "response": [ { "id": "a658301d-842c-4018-893e-0f5b6adb3ed5", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a658301d-842c-4018-893e-0f5b6adb3ed5" }, { "id": "4265065f-911e-41e8-ad1f-b581ccd6f6ca", "name": "Operator managed role 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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4265065f-911e-41e8-ad1f-b581ccd6f6ca" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2918f7df-9f3b-4f76-9f08-bd090047cba6" } ], "id": "afac124d-40f1-45f3-af1d-47980aa58888", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-afac124d-40f1-45f3-af1d-47980aa58888" }, { "name": "List Roles", "id": "dc1a412e-806b-46c0-b298-d5a3a4bfb76c", "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}}/operators/:operator_id/roles?owner=operator", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles" ], "query": [ { "description": "Filters by the type of the role. Specify one of the following:\n- `operator`: Operator managed role (default)\n- `soracom`: Soracom managed role\n- `all`: All roles\n", "key": "owner", "value": "operator" } ], "variable": [ { "id": "c9507d65-ccc5-4c65-93e6-63a7c19fa958", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a list of roles." }, "response": [ { "id": "4cd3be98-5e37-49aa-9070-c57a53b3bcb9", "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}}/operators/:operator_id/roles?owner=operator", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles" ], "query": [ { "description": "Filters by the type of the role. Specify one of the following:\n- `operator`: Operator managed role (default)\n- `soracom`: Soracom managed role\n- `all`: All roles\n", "key": "owner", "value": "operator" } ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-4cd3be98-5e37-49aa-9070-c57a53b3bcb9" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-dc1a412e-806b-46c0-b298-d5a3a4bfb76c" } ], "id": "d6b470fc-1175-4629-9cf3-9009064ff7f4", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d6b470fc-1175-4629-9cf3-9009064ff7f4" }, { "name": "emails", "item": [ { "name": "{email_id}", "item": [ { "name": "Delete email address", "id": "e419e6ca-a6bd-4929-84e6-27ea83a8944c", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "id": "67f81cc7-ac39-432b-aac5-0f275ce45471", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "a919b20a-e58a-4d86-9f4d-06782a778f6c", "key": "email_id", "value": "", "description": "(Required) Email address ID." } ] }, "description": "Deletes the email address corresponding to the specified email address ID from the operator.\n" }, "response": [ { "id": "783b7ef9-cf1c-4460-8066-230cfd4b06c2", "name": "Email address successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "key": "operator_id" }, { "key": "email_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-783b7ef9-cf1c-4460-8066-230cfd4b06c2" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e419e6ca-a6bd-4929-84e6-27ea83a8944c" }, { "name": "Get email address", "id": "087cf19b-18d0-44e7-a497-3f477ef34b44", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "id": "d72a5df3-10a4-493b-a1b2-c35c3dd84db3", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "d0c43891-9853-4ffc-9054-d6c26faf51ed", "key": "email_id", "value": "", "description": "(Required) Email address ID." } ] }, "description": "Retrieves information for the email address corresponding to the specified email address ID.\n" }, "response": [ { "id": "a055c223-350d-448a-a8b9-b0918a735dfa", "name": "Information about the specified email address.", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "key": "operator_id" }, { "key": "email_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a055c223-350d-448a-a8b9-b0918a735dfa" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-087cf19b-18d0-44e7-a497-3f477ef34b44" } ], "id": "07b3824b-80d8-4a2e-a423-51712a49bbc3", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-07b3824b-80d8-4a2e-a423-51712a49bbc3" }, { "name": "List email addresses", "id": "0d23ca62-dce9-4f49-8fcb-d4492a90a4de", "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}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "id": "7a81b484-29cb-4311-87a2-bcd1d77a1583", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Retrieves a list of email addresses registered to the operator.\n" }, "response": [ { "id": "fe8afb69-954d-4783-bf19-b885e0fed046", "name": "A list of email addresses registered to the operator.", "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}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n },\n {\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fe8afb69-954d-4783-bf19-b885e0fed046" }, { "id": "bd7a6bf2-58a2-4c99-affa-3220132de5fd", "name": "Invoked using SAM user credentials. This operation is allowed only for root user.\n", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-bd7a6bf2-58a2-4c99-affa-3220132de5fd" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-0d23ca62-dce9-4f49-8fcb-d4492a90a4de" } ], "id": "006b4d58-efbd-4de7-9cc5-94a994e78dee", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-006b4d58-efbd-4de7-9cc5-94a994e78dee" }, { "name": "system_notifications", "item": [ { "name": "{type}", "item": [ { "name": "Delete an email address from the email settings", "id": "cd9d4c0b-ab42-498c-a0e3-60593a7afd19", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "42e712c1-40f1-4b53-9bdb-4c24122dd5a8", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "30b456ee-c624-4314-a8c7-80fc8a151721", "key": "type", "value": "recovery", "description": "(Required) Email address type." } ] }, "description": "Delete an email address from the email settings." }, "response": [ { "id": "76cdc869-223b-455f-b091-689fb3f86ad6", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-76cdc869-223b-455f-b091-689fb3f86ad6" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-cd9d4c0b-ab42-498c-a0e3-60593a7afd19" }, { "name": "Get information on email settings", "id": "6fa1ed20-0342-4ef5-b6ee-282796340da8", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "637e2f16-3dec-466a-aced-e98351be1430", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "ec6d8fa5-2734-4347-8dc6-7637ad479fa0", "key": "type", "value": "support", "description": "(Required) Email address type." } ] }, "description": "Return information on email settings." }, "response": [ { "id": "0a56b473-ab47-445d-acd1-41fe04b620bf", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"support\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-0a56b473-ab47-445d-acd1-41fe04b620bf" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6fa1ed20-0342-4ef5-b6ee-282796340da8" }, { "name": "Set an email address in the email settings", "id": "11df0e57-83a9-4800-8aef-81af5586e0ef", "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 \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "5966485b-b46c-4446-83b8-ecf8a952e67f", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "3fc248ca-bdc2-456f-8685-670044f56fd1", "key": "type", "value": "support", "description": "(Required) Email address type." } ] }, "description": "Set an email address in the email settings." }, "response": [ { "id": "1827faf7-2245-48d5-ad35-47ee20a61dfe", "name": "OK.", "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 \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"support\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-1827faf7-2245-48d5-ad35-47ee20a61dfe" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-11df0e57-83a9-4800-8aef-81af5586e0ef" } ], "id": "91b36c41-34fb-4d0b-9b4d-da6c934028e6", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-91b36c41-34fb-4d0b-9b4d-da6c934028e6" }, { "name": "List email settings", "id": "64b2344a-2767-4bd6-beb5-0d293086f93b", "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}}/operators/:operator_id/system_notifications", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications" ], "variable": [ { "id": "c131d976-d443-482d-a2f3-707cd755b3cd", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Returns a list of email settings." }, "response": [ { "id": "05ab1061-27cc-4df2-baa5-5fbc8ed8e20c", "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}}/operators/:operator_id/system_notifications", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"recovery\",\n \"updateDateTime\": \"\"\n },\n {\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"primary\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-05ab1061-27cc-4df2-baa5-5fbc8ed8e20c" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-64b2344a-2767-4bd6-beb5-0d293086f93b" } ], "id": "fa625135-1eb7-4ff5-a563-988c0f8065a1", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fa625135-1eb7-4ff5-a563-988c0f8065a1" }, { "name": "Get Operator", "id": "cafae196-f53d-457d-b435-2cbf911958bc", "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}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "id": "409d6551-ebbc-4406-83ab-6eca4ff8c723", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns information about the operator." }, "response": [ { "id": "26395691-2ea3-4466-ad82-d24c053212ab", "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}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDate\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"operatorId\": \"\",\n \"rootOperatorId\": \"\",\n \"updateDate\": \"\"\n}", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-26395691-2ea3-4466-ad82-d24c053212ab" }, { "id": "57da2bfb-b9b2-4c70-9c6c-6f0564e60812", "name": "Invalid Operator Id.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-57da2bfb-b9b2-4c70-9c6c-6f0564e60812" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-cafae196-f53d-457d-b435-2cbf911958bc" } ], "id": "e87f969f-0b5c-4584-81b6-d80091f50f95", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e87f969f-0b5c-4584-81b6-d80091f50f95" }, { "name": "mfa_revoke_token", "item": [ { "name": "issue", "item": [ { "name": "Issue Operator's MFA Revoke Token", "id": "44436dc1-50be-4f94-8d5b-fb35f5936cd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] }, "description": "Issues a token to revoke operator's MFA. The issued token will be sent to the operator via email." }, "response": [ { "id": "7666d0f5-9f46-4378-92fc-51749c24ade9", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7666d0f5-9f46-4378-92fc-51749c24ade9" }, { "id": "104d1579-a2f1-4727-a994-8e85ac9ba372", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-104d1579-a2f1-4727-a994-8e85ac9ba372" }, { "id": "943d0157-13ce-4b03-a9f7-ee7834b19acc", "name": "Operator not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-943d0157-13ce-4b03-a9f7-ee7834b19acc" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-44436dc1-50be-4f94-8d5b-fb35f5936cd6" } ], "id": "7a186be5-399e-49ef-92ed-dcfeef460e96", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7a186be5-399e-49ef-92ed-dcfeef460e96" }, { "name": "verify", "item": [ { "name": "Verify Operator's MFA revoke token", "id": "3e061879-1252-4735-8f04-4cbbf82ba8de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] }, "description": "Verifies the one-time token which is previously issued by calling `/operators/mfa_revoke_token/issue` API, operator's email address, password, and one of the backup codes. If verified, operator's MFA is going to be revoked." }, "response": [ { "id": "56266d63-40f3-4fc3-909c-14a722b920d6", "name": "Revoked.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-56266d63-40f3-4fc3-909c-14a722b920d6" }, { "id": "3851ce07-892a-4a94-be2c-ae90b828e367", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3851ce07-892a-4a94-be2c-ae90b828e367" }, { "id": "d29264b7-7b00-4c2e-9965-97202fa6a1aa", "name": "Invalid username or password.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-d29264b7-7b00-4c2e-9965-97202fa6a1aa" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-3e061879-1252-4735-8f04-4cbbf82ba8de" } ], "id": "2c1f3759-a7a0-4f96-93ee-7c4ff5d11e0f", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-2c1f3759-a7a0-4f96-93ee-7c4ff5d11e0f" } ], "id": "6999660a-4080-49b9-a69a-cdaf46219290", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-6999660a-4080-49b9-a69a-cdaf46219290" }, { "name": "add_email_token", "item": [ { "name": "issue", "item": [ { "name": "Issue an authentication token to add an email address", "id": "e89b609b-fcbf-4176-b02d-5ccb490b89bf", "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" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] }, "description": "Generates an authentication token for adding a new email address and sends it to the specified email address. This authentication token is used with [Email:verifyAddEmailToken API](#/Email/verifyAddEmailToken) to complete email address verification and addition.\n\n**Warning**: This API can only be executed with root user credentials.\n" }, "response": [ { "id": "8884c7f6-ad2c-44ab-94bc-0c7c7f4fe45b", "name": "Authentication token successfully issued and sent to the specified email address.", "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 \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-8884c7f6-ad2c-44ab-94bc-0c7c7f4fe45b" }, { "id": "a5fecfd3-ff73-4a4b-b78b-e3c47d65f336", "name": "Exceeds maximum number of emails.", "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 \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-a5fecfd3-ff73-4a4b-b78b-e3c47d65f336" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-e89b609b-fcbf-4176-b02d-5ccb490b89bf" } ], "id": "7a33d93d-562a-47c9-9192-cf7b0d9efc94", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-7a33d93d-562a-47c9-9192-cf7b0d9efc94" }, { "name": "verify", "item": [ { "name": "Verify an authentication token to add an email address", "id": "9d3f79e7-d3e7-421f-bfdb-0c025b0267b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "verify" ] }, "description": "Verifies the authentication token issued by [Email:issueAddEmailToken API](#/Email/issueAddEmailToken) and adds the email address to the operator.\n\n**Warning**: Authentication tokens have an expiration time. Expired authentication tokens cannot be used.\n" }, "response": [ { "id": "fba5a9e2-597b-4f65-95fd-2f89bcaa1787", "name": "Email address successfully verified and added to the operator.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-fba5a9e2-597b-4f65-95fd-2f89bcaa1787" } ], "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-9d3f79e7-d3e7-421f-bfdb-0c025b0267b0" } ], "id": "ccaa9408-2f9e-4d62-bc02-78237fe4813e", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-ccaa9408-2f9e-4d62-bc02-78237fe4813e" } ], "id": "52dff6a9-de17-4630-970b-264b5e1bff2d", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-52dff6a9-de17-4630-970b-264b5e1bff2d" } ], "id": "21ddbadc-27e7-4b51-977d-036d1f2b146f", "createdAt": "2026-06-05T15:18:44.000Z", "updatedAt": "2026-06-05T15:18:44.000Z", "uid": "35240-21ddbadc-27e7-4b51-977d-036d1f2b146f" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }