Skip to main content

Get profile

GET 

https://api.iot.telenor.com/iot-connect/subscriptions/v1/profiles/:iccid

Fetches a profile with optionally included resources. A profile has a profileType which can refer to either a SIM_PROFILE (UICC) or a VIRTUAL_PROFILE (which resides on an eUICC). A profile always belongs to one IoT subscription and always has one connectivity subscription associated with it. If the profile is a VIRTUAL_PROFILE it will belong to one eUICC.

Request

Path Parameters

    iccid stringrequired

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    ICCID to perform request on.

Query Parameters

    include string[]

    Possible values: [iotSubscription, euicc, connectivitySubscriptions]

    Related resources to include in response. Format as a comma separated list. Omitting this query parameter means that no related resources will be included in response. Note that including resources may result in longer response times so only include what you actually need.

    extendWith string[]

    Possible values: [*, pinPuk]

    Extends the attributes property in the response body with the specified properties. Format as a comma separated list. Set the value to * to extend with all available properties. Omitting this query parameter means that no optional properties will be present in attributes. Note that including extended properties may result in longer response times.

Responses

Contains the requested profile.

Schema
    attributes objectrequired
    iccidstringrequired

    Integrated Circuit Card ID. Uniquely identifies a UICC (SIM card) or an eUICC profile.

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Example: 89000000000000000001
    profileTypestringrequired

    Specifies the type of profile. SIM_PROFILE means the profile resides on a UICC. For values starting with VIRTUAL_PROFILE the profile resides on an eUICC. Value VIRTUAL_PROFILE means the profile is of type SGP.02.

    Possible values: [SIM_PROFILE, VIRTUAL_PROFILE, VIRTUAL_PROFILE_SGP_22, VIRTUAL_PROFILE_SGP_32]

    isEnabledbooleanrequired

    True if this is the currently enabled profile on an eUICC or if this is on a UICC. False if this is a disabled profile on an eUICC.

    simProfileIdsimProfileId (string)required

    The profile's SIM profile ID.

    Example: 9876
    cmpcmp (string)

    The profile's Connectivity Management Platform (CMP) determines which underlying connectivity platform the profile belongs to and determines what kind of data is available for the profile and its connectivity subscription.

    Possible values: [IOTA_EU, ARQIA_BR, THINGSPACE_US, STC_SA]

    connectivityProfile object
    idstring

    The connectivity profile determines capabilities of a profile and its connectivity subscription.

    Possible values: [GLOBAL_SUBSCRIPTION, BR_DATORA_LOCAL_SIM, BR_DATORA, BR_DATORA_MULTI]

    namestring

    Human readable name of the connectivity profile.

    Example: Global subscription
    pinPuk object

    PIN and PUK information. Only available if specified using the extendWith query parameter. This property is only available for profiles on the IOTA_EU connectivity management platform.

    pin1string

    Identifies the PIN code.

    Possible values: Value must match regular expression ^[0-9]{4,8}$

    Example: 1234
    pin2string

    Identifies the PIN code.

    Possible values: Value must match regular expression ^[0-9]{4,8}$

    Example: 1234
    puk1string

    Identifies the PUK code.

    Possible values: Value must match regular expression ^[0-9]{8}$

    Example: 12345678
    puk2string

    Identifies the PUK code.

    Possible values: Value must match regular expression ^[0-9]{8}$

    Example: 12345678
    relationships objectrequired
    iotSubscription objectrequired

    References an IoT subscription that is related to this resource. The url property can be used to GET the resource. The attributes property will be null unless the query parameter include specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

    urlstringrequired

    Possible values: non-empty and <= 256 characters

    Example: /iot-connect/subscriptions/v1/iot-subscriptions/9746U5LX6B24P3AZ8X
    attributes object
    idstringrequired

    Identifies the IoT subscription.

    Possible values: Value must match regular expression ^[85,97]{2}[23456789ABCDEFGHJKLMNPQRSTUVWXYZ]{16}$

    Example: 8546U5LX6B24P3AZ8X
    subscriptionTypestringrequired

    The subscription type.

    Possible values: [IOT_CONNECT]

    domain objectrequired

    The domain that owns this subscription.

    domainIdstringrequired

    Domain the resource belongs to. Used to determine which users have access to the resource.

    Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

    Example: a1ce25s2-c23edcs9
    simSoldBysimSoldBy (string)required

    Indicates if the SIM was sold by Telenor IoT or an external party. For subscriptions associated with an unused SGP.22/32 activation code, this field will be set to SIM_NOT_ASSIGNED.

    Possible values: [TELENOR_IOT, EXTERNAL, SIM_NOT_ASSIGNED]

    metadata objectrequired

    All metadata key-value pairs associated with this subscription. This object contains dynamic properties since metadata has a customized definition process.

    property name*string
    lastModifiedAtdate-time

    Specifies when the IoT subscription or any of its parts was last updated.

    euicc object

    References an eUICC that is related to this resource. The url property can be used to GET the resource. The attributes property will be null unless the query parameter include specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

    urlstringrequired

    Possible values: non-empty and <= 256 characters

    Example: /iot-connect/subscriptions/v1/euiccs/89000000000000000000000000000001
    attributes object
    eidstringrequired

    Uniquely identifies an eUICC (eSIM).

    Possible values: Value must match regular expression ^[0-9]{32}$

    Example: 89000000000000000000000000000001
    enabledProfilestringnullablerequired

    ICCID of the currently enabled profile.

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Example: 89000000000000000001
    bootstrapProfilestringrequired

    ICCID of the bootstrap profile, i.e. the profile that was first enabled on this eUICC.

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Example: 89000000000000000001
    eimeim (string)nullablerequired

    Indicates if an SGP.32 eUICC is hosted in Telenor IoT's EIM or an external EIM. Valid values are TELENOR_IOT, EXTERNAL or null. This only applies to SGP.32 eUICCs, the value will be null for other eUICC types.

    Example: TELENOR_IOT
    connectivitySubscription object

    References a connectivity subscription that is related to this resource. The url property can be used to GET the resource. The attributes property will be omitted unless the query parameter specifies the inclusion of this resource. If present, the attributes property will only contain properties marked as required.

    urlstringrequired

    Possible values: non-empty and <= 256 characters

    Example: /iot-connect/subscriptions/v1/connectivity-subscriptions/230000000000001
    attributes object

    Attributes present in the response depends on profile type.

    anyOf
    imsistringrequired

    International Mobile Subscriber Identity. Uniquely identifies a subscriber in the mobile network.

    Possible values: Value must match regular expression ^[0-9]{6,15}$

    Example: 230000000000001
    iccidstringrequired

    Integrated Circuit Card ID. Uniquely identifies a UICC (SIM card) or an eUICC profile.

    Possible values: Value must match regular expression ^89[0-9]{16,18}$

    Example: 89000000000000000001
    msisdnstringrequired

    Mobile Station International Subscriber Directory Number. This is equivalent to the phone number, including the country code.

    Possible values: Value must match regular expression ^[0-9]{5,15}$

    Example: 46000000001
    modemode (string)required

    The mode of the subscription. This determines whether the subscription can connect to the network and how the subscription is billed.

    Possible values: [ACTIVE, ACTIVE_NO_BILLING, DEACTIVATED, PAUSED, TERMINATED]

    firstActivationDatedate-timenullablerequired

    Time when profile entered ACTIVE mode for the first time.

    trmExitedAtdate-timenullablerequired

    Time when profile exited Test Ready Mode (TRM). Is null if no TRM exit has been registered.

    fixedIpAddresses object[]

    Fixed IP addresses associated with this subscription.

  • Array [
  • ipAddressstring

    Possible values: Value must match regular expression ^[a-fA-F0-9.\/:]{1,100}$

    Example: 192.168.0.5
    subnetstring

    Possible values: Value must match regular expression ^[a-fA-F0-9.\/:]{1,100}$

    Example: 255.255.255.0
    ipVersionstring

    Possible values: [IPv4, IPv6]

    apnNameapnName (string)

    Possible values: Value must match regular expression ^[a-zA-Z0-9.]{3,256}$

    Example: internet.lte.cxn
    radiusServerstring
    Example: RADIUS2
  • ]
  • imei object

    IMEI related information.

    assignedImeistringnullablerequired

    Assigned IMEI for the subscription. Null if no assigned IMEI.

    Possible values: Value must match regular expression ^[0-9]{14,16}$

    Example: 013200003915965
    detectedImeistringnullablerequired

    Detected IMEI for the subscription. Null if no detected IMEI.

    Possible values: Value must match regular expression ^[0-9]{14,16}$

    Example: 013200003915965
    deactivatedApns object[]required
  • Array [
  • apnIdapnId (number)required
    Example: 12345
    apnNameapnName (string)required

    Possible values: Value must match regular expression ^[a-zA-Z0-9.]{3,256}$

    Example: internet.lte.cxn
  • ]

Authorization: http

name: TokenAuthorizertype: httpscheme: bearerbearerFormat: JWT
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.iot.telenor.com/iot-connect/subscriptions/v1/profiles/:iccid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.iot.telenor.com
Auth
Parameters
— pathrequired
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!