Citrix Virtual Apps and Desktops SDK

Get-AdminEffectiveAdministrator

August 9, 2024

Contributed by:

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

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-AdminEffectiveAdministrator

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Name

CitrixCommonParameters

CommonParameters

Inputs

String

Outputs

Citrix.DelegatedAdmin.Sdk.Administrator

Related Links

In this article