Citrix Virtual Apps and Desktops SDK

Get-AdminEffectiveAdministrator

March 11, 2024

Contributed by:

Retrieve the effective administrator objects for a user.

Syntax

Get-AdminEffectiveAdministrator [-Name] <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed 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.

Get-AdminAdministrator

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	User name or ID of user to query	true	true (ByValue)
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the IP address of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

String

User name or ID of user to query

Return Values

Citrix.Delegatedadmin.Sdk.Administrator

Administrator records matching the specified user

Examples

Example 1

C:\PS> Get-AdminEffectiveAdministrator MYDOMAIN\testuser

<!--NeedCopy-->

Description

Retrieve the administrator records matching user ‘testuser’.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-AdminEffectiveAdministrator

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-AdminEffectiveAdministrator

Syntax

Detailed Description

Related Commands

Parameters

Input Type

String

Return Values

Citrix.Delegatedadmin.Sdk.Administrator

Examples

Example 1

Description

In this article