eUICCs CSP
The eUICCs configuration service provider is used to support eUICC enterprise use cases and enables the IT admin to manage (assign, reassign, remove) subscriptions to employees.
The following list shows the eUICCs configuration service provider nodes:
- ./Device/Vendor/MSFT/eUICCs
{eUICC}
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}
Represents information associated with an eUICC. There is one subtree for each known eUICC, created by the Local Profile Assistant (LPA) when the eUICC is first seen. The node name is the eUICC ID (EID). The node name "Default" represents the currently active eUICC.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
| Dynamic Node Naming | UniqueName: The eUICC ID (EID) associated with the device. |
{eUICC}/Actions
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions
Actions that can be performed on the eUICC as a whole.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
{eUICC}/Actions/ResetToFactoryState
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/ResetToFactoryState
This triggers an eUICC Memory Reset, which erases all the eSIM profiles in the eUICC.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Exec |
{eUICC}/Actions/Status
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/Status
Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
| Default Value | 0 |
{eUICC}/DownloadServers
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 11, version 21H2 [10.0.22000] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers
Represents servers used for bulk provisioning and eSIM discovery.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
{eUICC}/DownloadServers/{ServerName}
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 11, version 21H2 [10.0.22000] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}
Node representing a bulk download/discovery server. The node name is the fully qualified domain name of the server that will be used. Creation of this subtree triggers a discovery request.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Add, Delete, Get, Replace |
| Dynamic Node Naming | UniqueName: ServerName used for the discovery operation. |
{eUICC}/DownloadServers/{ServerName}/AutoEnable
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 11, version 21H2 [10.0.22000] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/AutoEnable
Indicates whether the discovered profile must be enabled automatically after install. This must be set by the MDM when the ServerName subtree is created.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Add, Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disable. |
| true | Enable. |
{eUICC}/DownloadServers/{ServerName}/DiscoveryState
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 11, version 21H2 [10.0.22000] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/DiscoveryState
Current state of the discovery operation for this server (Requested = 1, Executing = 2, Completed = 3, Failed = 4).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
| Default Value | 1 |
{eUICC}/DownloadServers/{ServerName}/IsDiscoveryServer
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 11, version 22H2 [10.0.22621] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/IsDiscoveryServer
Indicates whether the server is a discovery server or if it's used for bulk download. A discovery server is used every time a user requests a profile discovery operation. Optional, default value is false.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Add, Get, Replace |
| Default Value | false |
Allowed values:
| Value | Description |
|---|---|
| false (Default) | Is Not Discovery Server. |
| true | Is Discovery Server. |
{eUICC}/Identifier
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Identifier
The unique eUICC identifier (EID).
Identifies an eUICC in an implementation-specific manner, for example, this identification could be an SHA-256 hash of the EID.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get |
{eUICC}/IsActive
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/IsActive
Indicates whether this eUICC is physically present and active. Updated only by the LPA.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get |
{eUICC}/Policies
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Policies
Device policies associated with the eUICC as a whole (not per-profile).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
{eUICC}/Policies/LocalUIEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Policies/LocalUIEnabled
Determines whether or not the user can make changes to the eSIM through the user interface.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
| Default Value | true |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true (Default) | Enabled. |
{eUICC}/PPR1Allowed
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/PPR1Allowed
Indicates whether the download of a profile with Profile Policy Rule 1 (PPR1) is allowed. If the eUICC has already a profile (regardless of its origin and policy rules associated with it), then the download of a profile with PPR1 isn't allowed.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get |
{eUICC}/PPR1AlreadySet
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/PPR1AlreadySet
Indicates whether the eUICC has already a profile with Profile Policy Rule 1 (PPR1).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get |
{eUICC}/Profiles
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles
Represents all enterprise-owned eSIM profiles.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
{eUICC}/Profiles/{ICCID}
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}
Node representing an enterprise-owned eSIM profile. The node name is the ICCID of the profile (which is a unique identifier). Creation of this subtree triggers an AddProfile request by the LPA (which installs the profile on the eUICC). Removal of this subtree triggers the LPA to delete the profile (if resident on the eUICC).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Add, Delete, Get, Replace |
| Dynamic Node Naming | UniqueName: ICCID of the profile. |
{eUICC}/Profiles/{ICCID}/ErrorDetail
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/ErrorDetail
Detailed error if the profile download and install procedure failed (None = 0, CardGeneralFailure = 1, ConfirmationCodeMissing = 3, ForbiddenByPolicy = 5, InvalidMatchingId = 6, NoEligibleProfileForThisDevice = 7, NotEnoughSpaceOnCard = 8, ProfileEidMismatch = 10, ProfileNotAvailableForNewBinding = 11, ProfileNotReleasedByOperator = 12, RemoteServerGeneralFailure = 13, RemoteServerUnreachable = 14).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
| Default Value | 0 |
{eUICC}/Profiles/{ICCID}/IsEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1803 [10.0.17134] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/IsEnabled
Indicates whether this eSIM profile is enabled. Can be set by both the MDM and the CSP.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Add, Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true | Enabled. |
{eUICC}/Profiles/{ICCID}/MatchingID
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/MatchingID
Matching ID (activation code token) for eSIM profile download. Must be set by the MDM when the ICCID subtree is created.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Add, Get, Replace |
| Allowed Values | Regular Expression: ^([0-9a-fA-F]{5}-){3}[0-9a-fA-F]{5}$ |
{eUICC}/Profiles/{ICCID}/PPR1Set
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR1Set
Profile Policy Rule 1 (PPR1) indicates whether disabling of this profile isn't allowed (true if not allowed, false otherwise).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get |
{eUICC}/Profiles/{ICCID}/PPR2Set
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR2Set
Profile Policy Rule 2 (PPR2) indicates whether deletion of this profile isn't allowed (true if not allowed, false otherwise).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get |
{eUICC}/Profiles/{ICCID}/ServerName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/ServerName
Fully qualified domain name of the server that can download this eSIM profile. Must be set by the MDM when the ICCID subtree is created.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Add, Get, Replace |
{eUICC}/Profiles/{ICCID}/State
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 [10.0.16299] and later |
./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/State
Current state of the eSIM profile (Installing = 1, Installed = 2, Deleting = 3, Error = 4).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
| Default Value | 1 |
Related articles
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for