Remove-AdfsClient
Deletes registration information for an OAuth 2.0 client that is currently registered with AD FS.
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>] 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.
Examples
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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetClient
Specifies the registered OAuth 2.0 client to delete.
| Type: | AdfsClient |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetClientId
Specifies the client identifier for the registered OAuth 2.0 client to delete.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetName
Specifies the name of the registered OAuth 2.0 client to delete.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
AdfsClient objects are received by the TargetClient parameter.
String objects are received by the TargetClientId and TargetName parameters.
Outputs
Returns the deleted AdfsClient object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.