Set-HubVaultPermission

2024-12-11

Set-HubVaultPermission

SYNOPSIS

SYNTAX

UserWithRolePermissions

Set-HubVaultPermission -VaultId <guid> -UserId <guid> -VaultRoleId <guid> [-HubContext <HubContext>]
 [<CommonParameters>]

UserWithCustomPermissions

Set-HubVaultPermission -VaultId <guid> -UserId <guid> -VaultPermission <VaultPermissionRole>
 [-HubContext <HubContext>] [<CommonParameters>]

GroupWithRolePermissions

Set-HubVaultPermission -VaultId <guid> -GroupId <guid> -VaultRoleId <guid>
 [-HubContext <HubContext>] [<CommonParameters>]

GroupWithCustomPermissions

Set-HubVaultPermission -VaultId <guid> -GroupId <guid> -VaultPermission <VaultPermissionRole>
 [-HubContext <HubContext>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

EXAMPLES

PARAMETERS

-GroupId

Id of the Hub Group

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

-HubContext

Hub context

Type: Devolutions.Hub.PowerShell.Entities.HubContext
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UserId

Id of the Hub User

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

-VaultId

Id of the Hub vault

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

-VaultPermission

Set custom vault permission

Type: Devolutions.Hub.Clients.VaultPermissionRole
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: UserWithCustomPermissions
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: GroupWithCustomPermissions
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultRoleId

Set predefined permissions based on Hub Vault Roles

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: UserWithRolePermissions
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: GroupWithRolePermissions
  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.

INPUTS

OUTPUTS

NOTES

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

RELATED LINKS