Export-User
Export (serialize) a Sitecore user to the filesystem on the server.
Syntax
Export-User [-Identity] <AccountIdentity> [-Root <String>]
Export-User [-Identity] <AccountIdentity> -Path <String>
Export-User -Filter <String> [-Root <String>]
Export-User [-User] <User> [-Root <String>]
Export-User [-User] <User> -Path <String>
Export-User -Current [-Root <String>]
Export-User -Current -Path <String>
Detailed Description
The Export-User command serializes a Sitecore user to the filesystem on the server.
The Identity parameter specifies the Sitecore user to get. You can specify a user by its local name or fully qualified name. You can also specify user object variable, such as $<user>.
To search for and retrieve more than one user, use the Filter parameter.
You can also pipe a user from the Get-user command.
© 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.
| Aliases | |
|---|---|
Required? | true |
Position? | 1 |
Default Value | |
Accept Pipeline Input? | true (ByValue) |
Accept Wildcard Characters? | false |
-Filter <String>
Specifies a simple pattern to match Sitecore users.
Examples: The following examples show how to use the filter syntax.
To get all the users, use the asterisk wildcard: Export-User -Filter *
To get all the users in a domain use the following command: Export-User -Filter "sitecore*"
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-User <User>
User object retrieved from the Sitecore API or using the Get-User command.
| Aliases | |
|---|---|
Required? | true |
Position? | 1 |
Default Value | |
Accept Pipeline Input? | true (ByValue) |
Accept Wildcard Characters? | false |
-Current <SwitchParameter>
Specifies that the current user should be serialized.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Path <String>
Path to the file the user should be saved to.
| Aliases | |
|---|---|
Required? | true |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Root <String>
Overrides Sitecore Serialization root directory
| Aliases | |
|---|---|
Required? | false |
Position? | named |
Default Value | |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Sitecore.Security.Accounts.User
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE
Related Topics
Last updated