Get-RDMImportableUser

Synopsis

Retrieve the users available for import from an identity provider.

Syntax

__AllParameterSets

Get-RDMImportableUser [-Provider] <ServerUserType> [-DomainName <string[]>] [-GroupFilter <string>]
 [-IncludeExisting] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

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

Examples

Example 1

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

Retrieve the importable users of every configured Active Directory domain.

Example 2

PS C:\> Get-RDMImportableUser -Provider Domain -DomainName 'contoso.com' -GroupFilter 'IT Admins'

Retrieve the importable users of a specific domain who belong to the IT Admins group.

Example 3

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

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

Parameters

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

-GroupFilter

Only return users belonging to this group. Ignored by the AzureAD provider. For the Domain provider, also excludes any user missing a UPN attribute.

Type: System.String
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: ''

-Provider

The identity provider to browse.

Type: Devolutions.RemoteDesktopManager.ServerUserType
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  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.PSImportableUser

Notes

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