Disable-User
Disables the specified Sitecore user.
Syntax
Disable-User [-Identity] <AccountIdentity>
Disable-User -Instance <User>
Detailed Description
The Disable-User command gets a user and disables the account in 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 lt;user>.
© 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.
1
Local Name
2
Example: michael
3
Fully Qualified Name
4
Example: sitecore\michael
Copied!
Aliases
​
Required?
true
Position?
1
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false
-Instance <User>
Specifies the Sitecore user by providing an instance of a user.
Aliases
​
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.StringRepresents the identity of a user.
Sitecore.Security.Accounts.User One or more user instances.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None.
Notes
Michael West
Examples
EXAMPLE 1
1
PS master:\> Disable-User -Identity michael
Copied!
EXAMPLE 2
1
PS master:\> Get-User -Filter * | Disable-User
Copied!
Related Topics
Last modified 2yr ago