Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

NetworkAccessProfile Resource


NetworkAccessProfile resources control which public land mobile networks (PLMNs) your Super SIMs can connect to:


_10
https://supersim.twilio.com/v1/NetworkAccessProfiles

A NetworkAccessProfile resource can be referenced in the API by either by its unique Sid or UniqueName:


_10
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}
_10
https://supersim.twilio.com/v1/NetworkAccessProfiles/{UniqueName}

Each NetworkAccessProfile (NAP) resource has a Networks subresource (NAP Networks):


_10
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}/Networks

Each NAP Network resource represents a cellular network that Super SIMs can connect to — an allowed Network.

The NAP Network resources in the Networks subresource will be a subset of all of the Network resources available from the main Networks resource. You can add or remove NAP Network resources from the NAP Networks subresource at any time to change which cellular networks your Super SIMs can access.

(information)

Info

The Super SIM Networks resource is a read-only resource which lists all of the cellular networks to which it is possible for Super SIMs to connect: it is a catalog of available networks for you to choose from. Once you've identified a cellular network you want to allow your Super SIMs to connect to, use its sid to add it to a NetworkAccessProfile resource's Networks subresource. See these examples to learn how to add or remove NAP Network resources.

(warning)

Warning

If your Super SIM has already attached to a network, authentication and authorization information may be cached in that network to allow devices to continue to use that network without re-authenticating. When you disable a network in a NAP, it may not take immediate effect for that Super SIM. The cached information for that Super SIM will need to expire before the Super SIM can no longer use that network. This may take up to a week, but varies by network.

To make use of a NetworkAccessProfile resource, it needs to be referenced by a Fleet resource. All of the Sim resources assigned to that Fleet will then be able to attach to the cellular networks allowed by the NetworkAccessProfile's Networks subresource. A NetworkAccessProfile can be used by multiple Fleet resources.


Forbidden networks

forbidden-networks page anchor

The Networks subresource serves as an allow list of the cellular networks to which Super SIMs can connect. Network resources not present in the Networks subresource are therefore blocked (i.e., forbidden).

When your device scans for available cellular networks to attempt to attach to, it may find a number of cellular networks. Super SIMs can only attach to a cellular network if the Network resource that represents the cellular network is present in the Networks subresource. If your device explicitly tries to attach to a cellular network that has not been allowed, the network will return the error 5004 / ROAMING_NOT_ALLOWED.

(warning)

Warning

There will be some cellular networks for which there is no Network resource available. As such there is no way to add them to the list of allowed cellular networks in a NetworkAccessProfile resource. No Super SIMs will be able to attach to these cellular networks.


New Feature Customers can now delete unused and unwanted NAPs and their associated data. This can be done in Console(link takes you to an external page): visit Internet of Things > Network access profiles(link takes you to an external page), click on the name of the NAP you wish to delete, and click the Delete NAP link at the bottom of the page. You will be asked to confirm your action before the NAP is deleted. NAPs which are currently assigned to Fleets cannot be deleted.

delete network access profile form in console.

NetworkAccessProfile Properties

networkaccessprofile-properties page anchor
Property nameTypePIIDescription
sidSID<HA>
Not PII

The unique string that identifies the Network Access Profile resource.

Pattern: ^HA[0-9a-fA-F]{32}$Min length: 34Max length: 34

unique_namestring

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.


account_sidSID<AC>

The SID of the Account that the Network Access Profile belongs to.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time>

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedstring<date-time>

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


urlstring<uri>

The absolute URL of the Network Access Profile resource.


linksobject<uri-map>

Create a NetworkAccessProfile resource

create-a-networkaccessprofile-resource page anchor
POST https://supersim.twilio.com/v1/NetworkAccessProfiles

Request body parameters

request-body-parameters page anchor
Property nameTypeRequiredPIIDescription
UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.


Networksarray[string]Optional

List of Network SIDs that this Network Access Profile will allow connections to.

Create a NetworkAccessProfile resource

create-a-networkaccessprofile-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function createNetworkAccessProfile() {
_17
const networkAccessProfile =
_17
await client.supersim.v1.networkAccessProfiles.create({ uniqueName: "" });
_17
_17
console.log(networkAccessProfile.sid);
_17
}
_17
_17
createNetworkAccessProfile();

Output

_11
{
_11
"unique_name": "",
_11
"sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"date_created": "2020-05-01T20:00:00Z",
_11
"date_updated": "2020-05-01T20:00:00Z",
_11
"url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"links": {
_11
"networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks"
_11
}
_11
}


Fetch a NetworkAccessProfile resource

fetch-a-networkaccessprofile-resource page anchor
GET https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}

Property nameTypeRequiredPIIDescription
Sidstringrequired

The SID of the Network Access Profile resource to fetch.

Fetch a NetworkAccessProfile resource

fetch-a-networkaccessprofile-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function fetchNetworkAccessProfile() {
_18
const networkAccessProfile = await client.supersim.v1
_18
.networkAccessProfiles("Sid")
_18
.fetch();
_18
_18
console.log(networkAccessProfile.sid);
_18
}
_18
_18
fetchNetworkAccessProfile();

Output

_11
{
_11
"unique_name": "My Network Access Profile",
_11
"sid": "Sid",
_11
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"date_created": "2020-05-01T20:00:00Z",
_11
"date_updated": "2020-05-01T20:00:00Z",
_11
"url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"links": {
_11
"networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks"
_11
}
_11
}


Read multiple NetworkAccessProfile resources

read-multiple-networkaccessprofile-resources page anchor
GET https://supersim.twilio.com/v1/NetworkAccessProfiles

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read NetworkAccessProfile resources

read-networkaccessprofile-resources page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function listNetworkAccessProfile() {
_17
const networkAccessProfiles =
_17
await client.supersim.v1.networkAccessProfiles.list({ limit: 20 });
_17
_17
networkAccessProfiles.forEach((n) => console.log(n.sid));
_17
}
_17
_17
listNetworkAccessProfile();

Output

_12
{
_12
"network_access_profiles": [],
_12
"meta": {
_12
"first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0",
_12
"key": "network_access_profiles",
_12
"next_page_url": null,
_12
"page": 0,
_12
"page_size": 50,
_12
"previous_page_url": null,
_12
"url": "https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0"
_12
}
_12
}


Update a NetworkAccessProfile resource

update-a-networkaccessprofile-resource page anchor
POST https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}

Property nameTypeRequiredPIIDescription
Sidstringrequired

The SID of the Network Access Profile to update.

Property nameTypeRequiredPIIDescription
UniqueNamestringOptional

The new unique name of the Network Access Profile.

Update a NetworkAccessProfile resource

update-a-networkaccessprofile-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function updateNetworkAccessProfile() {
_18
const networkAccessProfile = await client.supersim.v1
_18
.networkAccessProfiles("Sid")
_18
.update({ uniqueName: "new_unique_name" });
_18
_18
console.log(networkAccessProfile.uniqueName);
_18
}
_18
_18
updateNetworkAccessProfile();

Output

_11
{
_11
"unique_name": "new_unique_name",
_11
"sid": "Sid",
_11
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"date_created": "2020-05-01T20:00:00Z",
_11
"date_updated": "2020-05-01T20:00:00Z",
_11
"url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_11
"links": {
_11
"networks": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks"
_11
}
_11
}


Rate this page: