Skip to content

Remove-Adminright

Removes rights from an administrator.

Syntax

Remove-AdminRight -Scope <String> -Role <String> -Administrator <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminRight -Role <String> -Administrator <String> [-All] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminRight [-InputObject] <Right[]> -Administrator <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This command removes rights from the specified administrator.

For convenience, you can use the -All parameter to specify the 'All' scope.

Use the Get-AdminAdministrator cmdlet to determine what rights an administrator has.

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the rights to remove. true true (ByValue)
Scope Specifies the scope name or scope identifier. true false
Role Specifies the role name or role identifier. true false
Administrator Specifies the name or ID of the administrator. true false
All Specifies the 'All' scope. This parameter avoids localization issues or having to type the identifier of the 'All' scope. false false
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false
BearerToken Specifies the bearer token assigned to the calling user 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

Citrix.Delegatedadmin.Sdk.Right

You can pipe the rights to be removed into this command.

Return Values

None

Examples

Example 1

C:\PS> RemoveAdminRight -Role 'Help Desk Administrator' -Scope London -Administrator DOMAIN\Admin1

Description

Removes the 'Help Desk Administrator' role and 'London' scope from user 'Admin1'

Example 2

C:\PS> $admin = Get-AdminAdministrator -Name DOMAIN\Admin

C:\PS> Remove-AdminRight -InputObject $admin.Rights -Administrator DOMAIN\Admin

Description

Removes all rights from administrator 'Admin'.

Was this article helpful?