Remove-RDMCloudVaultAccess

Synopsis

Remove permission assignments from a Devolutions Cloud vault.

Syntax

User

Remove-RDMCloudVaultAccess [-Vault] <PSRepositoryInfo> [-User] <PSCloudUserInfo>
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

UserGroup

Remove-RDMCloudVaultAccess [-Vault] <PSRepositoryInfo> [-UserGroup] <PSRoleInfo>
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ApplicationIdentity

Remove-RDMCloudVaultAccess [-Vault] <PSRepositoryInfo> [-ApplicationIdentity] <PSApplicationIdentityInfo>
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

AllPrincipals

Remove-RDMCloudVaultAccess [-Vault] <PSRepositoryInfo> -RemoveAll [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes vault-level permission assignments from a Devolutions Cloud vault. When called with a specific principal (user, user group, or application identity), only that principal's assignment is removed. To remove all permission assignments at once, use the -RemoveAll switch. Principals that have no existing assignment on the vault are silently ignored.

Examples

Example 1

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> Remove-RDMCloudVaultAccess -Vault $vault -RemoveAll

Removes all permission assignments from the vault.

Example 2

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> $user = Get-RDMUser -Name "MyUser"
PS C:\> Remove-RDMCloudVaultAccess -Vault $vault -User $user

Removes the permission assignment for a specific user from the vault.

Parameters

-ApplicationIdentity

Application identity whose permission assignment should be removed.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSApplicationIdentityInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ApplicationIdentity
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

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

-RemoveAll

Confirm removal of all permission assignments from the vault.

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

-User

User whose permission assignment should be removed.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSCloudUserInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: User
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UserGroup

User group whose permission assignment should be removed.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: UserGroup
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Vault

Devolutions Cloud vault to remove permissions from.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  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: ''

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.

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo

Devolutions Cloud vault to remove permissions from.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSCloudUserInfo

User whose permission assignment should be removed.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo

User group whose permission assignment should be removed.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSApplicationIdentityInfo

Application identity whose permission assignment should be removed.

Notes

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