NetworkAccessProfile Resource

Control which mobile networks Super SIMs can connect to

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

https://supersim.api.korewireless.com/v1/NetworkAccessProfiles

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

https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{Sid}
https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{UniqueName}

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

https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{Sid}/Networks

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

The allowed networks represented by the NAP Network resources will be a subset of all of the networks supported by Super SIM represented by the Network resources returned from the main Networks endpoint. 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.

The Super SIM Networks endpoint 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.

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 with our services. 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 e able to attach to the cellular networks allowed by the NetworkAccessProfile's Networks subresource.

A NetworkAccessProfile can be used by multiple Fleet resources.

For a detailed guide on how Network Access Profiles, Networks, and Fleets work together, check out How to Use Super SIM Fleets and Network Access Profiles

---

Forbidden Networks

The NAP Networks subresource serves as an allow list of the cellular networks to which Super SIMs can connect. Networks not present in the NAP 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 a NAP's 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.

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.

---

Delete a Network Access Profile

New Feature Customers can now delete unused and unwanted NAPs and their associated data. This can be done in Console: visit Super SIM > Network Access Profiles, click on the name of the NAP you wish to delete, and click the Delete Network Access Profile 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.

---

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example on how to define your access token in a header:

curl -L "https://supersim.api.korewireless.com/v1/Sims" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" 

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

---

Create a Network Access Profile resource

post

Create a new Network Access Profile

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Body

application/x-www-form-urlencoded

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.

Networksstring[]Optional

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

Responses

201

Created

application/json

post

/v1/NetworkAccessProfiles

cURLNodeJsPython

curl -X POST "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles" -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" --data-urlencode "UniqueName=<UNIQUE_NAME>" --data-urlencode "Networks=<NETWORK_SID>" --data-urlencode "Networks=<NETWORK_SID>"

201

Created

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

---

Fetch a Network Access Profile resource

get

Fetch a Network Access Profile instance from your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

SidstringRequired

The SID of the Network Access Profile resource to fetch.

Responses

200

OK

application/json

get

/v1/NetworkAccessProfiles/{Sid}

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<Sid>" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>" 

200

OK

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

---

Read Multiple NetworkAccessProfile resources

get

Retrieve a list of Network Access Profiles from your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Query parameters

PageSizeinteger · min: 1 · max: 1000Optional

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

PageintegerOptional

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

PageTokenstringOptional

The page token. This is provided by the API.

Responses

200

OK

application/json

get

/v1/NetworkAccessProfiles

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles?Page=1&PageSize=1" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

200

OK

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

---

Update a NetworkAccessProfile resource

post

Updates the given properties of a Network Access Profile in your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

SidstringRequired

The SID of the Network Access Profile to update.

Body

application/x-www-form-urlencoded

UniqueNamestringOptional

The new unique name of the Network Access Profile.

Responses

200

OK

application/json

post

/v1/NetworkAccessProfiles/{Sid}

cURLNodeJsPython

curl -X POST "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<Sid>" -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" --data-urlencode "UniqueName=<NEW_UNIQUE_NAME>"

200

OK

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