Add-DSRoleAssignment

Synopsis

Assign an administrative role to one or more principals at one or more scopes.

Syntax

__AllParameterSets

Add-DSRoleAssignment -RoleID <guid> -PrincipalId <guid[]> -ScopeType <AdministrativeRoleAssignmentScopeType>
 [-ScopeID <guid[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Grant a role to one or more users, user groups, or application identities at one or more scope resources. Unlike the legacy Set-DSVaultUser/-UserGroup/-Application cmdlets, this sets the scope resource ID the server requires for the assignment to take effect.

Examples

Example 1

PS C:\> $role = Get-DSAdministrativeRole | Where-Object Name -EQ 'Vault Owner'
PS C:\> Add-DSRoleAssignment -RoleID $role.Id -PrincipalId $userID -ScopeType Repository -ScopeID $vaultID

Grant the 'Vault Owner' role to a user on a specific vault.

Example 2

PS C:\> Add-DSRoleAssignment -RoleID $role.Id -PrincipalId $userID1, $userID2 -ScopeType Repository -ScopeID $vaultID1, $vaultID2

Grant the role to two users on two vaults in a single call (4 assignments total).

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

-PrincipalId

IDs of the users, user groups, or application identities to assign the role to.

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

-RoleID

ID of the role to assign.

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

-ScopeID

IDs of the scope resources the role is assigned on: vault IDs when -ScopeType is Repository, gateway IDs when Gateway, PAM provider IDs when PamProvider, or business unit IDs when OrganizationalUnit. Required unless -ScopeType is Global; ignored (with a warning) when -ScopeType is Global.

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

-ScopeType

Scope type of the assignment. Required, there is no default, to avoid silently assigning at the wrong scope.

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

Notes

For more information, type "Get-Help Add-DSRoleAssignment -detailed". For technical information, type "Get-Help Add-DSRoleAssignment -full".