NetworkAccessProfile Network Subresource
Control which cellular networks are allowed by your Network Access Profile
Each Network Access Profile (NAP) resource has a Networks subresource (NAP Networks) that contains a list of allowed cellular networks Super SIMs can connect to.
The NAP Network resources in this subresource are a subset of all of the Network resources available from the Networks resource. You can add or remove NAP Network resources from the NAP Networks subresource at any time to change which cellular networks Super SIMs using the parent Network Access Profile resource can connect to.
The sid
used to add, remove, or identify NAP Network resources is the same as the sid
of the corresponding Network resource. You can filter the NAP Networks subresource the same way you can the Networks resource.
NetworkAccessProfile Network properties
A Network Access Profile Network resource (NAP Network) has the same representation and values as the corresponding available Network resource with the exception of the additional NetworkAccessProfileSid
property that identifies the Network Access Profile the subresource belongs to.
Managing Access to Networks
Allowing Access to a Network
To allow Super SIMs to connect to a cellular network represented by a Network resource, a NAP Network resource must be created. Use the sid
of the Network resource you with to add in your create request to add the NAP Networks subresource.
For example, if you wish to allow Super SIMs to connect to AT&T US you would follow these steps:
First, you need to know the
sid
of the Network resource that represents AT&T US. You could do that by reading through the list of Network resources or if you know the MCC and MNC identifiers (310 and 410, respectively for AT&T US), you can read Networks resource by MCC and MNC. You will find that thesid
of the Network resource representing AT&T US isHWd85b0262d6fc4c0b991bf8294596642e
.Now that you know the
sid
of the Network resource you wish to add, you can allow your Super SIMs to that use your NAP by creating NAP Network resource with AT&T US'sid
. See the documentation below for more details on how to do this.
Removing Access to a Network
To prevent Super SIMs from connecting to a cellular network that was previously allowed by your NAP, the corresponding NAP Network resource must be deleted. See the documentation below for more details on how to do this.
Remember that the networks listed in your NAP Networks list act as an allow list. Your SIMs will be blocked from connecting to any networks not present in the list. Adding networks to the list gives permission to connect to it. Removing networks from the list blocks them again.
Create a NetworkAccessProfile Network Resource
Add a Network resource to the Network Access Profile resource.
/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
The unique string that identifies the Network Access Profile resource.
The SID of the Network resource to be added to the Network Access Profile resource.
^HW[0-9a-fA-F]{32}$
Fetch a NetworkAccessProfile Network resource
Fetch a Network Access Profile resource's Network resource.
/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
The unique string that identifies the Network Access Profile resource.
The SID of the Network resource to fetch.
^HW[0-9a-fA-F]{32}$
Read multiple NetworkAccessProfile Network resources
Retrieve a list of Network Access Profile resource's Network resource.
/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
The unique string that identifies the Network Access Profile resource.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
The page index. This value is simply for client state.
The page token. This is provided by the API.
Delete a NetworkAccessProfile Network resource
Remove a Network resource from the Network Access Profile resource's.
/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
The unique string that identifies the Network Access Profile resource.
^HA[0-9a-fA-F]{32}$
The SID of the Network resource to be removed from the Network Access Profile resource.
^HW[0-9a-fA-F]{32}$
No body
Last updated
Was this helpful?