Get-RDMRoleAssignment

Synopsis

Retrieve administrative role assignments.

Syntax

Scope

Get-RDMRoleAssignment [-Role <PSAdministrativeRole>] [-ScopeType <AdministrativeRoleAssignmentScopeType>]
 [-ScopeID <guid>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

User

Get-RDMRoleAssignment -User <PSUserInfo> [-Role <PSAdministrativeRole>]
 [-ScopeType <AdministrativeRoleAssignmentScopeType>] [-ScopeID <guid>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

UserGroup

Get-RDMRoleAssignment -UserGroup <PSRoleInfo> [-Role <PSAdministrativeRole>]
 [-ScopeType <AdministrativeRoleAssignmentScopeType>] [-ScopeID <guid>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ApplicationIdentity

Get-RDMRoleAssignment -ApplicationIdentity <PSApplicationIdentityInfo> [-Role <PSAdministrativeRole>]
 [-ScopeType <AdministrativeRoleAssignmentScopeType>] [-ScopeID <guid>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Retrieve the administrative roles holding an assignment at a scope, each with its assigned members. With no filter, every assignment in the workspace is returned, across every scope type.

Examples

Example 1

PS C:\> Get-RDMRoleAssignment -ScopeType Repository -ScopeID $vault.ID

Retrieves every role assigned on a specific vault.

Example 2

PS C:\> Get-RDMRoleAssignment

Retrieves every role assignment in the workspace, across every scope type.

Example 3

PS C:\> Get-RDMAdministrativeRole -Name "Vault Owner" | Get-RDMRoleAssignment

Retrieves every scope where the 'Vault Owner' role is assigned.

Example 4

PS C:\> Get-RDMRoleAssignment -User (Get-RDMUser -Name "jsmith")

Retrieves every assignment held by a user.

Parameters

-ApplicationIdentity

Application identity to filter on

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

Administrative role to filter on

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

-ScopeID

Scope resource ID to filter on: a vault ID when -ScopeType is Repository, a gateway ID when Gateway, a PAM provider ID when PamProvider, or a business unit ID when OrganizationalUnit

Type: System.Nullable`1[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 to filter on. When omitted, assignments across every scope type are returned

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.AdministrativeRoleAssignmentScopeType]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-User

User to filter on

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

-UserGroup

User group to filter on

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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSAdministrativeRole

Administrative role to filter on

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleAssignmentScope

Notes

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