Remove-AdmPasswordSelfServiceEnrollment
Disenrolls an Active Directory user from Password Self-Service.
- Remove-AdmPasswordSelfServiceEnrollment
- [-Identity] <ADUser> required parameter
- -AdaxesService <string> required parameter
- [-Confirm]
- [-Credential <PSCredential>]
- [-Partition <string>]
- [-PassThru]
- [-Server <string>]
- [-WhatIf]
- [<CommonParameters>]
Description
The Remove-AdmPasswordSelfServiceEnrollment
cmdlet disenrolls an Active Directory user from Password Self-Service.
The Identity
parameter specifies the Active Directory user to disenroll. You can identify a user by their distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. You can also set the parameter to a user object variable, such as $<localUserObject>
or pass a user object through the pipeline to the Identity
parameter.
Examples
Example 1 – Disenroll a user from Password Self-Service
Remove-AdmPasswordSelfServiceEnrollment GlenJohn -AdaxesService localhost
This command disenrolls user GlenJohn from Password Self-Service.
Parameters
-AdaxesService
Specifies the DNS name of the Adaxes service that will be used to execute this cmdlet (e.g. localhost, adaxes.company.com).
-
Type:
-
string
-
Position:
-
Named
-
Required:
-
True
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-Confirm
Prompts you for confirmation before executing the command.
-
Type:
-
SwitchParameter
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
False
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-Credential
Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential
cmdlet. You can then set the Credential
parameter to the PSCredential object.
If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.
-
Type:
-
PSCredential
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-Identity
Specifies an Active Directory user object by providing one of the following property values. The identifier in parentheses is the schema name of the attribute.
Possible values for this parameter are:
- Distinguished name (distinguishedName)
- GUID (objectGUID)
- Security identifier (objectSid)
- SAM Account Name (sAMAccountName)
The cmdlet searches the default naming context or partition to find the object.
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
-
Type:
-
ADUser
-
Position:
-
1
-
Required:
-
True
-
Default Value:
-
None
-
Accept pipeline input:
-
True (ByValue)
-
Accept wildcard characters:
-
False
-Partition
Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity
parameter.
In many cases, a default value will be used for the Partition
parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.
- If the
Identity
parameter is set to a distinguished name, the default value ofPartition
is automatically generated from this distinguished name. - If running cmdlets from an Adaxes Active Directory provider drive, the default value of
Partition
is automatically generated from the current path in the drive. - If none of the previous cases apply, the default value of
Partition
will be set to the default partition or naming context of the target domain.
-
Type:
-
string
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-
Type:
-
SwitchParameter
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-Server
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance in one of the following ways:
Domain name values:
- Fully qualified domain name
- NetBIOS name
Directory server values:
- Fully qualified directory server name
- NetBIOS name
- Fully qualified directory server name and port
The default value for the Server
parameter is determined by one of the following methods in the order that they are listed:
- By using
Server
value from objects passed through the pipeline. - By using the server information associated with the Adaxes Active Directory PowerShell provider drive, when running under that drive.
- By using the domain of the computer running PowerShell.
-
Type:
-
string
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
Type:
-
SwitchParameter
-
Position:
-
Named
-
Required:
-
False
-
Default Value:
-
None
-
Accept pipeline input:
-
False
-
Accept wildcard characters:
-
False
Inputs
Softerra.Adaxes.PowerShellModule.Directory.ADUser
A user object is received by the Identity
parameter.
Outputs
None or Softerra.Adaxes.PowerShellModule.Directory.ADUser
Returns the user object when the PassThru
parameter is specified. By default, this cmdlet does not generate any output.