{
  "opencollection": "1.0.0",
  "info": {
    "name": "Soracom and Query Analysis Auth API",
    "version": "20250903-043502"
  },
  "items": [
    {
      "info": {
        "name": "Auth",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Performs authentication to access to the Soracom API.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/auth",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Revokes an API key and API token in order to remove access to the Soracom API.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/auth/logout",
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Issues a password reset token for the operator.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/auth/password_reset_token/issue",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Verifies the password reset token and updates password.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/auth/password_reset_token/verify",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the operator's password if the password reset token is verified."
        },
        {
          "info": {
            "name": "Generates an API key and an API token to call APIs as a different user.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/auth/switch_user",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "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."
        }
      ]
    }
  ],
  "bundled": true
}