New-RDMCloudVaultAccess

Synopsis

Create a new Devolutions Cloud vault permission assignment object.

Syntax

User

New-RDMCloudVaultAccess [-User] <PSCloudUserInfo> [[-Role] <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

UserGroup

New-RDMCloudVaultAccess [-UserGroup] <PSRoleInfo> [[-Role] <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ApplicationIdentity

New-RDMCloudVaultAccess [-ApplicationIdentity] <PSApplicationIdentityInfo> [[-Role] <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Creates a new PSVaultPermissionInfo object for a given user, user group, or application identity. Optionally seeds the permission flags from a predefined vault role. The returned object can be modified and then passed to Set-RDMCloudVaultAccess to apply the permissions to a vault.

Examples

Example 1

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> $user = Get-RDMUser -Name "MyUser"
PS C:\> $readerPerm = New-RDMCloudVaultAccess -User $user -Role Readers
PS C:\> Set-RDMCloudVaultAccess -Vault $vault -Permissions @($readerPerm)

Creates a Readers role permission for a user and applies it to a vault.

Example 2

PS C:\> $vault = Get-RDMVault -Name "MyVault"
PS C:\> $group = Get-RDMUserGroup -Name "MyGroup"
PS C:\> $customPerm = New-RDMCloudVaultAccess -UserGroup $group
PS C:\> $customPerm.ViewEntries = $true
PS C:\> $customPerm.ViewPassword = $true
PS C:\> Set-RDMCloudVaultAccess -Vault $vault -Permissions @($customPerm)

Creates a custom permission for a user group with specific flags enabled and applies it to a vault.

Parameters

-ApplicationIdentity

Application identity to create a permission assignment for.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSApplicationIdentityInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ApplicationIdentity
  Position: 0
  IsRequired: true
  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: ''

-Role

Predefined vault role to seed the permission flags from.

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

-User

User to create a permission assignment for.

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

-UserGroup

User group to create a permission assignment for.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: UserGroup
  Position: 0
  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.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSVaultPermissionInfo

Notes

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