Searching for SIM(s) (subscriber)
This guide describes how to find specific SIMs (subscriber) in the Soracom User Console and how to search SIM using the Soracom API. Search is useful when you have multiple SIMs and need a way to quickly find a specific SIM, by any identifier.
Log into the User Console and open SIM Management in the menu.
Next to the Search box, there is a drop down containing the various attributes you can search on. The default is “Any”.
Here is a brief description of the attributes:
|Any||All the searchable attributes shown below (those that match one of the attributes are subject to SIM)|
|Name||Name of SIM|
|Group||Name of the group to which the SIM belongs|
|IMSI||IMSI of SIM|
|MSISDN||MSISDN of SIM|
|ICCID||ICCID of SIM|
|Tag||*Values* of all tags associated in SIM|
To use the search, simpley type in the text/values you want and hit the Enter Key (or click the magnifying glass). Your results are shown in the list below.
SORACOM API provides SIM search API. Please refer to the API document below for API details.
Search SIM using the Soracom command line interface (CLI)
Below are a few examples of using the SIM search API using Soracom CLI. We recommend that you download the latest version.
This command searches for a SIM with
mysim in the name of SIM and returns the result.
$ soracom query subscribers --name='mysim'
This command searches for an SIM that contains
mysim in the name of SIM and also contains
mygroup in the group name to which SIM belongs.
$ soracom query subscribers --name='mysim' --group='mygroup'
This command searches for a SIM whose name is
mysim in the name of SIM or whose group name belongs to ‘SIM’.
--search-type, it is possible to switch between AND search and OR search. If unspecified, it functions as an AND search.
$ soracom query subscribers --name='mysim' --group='mygroup' --search-type='or'
When using Soracom Access Management (SAM) users, you need to grant “Allow” permission to
Query: searchSubscribers in order to use the SIM search feature.
If you grant the
Query: searchSubscribers permission, you will be given the right to search / list all Groups and SIMs.
As alternative, if you want to grant access to list SIMs, consider using
Subscriber: listSubscribers instead.
Please also refer to the following documents for details on the authority management and permission syntax of the SAM user.
- Using SORACOM Access Management to Manage Operation Access | Getting Started | SORACOM Developers
- Permission statements for configuring access permission | SORACOM Developers
- Search results will return partial matches.
- A search word requires at least two letters. It can not search with one character.
- The search term is not case sensitive.
- For multi-value tags, the search API will search all the values and return results of any match.