Citrix Virtual Apps and Desktops SDK

Remove-Adminpermission

August 3, 2023

Contributed by:

Remove permissions from the set of permissions of a role.

Syntax

Remove-AdminPermission [-InputObject] <Permission[]> -Role <String> [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminPermission [-Permission] <String[]> -Role <String> [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminPermission -All -Role <String> [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Remove permissions from the set of permissions that a role maps to.

Any administrator with a right including that role immediately loses the ability to use the operations of the removed permissions.

Duplicate permissions do not produce an error, and permissions that the roles does not already have are skipped (without error).

You cannot modify the permissions of built-in roles.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the permissions to remove.	true	true (ByValue)
Permission	Specifies the list of permissions to remove (by identifier).	true	true (ByPropertyName)
Role	Role name or identifier of the role to update.	true	false
All	Remove all permissions.	true	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
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

Citrix.Delegatedadmin.Sdk.Permission

You can pipe a list of permissions to be removed into this command.

Return Values

None

Examples

Example 1

C:\PS> Remove-AdminPermission -Role MyRole -Permission Global_Read,Logging_Read
<!--NeedCopy-->

Description

Remove a couple of specific permissions from the ‘MyRole’ role.

Example 2

C:\PS> Remove-AdminPermission -Role MyRole -All
<!--NeedCopy-->

Description

Remove all permissions from the ‘MyRole’ role.

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

Remove-Adminpermission

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-Adminpermission

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Delegatedadmin.Sdk.Permission

Return Values

None

Examples

Example 1

Description

Example 2

Description

In this article