Skip to main content
Version: 4.0

Get-ADTRunAsActiveUser

SYNOPSIS​

Retrieves the active user session information.

SYNTAX​

Get-ADTRunAsActiveUser [[-UserSessionInfo] <CompatibilitySessionInfo[]>] [<CommonParameters>]

DESCRIPTION​

The Get-ADTRunAsActiveUser function determines the account that will be used to execute commands in the user session when the toolkit is running under the SYSTEM account.

The active console user will be chosen first. If no active console user is found, for multi-session operating systems, the first logged-on user will be used instead.

EXAMPLES​

EXAMPLE 1​

Get-ADTRunAsActiveUser

This example retrieves the active user session information.

PARAMETERS​

-UserSessionInfo​

An array of UserSessionInfo objects to enumerate through. If not supplied, a fresh query will be performed.

Type: CompatibilitySessionInfo[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: (Get-ADTLoggedOnUser)
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

None​

You cannot pipe objects to this function.​

OUTPUTS​

PSADT.Types.UserSessionInfo​

Returns a custom object containing the user session information.​

NOTES​

An active ADT session is NOT required to use this function.

Tags: psadt
Website: https://psappdeploytoolkit.com
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
License: https://opensource.org/license/lgpl-3-0

https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTRunAsActiveUser