Set-DSVaultRole

2024-12-11

Set-DSVaultRole

SYNOPSIS

Sets the allowed user groups for a given vault.

SYNTAX

__AllParameterSets

Set-DSVaultRole [-VaultID] <guid> [[-AllowedRolesList] <string[]>] [-Update] [-AsLegacyResponse]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Sets which users have access to a given vault. If the "Update" flag is present and a supplied username is already a member of the vault, it will remove this user.

EXAMPLES

EXAMPLE 1

PS C:> Set-DSVaultRole @("Role1", "Role2")

No role allowed in the vault before the execution. Role1 and Role2 allowed in the vault after the command.

EXAMPLE 2

PS C:> Set-DSVaultRole @("Role3")

Role1 and Role2 allowed in the vault before the execution. Role3 is the only role allowed in the vault after the command.

EXAMPLE 3

PS C:> Set-DSVaultRole @("Role2") -Update

User1 allowed in the vault before the execution. Role1 and Role2 allowed in the vault after the command. The update flag keeps previous users.

EXAMPLE 4

PS C:> Set-DSVaultRole @("User2", "Role3") -Update

Role1 and Role2 allowed in the vault before the execution. Role1 and Role3 allowed in the vault after the command. Role2 lose his access because of the presence of the update flag.

PARAMETERS

-AllowedRolesList

Accept an array of strings containing usernames (not id) to allow in vault

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

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

-Update

Update the current users instead of overwriting them.

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

-VaultID

Vault's ID to update

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  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.

INPUTS

OUTPUTS

RemoteDesktopManager.PowerShellModule.Private.ServerResponse

NOTES

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

RELATED LINKS