From e5f68bb6e9412bbb141aff4dd4e8cc0d9dfa849d Mon Sep 17 00:00:00 2001 From: Liz Long <104389055+lizgt2000@users.noreply.github.com> Date: Tue, 3 Jan 2023 10:05:10 -0500 Subject: [PATCH] kioskbrowser --- .../mdm/policy-csp-kioskbrowser.md | 496 ++++++++++-------- 1 file changed, 282 insertions(+), 214 deletions(-) diff --git a/windows/client-management/mdm/policy-csp-kioskbrowser.md b/windows/client-management/mdm/policy-csp-kioskbrowser.md index 693f130feb..162f7c6bb1 100644 --- a/windows/client-management/mdm/policy-csp-kioskbrowser.md +++ b/windows/client-management/mdm/policy-csp-kioskbrowser.md @@ -1,313 +1,381 @@ --- -title: Policy CSP - KioskBrowser -description: Use the Policy CSP - KioskBrowser setting to configure URLs kiosk browsers are allowed to navigate to, which are a subset of the blocked URLs. +title: KioskBrowser Policy CSP +description: Learn more about the KioskBrowser Area in Policy CSP +author: vinaypamnani-msft +manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 01/03/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.localizationpriority: medium -ms.date: 09/27/2019 -ms.reviewer: -manager: aaroncz +ms.topic: reference --- + + + # Policy CSP - KioskBrowser -These policies currently only apply to Kiosk Browser app. Kiosk Browser is a Microsoft Store app, added in Windows 10 version 1803, that provides IT a way to customize the end user's browsing experience to fulfill kiosk, signage, and shared device scenarios. Application developers can also create their own kiosk browser and read these policies using [NamedPolicy.GetPolicyFromPath(String, String) Method](/uwp/api/windows.management.policies.namedpolicy.getpolicyfrompath#Windows_Management_Policies_NamedPolicy_GetPolicyFromPath_System_String_System_String_). + + + + +## BlockedUrlExceptions -
+ +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + - -## KioskBrowser policies + +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/BlockedUrlExceptions +``` -
-
- KioskBrowser/BlockedUrlExceptions -
-
- KioskBrowser/BlockedUrls -
-
- KioskBrowser/DefaultURL -
-
- KioskBrowser/EnableEndSessionButton -
-
- KioskBrowser/EnableHomeButton -
-
- KioskBrowser/EnableNavigationButtons -
-
- KioskBrowser/RestartOnIdleTime -
-
+```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/BlockedUrlExceptions +``` + + + +List of exceptions to the blocked website URLs (with wildcard support). This is used to configure URLs kiosk browsers are allowed to navigate to, which are a subset of the blocked URLs. + -
- - -**KioskBrowser/BlockedUrlExceptions** - - - -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| - - -
- - -[Scope](./policy-configuration-service-provider.md#policy-scope): - -> [!div class = "checklist"] -> * Device - -
- - - -List of exceptions to the blocked website URLs (with wildcard support). This policy is used to configure URLs kiosk browsers are allowed to navigate to, which are a subset of the blocked URLs. - + + > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | List (Delimiter: `0xF000`) | + - -**KioskBrowser/BlockedUrls** + + + - + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + +## BlockedUrls - -
+ +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/BlockedUrls +``` -> [!div class = "checklist"] -> * Device +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/BlockedUrls +``` + -
- - - -List of blocked website URLs (with wildcard support). This policy is used to configure blocked URLs kiosk browsers can't navigate to. The delimiter for the URLs is "\uF000" character. + + +List of blocked website URLs (with wildcard support). This is used to configure blocked URLs kiosk browsers can not navigate to. + + + > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | List (Delimiter: `0xF000`) | + - -**KioskBrowser/DefaultURL** + + + - + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + +## DefaultURL - -
+ +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/DefaultURL +``` -> [!div class = "checklist"] -> * Device +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/DefaultURL +``` + -
- - - + + Configures the default URL kiosk browsers to navigate on launch and restart. + + + > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + - -**KioskBrowser/EnableEndSessionButton** + + + - + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + +## EnableEndSessionButton - -
+ +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/EnableEndSessionButton +``` -> [!div class = "checklist"] -> * Device +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/EnableEndSessionButton +``` + -
+ + +Enable/disable kiosk browser's end session button. + - - -Shows the Kiosk Browser's end session button. When the policy is enabled, the Kiosk Browser app shows a button to reset the browser. When the user selects the button, the app will prompt the user for confirmation to end the session. When the user confirms, the Kiosk browser will clear all browsing data (cache, cookies, etc.) and navigate back to the default URL. + + +When the policy is enabled, the Kiosk Browser app shows a button to reset the browser. When the user selects the button, the app will prompt the user for confirmation to end the session. When the user confirms, the Kiosk browser will clear all browsing data (cache, cookies, etc.) and navigate back to the default URL. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + - -**KioskBrowser/EnableHomeButton** + +**Allowed values**: - +| Value | Description | +|:--|:--| +| 1 | Enable | +| 0 (Default) | Disable | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## EnableHomeButton -> [!div class = "checklist"] -> * Device + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + -
+ +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/EnableHomeButton +``` - - +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/EnableHomeButton +``` + + + + Enable/disable kiosk browser's home button. + + + > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + - -**KioskBrowser/EnableNavigationButtons** + +**Allowed values**: - +| Value | Description | +|:--|:--| +| 1 | Enable | +| 0 (Default) | Disable | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## EnableNavigationButtons -> [!div class = "checklist"] -> * Device + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + -
+ +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/EnableNavigationButtons +``` - - +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/EnableNavigationButtons +``` + + + + Enable/disable kiosk browser's navigation buttons (forward/back). + + + > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - + +**Description framework properties**: -
+| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Default Value | 0 | + - -**KioskBrowser/RestartOnIdleTime** + +**Allowed values**: - +| Value | Description | +|:--|:--| +| 1 | Enable | +| 0 (Default) | Disable | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## RestartOnIdleTime -> [!div class = "checklist"] -> * Device + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :heavy_check_mark: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later | + -
+ +```User +./User/Vendor/MSFT/Policy/Config/KioskBrowser/RestartOnIdleTime +``` - - -Amount of time in minutes, the session is idle until the kiosk browser restarts in a fresh state. +```Device +./Device/Vendor/MSFT/Policy/Config/KioskBrowser/RestartOnIdleTime +``` + + + +Amount of time in minutes the session is idle until the kiosk browser restarts in a fresh state. + + + + The value is an int 1-1440 that specifies the number of minutes the session is idle until the kiosk browser restarts in a fresh state. The default value is empty, which means there's no idle timeout within the kiosk browser. > [!NOTE] > This policy only applies to the Kiosk Browser app in Microsoft Store. + - - -
+ +**Description framework properties**: - +| Property name | Property value | +|:--|:--| +| Format | int | +| Access Type | Add, Delete, Get, Replace | +| Allowed Values | Range: `[1-1440]` | +| Default Value | 0 | + -## Related topics + + + + + + + + + + + + +## Related articles [Policy configuration service provider](policy-configuration-service-provider.md)