Remove-AdfsClient

Article
06/30/2015

Remove-AdfsClient

Deletes registration information for an OAuth 2.0 client that is currently registered with AD FS.

Syntax

Parameter Set: Name
Remove-AdfsClient [-TargetName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ClientId
Remove-AdfsClient [-TargetClientId] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Remove-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-AdfsClient cmdlet deletes registration information for an OAuth 2.0 client that is currently registered withActive 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.

Aliases	none
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.

Aliases	none
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.

Aliases	none
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.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

System.Object

Examples

Example 1: Delete registration information for an OAuth client

This command deletes registration information for the OAuth 2.0 client that is identified by the name Payroll Application.

PS C:\> Remove-AdfsClient -TargetName "Payroll Application"

Remove-AdfsClient