New-MceUser
SYNOPSIS
Creates a new MCE user.
SYNTAX
Pipe
New-MceUser [[-Name] <String>] [[-Status] <InitialUserStatus>] [-ObjectGuid] <Guid> [-Force]
[<CommonParameters>]
Properties
New-MceUser [[-Name] <String>] [[-Status] <InitialUserStatus>] [-LinkedUserIdentities] <Array> [-Force]
[<CommonParameters>]
DESCRIPTION
This cmdlet creates a new user on the system, and returns the user's ID.
The cmdlet is designed to support pipelining from Microsoft.ActiveDirectory.Management.ADUser instances to create users linked to Active Directory identities.
EXAMPLES
EXAMPLE 1
New-MceUser
Creates a default disabled user.
EXAMPLE 2
New-MceUser -Status Enabled
Creates an enabled user.
EXAMPLE 3
New-MceUser -DisplayName "testuser" -ObjectGuid 12345678-1234-1234-1234-123456789012 -Status Enabled
Creates an enabled user with the display name "testuser" and IDAM Guid "12345678-1234-1234-1234-123456789012"
EXAMPLE 4
Get-AdUser -Filter 'Name -Like "Harry*"' | New-MceUser -Status Enabled
Creates an enabled user for every guid returned by the Get-AdUser cmdlet.
EXAMPLE 5
New-MceUser -DisplayName "testuser" -ObjectGuid 12345678-1234-1234-1234-123456789012 -Status Enabled -Force
Force creates a user by bypassing the duplicate users check. May result in creation of duplicate users for the same linked user identity.
PARAMETERS
-Name
The user display name.
This value is optional, since the user display name may be synchronized from external identity provider. Additionally, if synchronized from an external provider, the display name value provided here will be overridden.
Type: String
Parameter Sets: (All)
Aliases: DisplayName
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Status
This represents the status of the user, where enabled will allow logon and attribute synchronization.
Possible values: Disabled, Enabled, Suspended
Type: InitialUserStatus
Parameter Sets: (All)
Aliases:
Accepted values: Disabled, Enabled, Suspended
Required: False
Position: 1
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False
-ObjectGuid
The objectGuid property of an associated identity in Active Directory.
Setting this property adds a linked identity.
This property is designed for pipelining from Microsoft Active Directory cmdlets.
Type: Guid
Parameter Sets: Pipe
Aliases:
Required: True
Position: 2
Default value: 00000000-0000-0000-0000-000000000000
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LinkedUserIdentities
The linked user identities.
Type: Array
Parameter Sets: Properties
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
{{ Fill Force Description }}
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.String
The user display name.
This value is optional, since the user display name may be synchronized from external identity provider. Additionally, if synchronized from an external provider, the display name value provided here will be overridden.
System.Guid
The objectGuid property of an associated identity in Active Directory.
Setting this property adds a linked identity.
This property is designed for pipelining from Microsoft Active Directory cmdlets.