# Get-User Returns one or more Sitecore users using the specified criteria. ## Syntax ``` Get-User [-Identity] [-Authenticated] Get-User -Filter [-Authenticated] [-ResultPageSize ] Get-User -Current ``` ## Detailed Description The Get-User command returns a user or performs a search to retrieve multiple users from Sitecore. 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 $\. To search for and retrieve more than one user, use the Filter parameter. © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions ## Parameters ### -Identity \ Specifies the Sitecore user by providing one of the following values. Local Name: ```powershell admin ``` Fully Qualified Name: ```powershell sitecore\admin ``` | Aliases | | | --------------------------- | -------------- | | Required? | true | | Position? | 1 | | Default Value | | | Accept Pipeline Input? | true (ByValue) | | Accept Wildcard Characters? | false | ### -Filter \ 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: ```powershell Get-User -Filter * ``` To get all the users in a domain use the following command: ```powershell Get-User -Filter "sitecore\*" ``` | Aliases | | | --------------------------- | ----- | | Required? | true | | Position? | named | | Default Value | | | Accept Pipeline Input? | false | | Accept Wildcard Characters? | false | ### -Current \ | Aliases | | | --------------------------- | ----- | | Required? | true | | Position? | named | | Default Value | | | Accept Pipeline Input? | false | | Accept Wildcard Characters? | false | ### -Authenticated \ | Aliases | | | --------------------------- | ----- | | Required? | false | | Position? | named | | Default Value | | | Accept Pipeline Input? | false | | Accept Wildcard Characters? | false | ### -ResultPageSize \ Specifies the number of users to retrieve per request to the user provider. Each page of users is written to the pipeline before the next request is made. Without specifying this parameter all accounts are retrieved before passing down the pipeline. | 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. * System.String Represents the identity of a user. ## Outputs The output type is the type of the objects that the cmdlet emits. * Sitecore.Security.Accounts.User Returns one or more users. ## Notes Help Author: Adam Najmanowicz, Michael West ## Examples ### EXAMPLE 1 ```powershell PS master:\> Get-User -Identity admin Name Domain IsAdministrator IsAuthenticated ---- ------ --------------- --------------- sitecore\admin sitecore True False ``` ### EXAMPLE 2 ```powershell PS master:\> "admin","michael" | Get-User Name Domain IsAdministrator IsAuthenticated ---- ------ --------------- --------------- sitecore\Admin sitecore True False sitecore\michael sitecore False False ``` ### EXAMPLE 3 ```powershell PS master:\> Get-User -Filter * Name Domain IsAdministrator IsAuthenticated ---- ------ --------------- --------------- default\Anonymous default False False extranet\Anonymous extranet False False sitecore\Admin sitecore True False sitecore\michael sitecore False False ``` ### EXAMPLE 4 ```powershell PS master:\> Get-User -Filter "michaellwest@*.com" Name Domain IsAdministrator IsAuthenticated ---- ------ --------------- --------------- sitecore\michael sitecore False False ``` ### EXAMPLE 5 Expand the MemberOf property to see a list of roles that the specified user is a member. ```powershell PS master:\> Get-User -Identity sitecore\michael | Select-Object -ExpandProperty MemberOf Name Domain IsEveryone ---- ------ ---------- sitecore\PowerShell Extensions Remoting sitecore False sitecore\Developer sitecore False ``` ## Related Topics * * [Set-User](https://doc.sitecorepowershell.com/appendix/security/set-user) * [New-User](https://doc.sitecorepowershell.com/appendix/security/new-user) * [Remove-User](https://doc.sitecorepowershell.com/appendix/security/remove-user) * [Unlock-User](https://doc.sitecorepowershell.com/appendix/security/unlock-user) --- # 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/get-user.md?ask= ``` 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.