Remove-DSRoleAssignment

Synopsis

Remove an administrative role assignment.

Syntax

ByAssignee

Remove-DSRoleAssignment -RoleID <guid> -PrincipalId <guid[]>
 -ScopeType <AdministrativeRoleAssignmentScopeType> [-ScopeID <guid[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

WholeScope

Remove-DSRoleAssignment -RoleID <guid> -WholeScope -ScopeType <AdministrativeRoleAssignmentScopeType>
 [-ScopeID <guid[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Remove specific principals from a role at one or more scopes, or use -WholeScope to remove every member of the role at those scopes in one call.

Examples

Example 1

PS C:\> Remove-DSRoleAssignment -RoleID $role.Id -PrincipalId $userID -ScopeType Repository -ScopeID $vaultID

Remove a single user's 'Vault Owner' assignment on a specific vault.

Example 2

PS C:\> Remove-DSRoleAssignment -RoleID $role.Id -ScopeType Repository -ScopeID $vaultID -WholeScope

Remove every principal holding the role on the vault. Prompts for confirmation; pass -Confirm:$false to skip it.

Parameters

-Confirm

Prompts for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PrincipalId

IDs of the users, user groups, or application identities to remove the role from.

Type: System.Guid[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByAssignee
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-RoleID

ID of the role.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ScopeID

IDs of the scope resources to remove the assignment(s) from: vault IDs when -ScopeType is Repository, gateway IDs when Gateway, PAM provider IDs when PamProvider, or business unit IDs when OrganizationalUnit. Required unless -ScopeType is Global; ignored (with a warning) when -ScopeType is Global.

Type: System.Guid[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ScopeType

Scope type of the assignment(s) to remove. Required, there is no default, to avoid silently removing at the wrong scope.

Type: Devolutions.RemoteDesktopManager.AdministrativeRoleAssignmentScopeType
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WholeScope

Remove every principal holding the role at the given scope(s), instead of only the principals listed in -PrincipalId.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: WholeScope
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Remove-DSRoleAssignment -detailed". For technical information, type "Get-Help Remove-DSRoleAssignment -full".