# 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.

```powershell
Local Name
    Example: admin
Fully Qualified Name
    Example: sitecore\admi
```

| 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

```powershell
PS master:\> Export-User -Identify sitecore\admin
```

## Related Topics

* [Export-Role](/appendix/security/export-role.md)
* [Import-User](/appendix/security/import-user.md)
* [Export-Item](/appendix/packaging/export-item.md)
* [Import-Role](/appendix/security/import-role.md)
* [Import-Item](/appendix/security/export-user.md)
* [Get-User](/appendix/security/get-user.md)
* <https://github.com/SitecorePowerShell/Console/>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.sitecorepowershell.com/appendix/security/export-user.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.