Skip to content

new-user.md

Latest commit

 

History

History
161 lines (113 loc) · 3.66 KB

new-user.md

File metadata and controls

161 lines (113 loc) · 3.66 KB

New-User

Creates a new Sitecore user.

Syntax

New-User [-Identity] <AccountIdentity> [-Password <String>] [-Email <String>] [-FullName <String>] [-Comment <String>] [-Portrait <String>] [-Enabled] [-ProfileItemId <ID>]

Detailed Description

The New-User command creates a new user in Sitecore.

The Identity parameter specifies the Sitecore user to create. You can specify a user by its local name or fully qualified name.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Identity <AccountIdentity>

Specifies the Sitecore user by providing one of the following values.

Local Name
    Example: developer
Fully Qualified Name
    Example: sitecore\developer
Aliases
Required? true
Position? 1
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-Password <String>

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-Email <String>

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-FullName <String>

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-Comment <String>

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-Portrait <String>

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-Enabled <SwitchParameter>

Specifies that the account should be enabled. When enabled, the Password parameter is required.

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

-ProfileItemId <ID>

Specifies the profile id to use for the user.

Aliases
Required? false
Position? named
Default Value
Accept Pipeline Input? true (ByPropertyName)
Accept Wildcard Characters? false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    Represents the identity of a role.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None.

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

PS master:\> New-User -Identity michael

EXAMPLE 2

PS master:\> New-User -Identity michael -Enabled -Password b -Email michaellwest@gmail.com -FullName "Michael West"

EXAMPLE 3

PS master:\> New-User -Identity michael -PassThru

Name                     Domain       IsAdministrator IsAuthenticated
----                     ------       --------------- ---------------
sitecore\michael2        sitecore     False           False

Related Topics