Remove-AdfsClient
Remove-AdfsClient is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.
Synopsis
Deletes registration information for an OAuth 2.0 client that is currently registered with AD FS.
Description
The Remove-AdfsClient cmdlet deletes registration information for an OAuth 2.0 client that is currently registered with Active Directory Federation Services (AD FS). After you delete the registration information for the OAuth 2.0 client, AD FS no longer issues authorization codes or access tokens to that OAuth 2.0 client.
Parameters
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetClient <AdfsClient>
Specifies the registered OAuth 2.0 client to delete.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-TargetClientId <String>
Specifies the client identifier for the registered OAuth 2.0 client to delete.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TargetName <String>
Specifies the name of the registered OAuth 2.0 client to delete.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
Syntax
Remove-AdfsClient [-TargetName] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-AdfsClient [-TargetClientId] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
————————-Example 1————————-
Delete registration information for an OAuth client
PS C:> Remove-AdfsClient -TargetName “Payroll Application”
This command deletes registration information for the OAuth 2.0 client that is identified by the name Payroll Application.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Remove-AdfsClient
You can also read about
- Add-AdfsClient
- Disable-AdfsClient
- Enable-AdfsClient
- Get-AdfsClient
- Set-AdfsClient