10 KiB
title, description, ms.date, ms.topic
title | description | ms.date | ms.topic |
---|---|---|---|
Configure a Single-App Kiosk With Assigned Access | Learn how to configure a single-app kiosk with Assigned Access. | 02/27/2025 | overview |
Configure a single-app kiosk with Assigned Access
<<<<<<< HEAD:windows/configuration/assigned-access/configure-single-app-kiosk.md A single-app kiosk uses the Assigned Access feature to run a single application above the lock screen. When the kiosk account signs in, the app is launched automatically. The person using the kiosk can't do anything on the device outside of the kiosk app.
Assigned Access is a Windows feature that you can use to configure a device as a kiosk or with a restricted user experience.
When you configure a kiosk experience, a single Universal Windows Platform (UWP) application or Microsoft Edge is executed in full screen. Users can only use that application and once the kiosk app is closed, it automatically restarts. Practical examples include:
- Public browsing
- Interactive digital signage
When you configure a restricted user experience, users can only execute a defined list of applications, with a tailored Start menu and Taskbar. Different policy settings and AppLocker rules are enforced, creating a locked down experience. The users can access a familiar Windows desktop, while limiting their access, reducing distractions, and potential for inadvertent uses. Ideal for shared devices, you can create different configurations for different users. Practical examples include:
- Frontline worker devices
- Student devices
- Lab devices
Note
When you configure a restricted user experience, different policy settings are applied to the device. Some policy settings apply to standard users only, and some to administrator accounts too. For more information, see Assigned Access policy settings.
Requirements
Here are the requirements for Assigned Access:
- To use a kiosk experience, User account control (UAC) must be enabled
- To use a kiosk experience, you must sign in from the console. The kiosk experience isn't supported over a remote desktop connection
[!INCLUDE assigned-access]
Configure a kiosk experience
29fc1e82cb8d18c0059926e1e862a382aa6ae7a9:windows/configuration/assigned-access/overview.md
There are several options to configure a kiosk experience. If you need to configure a single device with a local account, you can use:
- PowerShell: you can use the
Set-AssignedAccess
PowerShell cmdlet to configure a kiosk experience using a local standard account - Settings: use this option when you need a simple method to configure a single device with a local standard user account
For advanced customizations, you can use the Assigned Access CSP to configure the kiosk experience. The CSP allows you to configure the kiosk app, the user account, and the kiosk app's behavior. When you use the CSP, you must create an XML configuration file that specifies the kiosk app and the user account. The XML file is applied to the device using one of the following options:
- A Mobile Device Management (MDM) solution, like Microsoft Intune
- Provisioning packages
- PowerShell, with the MDM Bridge WMI Provider
To learn how to configure the Shell Launcher XML file, see Create an Assigned Access configuration file.
[!INCLUDE tab-intro]
:::image type="icon" source="../images/icons/intune.svg"::: Intune/CSP
You can configure devices using a custom policy with the AssignedAccess CSP.
- Setting:
./Vendor/MSFT/AssignedAccess/Configuration
- Value: content of the XML configuration file
Assign the policy to a group that contains as members the devices that you want to configure.
:::image type="icon" source="../images/icons/provisioning-package.svg"::: PPKG
[!INCLUDE provisioning-package-1]
- Path:
AssignedAccess/AssignedAccessSettings
- Value: Enter the account and the application you want to use for Assigned access, using the AUMID of the app. Example:
{"Account":"domain\user", "AUMID":"Microsoft.WindowsCalculator_8wekyb3d8bbwe!App"}
[!INCLUDE provisioning-package-2]
:::image type="icon" source="../images/icons/powershell.svg"::: PowerShell
To configure a device using Windows PowerShell:
-
Sign in as administrator
-
Create the user account for Assigned Access
-
Sign in as the Assigned Access user account
-
Install the required UWP app
-
Sign out as the Assigned Access user account
-
Sign in as administrator and from an elevated PowerShell prompt use one of the following commands:
#Configure Assigned Access by AppUserModelID and user name Set-AssignedAccess -AppUserModelId <AUMID> -UserName <username> #Configure Assigned Access by AppUserModelID and user SID Set-AssignedAccess -AppUserModelId <AUMID> -UserSID <usersid> #Configure Assigned Access by app name and user name Set-AssignedAccess -AppName <CustomApp> -UserName <username> #Configure Assigned Access by app name and user SID**: Set-AssignedAccess -AppName <CustomApp> -UserSID <usersid>
Note
To set up Assigned Access using
-AppName
, the user account that you enter for Assigned Access must have signed in at least once.
For more information:
To remove assigned access, using PowerShell, run the following cmdlet:
Clear-AssignedAccess
For advanced customizations that use the XML configuration file, you can use PowerShell scripts via the MDM Bridge WMI Provider.
Important
For all device settings, the WMI Bridge client must be executed as SYSTEM (LocalSystem) account.
To test the PowerShell script, you can:
- Download the psexec tool
- Open an elevated command prompt and run:
psexec.exe -i -s powershell.exe
- Run the script in the PowerShell session
$shellLauncherConfiguration = @"
# content of the XML configuration file
"@
$namespaceName="root\cimv2\mdm\dmmap"
$className="MDM_AssignedAccess"
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
$obj.ShellLauncher = [System.Net.WebUtility]::HtmlEncode($shellLauncherConfiguration)
$obj = Set-CimInstance -CimInstance $obj -ErrorVariable cimSetError -ErrorAction SilentlyContinue
if($cimSetError) {
Write-Output "An ERROR occurred. Displaying error record and attempting to retrieve error logs...`n"
Write-Error -ErrorRecord $cimSetError[0]
$timeout = New-TimeSpan -Seconds 30
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
do{
$events = Get-WinEvent -FilterHashtable $eventLogFilterHashTable -ErrorAction Ignore
} until ($events.Count -or $stopwatch.Elapsed -gt $timeout) # wait for the log to be available
if($events.Count) {
$events | ForEach-Object {
Write-Output "$($_.TimeCreated) [$($_.LevelDisplayName.ToUpper())] $($_.Message -replace "`n|`r")"
}
} else {
Write-Warning "Timed-out attempting to retrieve event logs..."
}
Exit 1
}
Write-Output "Successfully applied Shell Launcher configuration"
[!INCLUDE powershell-wmi-bridge-2]
:::image type="icon" source="../images/icons/settings-app.svg"::: Settings
Here are the steps to configure a kiosk using the Settings app:
-
Open the Settings app to view and configure a device as a kiosk. Go to Settings > Accounts > Other Users, or use the following shortcut:
[!div class="nextstepaction"]
-
Under Set up a kiosk, select Get Started
-
In the Create an account dialog, enter the account name, and select Next
Note
If there are any local standard user accounts already, the Create an account dialog offers the option to Choose an existing account
-
Choose the application to run when the kiosk account signs in. If you select Microsoft Edge as the kiosk app, you configure the following options:
- Whether Microsoft Edge should display your website full-screen (digital sign) or with some browser controls available (public browser)
- Which URL should be open when the kiosk accounts signs in
- When Microsoft Edge should restart after a period of inactivity (if you select to run as a public browser)
-
Select Close
When the device isn't joined to an Active Directory domain or Microsoft Entra ID, automatic sign-in of the kiosk account is configured automatically:
- If you want the kiosk account to sign in automatically, and the kiosk app launched when the device restarts, then you don't need to do anything
- If you don't want the kiosk account to sign in automatically when the device restarts, then you must change the default setting before you configure the device as a kiosk. Sign in with the account that you want to use as the kiosk account. Open Settings > Accounts > Sign-in options. Set the Use my sign-in info to automatically finish setting up my device after an update or restart setting to Off. After you change the setting, you can apply the kiosk configuration to the device
Tip
For practical examples, see the Quickstart: Configure a kiosk with Assigned Access.
[!INCLUDE user-experience]