Set-RDMCloudVaultAccess

Synopsis

Replace all permission assignments on a Devolutions Cloud vault.

Syntax

__AllParameterSets

Set-RDMCloudVaultAccess [-Vault] <PSRepositoryInfo> [-Permissions] <PSVaultPermissionInfo[]>
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Replaces the entire set of vault-level permission assignments on a Devolutions Cloud vault. Pass an array of PSVaultPermissionInfo objects (created with New-RDMCloudVaultAccess or retrieved with Get-RDMCloudVaultAccess) to define the full desired access list. Any user, user group, or application identity not included in the array will lose access to the vault. Pass an empty array to clear all permissions.

Examples

Example 1

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> $user = Get-RDMUser -Name "MyUser"
PS C:\> $group = Get-RDMUserGroup -Name "MyGroup"
PS C:\> $userPerm = New-RDMCloudVaultAccess -User $user -Role Contributors
PS C:\> $groupPerm = New-RDMCloudVaultAccess -UserGroup $group -Role Readers
PS C:\> Set-RDMCloudVaultAccess -Vault $vault -Permissions @($userPerm, $groupPerm)

Replaces vault permissions with a contributor user and a reader user group.

Example 2

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> $userToRemove = Get-RDMUser -Name "MyUser"
PS C:\> $perms = Get-RDMCloudVaultAccess -Vault $vault
PS C:\> $perms = $perms | Where-Object { $_.PrincipalId -ne $userToRemove.ID }
PS C:\> Set-RDMCloudVaultAccess -Vault $vault -Permissions $perms

Retrieves existing permissions, removes one user, and re-applies the updated list.

Example 3

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> Set-RDMCloudVaultAccess -Vault $vault -Permissions @()

Clears all permission assignments from the vault.

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

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

-Permissions

Full set of permission assignments to apply to the vault. Replaces all existing assignments.

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

-Vault

Devolutions Cloud vault to replace permissions on.

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 replace permissions on.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSVaultPermissionInfo

Full set of permission assignments to apply to the vault.

Notes

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