Getting Started

Getting to Know the Soracom User Console

The Soracom User Console provides an intuitive web interface for easily managing your Soracom IoT SIMs and conveniently accessing essential features of your Soracom Account.

Main Menus

The buttons and selectors in the top menu bar provide quick access to the primary features and management tools of the User Console.

Menu

Menu - Show or hide the main navigation menu

• Orders - Purchase Soracom-compatible devices and manage order history
• Soracom Air for Cellular
  • SIM Management - List Air SIMs and perform SIM management functions
  • Groups - List Air SIM groups and configure group options
  • Event Handler - Configure Air SIM management behavior
  • VPG - List Virtual Private Gateways and configure VPG options
• Soracom Air for Sigfox
  • Sigfox Devices - List Sigfox devices and perform management tasks
  • Sigfox Groups - List Sigfox groups and configure group options
• Soracom Inventory
  • Inventory Devices - List Soracom Inventory devices and perform management tasks
  • Inventory Groups - List Soracom Inventory groups and configure group options
  • Object Models - List Soracom Inventory models and configure object model options
• Soracom Flux
  • Flux Apps - Create and manage apps in Soracom Flux, a low-code IoT application builder
  • Flux Pricing - View and manage your Flux plan
• Soracom Orbit
  • Soralet Management - Create and manage Soracom Orbit modules
• Data storage & visualization
  • Soracom Harvest Data - View Harvest data
  • Soracom Harvest Files - View Harvest files
  • Soracom Lagoon - Launch Soracom Lagoon dashboard
• Soracom Relay
  • Limited preview application form - Submit an application to participate in the Soracom Relay Limited Preview program
• Logs & Statistics
  • Audit Logs - View detailed API calls made against your Soracom account
  • Napter Audit Logs - Monitor connections to your devices using the Napter service
  • Error Logs - View Air, Beam, Funk, Funnel, Harvest, Napter, Orbit, and Unified Endpoint error logs
  • Usage statistics - View reports displaying data use for your device or group
  • Service usage history - Download Soracom platform service usage history in CSV format

Coverage Type

Global - Switch between coverage types

Clicking the Coverage Type selector allows you to switch between different coverage regions. For more information regarding coverage types, refer to the SIM Types documentation.

Support Menu

Support - Show or hide the Support menu

• Soracom Support Bot - Opens the Soracom Support Bot panel; ask the bot a question
• Getting Started - Opens Soracom's developer guides
• Documentation - Opens Soracom's developer documentation
• FAQ - Opens the Soracom Support Center knowledgebase
• Contact us - Opens the Soracom Support Center
• Status Dashboard - Opens Soracom's system status dashboard

Account Menu

(your email) - Show or hide the account menu

• Operator ID - Your Soracom Operator ID
• Switch user - Switch to another SAM user account
• Security - Opens the Security screen for passwords, user management, authentication, and audit logs
• Account - Account management
  • Language settings - Change the User Console display language
  • Email settings - Manage email addresses associated with your Soracom account
  • Contact information - Change the contact information associated with your Soracom account
  • Terminate account - Initiates a request to permanently delete your Soracom account
  • Shipping Addresses - Register and manage shipping addresses to your account for future purchases
• Payment - Payment-related functionality
  • Billing Dashboard - Manage payment methods and list current and previous billing history
  • Payment settings - Opens the Payment settings screen for managing payment methods
  • Manage coupons - Register a coupon to your account
• Logout - Securely log out of the User Console

SIM Management

The SIM Management screen is your one-stop portal for viewing, configuring, and troubleshooting Soracom Air SIMs via your browser. ​

For further details, see SIM Management.

Groups

Groups make it easy to manage options for multiple SIMs by organizing them for streamlined management or applying Soracom services—such as Beam, Funnel, Funk, and Harvest—across multiple SIMs simultaneously.

The Groups screen allows you to create and modify groups in your account.

• To add a new group, click the Add button.
• To add or remove a SIM from a group, refer to SIM Management Common Actions Change group.
• To edit a group, click the group Name in the list of groups.
• To delete a group, click the group Name in the list of groups to open its settings page. Then from the Advanced settings tab, click the Delete this group panel.

For additional information on Groups usage, please refer to the Groups documentation .

Event Handler

The Event Handler screen allows you to create custom SIM management actions, such as sending an email notification when a SIM uses a certain amount of data, or controlling SIM bandwidth.

Event handlers can be customized for all SIMs in your account, a group of SIMs, or even a single SIM. Refer to the Event Handler documentation for more details on creating event handlers.

VPG

The VPG screen allows you to add, remove, and configure Virtual Private Gateways. For additional information on VPG features and configuration options, refer to the VPG documentation .

• To add a new VPG, click the Create VPG button.
• To attach a group to a VPG, please refer to the Groups documentation .
• To edit a VPG, click the VPG Name in the list of VPGs.
• To delete a VPG, click the VPG Name in the list of VPGs to open its settings page. Then from the Advanced settings tab, click the Terminate panel.

Orders

The Orders screen allows you to purchase devices and SIMs directly from Soracom, and manage your order history.

• To place a new order, click the New Order button.
• To cancel an order that has not shipped, click the Cancel button.
• To register all SIMs in an order, click the Register button.

Once an order has been shipped, order tracking details will become visible within the Order Status section of your order history in the User Console. These details will include the name of the delivery company and tracking number(s), and clicking the delivery company link will take you to the delivery company's shipment status inquiry page, where you can enter the tracking number to check the delivery status.

Billing

The Billing screen allows you to view and download billing details and statements, and manage your payment method.

• 1 Bills - The latest balance on your account, as well as previous billing history.
• 2 Invoices - Allows you to download invoices for monthly charges as well as individual device orders.
• 3 Payment Statements - Allows you to download payment statements (proof of payment).
• 4 Payment Method - Allows you to manage your payment method.

Shipping

The Shipping Addresses screen allows you to add, remove, or update shipping addresses tied to your account for future orders.

Security

The Security screen allows you to manage users and roles, credential sets, password, and multi-factor authentication settings.

• 1 Users - Add, edit, or remove Soracom Access Management (SAM) users.
• 2 Roles - Add, edit, or remove roles that can be applied to SAM users.
• 3 Credentials - Add or remove credential sets for use with various authentication providers (AWS, Azure, X.509, etc.).
• 4 Password - Update your Soracom account password.
• 5 Multi-factor Authentication - Enable or disable MFA for your Soracom account.
• 6 AuthKeys - Add or remove AuthKeys to allow programmatic access to your Soracom account.
• 7 Default SAM Permission Configuration - Set default permissions applied to all SAM users.