New-RDMUser

    2025-02-17

    New-RDMUser

    SYNOPSIS

    Create a new user instance.

    SYNTAX

    Password

    New-RDMUser [-Administrator] [-BypassAzureADValidationEvenIfUnsupported] [-Login <string>]
 [-SetUser] [-ForcePromptAnswer <DialogResult[]>] [-Email <string>] [-Password <securestring>]
 [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Create a user instance. The instance has not yet been saved. Use the SetUser parameter or assign the result to a variable then call "Set-RDMUser $s" to save the user.

    EXAMPLES

    EXAMPLE 1

    PS C:> $user = New-RDMUser -AuthenticationType SqlServer -Login 'PSTest' -Password (ConvertTo-SecureString -String 'password' -AsPlainText -Force) -SetUser

    Create & save new user.

    EXAMPLE 2

    PS C:> $user = New-RDMUser -Login 'domain\username' -IntegratedSecurity -SkipCreateSQLServerLogin; $user.UserType = 'User'; Set-RDMUser $user

    Before everything, the administrator add the login/user to the database. Create the user domain\username with integrated security. The SkipCreateSQLServerLogin switch indicates the administrator will manually add the information in the database. Change the user type from read-only to user and save the user.

    EXAMPLE 3

    PS C:> $user = = New-RDMUser -AuthenticationType SqlServer -Login 'PSTest' -Password (ConvertTo-SecureString -String 'password' -AsPlainText -Force); $user.UserInfo.UserProfile.Company = 'UsersCompany'; $user.UserInfo.UserProfile.Department = 'UsersDepartment'; $user.UserInfo.UserProfile.Address = '123 UsersAddress'; $user.UserInfo.UserProfile.Phone = '555-0100'; Set-RDMUser -User $user

    Create a user and add some details about him before saving him.

    PARAMETERS

    -Administrator

    Gives the user administrator rights

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

    -BypassAzureADValidationEvenIfUnsupported

    Bypass validation preventing creation of AzureAD user when connected with a database user. Do so at your own risk.

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

    -Email

    User email. Available when using a all data source except DODB

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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 not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Login

    Login.

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

    -Password

    User password. Available when using a SQL Server data source and integrated security is not used

    Type: System.Security.SecureString
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Password
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -SetUser

    Set the user in the data source

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
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.

    INPUTS

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo

    NOTES

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