{ "opencollection": "1.0.0", "info": { "name": "Soracom and Query Analysis User API", "version": "20250903-043502" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of SAM users", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "The operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of SAM users." }, { "info": { "name": "Get User.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a SAM user." }, { "info": { "name": "Create User.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a new SAM user." }, { "info": { "name": "Update User.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the SAM user." }, { "info": { "name": "Delete User.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the SAM user." }, { "info": { "name": "List User AuthKeys.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the SAM user's AuthKey list." }, { "info": { "name": "Generate AuthKey.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Generates an AuthKey for the SAM user." }, { "info": { "name": "Get AuthKey.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" }, { "name": "auth_key_id", "value": "", "type": "path", "description": "auth_key_id" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the SAM user's AuthKey." }, { "info": { "name": "Delete User AuthKey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" }, { "name": "auth_key_id", "value": "", "type": "path", "description": "auth_key_id" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes an AuthKey from the SAM user." }, { "info": { "name": "Get SAM user's MFA status", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get SAM user's MFA status" }, { "info": { "name": "Enable SAM user's MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enable SAM user's MFA" }, { "info": { "name": "Revoke SAM user's MFA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revoke SAM user's MFA" }, { "info": { "name": "Verify SAM user's MFA OTP code when MFA activation phase", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa/verify", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Verify SAM user's MFA OTP code when MFA activation phase" }, { "info": { "name": "Has User Password.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves whether the SAM user has a password or not." }, { "info": { "name": "Create Password.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a password for the SAM user." }, { "info": { "name": "Update Password.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the password of the SAM user." }, { "info": { "name": "Delete Password.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the user's password." }, { "info": { "name": "Get User Permission.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the SAM user's permissions." }, { "info": { "name": "Update user permission.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the SAM user's permissions." }, { "info": { "name": "Delete user permission.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the SAM user's permission." }, { "info": { "name": "Revoke all API keys and API tokens that were generated by the specified SAM user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/tokens", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Gets user trust policy.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets user trust policy for switching user." }, { "info": { "name": "Updates user trust policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "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" }, { "info": { "name": "Deletes user trust policy.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes user trust policy for switching user." }, { "info": { "name": "Get the default permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the default permissions rule that is applied to all of the SAM users" }, { "info": { "name": "Update the default permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update the default permissions rule that is applied to all of the SAM" }, { "info": { "name": "Delete the default permissions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete the default permissions rule that is applied to all of the SAM" } ] } ], "bundled": true }