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.

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

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:

  1. 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 the sid of the Network resource representing AT&T US is HWd85b0262d6fc4c0b991bf8294596642e.

  2. 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.

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 NetworkAccessProfile Network Resource

post

Add a Network resource to the Network Access Profile resource.

Authorizations
Path parameters
NetworkAccessProfileSidstringRequired

The unique string that identifies the Network Access Profile resource.

Body
Networkstring · min: 34 · max: 34Required

The SID of the Network resource to be added to the Network Access Profile resource.

Pattern: ^HW[0-9a-fA-F]{32}$
Responses
201
Created
application/json
post
curl -X POST "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<Sid>/Networks" -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" --data-urlencode "Network=<NETWORK_SID>"
201

Created

{
  "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendly_name": "AT&T",
  "iso_country": "us",
  "identifiers": [
    {
      "mcc": "310",
      "mnc": "410"
    }
  ],
  "url": "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Fetch a NetworkAccessProfile Network resource

get

Fetch a Network Access Profile resource's Network resource.

Authorizations
Path parameters
NetworkAccessProfileSidstringRequired

The unique string that identifies the Network Access Profile resource.

Sidstring · min: 34 · max: 34Required

The SID of the Network resource to fetch.

Pattern: ^HW[0-9a-fA-F]{32}$
Responses
200
OK
application/json
get
curl -L "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<NETWORK_ACCESS_PROFILE_SID>/Networks/<NETWORK_SID>" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"
200

OK

{
  "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendly_name": "AT&T",
  "iso_country": "us",
  "identifiers": [
    {
      "mcc": "310",
      "mnc": "410"
    }
  ],
  "url": "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Read multiple NetworkAccessProfile Network resources

get

Retrieve a list of Network Access Profile resource's Network resource.

Authorizations
Path parameters
NetworkAccessProfileSidstringRequired

The unique string that identifies the Network Access Profile resource.

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
curl -L "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<NETWORK_ACCESS_PROFILE_SID>/Networks?Page=1&PageSize=10" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"
200

OK

{
  "meta": {
    "first_page_url": "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0",
    "key": "networks",
    "next_page_url": null,
    "page": 0,
    "page_size": 50,
    "previous_page_url": null,
    "url": "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0"
  },
  "networks": [
    {
      "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "friendly_name": "AT&T",
      "iso_country": "us",
      "identifiers": [
        {
          "mcc": "310",
          "mnc": "410"
        }
      ],
      "url": "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}

Delete a NetworkAccessProfile Network resource

delete

Remove a Network resource from the Network Access Profile resource's.

Authorizations
Path parameters
NetworkAccessProfileSidstring · min: 34 · max: 34Required

The unique string that identifies the Network Access Profile resource.

Pattern: ^HA[0-9a-fA-F]{32}$
Sidstring · min: 34 · max: 34Required

The SID of the Network resource to be removed from the Network Access Profile resource.

Pattern: ^HW[0-9a-fA-F]{32}$
Responses
204
The resource was deleted successfully.
delete
curl -L -X DELETE "https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/<NETWORK_ACCESS_PROFILE_SID>/Networks/<NETWORK_SID>" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"
204

The resource was deleted successfully.

No content

PreviousNetworkAccessProfile ResourceNextNetwork Resource

Last updated

Was this helpful?