Get-RDMImportableUserGroup

Synopsis

Retrieve the user groups available for import from an identity provider.

Syntax

__AllParameterSets

Get-RDMImportableUserGroup -Provider <ServerUserType> [-DomainName <string[]>] [-Name <string[]>]
 [-CaseSensitive] [-IncludeExisting] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Retrieve the security groups an identity provider makes available for import. Candidates already present on this workspace are excluded by default; use -IncludeExisting to see them too. Pipe the result to Import-RDMUserGroup to create the selected user groups. Requires a Devolutions Server workspace.

Examples

Example 1

PS C:\> Get-RDMImportableDomain -Provider Domain | Get-RDMImportableUserGroup

Retrieve the importable user groups of every configured Active Directory domain.

Example 2

PS C:\> Get-RDMImportableUserGroup -Provider Domain -DomainName 'contoso.com'

Retrieve the importable user groups of a specific domain.

Example 3

PS C:\> Get-RDMImportableUserGroup -Provider AzureAD -Name 'IT *'

Retrieve only the Microsoft Entra ID groups whose name starts with 'IT '.

Example 4

PS C:\> Get-RDMImportableUserGroup -Provider AzureAD -IncludeExisting

Retrieve every Microsoft Entra ID group, including the ones already present on this workspace.

Parameters

-CaseSensitive

Whether the name filter is case sensitive

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

-DomainName

The domain(s) to browse. Required for the Domain provider; ignored by AzureAD, Okta and PingOne.

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

-IncludeExisting

Include the candidates that already exist on this workspace.

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

-Name

Only return the user groups whose name matches. Wildcards are supported.

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

-Provider

The identity provider to browse.

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

Notes

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