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 Operator API

- Operator management- Update registration information- Password changes- [Multi-factor authentication](/en/docs/mfa/)

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Operator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 26 operations across 17 paths, and defines 31 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.

26 operations 17 paths 31 schemas 5 DELETE6 GET13 POST2 PUT

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 Operator 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 26

Across 17 paths, the API surfaces 26 operations — 5 DELETE, 6 GET, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Operator 26

- Operator management - Update registration information - Password changes - [Multi-factor authentication](/en/docs/mfa/)

GET
/operators/{operator_id}
Get Operator
getOperator 1 param → 200400
GET
/operators/{operator_id}/auth_keys
List Operator AuthKeys
listOperatorAuthKeys 1 param → 200
POST
/operators/{operator_id}/auth_keys
Generate Operator AuthKey
generateOperatorAuthKey 1 param → 201
DELETE
/operators/{operator_id}/auth_keys/{auth_key_id}
Delete Operator AuthKey
deleteOperatorAuthKey 2 params → 204
GET
/operators/{operator_id}/company_information
Get company information
getCompanyInformation 1 param → 200
POST
/operators/{operator_id}/company_information
Create company information
createCompanyInformation 1 param body → 201
PUT
/operators/{operator_id}/company_information
Update company information
updateCompanyInformation 1 param body → 200
DELETE
/operators/{operator_id}/configuration/{namespace}
Delete operator configuration of the namespace
deleteOperatorConfigurationNamespace 2 params → 204400404
GET
/operators/{operator_id}/configuration/{namespace}
Get operator configuration of the namespace
getOperatorConfigurationNamespace 2 params → 200400404
POST
/operators/{operator_id}/configuration/{namespace}
Set operator configuration of the namespace
setOperatorConfigurationNamespace 2 params body → 200400409
POST
/operators/{operator_id}/contracts
Add Operator Contract
addOperatorContract 1 param body → 200
DELETE
/operators/{operator_id}/contracts/{contract_name}
Delete Operator Contract
deleteOperatorContract 2 params → 204
POST
/operators/{operator_id}/coverage_type/{coverage_type}
Add coverage type
addCoverageType 2 params → 201
GET
/operators/{operator_id}/individual_information
Get individual information
getIndividualInformation 1 param → 200
POST
/operators/{operator_id}/individual_information
Create individual information
createIndividualInformation 1 param body → 201
PUT
/operators/{operator_id}/individual_information
Update individual information
updateIndividualInformation 1 param body → 200
DELETE
/operators/{operator_id}/mfa
Revoke Operator's MFA
revokeMFA 1 param body → 204400
GET
/operators/{operator_id}/mfa
Get Operator's MFA Status
getMFAStatus 1 param → 200400
POST
/operators/{operator_id}/mfa
Enable Operator's MFA
enableMFA 1 param → 200400
POST
/operators/{operator_id}/mfa/verify
Verify Operator's MFA OTP Code
verifyMFA 1 param body → 200400
POST
/operators/{operator_id}/password
Update Operator Password
updateOperatorPassword 1 param body → 200400
POST
/operators/{operator_id}/support/token
Generate Token for Support Console
generateSupportToken 1 param → 200400403
POST
/operators/{operator_id}/token
Generate API Token
generateAuthToken 1 param body → 200400
DELETE
/operators/{operator_id}/tokens
Revoke all API keys and API tokens that were generated by the root user
revokeOperatorAuthTokens 1 param → 204400
POST
/operators/mfa_revoke_token/issue
Issue Operator's MFA Revoke Token
issueMFARevokingToken body → 200400404
POST
/operators/mfa_revoke_token/verify
Verify Operator's MFA revoke token
verifyMFARevokingToken body → 200400403

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are CompanyInformationModel (12 properties), IndividualInformationModel (9 properties), GetOperatorResponse (6 properties), OperatorConfigurationModel (4 properties). Each schema is shown below with its type and property counts.

OperatorConfigurationOfEmail
object
2 properties
GenerateTokenRequest
object
1 property
OperatorConfigurationModel
object
4 properties
UpdatePasswordRequest
object
2 properties 2 required
OperatorConfigurationOfSupport
object
3 properties
MFAStatusOfUseResponse
object
1 property
MFARevokeRequest
object
1 property 1 required
AuthKeyResponse
object
3 properties 2 required
MFAIssueRevokingTokenRequest
object
2 properties
CoverageType
string
GenerateTokenResponse
object
1 property 1 required
GenerateOperatorsAuthKeyResponse
object
2 properties
SupportTier
string
ContractUpdatedResponse
object
2 properties
OperatorConfigurationOfUserConsole
object
2 properties
EnableMFAOTPResponse
object
1 property 1 required
SetOperatorConfigurationNamespaceRequest
object
2 properties 1 required
SupportTokenResponse
object
1 property 1 required
CompanyInformationModel
object
12 properties 6 required
IndividualInformationModel
object
9 properties 4 required
ContractUpdatingRequest
object
2 properties 1 required
OperatorMFAVerifyingResponse
object
1 property
EmailConfigurationOfBilling
object
1 property
MFARevokingTokenVerifyRequest
object
4 properties
ContractDetailOfSupport
object
1 property
EmailConfigurationOfNotification
object
1 property
ContractDetailOfHarvest
object
2 properties
GetOperatorResponse
object
6 properties 6 required
APICallError
object
2 properties
APICallErrorMessage
object
2 properties 2 required
MFAAuthenticationRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-operator-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 Auth and Access Management 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
Where this information came from

This is an independent, third-party profile of Soracom Operator 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.