How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Soracom Auth and Access Management API

Authenticate operators (email/password or AuthKey), issue short-lived API Keys + Tokens, manage operator profile, SAM (Soracom Access Management) users and roles, MFA settings, registered email addresses, switch-user (cross-operator) flows, and system notifications.

Soracom Auth and Access Management API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IoT, Authentication, SAM, Access Management, and MFA. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

5 operations 5 paths 5 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Auth and Access Management API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 5

- [Generate API key and token](/en/tools/api/key-and-token/) - Password reset token generation and verification - [Switch user](/en/docs/switch-user/) API key and token generation

POST
/auth
Performs authentication to access to the Soracom API.
auth body → 200401
POST
/auth/logout
Revokes an API key and API token in order to remove access to the Soracom API.
logout → 204
POST
/auth/password_reset_token/issue
Issues a password reset token for the operator.
issuePasswordResetToken body → 200400
POST
/auth/password_reset_token/verify
Verifies the password reset token and updates password.
verifyPasswordResetToken body → 200400404
POST
/auth/switch_user
Generates an API key and an API token to call APIs as a different user.
switchUser body → 200400

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AuthRequest (8 properties), AuthResponse (4 properties), SwitchUserRequest (3 properties), VerifyPasswordResetTokenRequest (2 properties). Each schema is shown below with its type and property counts.

VerifyPasswordResetTokenRequest
object
2 properties 2 required
AuthRequest
object
8 properties
IssuePasswordResetTokenRequest
object
1 property 1 required
AuthResponse
object
4 properties
SwitchUserRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-auth-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
Soracom Group Configuration API
Soracom Billing API
Soracom Stats and Diagnostics API
Soracom Lagoon API
Soracom Cloud Camera Services API
Soracom Batch API
Soracom Analysis API
Soracom API Sandbox: Coupon API
Soracom API Sandbox: Operator API
Soracom API Sandbox: Order API
Soracom API Sandbox: Stats API
Where this information came from

This is an independent, third-party profile of Soracom Auth and Access Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.