Citrix Virtual Apps and Desktops SDK

Get-AdminEffectiveAdministrator

Retrieve the effective administrator objects for a user.

Syntax

Get-AdminEffectiveAdministrator
   [-Name] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This command determines what groups the specified user belongs to and retrieves the matching administrator records. It includes the set of rights that would be granted to the user if he or she used the system.

As this command uses Active Directory to determine what groups the user has, the caller must have the ability to read this information from Active Directory.

Only enabled administrator records are returned.

Examples

EXAMPLE 1

Retrieve the administrator records matching user ‘testuser’.

Get-AdminEffectiveAdministrator MYDOMAIN\testuser
<!--NeedCopy-->

Parameters

-Name

User name or ID of user to query

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

String

User name or ID of user to query

Outputs

Citrix.DelegatedAdmin.Sdk.Administrator

Administrator records matching the specified user

Get-AdminEffectiveAdministrator